org.apache.tiles.taglib
Class PutListAttributeTag

Package class diagram package PutListAttributeTag
java.lang.Object
  extended by javax.servlet.jsp.tagext.TagSupport
      extended by javax.servlet.jsp.tagext.BodyTagSupport
          extended by org.apache.tiles.taglib.ContainerTagSupport
              extended by org.apache.tiles.taglib.PutAttributeTag
                  extended by org.apache.tiles.taglib.PutListAttributeTag
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, AddAttributeTagParent, ComponentConstants

public class PutListAttributeTag
extends PutAttributeTag
implements AddAttributeTagParent

PutList tag implementation.

Since:
Tiles 1.0
See Also:
Serialized Form

Field Summary
 
Fields inherited from class org.apache.tiles.taglib.PutAttributeTag
name
 
Fields inherited from class org.apache.tiles.taglib.ContainerTagSupport
componentContext, 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 org.apache.tiles.taglib.ComponentConstants
COMPONENT_CONTEXT_STACK, COMPONENT_SCOPE, EXCEPTION_KEY, LOCALE_KEY
 
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
PutListAttributeTag()
           
 
Method Summary
 int doAfterBody()
          PutListAttributeTag may not have any body, except for PutAttribute tags.
 int doStartTag()
          By default, all ContainerTags evaluate their body.
protected  void endContext(javax.servlet.jsp.PageContext context)
           
 java.util.List<org.apache.tiles.ComponentAttribute> getValue()
          Get list defined in tag.
 void processNestedTag(AddAttributeTag nestedTag)
          Process nested ≶putAttribute> tag.
 void release()
          Release the state of this put list by clearing the contents of the list.
 void setValue(java.lang.Object object)
           
protected  void startContext(javax.servlet.jsp.PageContext context)
           
 
Methods inherited from class org.apache.tiles.taglib.PutAttributeTag
execute, getName, getType, setName, setType
 
Methods inherited from class org.apache.tiles.taglib.ContainerTagSupport
doEndTag, getRole, isAccessAllowed, setRole
 
Methods inherited from class javax.servlet.jsp.tagext.BodyTagSupport
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
 

Constructor Detail

PutListAttributeTag

public PutListAttributeTag()
Method Detail

getValue

public java.util.List<org.apache.tiles.ComponentAttribute> getValue()
Get list defined in tag.

Overrides:
getValue in class PutAttributeTag

setValue

public void setValue(java.lang.Object object)
Overrides:
setValue in class PutAttributeTag

doStartTag

public int doStartTag()
Description copied from class: ContainerTagSupport
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 ContainerTagSupport

doAfterBody

public int doAfterBody()
                throws javax.servlet.jsp.JspException
PutListAttributeTag may not have any body, except for PutAttribute tags.

Specified by:
doAfterBody in interface javax.servlet.jsp.tagext.IterationTag
Overrides:
doAfterBody in class PutAttributeTag
Throws:
javax.servlet.jsp.JspException - if a JSP exception has occurred

release

public void release()
Release the state of this put list by clearing the contents of the list.

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

processNestedTag

public void processNestedTag(AddAttributeTag nestedTag)
Process nested ≶putAttribute> tag.

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

Specified by:
processNestedTag in interface AddAttributeTagParent
Parameters:
nestedTag - the put tag desciendent.

startContext

protected void startContext(javax.servlet.jsp.PageContext context)
Overrides:
startContext in class PutAttributeTag

endContext

protected void endContext(javax.servlet.jsp.PageContext context)
Overrides:
endContext in class PutAttributeTag