com.tridion.linking

Class PageLink

java.lang.Object

com.tridion.linking.AbstractLink

com.tridion.linking.PageLink

public class PageLink
extends AbstractLink

The PageLink class provides functionality to validate and resolve links to Pages.

//create a new PageLink instance for publication 1: PageLink pageLink = new PageLink("tcm:0-1-1"); //resolve the link and print it to the output stream: out.println(pageLink.getLinkAsString("tcm:1-456-64", "2", "style='color: red;'", "read more", false);

Constructor Summary

Constructors

Constructor and Description
PageLink(int publicationId) Creates a new PageLink instance.
PageLink(String publicationURI) Creates a new PageLink instance.
PageLink(String namespace, int publicationId, boolean relativeLink) Creates a new PageLink instance.

Method Summary

Modifier and Type	Method and Description
Link	getLink(int targetPageId) Create a new Link object targetting a page with just a page Id.
Link	getLink(int targetPageId, String anchor, String linkTagAttributes, String linkText, boolean showTextOnFail) Create a Link object targetting a page.
Link	getLink(int targetPageId, String anchor, String linkTagAttributes, String linkText, boolean showTextOnFail, String parameters) Create a Link object targeting a page.
Link	getLink(String targetPageURI) Create a new Link object targetting a page with just a page URI.
Link	getLink(String targetPageURI, String anchor, String linkTagAttributes, String linkText, boolean showTextOnFail) Create a page link using a tcm:uri.
Link	getLink(String targetPageURI, String anchor, String linkTagAttributes, String linkText, boolean showTextOnFail, String parameters) Create a page link using a tcm:uri.
Link	getLink(String targetPageURI, String targetURL, String anchor, String linkTagAttributes, String linkText, boolean showTextOnFail, String parameters) Create a page link as a String a tcm:uri.
String	getLinkAsString(int targetPageId, String anchor, String linkTagAttributes, String linkText, boolean showTextOnFail) Create a page link as a String.
String	getLinkAsString(int targetPageId, String anchor, String linkTagAttributes, String linkText, boolean showTextOnFail, String parameters) Create a page link as a String, using a tcm:uri.
String	getLinkAsString(int targetPageId, String anchor, String linkTagAttributes, String linkText, boolean showTextOnFail, String parameters, LinkStringStyle style) Create a page link as a String, using a tcm:uri.
String	getLinkAsString(String targetPageURI, String anchor, String linkTagAttributes, String linkText, boolean showTextOnFail) Create a page link as a String using a tcm:uri.
String	getLinkAsString(String targetPageURI, String anchor, String linkTagAttributes, String linkText, boolean showTextOnFail, String parameters) Create a page link as a String, using a tcm:uri.
String	getLinkAsString(String targetPageURI, String anchor, String linkTagAttributes, String linkText, boolean showTextOnFail, String parameters, LinkStringStyle style) Create a page link as a String, using a tcm:uri.

Methods inherited from class com.tridion.linking.AbstractLink

getBaseNamespaceId, getErrorList, getFullyQualifiedURL, getLinking, getNamespace, getNamespaceService, getPublicationId, getURL, isRelativeLink, isWrappedCacheDAO, setPublicationId

Methods inherited from class java.lang.Object

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

Constructor Detail

PageLink

public PageLink(String namespace,
                int publicationId,
                boolean relativeLink)

Creates a new PageLink instance.

Parameters:

namespace - The namespace of the publication that is targeted

publicationId - The id of the publication that is targeted.

relativeLink - If true then the realtive URL will be returned from a Link object despite on linking configuration.

PageLink

public PageLink(int publicationId)

Creates a new PageLink instance. By default tries to resolve links using linking configuration.

Parameters:

publicationId - The id of the publication that is targeted.

PageLink

public PageLink(String publicationURI)

Creates a new PageLink instance. By default tries to resolve links using linking configuration.

Parameters:

