com.tridion.smarttarget.tcdl.renderers

Class ItemTemplateTagRenderer

java.lang.Object

com.tridion.smarttarget.tcdl.renderers.DefaultTagRenderer

com.tridion.smarttarget.tcdl.renderers.ItemTemplateTagRenderer

All Implemented Interfaces:

com.tridion.tcdl.IterationTagSupport, com.tridion.tcdl.TagHandlerBase, com.tridion.tcdl.TagRenderer

public class ItemTemplateTagRenderer
extends DefaultTagRenderer
implements com.tridion.tcdl.IterationTagSupport

Handles looping over SmartTarget collections. The ItemTemplateTagRenderer can be used to iterate over collections in the TransformContext. If the tcdl:ItemTemplate tag has both a var and items attribute, those are used to get the collection from the TransformContext and define the variableName used to put individual items on the TransformContext. If no var / items attributes are set, the TransformContext is tested for the following collections: - Promotions - PromotionalItems - Items - NavigationSections - NavigationLinks PromotionalItems can be nested in Promotions, so PromotionalItems will take precedence over Promotions. NavigationLinks can be nested in NavigationSections, so NavigationLinks will take precedence over NavigationSections.

Field Summary

Fields inherited from interface com.tridion.tcdl.IterationTagSupport

EVAL_BODY_AGAIN, SKIP_BODY

Constructor Summary

Constructors

Constructor and Description
ItemTemplateTagRenderer()

Method Summary

Modifier and Type	Method and Description
int	doAfterBody(com.tridion.tcdl.Tag tag, StringBuffer stringBuffer, com.tridion.tcdl.TransformContext transformContext, com.tridion.tcdl.OutputDocument outputDocument)
String	doEndTag(com.tridion.tcdl.Tag tag, StringBuffer tagBody, com.tridion.tcdl.TransformContext transformContext, com.tridion.tcdl.OutputDocument outputDocument)
int	doStartTag(com.tridion.tcdl.Tag tag, StringBuffer stringBuffer, com.tridion.tcdl.TransformContext transformContext, com.tridion.tcdl.OutputDocument outputDocument)
Object	getCurrentItem()
boolean	hasNext()
void	iterationEnd(com.tridion.tcdl.Tag tag, StringBuffer tagBody, com.tridion.tcdl.TransformContext context, com.tridion.tcdl.OutputDocument outputDocument)
void	iterationStart(com.tridion.tcdl.Tag tag, StringBuffer tagBody, com.tridion.tcdl.TransformContext context, com.tridion.tcdl.OutputDocument outputDocument)
Object	next()
void	prepare(com.tridion.tcdl.Tag tag, StringBuffer tagBody, com.tridion.tcdl.TransformContext context, com.tridion.tcdl.OutputDocument outputDocument)
void	release()
boolean	requiresCodeBlock(com.tridion.tcdl.TransformContext transformContext, com.tridion.tcdl.OutputDocument outputDocument, com.tridion.tcdl.Tag tag)

Methods inherited from class com.tridion.smarttarget.tcdl.renderers.DefaultTagRenderer

getCurrentIterationItem, getEnclosingIterativeTagRenderer, getEnclosingTagRenderer, getItemTemplateTagRenderer, getQueryTagRenderer, getVariable, isConfiguredPattern, logEnd, logStart, replaceConfiguredPattern, replaceNonConfiguredPatternVariables, replaceVariables

Methods inherited from class java.lang.Object

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

Constructor Detail

ItemTemplateTagRenderer

public ItemTemplateTagRenderer()

Method Detail

prepare

public void prepare(com.tridion.tcdl.Tag tag,
                    StringBuffer tagBody,
                    com.tridion.tcdl.TransformContext context,
                    com.tridion.tcdl.OutputDocument outputDocument)
             throws com.tridion.transformer.TCDLTransformerException

Throws:

com.tridion.transformer.TCDLTransformerException

hasNext

public boolean hasNext()

next

public Object next()

iterationStart

public void iterationStart(com.tridion.tcdl.Tag tag,
                           StringBuffer tagBody,
                           com.tridion.tcdl.TransformContext context,
                           com.tridion.tcdl.OutputDocument outputDocument)
                    throws com.tridion.transformer.TCDLTransformerException

Throws:

com.tridion.transformer.TCDLTransformerException

iterationEnd

public void iterationEnd(com.tridion.tcdl.Tag tag,
                         StringBuffer tagBody,
                         com.tridion.tcdl.TransformContext context,
                         com.tridion.tcdl.OutputDocument outputDocument)

release

public void release()

doStartTag

public int doStartTag(com.tridion.tcdl.Tag tag,
                      StringBuffer stringBuffer,
                      com.tridion.tcdl.TransformContext transformContext,
                      com.tridion.tcdl.OutputDocument outputDocument)
               throws com.tridion.transformer.TCDLTransformerException

Specified by:

doStartTag in interface com.tridion.tcdl.TagHandlerBase

Overrides:

doStartTag in class DefaultTagRenderer

Throws:

com.tridion.transformer.TCDLTransformerException

doEndTag

public String doEndTag(com.tridion.tcdl.Tag tag,
                       StringBuffer tagBody,
                       com.tridion.tcdl.TransformContext transformContext,
                       com.tridion.tcdl.OutputDocument outputDocument)
                throws com.tridion.transformer.TCDLTransformerException

Specified by:

doEndTag in interface com.tridion.tcdl.TagHandlerBase

Overrides:

doEndTag in class DefaultTagRenderer

Throws:

com.tridion.transformer.TCDLTransformerException

requiresCodeBlock

public boolean requiresCodeBlock(com.tridion.tcdl.TransformContext transformContext,
                                 com.tridion.tcdl.OutputDocument outputDocument,
                                 com.tridion.tcdl.Tag tag)

Specified by:

requiresCodeBlock in interface com.tridion.tcdl.TagHandlerBase

Overrides:

requiresCodeBlock in class DefaultTagRenderer

getCurrentItem

public Object getCurrentItem()

doAfterBody

public int doAfterBody(com.tridion.tcdl.Tag tag,
                       StringBuffer stringBuffer,
                       com.tridion.tcdl.TransformContext transformContext,
                       com.tridion.tcdl.OutputDocument outputDocument)
                throws com.tridion.transformer.TCDLTransformerException

Specified by:

doAfterBody in interface com.tridion.tcdl.IterationTagSupport

Throws:

com.tridion.transformer.TCDLTransformerException