org.apache.tiles.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.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:
AddAttributeTag, PutAttributeTag, RenderTagSupport

public abstract class ContainerTagSupport
extends javax.servlet.jsp.tagext.BodyTagSupport

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

Since:
Tiles 2.0
See Also:
Serialized Form

Field Summary
protected  org.apache.tiles.ComponentContext componentContext
           
protected  org.apache.tiles.TilesContainer container
           
 
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)
           
protected abstract  void execute()
           
 java.lang.String getRole()
           
protected  boolean isAccessAllowed()
           
 void release()
           
 void setRole(java.lang.String role)
           
protected  void startContext(javax.servlet.jsp.PageContext context)
           
 
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

componentContext

protected org.apache.tiles.ComponentContext componentContext
Constructor Detail

ContainerTagSupport

public ContainerTagSupport()
Method Detail

getRole

public java.lang.String getRole()

setRole

public void setRole(java.lang.String role)

doStartTag

public int doStartTag()
By default, all ContainerTags evaluate their body. Subclasses may choose to be more selective. In any case, children can rely upon the container and componentContext 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

doEndTag

public int doEndTag()
             throws javax.servlet.jsp.JspException
Specified by:
doEndTag in interface javax.servlet.jsp.tagext.Tag
Overrides:
doEndTag in class javax.servlet.jsp.tagext.BodyTagSupport
Throws:
javax.servlet.jsp.JspException

release

public void release()
Specified by:
release in interface javax.servlet.jsp.tagext.Tag
Overrides:
release in class javax.servlet.jsp.tagext.BodyTagSupport

execute

protected abstract void execute()
                         throws org.apache.tiles.TilesException,
                                javax.servlet.jsp.JspException,
                                java.io.IOException
Throws:
org.apache.tiles.TilesException
javax.servlet.jsp.JspException
java.io.IOException

isAccessAllowed

protected boolean isAccessAllowed()

startContext

protected void startContext(javax.servlet.jsp.PageContext context)

endContext

protected void endContext(javax.servlet.jsp.PageContext context)