publicationURI - The tcm:uri of the publication that is targetted.

Method Detail

getLink

public Link getLink(int targetPageId)

Create a new Link object targetting a page with just a page Id.

Parameters:

targetPageId - Id for the targetpage

getLink

public Link getLink(String targetPageURI)

Create a new Link object targetting a page with just a page URI.

Parameters:

targetPageURI - The URI for the targetpage

getLink

public Link getLink(int targetPageId,
                    String anchor,
                    String linkTagAttributes,
                    String linkText,
                    boolean showTextOnFail,
                    String parameters)

Create a Link object targeting a page.

Parameters:

targetPageId - Id for the targetpage

anchor - The anchor on the page where the link has to be pointing to.

linkTagAttributes - Attributes to include in the link.

linkText - The linkText that builds up the link.

showTextOnFail - Indicates if the linkText needs to be returned in case no link can be build: an empty string is returned if false.

parameters - HTTP parameters to be appended to the URL.

Returns:

The link (<A HREF=..>... </A>), linktext or empty string.

getLink

public Link getLink(int targetPageId,
                    String anchor,
                    String linkTagAttributes,
                    String linkText,
                    boolean showTextOnFail)

Create a Link object targetting a page.

Parameters:

targetPageId - Id for the targetpage

anchor - The anchor on the page where the link has to be pointing to.

linkTagAttributes - Attributes to include in the link.

linkText - The linkText that builds up the link.

showTextOnFail - Indicates if the linkText needs to be returned in case no link can be build: an empty string is returned if false.

Returns:

The link (<A HREF=..>... </A>), linktext or empty string.

getLink

public Link getLink(String targetPageURI,
                    String targetURL,
                    String anchor,
                    String linkTagAttributes,
                    String linkText,
                    boolean showTextOnFail,
                    String parameters)

Create a page link as a String a tcm:uri. Use this version to give aditional http parameters.

Parameters:

targetPageURI - The Id of the page where this link should link to.

targetURL - The targetURL for the targetpage

anchor - The anchor on the page where the link has to be pointing to.

linkTagAttributes - Attributes to include in the link.

linkText - The text that builds up the link.

showTextOnFail - Indicates if the linkText needs to be returned in case no link can be build: an empty string is returned if false.

parameters - HTTP parameters to be appended to the URL.

Returns:

The link (<A HREF=..>... </A>), linktext or empty string.

getLink

public Link getLink(String targetPageURI,
                    String anchor,
                    String linkTagAttributes,
                    String linkText,
                    boolean showTextOnFail,
                    String parameters)

Create a page link using a tcm:uri.

Parameters:

targetPageURI - The Id of the page where this link should link to.

anchor - The anchor on the page where the link has to be pointing to.

linkTagAttributes - Attributes to include in the link.

linkText - The text that builds up the link.

showTextOnFail - Indicates if the linkText needs to be returned in case no link can be build: an empty string is returned if false.

Returns:

The link (<A HREF=..>... </A>), linktext or empty string.

getLink

public Link getLink(String targetPageURI,
                    String anchor,
                    String linkTagAttributes,
                    String linkText,
                    boolean showTextOnFail)

Create a page link using a tcm:uri.

Parameters:

targetPageURI - The Id of the page where this link should link to.

anchor - The anchor on the page where the link has to be pointing to.

linkTagAttributes - Attributes to include in the link.

linkText - The text that builds up the link.

showTextOnFail - Indicates if the linkText needs to be returned in case no link can be build: an empty string is returned if false.

Returns:

The link (<A HREF=..>... </A>), linktext or empty string.

getLinkAsString

public String getLinkAsString(int targetPageId,
                              String anchor,
                              String linkTagAttributes,
                              String linkText,
                              boolean showTextOnFail)

Create a page link as a String.

Parameters:

targetPageId - The Id of the page where this link should link to.

anchor - The anchor on the page where the link has to be pointing to.

