com.tridion.tcdl.renderer

Class TaxonomyTagRenderer

java.lang.Object

com.tridion.tcdl.renderer.TaxonomyTagRenderer

All Implemented Interfaces:

TagHandlerBase, TagRenderer

public class TaxonomyTagRenderer
extends Object
implements TagRenderer

This class is responsible for runtime Taxonomy Tag rendering. It displays a Taxonomy in a basic way using

• constructs. Warning: for the moment we have no support for selectedKeywords, taxonomyFilter and taxonomyFormatter.

Constructor Summary

Constructors

Constructor and Description
TaxonomyTagRenderer()

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) Processes and retrieves a Taxonomy for the given TaxonomyURI which is displayed as a simple tree.
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	setContextKeyword(String contextKeyword) This sets the Context Facet for this TaxonomyHandler, to use as starting point.
void	setKeywordParameterName(String keywordParameterName) The name of the parameter the TCMURI value of the TaxonomyFacet will be given to in a HTML link .
void	setPageRedirect(String pageRedirect) This sets the pageLink to which all taxonomyFacet links will point to.
void	setShowDescription(String showDescription) This sets if the Taxonomy Tree should consist of only the description field instead of the keyword name.
void	setShowEmptyKeywords(String showEmptyKeywords) This sets if empty TaxonomyFacets with a reference count of 0 should be displayed.
void	setShowRoot(String showRoot) This sets if the root of the Taxonomy shall be displayed, by default will always be displayed.
void	setTaxonomyURI(String taxonomyURI) Sets the TaxonomyURI to display.

Methods inherited from class java.lang.Object

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

Constructor Detail

TaxonomyTagRenderer

public TaxonomyTagRenderer()

Method Detail

doStartTag

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

Processes and retrieves a Taxonomy for the given TaxonomyURI which is displayed as a simple tree.

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

Throws:

TCDLTransformerException - On problems transforming the TCDL.

TCDLTransformerException

doEndTag

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

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

Throws:

TCDLTransformerException - On problems transforming the TCDL.

TCDLTransformerException

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.

setTaxonomyURI

public void setTaxonomyURI(String taxonomyURI)

Sets the TaxonomyURI to display.

Parameters:

taxonomyURI - The uri of the Taxonomy to display

setPageRedirect

public void setPageRedirect(String pageRedirect)

This sets the pageLink to which all taxonomyFacet links will point to.

Parameters:

pageRedirect - The page every TaxonomyFacet link will point to

setKeywordParameterName

public void setKeywordParameterName(String keywordParameterName)

The name of the parameter the TCMURI value of the TaxonomyFacet will be given to in a HTML link .

Parameters:

keywordParameterName - The name of the parameter the TCMURI value of the TaxonomyFacet will be given to in a HTML link

setContextKeyword

public void setContextKeyword(String contextKeyword)

This sets the Context Facet for this TaxonomyHandler, to use as starting point.

Parameters:

contextKeyword - The Taxonomyfacet to use as the context for this Taxonomy

setShowRoot

public void setShowRoot(String showRoot)

This sets if the root of the Taxonomy shall be displayed, by default will always be displayed.

Parameters:

showRoot - true if the root must be displayed, false if not

setShowEmptyKeywords

public void setShowEmptyKeywords(String showEmptyKeywords)

This sets if empty TaxonomyFacets with a reference count of 0 should be displayed.

Parameters:

showEmptyKeywords - true if the TaxonomyFacets with reference count of 0 must be displayed, false if they shouldn't be displayed.

setShowDescription

public void setShowDescription(String showDescription)

This sets if the Taxonomy Tree should consist of only the description field instead of the keyword name.

Parameters:

showDescription - If true, the description field will be used, when false the keyword name is used