com.tridion.linking

Class Link

java.lang.Object

com.tridion.linking.Link

All Implemented Interfaces:

com.tridion.linking.fastserialization.FastSerializable<Link>, ObjectSizeProvider, Serializable

public class Link
extends Object
implements ObjectSizeProvider, Serializable, com.tridion.linking.fastserialization.FastSerializable<Link>

The Link object is a bean that holds information about a link to a UDP resource. Other functional objects, like PageLink, ComponentLink and BinaryLink use this object.

All link properties can be modified after creation, allowing Template Designers to influence the Link object after creation.

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
Link(String url, String anchor, String parameters, String targetURI, String text, String attributes, boolean textOnFail) Creates a new Link instance.

Method Summary

Modifier and Type	Method and Description
String	getAnchor() Returns the anchor for this link.
String	getAttributes() Returns the attributes for this link.
String	getBinaryUrl()
int	getObjectSize() Estimates the size in bytes of this object and the objects that it owns.
String	getParameters() Returns the QueryString for this link.
String	getTargetURI() Returns the tcm:uri if the Item targetted by this link.
String	getText() Returns the link text for this link.
boolean	getTextOnFail() Returns the textOnFail value, which indicates if the link will return text if the targetted URI cannot be resolved or validated.
String	getURL() Returns the URL of the resolved item.
boolean	isResolved() Indicates if this link has been resolved and is targetting a valid URL.
Link	makeClone() This method creates a clone for current object.
void	setAnchor(String anchor) Sets the anchor of this Link instance.
void	setAttributes(String attributes) Sets the attributes for this Link instance.
void	setBinaryUrl(String binaryUrl) Allows to set image instead of given text.
void	setParameters(String parameters) Sets the QueryString of this Link instance.
void	setText(String text) Sets the link text for this Link instance.
void	setTextOnFail(boolean textOnFail) Sets the textOnFail property for this Link instance.
void	setURL(String theUrl) Sets the URL of this Link instance.
String	toString() The toString method returns a string representation of this instance.
String	toString(LinkStringStyle linkStringStyle) The toString method returns a string representation of this instance.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

Link

public Link(String url,
            String anchor,
            String parameters,
            String targetURI,
            String text,
            String attributes,
            boolean textOnFail)

Creates a new Link instance.

Parameters:

url - The URL to which this link object should point.

anchor - The anchor on a page to which should point.

parameters - The parameters that should be used appended to the URL.

targetURI - The tcm:uri that is targeted by this link.

text - The text that should be inside the link.

attributes - The attributes that should be used inside the link tag.

textOnFail - A boolean indicating whether or not the link text should be returned in case the link cannot be resolved.

Method Detail

makeClone

public Link makeClone()

This method creates a clone for current object. Instead of using serialization/deserialization it is based on fact that all fields in this class are immutable and they do not need to be cloned. It also decreases a memory consumption. NOTE: do not forget to fix this after adding new fields

Specified by:

makeClone in interface com.tridion.linking.fastserialization.FastSerializable<Link>

Returns:

cloned copy of object.

getObjectSize

public int getObjectSize()

Estimates the size in bytes of this object and the objects that it owns.

Specified by:

getObjectSize in interface ObjectSizeProvider

Returns:

The size in bytes.

getURL

public String getURL()

Returns the URL of the resolved item. The URL uses linking configuration information.

Returns:

The URL to which this link object is pointing, or null if it could not be resolved.

setURL

public void setURL(String theUrl)

Sets the URL of this Link instance.

Parameters:

theUrl - The new URL to which this link object should point.

getAnchor

public String getAnchor()

Returns the anchor for this link.

Returns:

The anchor for this link.

setAnchor

public void setAnchor(String anchor)

Sets the anchor of this Link instance.

Parameters:

anchor - The new anchor for this link.

getParameters

public String getParameters()

Returns the QueryString for this link.

Returns:

The QueryString for this link.

setParameters

public void setParameters(String parameters)

Sets the QueryString of this Link instance.

Parameters:

parameters - The new QueryString for this link instance.

getAttributes

public String getAttributes()

Returns the attributes for this link.

Returns:

The attributes for this link.

setAttributes

public void setAttributes(String attributes)

Sets the attributes for this Link instance.

Parameters:

attributes - The new attributes for this link instance.

getText

public String getText()

Returns the link text for this link.

Returns:

The link text for this link.

setText

public void setText(String text)

Sets the link text for this Link instance. In case binaryUrl is set, this text will be ignored.

Parameters:

text - The new link text that should appear inside the link.

getTextOnFail

public boolean getTextOnFail()

Returns the textOnFail value, which indicates if the link will return text if the targetted URI cannot be resolved or validated.

Returns:

The textOnFail property for this link.

setTextOnFail

public void setTextOnFail(boolean textOnFail)

Sets the textOnFail property for this Link instance.

Parameters:

textOnFail - The new textOnFail value.

getTargetURI

public String getTargetURI()

Returns the tcm:uri if the Item targetted by this link.

Returns:

The tcm:uri of this link's target.

getBinaryUrl

public String getBinaryUrl()

setBinaryUrl

public void setBinaryUrl(String binaryUrl)

Allows to set image instead of given text. In case both are set, text will be ignored.

Parameters:

binaryUrl - url of image (a.k.a. 'src' attribute in <img> tag).

isResolved

public boolean isResolved()

Indicates if this link has been resolved and is targetting a valid URL.

Returns:

A boolean indicating if this link has resolved.

toString

public String toString()

The toString method returns a string representation of this instance. When the link resolves, this will be in the form of <a href="...">text</a>. If the link doesn't resolve, it depends on the textOnFail attribute whether an empty String is returned, or the link text.

Overrides:

toString in class Object

Returns:

A String representing the link. This can be just the link text or an empty String depending on the resolving of the link and on the textOnFail parameter.

toString

public String toString(LinkStringStyle linkStringStyle)

The toString method returns a string representation of this instance. When the link resolves, this will be in the form of <a href="...">text</a>. If the link doesn't resolve, it depends on the textOnFail attribute whether an empty String is returned, or the link text.

Parameters:

linkStringStyle - the style of link

Returns:

A String representing the link. This can be just the link text or an empty String depending on the resolving of the link and on the textOnFail parameter.