linkTagAttributes - Attributes to include in the link.

linkText - The linkText that builds up the link.

showTextOnFail - Indicates if the linkText needs to be returned in case no link can be build: an empty string is returned if false.

Returns:

The link (<A HREF=..>... </A>), linktext or empty string.

getLinkAsString

public String getLinkAsString(int targetPageId,
                              String anchor,
                              String linkTagAttributes,
                              String linkText,
                              boolean showTextOnFail,
                              String parameters,
                              LinkStringStyle style)

Create a page link as a String, using a tcm:uri. Use this version to give additional http parameters.

Parameters:

targetPageId - The tcm:uri of the page where this link should link to.

anchor - The anchor on the page where the link has to be pointing to.

linkTagAttributes - Attributes to include in the link.

linkText - The text that builds up the link.

showTextOnFail - Indicates if the linkText needs to be returned in case no link can be build: an empty string is returned if false.

parameters - HTTP parameters to be appended to the URL.

style - Link style

Returns:

The link (<A HREF=..>... </A>), linktext or empty string.

getLinkAsString

public String getLinkAsString(int targetPageId,
                              String anchor,
                              String linkTagAttributes,
                              String linkText,
                              boolean showTextOnFail,
                              String parameters)

Create a page link as a String, using a tcm:uri. Use this version to give additional http parameters.

Parameters:

targetPageId - The tcm:uri of the page where this link should link to.

anchor - The anchor on the page where the link has to be pointing to.

linkTagAttributes - Attributes to include in the link.

linkText - The text that builds up the link.

showTextOnFail - Indicates if the linkText needs to be returned in case no link can be build: an empty string is returned if false.

parameters - HTTP parameters to be appended to the URL.

Returns:

The link (<A HREF=..>... </A>), linktext or empty string.

getLinkAsString

public String getLinkAsString(String targetPageURI,
                              String anchor,
                              String linkTagAttributes,
                              String linkText,
                              boolean showTextOnFail,
                              String parameters,
                              LinkStringStyle style)

Create a page link as a String, using a tcm:uri. Use this version to give additional http parameters.

Parameters:

targetPageURI - The tcm:uri of the page where this link should link to.

anchor - The anchor on the page where the link has to be pointing to.

linkTagAttributes - Attributes to include in the link.

linkText - The text that builds up the link.

showTextOnFail - Indicates if the linkText needs to be returned in case no link can be build: an empty string is returned if false.

parameters - HTTP parameters to be appended to the URL.

style - Link style

Returns:

The link (<A HREF=..>... </A>), linktext or empty string.

getLinkAsString

public String getLinkAsString(String targetPageURI,
                              String anchor,
                              String linkTagAttributes,
                              String linkText,
                              boolean showTextOnFail,
                              String parameters)

Create a page link as a String, using a tcm:uri. Use this version to give additional http parameters.

Parameters:

targetPageURI - The tcm:uri of the page where this link should link to.

anchor - The anchor on the page where the link has to be pointing to.

linkTagAttributes - Attributes to include in the link.

linkText - The text that builds up the link.

showTextOnFail - Indicates if the linkText needs to be returned in case no link can be build: an empty string is returned if false.

parameters - HTTP parameters to be appended to the URL.

Returns:

The link (<A HREF=..>... </A>), linktext or empty string.

getLinkAsString

public String getLinkAsString(String targetPageURI,
                              String anchor,
                              String linkTagAttributes,
                              String linkText,
                              boolean showTextOnFail)

Create a page link as a String using a tcm:uri.

Parameters:

targetPageURI - The tcm:uri of the page where this link should link to.

anchor - The anchor on the page where the link has to be pointing to.

linkTagAttributes - Attributes to include in the link.

linkText - The text that builds up the link.

showTextOnFail - Indicates if the linkText needs to be returned in case no link can be build: an empty string is returned if false.

Returns:

The link (<A HREF=..>... </A>), linktext or empty string.