Save This Page
Home » tiles-2.0.6-src » org.apache.tiles.jsp » taglib » [javadoc | source]
org.apache.tiles.jsp.taglib
abstract public class: RenderTagSupport [javadoc | source]
java.lang.Object
   javax.servlet.jsp.tagext.TagSupport
      javax.servlet.jsp.tagext.BodyTagSupport
         org.apache.tiles.jsp.taglib.RoleSecurityTagSupport
            org.apache.tiles.jsp.taglib.ContainerTagSupport
               org.apache.tiles.jsp.taglib.RenderTagSupport

All Implemented Interfaces:
    PutAttributeTagParent, BodyTag, IterationTag, Serializable

Direct Known Subclasses:
    InsertDefinitionTag, InsertTemplateTag, InsertAttributeTag, GetAsStringTag

Support for all tags which render (a template, or definition).

Properly invokes the defined preparer and invokes the abstract render method upon completion.

This tag takes special care to ensure that the attribute context is reset to it's original state after the execution of the tag is complete. This ensures that all all included attributes in subsequent tiles are scoped properly and do not bleed outside their intended scope.
Field Summary
protected  String preparer    The view preparer to use before the rendering. 
protected  boolean flush    This flag, if true, flushes the content before rendering. 
protected  boolean ignore    This flag, if true, ignores exception thrown by preparers and those caused by problems with definitions. 
Fields inherited from org.apache.tiles.jsp.taglib.ContainerTagSupport:
container,  attributeContext
Method from org.apache.tiles.jsp.taglib.RenderTagSupport Summary:
doStartTag,   execute,   getPreparer,   isFlush,   isIgnore,   processNestedTag,   release,   render,   setFlush,   setIgnore,   setPreparer
Methods from org.apache.tiles.jsp.taglib.ContainerTagSupport:
doEndTag,   doStartTag,   endContext,   release,   startContext
Methods from org.apache.tiles.jsp.taglib.RoleSecurityTagSupport:
doEndTag,   execute,   getRole,   isAccessAllowed,   release,   setRole
Methods from javax.servlet.jsp.tagext.BodyTagSupport:
doAfterBody,   doEndTag,   doInitBody,   doStartTag,   getBodyContent,   getPreviousOut,   release,   setBodyContent
Methods from javax.servlet.jsp.tagext.TagSupport:
doAfterBody,   doEndTag,   doStartTag,   findAncestorWithClass,   getId,   getParent,   getValue,   getValues,   release,   removeValue,   setId,   setPageContext,   setParent,   setValue
Methods from java.lang.Object:
equals,   getClass,   hashCode,   notify,   notifyAll,   toString,   wait,   wait,   wait
Method from org.apache.tiles.jsp.taglib.RenderTagSupport Detail:
 public int doStartTag() throws JspException 
    {@inheritDoc}
 protected  void execute() throws IOException, JspException, TilesException 
    Execute the tag by invoking the preparer, if defined, and then rendering.
 public String getPreparer() 
    Returns the preparer name.
 public boolean isFlush() 
    Returns the flush flag. If true, current page out stream is flushed before insertion.
 public boolean isIgnore() 
    Returns the ignore flag. If it is set to true, and the attribute specified by the name does not exist, simply return without writing anything. The default value is false, which will cause a runtime exception to be thrown.
 public  void processNestedTag(PutAttributeTag nestedTag) 

    Process nested ≶put> tag.

    Places the value of the nested tag within the org.apache.tiles.AttributeContext .It is the responsibility of the descendent to check security. Tags extending the ContainerTagSupport will automatically provide the appropriate security.

 public  void release() 
    {@inheritDoc}
 abstract protected  void render() throws IOException, JspException, TilesException
    Render the specified content.
 public  void setFlush(boolean flush) 
    Sets the flush flag. If true, current page out stream is flushed before insertion.
 public  void setIgnore(boolean ignore) 
    Sets the ignore flag. If this attribute is set to true, and the attribute specified by the name does not exist, simply return without writing anything. The default value is false, which will cause a runtime exception to be thrown.
 public  void setPreparer(String preparer) 
    Sets the preparer name.