org.apache.tiles.jsp.taglib.definition
Class DefinitionTag

Package class diagram package DefinitionTag
java.lang.Object
  extended by javax.servlet.jsp.tagext.TagSupport
      extended by org.apache.tiles.jsp.taglib.definition.DefinitionTag
All Implemented Interfaces:
java.io.Serializable, javax.servlet.jsp.tagext.IterationTag, javax.servlet.jsp.tagext.JspTag, javax.servlet.jsp.tagext.Tag, PutAttributeTagParent

public class DefinitionTag
extends javax.servlet.jsp.tagext.TagSupport
implements PutAttributeTagParent

This is the tag handler for <tiles:definition>, which creates a custom definition. If the configured container is a MutableTilesContainer, this newly created definition can be used in <tiles:insertDefinition>.

See Also:
Serialized Form

Field Summary
 
Fields inherited from class javax.servlet.jsp.tagext.TagSupport
id, pageContext
 
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
DefinitionTag()
           
 
Method Summary
 int doEndTag()
          
 int doStartTag()
          
 java.lang.String getExtends()
          Returns the (optional) definition name that this definition extends.
 java.lang.String getName()
          Returns the name of the definition to configure.
 java.lang.String getPreparer()
          Returns the definition view preparer.
 java.lang.String getRole()
          Returns the role to check when rendering this definition.
 java.lang.String getTemplate()
          Returns the template URI of the definition.
 void processNestedTag(PutAttributeTag nestedTag)
          Reset member values for reuse.
 void release()
          
 void setExtends(java.lang.String extend)
          Sets the (optional) definition name that this definition extends.
 void setName(java.lang.String name)
          Sets the name of the definition to configure.
 void setPreparer(java.lang.String preparer)
          Sets the definition view preparer.
 void setRole(java.lang.String role)
          Sets the role to check when rendering this definition.
 void setTemplate(java.lang.String template)
          Sets the template URI of the definition.
 
Methods inherited from class javax.servlet.jsp.tagext.TagSupport
doAfterBody, 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
 

Constructor Detail

DefinitionTag

public DefinitionTag()
Method Detail

getName

public java.lang.String getName()
Returns the name of the definition to configure.

Returns:
The definition name.

setName

public void setName(java.lang.String name)
Sets the name of the definition to configure.

Parameters:
name - The definition name.

getTemplate

public java.lang.String getTemplate()
Returns the template URI of the definition.

Returns:
The template URI.

setTemplate

public void setTemplate(java.lang.String template)
Sets the template URI of the definition.

Parameters:
template - The template URI.

getExtends

public java.lang.String getExtends()
Returns the (optional) definition name that this definition extends.

Returns:
The extending definition name.

setExtends

public void setExtends(java.lang.String extend)
Sets the (optional) definition name that this definition extends.

Parameters:
extend - The extending definition name.

getRole

public java.lang.String getRole()
Returns the role to check when rendering this definition.

Returns:
The role to check.

setRole

public void setRole(java.lang.String role)
Sets the role to check when rendering this definition.

Parameters:
role - The role to check.

getPreparer

public java.lang.String getPreparer()
Returns the definition view preparer.

Returns:
The view preparer name.

setPreparer

public void setPreparer(java.lang.String preparer)
Sets the definition view preparer.

Parameters:
preparer - The view preparer name.

release

public void release()

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

doStartTag

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

Specified by:
doStartTag in interface javax.servlet.jsp.tagext.Tag
Overrides:
doStartTag in class javax.servlet.jsp.tagext.TagSupport
Throws:
javax.servlet.jsp.JspException

doEndTag

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

Specified by:
doEndTag in interface javax.servlet.jsp.tagext.Tag
Overrides:
doEndTag in class javax.servlet.jsp.tagext.TagSupport
Throws:
javax.servlet.jsp.JspException

processNestedTag

public void processNestedTag(PutAttributeTag nestedTag)
                      throws javax.servlet.jsp.JspException
Reset member values for reuse. This method calls super.release(), which invokes TagSupport.release(), which typically does nothing.

Specified by:
processNestedTag in interface PutAttributeTagParent
Parameters:
nestedTag - The nested PutAttributeTag
Throws:
javax.servlet.jsp.JspException - Never thrown, it's here for API compatibility.