org.springframework.extensions.surf.taglib

Class PresetToken

java.lang.Object

javax.servlet.jsp.tagext.TagSupport

org.springframework.extensions.surf.taglib.PresetToken

All Implemented Interfaces:

Serializable, javax.servlet.jsp.tagext.IterationTag, javax.servlet.jsp.tagext.JspTag, javax.servlet.jsp.tagext.Tag

public class PresetToken
extends javax.servlet.jsp.tagext.TagSupport

This class provides the "presetToken" custom JSP tag that can only be used as a child tag of the "constructPreset" custom JSP tag. Multiple instances the tag can be used to define token map entries to apply when constructing a Spring Surf preset. It should be used as follows:

 <constructPreset preset="">
     <presetToken key="someKey" value="someValue"></presetToken>
     <presetToken key="anotherKey" value="anotherValue"></presetToken>
 </constructPreset>
 

Author:

David Draper

See Also:

Serialized Form

Field Summary

Fields inherited from class javax.servlet.jsp.tagext.TagSupport

id, pageContext

Fields inherited from interface javax.servlet.jsp.tagext.IterationTag

EVAL_BODY_AGAIN

Fields inherited from interface javax.servlet.jsp.tagext.Tag

EVAL_BODY_INCLUDE, EVAL_PAGE, SKIP_BODY, SKIP_PAGE

Constructor Summary

Constructors

Constructor and Description
PresetToken()

Method Summary

Methods

Modifier and Type	Method and Description
int	doStartTag() Checks that the tag has been used as a direct child of a ConstructPreset tag and calls its addToken method with the key and value attributes that have been provided.
void	setKey(String key) This is required to set the key attribute when the custom tag is used.
void	setValue(String value) This is required to set the value attribute when the custom tag is used.

Methods inherited from class javax.servlet.jsp.tagext.TagSupport

doAfterBody, doEndTag, findAncestorWithClass, getId, getParent, getValue, getValues, release, removeValue, setId, setPageContext, setParent, setValue

Methods inherited from class java.lang.Object

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

Constructor Detail

PresetToken

public PresetToken()

Method Detail

setKey

public void setKey(String key)

This is required to set the key attribute when the custom tag is used.

Parameters:

key - String

setValue

public void setValue(String value)

This is required to set the value attribute when the custom tag is used.

Parameters:

value - String

doStartTag

public int doStartTag()
               throws javax.servlet.jsp.JspException

Checks that the tag has been used as a direct child of a ConstructPreset tag and calls its addToken method with the key and value attributes that have been provided.

Specified by:

doStartTag in interface javax.servlet.jsp.tagext.Tag

Overrides:

doStartTag in class javax.servlet.jsp.tagext.TagSupport

Throws:

javax.servlet.jsp.JspException - If the parent of the tag is not a ConstructPreset tag.