com.sdl.web.api.linking

Interface PageLink

public interface PageLink

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);

Field Summary

Fields

Modifier and Type	Field and Description
static org.slf4j.Logger	LOG Logger for PageLink.

Method Summary

Modifier and Type	Method and Description
Link	getLink(int targetPageId) Create a new Link object targeting a page with just a page Id.
Link	getLink(int targetPageId, String anchor, String linkTagAttributes, String linkText, boolean showTextOnFail) Create a Link object targeting 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 targeting 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(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.

Field Detail

LOG

static final org.slf4j.Logger LOG

Logger for PageLink.

Method Detail

getLink

Link getLink(int targetPageId)

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

Parameters:

targetPageId - Id for the target page

getLink

Link getLink(String targetPageURI)

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

Parameters:

targetPageURI - The URI for the target page

getLink

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 target page

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>), link text or empty string.

getLink

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

Create a Link object targeting a page.

Parameters:

targetPageId - Id for the target page

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>), link text or empty string.

getLink

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 additional http parameters.

Parameters:

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

targetURL - The targetURL for the target page

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>), link text or empty string.

getLink

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>), link text or empty string.

getLink

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>), link text or empty string.

getLinkAsString

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>), link text or empty string.

getLinkAsString

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>), link text or empty string.

getLinkAsString

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>), link text or empty string.

getLinkAsString

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>), link text or empty string.