org.springframework.extensions.surf.taglib

Class ConstructPreset

java.lang.Object

javax.servlet.jsp.tagext.TagSupport

org.springframework.web.servlet.tags.RequestContextAwareTag

org.springframework.extensions.surf.taglib.ConstructPreset

All Implemented Interfaces:

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

public class ConstructPreset
extends org.springframework.web.servlet.tags.RequestContextAwareTag

This class provides the "constructPreset" custom JSP tag that can be used instantiate a Spring Surf preset. It should be used (optionally) with the "presetToken" custom tag 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 org.springframework.web.servlet.tags.RequestContextAwareTag

logger, REQUEST_CONTEXT_PAGE_ATTRIBUTE

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
ConstructPreset()

Method Summary

Methods

Modifier and Type	Method and Description
void	addToken(String key, String value) Adds a new token to the tokens map.
int	doAfterBody() This calls the PresetsManager to actually construct the preset.
protected int	doStartTagInternal() Retrieves the PresetsManager from the application context the first time the tag is used and at all other times just returns the EVAL_BODY_INCLUDE constant to process any child tags.
void	release() Extends the super class implementation to ensure that the preset id and token map are reset after each request is processed.
void	setPreset(String preset)

Methods inherited from class org.springframework.web.servlet.tags.RequestContextAwareTag

doCatch, doFinally, doStartTag, getRequestContext

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

doEndTag, findAncestorWithClass, getId, getParent, getValue, getValues, 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

ConstructPreset

public ConstructPreset()

Method Detail

setPreset

public void setPreset(String preset)

addToken

public void addToken(String key,
            String value)

Adds a new token to the tokens map. This method is intended to only be called by child PresetToken tags. This is because it is not possible for a custom tag to have map attributes so they have to be provided through child tags.

Parameters:

key - The key of the token to add. This should be a substitution value in the preset being constructed.

value - The value of the token to add.

release

public void release()

Extends the super class implementation to ensure that the preset id and token map are reset after each request is processed.

Specified by:

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

Overrides:

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

doStartTagInternal

protected int doStartTagInternal()
                          throws Exception

Retrieves the PresetsManager from the application context the first time the tag is used and at all other times just returns the EVAL_BODY_INCLUDE constant to process any child tags. This is currently hard-coded to retrieve the default Spring Surf PresetsManager bean with an id of "webframework.presets.manager".

Specified by:

doStartTagInternal in class org.springframework.web.servlet.tags.RequestContextAwareTag

Throws:

Exception

doAfterBody

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

This calls the PresetsManager to actually construct the preset. The PresetsManager will have been retrieved in the doStartTagInternal method the first time the tag was executed and the token map applied will have been populated by executing any child PresetToken tags.

Specified by:

doAfterBody in interface javax.servlet.jsp.tagext.IterationTag

Overrides:

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

Throws:

javax.servlet.jsp.JspException