org.apache.tiles.jsp.taglib
Class ContainerTagSupport

Package class diagram package ContainerTagSupport
java.lang.Object
  extended by javax.servlet.jsp.tagext.TagSupport
      extended by javax.servlet.jsp.tagext.BodyTagSupport
          extended by org.apache.tiles.jsp.taglib.RoleSecurityTagSupport
              extended by org.apache.tiles.jsp.taglib.ContainerTagSupport
All Implemented Interfaces:
java.io.Serializable, javax.servlet.jsp.tagext.BodyTag, javax.servlet.jsp.tagext.IterationTag, javax.servlet.jsp.tagext.JspTag, javax.servlet.jsp.tagext.Tag
Direct Known Subclasses:
RenderTagSupport

public abstract class ContainerTagSupport
extends RoleSecurityTagSupport

Base tag for the tiles tags which interact with the container. Provides standard support for security, and provides access to the container and attribute context.

Since:
Tiles 2.0
See Also:
Serialized Form

Field Summary
protected  org.apache.tiles.AttributeContext attributeContext
          The attribute context to use to store and read attribute values.
protected  org.apache.tiles.TilesContainer container
          The Tiles container that can be used inside the tag.
 
Fields inherited from class javax.servlet.jsp.tagext.BodyTagSupport
bodyContent
 
Fields inherited from class javax.servlet.jsp.tagext.TagSupport
id, pageContext
 
Fields inherited from interface javax.servlet.jsp.tagext.BodyTag
EVAL_BODY_BUFFERED, EVAL_BODY_TAG
 
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
ContainerTagSupport()
           
 
Method Summary
 int doEndTag()
          
 int doStartTag()
          By default, all ContainerTags evaluate their body.
protected  void endContext(javax.servlet.jsp.PageContext context)
          Ends the context when exiting the tag.
 void release()
          
protected  void startContext(javax.servlet.jsp.PageContext context)
          Starts the context when entering the tag.
 
Methods inherited from class org.apache.tiles.jsp.taglib.RoleSecurityTagSupport
execute, getRole, isAccessAllowed, setRole
 
Methods inherited from class javax.servlet.jsp.tagext.BodyTagSupport
doAfterBody, doInitBody, getBodyContent, getPreviousOut, setBodyContent
 
Methods inherited from class javax.servlet.jsp.tagext.TagSupport
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
 
Methods inherited from interface javax.servlet.jsp.tagext.Tag
getParent, setPageContext, setParent
 

Field Detail

container

protected org.apache.tiles.TilesContainer container
The Tiles container that can be used inside the tag.


attributeContext

protected org.apache.tiles.AttributeContext attributeContext
The attribute context to use to store and read attribute values.

Constructor Detail

ContainerTagSupport

public ContainerTagSupport()
Method Detail

doStartTag

public int doStartTag()
               throws javax.servlet.jsp.JspException
By default, all ContainerTags evaluate their body. Subclasses may choose to be more selective. In any case, children can rely upon the container and attributeContext being initialized if they call super.doStartTag()

Specified by:
doStartTag in interface javax.servlet.jsp.tagext.Tag
Overrides:
doStartTag in class javax.servlet.jsp.tagext.BodyTagSupport
Returns:
EVAL_BODY_BUFFERED.
Throws:
javax.servlet.jsp.JspException - If the container has not been initialized.

doEndTag

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

Specified by:
doEndTag in interface javax.servlet.jsp.tagext.Tag
Overrides:
doEndTag in class RoleSecurityTagSupport
Throws:
javax.servlet.jsp.JspException

release

public void release()

Specified by:
release in interface javax.servlet.jsp.tagext.Tag
Overrides:
release in class RoleSecurityTagSupport

startContext

protected void startContext(javax.servlet.jsp.PageContext context)
Starts the context when entering the tag.

Parameters:
context - The page context to use.

endContext

protected void endContext(javax.servlet.jsp.PageContext context)
Ends the context when exiting the tag.

Parameters:
context - The page context to use.