org.apache.struts.tiles.taglib
Class PutListTag

java.lang.Object
  extended by javax.servlet.jsp.tagext.TagSupport
      extended by org.apache.struts.tiles.taglib.PutListTag
All Implemented Interfaces:
Serializable, IterationTag, Tag, AddTagParent, ComponentConstants, PutListTagParent

public class PutListTag
extends TagSupport
implements ComponentConstants, AddTagParent, PutListTagParent

PutList tag implementation.

See Also:
Serialized Form

Field Summary
 
Fields inherited from class javax.servlet.jsp.tagext.TagSupport
id, pageContext
 
Fields inherited from interface org.apache.struts.tiles.taglib.ComponentConstants
COMPONENT_CONTEXT, COMPONENT_SCOPE, EXCEPTION_KEY, LOCALE_KEY
 
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
PutListTag()
          Default constructor.
 
Method Summary
 void addElement(Object value)
          Set property.
 int doEndTag()
          Do end tag.
 int doStartTag()
          Do start tag.
protected  PutListTagParent findEnclosingParent()
          Find enclosing parent tag accepting this tag.
 List getList()
          Get list defined in tag.
 String getName()
          Get property.
 String getRole()
          Get role attribute.
 void processNestedTag(AddTag nestedTag)
          Process nested ≶add> tag.
 void processNestedTag(PutListTag nestedTag)
          Process nested ≶putList> tag.
 void release()
          Release all allocated resources.
protected  void releaseInternal()
          Release all internal resources.
 void setName(String name)
          Set property.
 void setRole(String role)
          Set role attribute.
 
Methods inherited from class javax.servlet.jsp.tagext.TagSupport
doAfterBody, 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
 

Constructor Detail

PutListTag

public PutListTag()
Default constructor.

Method Detail

release

public void release()
Release all allocated resources.

Specified by:
release in interface Tag
Overrides:
release in class TagSupport

releaseInternal

protected void releaseInternal()
Release all internal resources.


setName

public void setName(String name)
Set property.


getName

public String getName()
Get property.


setRole

public void setRole(String role)
Set role attribute.

Parameters:
role - The role the user must be in to store content.

getRole

public String getRole()
Get role attribute.


getList

public List getList()
Get list defined in tag.


addElement

public void addElement(Object value)
Set property.


processNestedTag

public void processNestedTag(PutListTag nestedTag)
                      throws JspException
Process nested ≶putList> tag. Method calls by nested ≶putList> tags. Nested list is added to current list. If role is defined, nested attribute is wrapped into an untypped definition containing attribute value and role.

Specified by:
processNestedTag in interface PutListTagParent
Parameters:
nestedTag - Nested PutTag defining the attribute.
Throws:
JspException

processNestedTag

public void processNestedTag(AddTag nestedTag)
                      throws JspException
Process nested ≶add> tag. Method calls by nested ≶add> tags. Nested attribute is added to current list. If role is defined, nested attribute is wrapped into an untypped definition containing attribute value and role.

Specified by:
processNestedTag in interface AddTagParent
Parameters:
nestedTag - Nested to process.
Throws:
JspException

doStartTag

public int doStartTag()
               throws JspException
Do start tag.

Specified by:
doStartTag in interface Tag
Overrides:
doStartTag in class TagSupport
Throws:
JspException

doEndTag

public int doEndTag()
             throws JspException
Do end tag.

Specified by:
doEndTag in interface Tag
Overrides:
doEndTag in class TagSupport
Throws:
JspException

findEnclosingParent

protected PutListTagParent findEnclosingParent()
                                        throws JspException
Find enclosing parent tag accepting this tag.

Throws:
JspException - If we can't find an appropriate enclosing tag.


Copyright © 2000-2008 Apache Software Foundation. All Rights Reserved.