This project has retired. For details please refer to its Attic page.
PutListAttributeTag (Tiles 2 2.1.4 API)

org.apache.tiles.jsp.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.jsp.taglib.TilesBodyTag
              extended by org.apache.tiles.jsp.taglib.AddAttributeTag
                  extended by org.apache.tiles.jsp.taglib.PutAttributeTag
                      extended by org.apache.tiles.jsp.taglib.PutListAttributeTag
All Implemented Interfaces:
Serializable, BodyTag, IterationTag, JspTag, Tag, TryCatchFinally, AddAttributeTagParent, DefinitionTagParent

public class PutListAttributeTag
extends PutAttributeTag
implements AddAttributeTagParent

PutList tag implementation.

Since:
Tiles 1.0
Version:
$Rev: 734389 $ $Date: 2009-01-14 14:38:06 +0100 (mer, 14 gen 2009) $
See Also:
Serialized Form

Field Summary
 
Fields inherited from class org.apache.tiles.jsp.taglib.PutAttributeTag
name
 
Fields inherited from class org.apache.tiles.jsp.taglib.AddAttributeTag
role
 
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
PutListAttributeTag()
           
 
Method Summary
 int doAfterBody()
          PutListAttributeTag may not have any body, except for PutAttribute tags.
 int doStartTag()
          
protected  void execute()
          Executes the processing of this tag, calling its parent tag.
 List<Attribute> getAttributes()
          Get list defined in tag.
 boolean getInherit()
          If true, the attribute will put the elements of the attribute with the same name of the parent definition before the ones specified here.
 void processNestedTag(AddAttributeTag nestedTag)
          Process nested ≶putAttribute> tag.
protected  void reset()
          Release any per-invocation resources, resetting any resources or state that should be cleared between successive invocations of Tag.doEndTag() and Tag.doStartTag().
 void setInherit(boolean inherit)
          If true, the attribute will put the elements of the attribute with the same name of the parent definition before the ones specified here.
 void setValue(Object object)
          Sets the attribute value.
 
Methods inherited from class org.apache.tiles.jsp.taglib.PutAttributeTag
getName, isCascade, setCascade, setName
 
Methods inherited from class org.apache.tiles.jsp.taglib.AddAttributeTag
doEndTag, getRole, getType, getValue, isAccessAllowed, processNestedDefinitionName, setRole, setType
 
Methods inherited from class org.apache.tiles.jsp.taglib.TilesBodyTag
doCatch, doFinally, release
 
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

setInherit

public void setInherit(boolean inherit)
If true, the attribute will put the elements of the attribute with the same name of the parent definition before the ones specified here. By default, it is 'false'

Parameters:
inherit - The "inherit" value.
Since:
2.1.0

getInherit

public boolean getInherit()
If true, the attribute will put the elements of the attribute with the same name of the parent definition before the ones specified here. By default, it is 'false'

Returns:
The "inherit" value.
Since:
2.1.0

getAttributes

public List<Attribute> getAttributes()
Get list defined in tag.

Returns:
The value of this list attribute.

setValue

public void setValue(Object object)
Sets the attribute value.

Overrides:
setValue in class AddAttributeTag
Parameters:
object - Attribute value. Can be a String or Object.

doStartTag

public int doStartTag()

Specified by:
doStartTag in interface Tag
Overrides:
doStartTag in class BodyTagSupport

doAfterBody

public int doAfterBody()
PutListAttributeTag may not have any body, except for PutAttribute tags.

Specified by:
doAfterBody in interface IterationTag
Overrides:
doAfterBody in class AddAttributeTag
Returns:
SKIP_BODY.

reset

protected void reset()
Release any per-invocation resources, resetting any resources or state that should be cleared between successive invocations of Tag.doEndTag() and Tag.doStartTag().

Overrides:
reset in class PutAttributeTag

processNestedTag

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

Places the value of the nested tag within the AttributeContext.It is the responsibility of the descendent to check security. Security will be managed by called tags.

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

execute

protected void execute()
                throws TilesJspException
Executes the processing of this tag, calling its parent tag.

Overrides:
execute in class PutAttributeTag
Throws:
TilesJspException - If something goes wrong during execution.


Copyright © 2001-2009 Apache Software Foundation. All Rights Reserved.