org.apache.tiles.jsp.taglib

Class PutListAttributeTag

java.lang.Object

javax.servlet.jsp.tagext.SimpleTagSupport

org.apache.tiles.jsp.taglib.PutListAttributeTag

All Implemented Interfaces:

javax.servlet.jsp.tagext.JspTag, javax.servlet.jsp.tagext.SimpleTag

public class PutListAttributeTag
extends javax.servlet.jsp.tagext.SimpleTagSupport

PutList tag implementation.

Since:

Tiles 1.0

Version:

$Rev: 927562 $ $Date: 2010-03-25 20:35:34 +0100 (gio, 25 mar 2010) $

Constructor Summary

Constructors

Constructor and Description
PutListAttributeTag()

Method Summary

Modifier and Type	Method and Description
void	doTag()
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.
String	getName() Returns the name of the attribute.
String	getRole() Returns the role to check.
String	getType() Deprecated. Do not use, ignored.
boolean	isCascade() Checks if the attribute should be cascaded to nested definitions.
void	setCascade(boolean cascade) Sets the property that tells if the attribute should be cascaded to nested definitions.
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	setName(String name) Sets the name of the attribute.
void	setRole(String role) Sets the role to check.
void	setType(String type) Deprecated. Do not use, ignored.

Methods inherited from class javax.servlet.jsp.tagext.SimpleTagSupport

findAncestorWithClass, getJspBody, getJspContext, getParent, setJspBody, setJspContext, setParent

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

PutListAttributeTag

public PutListAttributeTag()

Method Detail

getName

public String getName()

Returns the name of the attribute.

Returns:

The name of the attribute.

setName

public void setName(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

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.

getType

@Deprecated
public String getType()

Deprecated. Do not use, ignored.

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

@Deprecated
public void setType(String type)

Deprecated. Do not use, ignored.

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.

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

doTag

public void doTag()
           throws javax.servlet.jsp.JspException,
                  IOException

Specified by:

doTag in interface javax.servlet.jsp.tagext.SimpleTag

Overrides:

doTag in class javax.servlet.jsp.tagext.SimpleTagSupport

Throws:

javax.servlet.jsp.JspException

IOException