Apache Struts API Documentation: Class DefinitionTag

org.apache.struts.taglib.tiles Class DefinitionTag

java.lang.Object
  |
  +--javax.servlet.jsp.tagext.TagSupport
        |
        +--org.apache.struts.taglib.tiles.DefinitionTagSupport
              |
              +--org.apache.struts.taglib.tiles.DefinitionTag

All Implemented Interfaces:

PutListTagParent, PutTagParent, java.io.Serializable, javax.servlet.jsp.tagext.Tag

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) $

See Also:

Serialized Form

id

private java.lang.String id

Definition identifier.

scope

private java.lang.String scope

Scope into which definition will be saved.

extendsDefinition

private java.lang.String extendsDefinition

Extends attribute value.

definition

private ComponentDefinition definition

Template definition

DefinitionTag

public DefinitionTag()

release

public void release()

Reset member values for reuse. This method calls super.release(), which invokes TagSupport.release(), which typically does nothing.

Overrides:

release in class DefinitionTagSupport

releaseInternal

protected void releaseInternal()

Release internal references.

putAttribute

public void putAttribute(java.lang.String name,
                         java.lang.Object content)

This method is a convenience for other tags for putting content into the tile definition. Content is already typed by caller.

processNestedTag

public void processNestedTag(PutTag nestedTag)
                      throws javax.servlet.jsp.JspException

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.

Specified by:

processNestedTag in interface PutTagParent

Following copied from interface: org.apache.struts.taglib.tiles.PutTagParent

Parameters:

nestedTag - Nested tag to process.

processNestedTag

public void processNestedTag(PutListTag nestedTag)
                      throws javax.servlet.jsp.JspException

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.

Specified by:

processNestedTag in interface PutListTagParent

Following copied from interface: org.apache.struts.taglib.tiles.PutListTagParent

Parameters:

nestedTag - Nested PutTag defining the attribute.

getId

public java.lang.String getId()

Get the ID.

Overrides:

getId in class javax.servlet.jsp.tagext.TagSupport

Returns:

ID

setId

public void setId(java.lang.String id)

Set the ID.

Overrides:

setId in class javax.servlet.jsp.tagext.TagSupport

Parameters:

id - New ID.

getScope

public java.lang.String getScope()

Get the scope.

Returns:

Scope.

setScope

public void setScope(java.lang.String aScope)

Set the scope.

Parameters:

aScope - Scope.

setExtends

public void setExtends(java.lang.String definitionName)

Set extends (parent) definition name.

Parameters:

definitionName - Name of parent definition.

getExtends

public java.lang.String getExtends()

Get extends (parent) definition name.

Returns:

Name of parent definition.

doStartTag

public int doStartTag()
               throws javax.servlet.jsp.JspException

Process the start tag by creating a new definition.

Overrides:

doStartTag in class javax.servlet.jsp.tagext.TagSupport

Throws:

javax.servlet.jsp.JspException - On errors processing tag.

doEndTag

public int doEndTag()
             throws javax.servlet.jsp.JspException

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

Overrides:

doEndTag in class javax.servlet.jsp.tagext.TagSupport

Throws:

javax.servlet.jsp.JspException - On errors processing tag.