com.tridion.tcdl.renderer

Class LinkTagRenderer

java.lang.Object

com.tridion.tcdl.renderer.LinkTagRenderer

All Implemented Interfaces:

TagHandlerBase, TagRenderer

public class LinkTagRenderer
extends Object
implements TagRenderer

This class is responsible for runtime Link Tag rendering.

Constructor Summary

Constructors

Constructor and Description
LinkTagRenderer()

Method Summary

Modifier and Type	Method and Description
String	doEndTag(Tag tag, StringBuffer tagBody, TransformContext context, OutputDocument target) Called whenever an ending Tag that is associated with the handler is encountered in TCDL content.
int	doStartTag(Tag tag, StringBuffer tagBody, TransformContext context, OutputDocument target) Called whenever as starting Tag that is associated with the handler is encountered in TCDL content.
protected String	generateBinaryLink(String binaryURI, String theVariantId, String linkAnchor, String linkText, String theLinkAttributes, boolean linkTextOnFail, boolean relativeLink) Creating binary HTML link content based on input parameters.
protected String	generateBinaryLink(String binaryURI, String theVariantId, String linkAnchor, String linkText, String theLinkAttributes, boolean linkTextOnFail, boolean relativeLink, Tag tag) Creating binary HTML link content based on input parameters.
boolean	requiresCodeBlock(TransformContext context, OutputDocument target, Tag tag) This method is called right before doStartTag and its return value indicates if the engine must wrap the result of doEndTag inside a code block.
void	setAddAnchor(String addAnchor)
void	setBinaryUrl(String binaryUrl)
void	setLinkAttributes(String linkAttributes)
void	setOrigin(String theOriginURI)
void	setParameters(String parameters)
void	setRequiredDestination(String requiredDestination)
void	setRequiredType(String requiredType)
void	setTemplateURI(String templateURI)
void	setTextOnFail(String textOnFail)
void	setVariantId(String variantId)

Methods inherited from class java.lang.Object

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

Constructor Detail

LinkTagRenderer

public LinkTagRenderer()

Method Detail

setOrigin

public void setOrigin(String theOriginURI)

setRequiredDestination

public void setRequiredDestination(String requiredDestination)

setBinaryUrl

public void setBinaryUrl(String binaryUrl)

setTemplateURI

public void setTemplateURI(String templateURI)

setLinkAttributes

public void setLinkAttributes(String linkAttributes)

setTextOnFail

public void setTextOnFail(String textOnFail)

setAddAnchor

public void setAddAnchor(String addAnchor)

setRequiredType

public void setRequiredType(String requiredType)

setVariantId

public void setVariantId(String variantId)

setParameters

public void setParameters(String parameters)

doStartTag

public int doStartTag(Tag tag,
                      StringBuffer tagBody,
                      TransformContext context,
                      OutputDocument target)

Description copied from interface: TagHandlerBase

Called whenever as starting Tag that is associated with the handler is encountered in TCDL content. At the very least the start tag must indicate if processing the tag contents should proceed, by returning either Tag.CONTINUE_TAG_EVALUATION or Tag.SKIP_TAG When SKIP_TAG is returned, doEndTag will not be called.

It is possible to prepend data to the tagContents using the [tagBody] buffer. The tagBody StringBuffer collects the content occurring (or generated by nested tags) between the start and closing tag.

Specified by:

doStartTag in interface TagHandlerBase

Parameters:

tag - The fully initialized tag

tagBody - Buffer that will be used by the framework to write tag content to.

context - TransformContext offering access to context attributes

target - OutputDocument for setting supporting information to build the final document

Returns:

control code of the tag flow. Currently only Tag.CONTINUE_TAG_EVALUATION or Tag.SKIP_TAG

doEndTag

public String doEndTag(Tag tag,
                       StringBuffer tagBody,
                       TransformContext context,
                       OutputDocument target)

Description copied from interface: TagHandlerBase

Called whenever an ending Tag that is associated with the handler is encountered in TCDL content. The primary responsibility of this method is to generate the tag contents that will be embedded in the output document. This is done by returning the proper value. The tagBody will contain all element data that occurred between the start/end tag as well as data that was written by the doStartTag method of this handler. E.g. return tagBody.toString() would simply return the content that was encountered between the start/end tag (as well as resolved content of nested tags).

Note that the Tag [tag] parameter will have all attributes set of the start tag (in fact it is the start tag), so all information of the tag is at your disposal.

Specified by:

doEndTag in interface TagHandlerBase

Parameters:

tag - The fully initialized tag

tagBody - Buffer that will be used by the framework to write tag content to.

context - TransformContext offering access to context attributes

target - OutputDocument for setting supporting information to build the final document

Returns:

control code of the tag flow. Currently only Tag.CONTINUE_TAG_EVALUATION or Tag.SKIP_TAG

requiresCodeBlock

public boolean requiresCodeBlock(TransformContext context,
                                 OutputDocument target,
                                 Tag tag)

Description copied from interface: TagHandlerBase

This method is called right before doStartTag and its return value indicates if the engine must wrap the result of doEndTag inside a code block.

The start [tag] is passed, so the handler may use attribute values to decide upon it's result

Specified by:

requiresCodeBlock in interface TagHandlerBase

Parameters:

context - TransformContext offering access to context attributes

target - OutputDocument for setting supporting information to build the final document

tag - The fully initialized tag

Returns:

Whether or not it requires a code block.

generateBinaryLink

protected String generateBinaryLink(String binaryURI,
                                    String theVariantId,
                                    String linkAnchor,
                                    String linkText,
                                    String theLinkAttributes,
                                    boolean linkTextOnFail,
                                    boolean relativeLink,
                                    Tag tag)

Creating binary HTML link content based on input parameters.

Parameters:

binaryURI - Binary URI.

theVariantId - Variant identifier.

linkAnchor - Link anchor.

linkText - Link text.

theLinkAttributes - Link attributes.

linkTextOnFail - Text to be shown if link can not be rendered.

tag - Tag (tcdl:Link) which is supposed to be replaced

Returns:

Rendered HTML link.

generateBinaryLink

protected String generateBinaryLink(String binaryURI,
                                    String theVariantId,
                                    String linkAnchor,
                                    String linkText,
                                    String theLinkAttributes,
                                    boolean linkTextOnFail,
                                    boolean relativeLink)

Creating binary HTML link content based on input parameters.

Parameters:

binaryURI - Binary URI.

theVariantId - Variant identifier.

linkAnchor - Link anchor.

linkText - Link text.

theLinkAttributes - Link attributes.

linkTextOnFail - Text to be shown if link can not be rendered.

Returns:

Rendered HTML link.