nl.gx.webmanager.cms.core
Interface RelatedLink

All Superinterfaces:

Wrapper

All Known Subinterfaces:

RelatedDownloadLink, RelatedExternalLink, RelatedInternalLink, RelatedMediaItemLink, RelatedResourceLink

public interface RelatedLink
extends Wrapper

Meta information for related links. In GX WebManager, each page has a list of related links. Each of those links has a code. Links on the page link to the code and GX WebManager resolves the code to the actual link when it displays the page.

See Also:

ElementHolder, RelatedInternalLink, RelatedExternalLink, RelatedResourceLink, RelatedDownloadLink, RelatedMediaItemLink

Method Summary

java.lang.String	getCode() RelatedLinks have a code.
Link	getEditLink() Return the link object to be used in the Edit environment Returns the same result as getLink when the target object is 'published', but returns a valid link instead of null when the target object is 'planned'.
Link	getLink() The Link object for this RelatedLink.
Link	getLink(java.lang.String linkText, java.lang.String className) Return a Link object with an alternative linkText and className.
LinkModel	getLinkModel() Get the link model for this link
java.lang.String	getPopUpProperties() Return onClick javascript to open a popup.
java.lang.String	getTarget() Return value for the target attribute in the <a> tag.
void	setCode(java.lang.String code) Set the code for the RelatedLink
void	setLinkModel(LinkModel linkModel) Sets the link model to be used when generating the link

Methods inherited from interface nl.gx.webmanager.wrapper.Wrapper

getId, getUUID, setId, setUUID

Method Detail

getCode

java.lang.String getCode()

RelatedLinks have a code.

Returns:

the code.

setCode

void setCode(java.lang.String code)

Set the code for the RelatedLink

Parameters:

code - the code.

Since:

9.12.0

getLink

Link getLink()

The Link object for this RelatedLink.

Returns:

a Link object for this RelatedLink

getEditLink

Link getEditLink()

Return the link object to be used in the Edit environment Returns the same result as getLink when the target object is 'published', but returns a valid link instead of null when the target object is 'planned'.

Returns:

A Link object, even when the target object is planned.

getLink

Link getLink(java.lang.String linkText,
             java.lang.String className)

Return a Link object with an alternative linkText and className.

Parameters:

linkText - description

className - css class

Returns:

a Link object with an alternative linkText and className.

getPopUpProperties

java.lang.String getPopUpProperties()

Return onClick javascript to open a popup.

Returns:

onClick javascript to open a popup.

getTarget

java.lang.String getTarget()

Return value for the target attribute in the <a> tag. For example, target="_blank".

Returns:

value for target attribute.

getLinkModel

LinkModel getLinkModel()

Get the link model for this link

Returns:

The link model

Since:

9.12.0

setLinkModel

void setLinkModel(LinkModel linkModel)

Sets the link model to be used when generating the link

Parameters:

linkModel - The link model

Since:

9.12.0