org.apache.tiles.jsp.taglib
Class PutAttributeTag

Package class diagram package PutAttributeTag
java.lang.Object
  extended by javax.servlet.jsp.tagext.TagSupport
      extended by javax.servlet.jsp.tagext.BodyTagSupport
          extended by org.apache.tiles.jsp.taglib.AddAttributeTag
              extended by org.apache.tiles.jsp.taglib.PutAttributeTag
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, DefinitionTagParent
Direct Known Subclasses:
PutListAttributeTag

public class PutAttributeTag
extends AddAttributeTag

Put an attribute in enclosing attribute container tag.

Enclosing attribute container tag can be :

(or any other tag which implements the PutAttributeTagParent interface. Exception is thrown if no appropriate tag can be found.

Put tag can have following atributes :

Value can also come from tag body. Tag body is taken into account only if value is not set by one of the tag attributes. In this case Attribute type is "string", unless tag body define another type.

See Also:
Serialized Form

Field Summary
protected  java.lang.String name
          Name of attribute to put in attribute context.
 
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
PutAttributeTag()
           
 
Method Summary
protected  void execute()
          Executes the processing of this tag, calling its parent tag.
 java.lang.String getName()
          Returns the name of the attribute.
 boolean isCascade()
          Checks if the attribute should be cascaded to nested definitions.
 void release()
          Release all allocated resources.
 void setCascade(boolean cascade)
          Sets the property that tells if the attribute should be cascaded to nested definitions.
 void setName(java.lang.String name)
          Sets the name of the attribute.
 
Methods inherited from class org.apache.tiles.jsp.taglib.AddAttributeTag
doAfterBody, doEndTag, getRole, getType, getValue, isAccessAllowed, processNestedDefinitionName, setRole, setType, setValue
 
Methods inherited from class javax.servlet.jsp.tagext.BodyTagSupport
doInitBody, doStartTag, 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

name

protected java.lang.String name
Name of attribute to put in attribute context.

Constructor Detail

PutAttributeTag

public PutAttributeTag()
Method Detail

getName

public java.lang.String getName()
Returns the name of the attribute.

Returns:
The name of the attribute.

setName

public void setName(java.lang.String name)
Sets the name of the attribute.

Parameters:
name - The name of the attribute.

isCascade

public boolean isCascade()
Checks if the attribute should be cascaded to nested definitions.

Returns:
true if the attribute will be cascaded.
Since:
2.1.0

setCascade

public void setCascade(boolean cascade)
Sets the property that tells if the attribute should be cascaded to nested definitions.

Parameters:
cascade - true if the attribute will be cascaded.
Since:
2.1.0

release

public void release()
Release all allocated resources.

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

execute

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

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