org.apache.struts.taglib.tiles

Class DefinitionTag

public class DefinitionTag extends DefinitionTagSupport implements PutTagParent, PutListTagParent

This is the tag handler for <tiles:definition>, which defines a tiles (or template / component). Definition is put in requested context and can be used in <tiles:insert>.

Version: $Rev: 54929 $ $Date: 2004-10-16 17:38:42 +0100 (Sat, 16 Oct 2004) $

Field Summary
ComponentDefinition	definition Template definition
String	extendsDefinition Extends attribute value.
String	id Definition identifier.
String	scope Scope into which definition will be saved.

Method Summary
int	doEndTag() Process the end tag by putting the definition in appropriate context.
int	doStartTag() Process the start tag by creating a new definition.
String	getExtends() Get `extends` (parent) definition name.
String	getId() Get the ID.
String	getScope() Get the scope.
void	processNestedTag(PutTag nestedTag) Process nested ≶put> tag.
void	processNestedTag(PutListTag nestedTag) Process nested ≶putList> tag.
void	putAttribute(String name, Object content) This method is a convenience for other tags for putting content into the tile definition.
void	release() Reset member values for reuse.
protected void	releaseInternal() Release internal references.
void	setExtends(String definitionName) Set `extends` (parent) definition name.
void	setId(String id) Set the ID.
void	setScope(String aScope) Set the scope.

Field Detail

definition

private ComponentDefinition definition

Template definition

extendsDefinition

private String extendsDefinition

Extends attribute value.

scope

private String scope

Scope into which definition will be saved.

Method Detail

doEndTag

public int doEndTag()

Process the end tag by putting the definition in appropriate context.

Throws: JspException On errors processing tag.

doStartTag

public int doStartTag()

Process the start tag by creating a new definition.

Throws: JspException On errors processing tag.

getExtends

public String getExtends()

Get extends (parent) definition name.

Returns: Name of parent definition.

getId

public String getId()

Get the ID.

Returns: ID

getScope

public String getScope()

Get the scope.

Returns: Scope.

processNestedTag

public void processNestedTag(PutTag nestedTag)

Process nested ≶put> tag. Method is called from nested ≶put> tags. Nested list is added to current list. If role is defined, nested attribute is wrapped into an untyped definition containing attribute value and role.

processNestedTag

public void processNestedTag(PutListTag nestedTag)

Process nested ≶putList> tag. Method is called from nested ≶putList> tags. Nested list is added to current list. If role is defined, nested attribute is wrapped into an untyped definition containing attribute value and role.