This project has retired. For details please refer to its Attic page.

org.apache.tiles.jsp.taglib
Class AddAttributeTag

java.lang.Object
  javax.servlet.jsp.tagext.TagSupport
      javax.servlet.jsp.tagext.BodyTagSupport
          org.apache.tiles.jsp.taglib.TilesBodyTag
              org.apache.tiles.jsp.taglib.AddAttributeTag

All Implemented Interfaces:

Serializable, BodyTag, IterationTag, JspTag, Tag, TryCatchFinally, DefinitionTagParent

Direct Known Subclasses:

AddListAttributeTag, PutAttributeTag

public class AddAttributeTag
extends TilesBodyTag
implements DefinitionTagParent

Adds an attribute in enclosing attribute container tag.

Enclosing attribute container tag can be :

• <putListAttribute>
• <putAttribute>

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

Put tag can have following atributes :

• name : Name of the attribute
• value : value to put as attribute
• type : value type. Only valid if value is a String and is set by value="something" or by a bean. Possible type are : string (value is used as direct string), template (value is used as a page url to insert), definition (value is used as a definition name to insert)
• role : Role to check when 'insert' will be called. If enclosing tag is <insert>, role is checked immediately. If enclosing tag is <definition>, role will be checked when this definition will be inserted.

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.

Version:

$Rev: 739526 $ $Date: 2009-01-31 09:50:58 +0100 (sab, 31 gen 2009) $

See Also:

Serialized Form

Field Summary

protected String

role The role to check.

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

AddAttributeTag()

Method Summary

int	doAfterBody() Save the body content of this tag (if any).
int	doEndTag()
protected void	execute() Executes the processing of this tag, calling its parent tag.
String	getRole() Returns the role to check.
String	getType() Returns content type: string, template or definition.
Object	getValue() Returns the attribute value.
protected boolean	isAccessAllowed() Checks if the user is inside the specified role.
void	processNestedDefinitionName(String definitionName) Process the nested <tiles:definition> 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	setRole(String role) Sets the role to check.
void	setType(String type) Sets content type: string, template or definition.
void	setValue(Object value) Sets the attribute value.

Methods inherited from class org.apache.tiles.jsp.taglib.TilesBodyTag

doCatch, doFinally, release

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

role

protected String role

The role to check. If the user is in the specified role, the tag is taken into account; otherwise, the tag is ignored (skipped).

Constructor Detail

AddAttributeTag

public AddAttributeTag()

Method Detail

getRole

public String getRole()

Returns the role to check. If the user is in the specified role, the tag is taken into account; otherwise, the tag is ignored (skipped).

Returns:

The role to check.

setRole

public void setRole(String role)

Sets the role to check. If the user is in the specified role, the tag is taken into account; otherwise, the tag is ignored (skipped).

Parameters:

role - The role to check.

getValue

public Object getValue()

Returns the attribute value.

Returns:

Attribute value. Can be a String or Object.

setValue

public void setValue(Object value)

Sets the attribute value.

Parameters:

value - Attribute value. Can be a String or Object.

getType

public String getType()

Returns content type: string, template or definition.

• String : Content is printed directly.
• template : Content is included from specified URL. Value is used as an URL.
• definition : Value denote a definition defined in factory (xml file). Definition will be searched in the inserted tile, in a <insert attribute="attributeName"> tag, where 'attributeName' is the name used for this tag.

Returns:

The attribute type.

setType

public void setType(String type)

Sets content type: string, template or definition.

• String : Content is printed directly.
• template : Content is included from specified URL. Value is used as an URL.
• definition : Value denote a definition defined in factory (xml file). Definition will be searched in the inserted tile, in a <insert attribute="attributeName"> tag, where 'attributeName' is the name used for this tag.

Parameters:

type - The attribute type.

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 TilesBodyTag

doAfterBody

public int doAfterBody()

Save the body content of this tag (if any).

Specified by:

doAfterBody in interface IterationTag

Overrides:

doAfterBody in class BodyTagSupport

Returns:

It returns SKIP_BODY.

doEndTag

public int doEndTag()
             throws TilesJspException

Specified by:

doEndTag in interface Tag

Overrides:

doEndTag in class BodyTagSupport

Throws:

TilesJspException

processNestedDefinitionName

public void processNestedDefinitionName(String definitionName)

Process the nested <tiles:definition> tag.

Specified by:

processNestedDefinitionName in interface DefinitionTagParent

Parameters:

definitionName - Nested definition name.

execute

protected void execute()
                throws TilesJspException

Executes the processing of this tag, calling its parent tag.

Throws:

TilesJspException - If something goes wrong during execution.

isAccessAllowed

protected boolean isAccessAllowed()

Checks if the user is inside the specified role.

Returns:

true if the user is allowed to have the tag rendered.