org.springframework.extensions.surf.taglib

Class ComponentTag

java.lang.Object

javax.servlet.jsp.tagext.TagSupport

org.springframework.web.servlet.tags.RequestContextAwareTag

org.springframework.extensions.surf.taglib.RenderServiceTag

org.springframework.extensions.surf.taglib.ComponentTag

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 ComponentTag
extends RenderServiceTag

Author:

muzquiano, David Draper

See Also:

Serialized Form

Field Summary

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

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

Method Summary

Methods

Modifier and Type	Method and Description
String	getChrome()
String	getComponent()
protected int	invokeRenderService(RenderService renderService, RequestContext renderContext, ModelObject object) This method should be implemented to invoke the required method of the RenderService that the subclass needs to render its output
boolean	isChromeless()
void	release() The life-cycle of a custom JSP tag is that the class is is instantiated when it is first required and then re-used for all subsequent invocations.
void	setChrome(String chrome)
void	setChromeless(boolean chromeless)
void	setComponent(String componentId)

Methods inherited from class org.springframework.extensions.surf.taglib.RenderServiceTag

doStartTagInternal

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

doCatch, doFinally, doStartTag, getRequestContext

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

doAfterBody, 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

ComponentTag

public ComponentTag()

Method Detail

release

public void release()

The life-cycle of a custom JSP tag is that the class is is instantiated when it is first required and then re-used for all subsequent invocations. When a JSP has non-mandatory properties it means that the setters for those properties will not be called if the properties are not provided and the old values will still be available which can corrupt the behaviour of the code. In order to prevent this from happening we should override the release method to ensure that all instance variables are reset to their initial state.

Specified by:

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

Overrides:

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

setComponent

public void setComponent(String componentId)

getComponent

public String getComponent()

setChrome

public void setChrome(String chrome)

getChrome

public String getChrome()

isChromeless

public boolean isChromeless()

setChromeless

public void setChromeless(boolean chromeless)

invokeRenderService

protected int invokeRenderService(RenderService renderService,
                      RequestContext renderContext,
                      ModelObject object)
                           throws RequestDispatchException

Description copied from class: RenderServiceTag

This method should be implemented to invoke the required method of the RenderService that the subclass needs to render its output

Specified by:

invokeRenderService in class RenderServiceTag

Parameters:

renderService - RenderService

renderContext - RequestContext

object - ModelObject

Returns:

The appropriate return code to pass on (e.g. SKIP_BODY, EVAL_BODY_INCLUDE, etc).

Throws:

RequestDispatchException