org.springframework.extensions.surf.taglib

Class IncludeTag

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.IncludeTag

All Implemented Interfaces:

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

Direct Known Subclasses:

ComponentIncludeTag, RegionIncludeTag

public class IncludeTag
extends RenderServiceTag

This class has been created to solve the problem of components rendering chrome that use the regionInclude tag (resulting in an OutOfMemory exception) and regions rendering chrome that use the componentInclude tag (resulting in an infinite loop).

The tags rely on the context being set to indicate the type of rendering being requested (either component or region) and then applies the appropriate logic required. This means that if componentInclude and regionInclude can be used interchangeably without risk of error.

Author:

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

Method Summary

Methods

Modifier and Type	Method and Description
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

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

IncludeTag

public IncludeTag()

Method Detail

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