Package org.apache.tiles.jsp.taglib

Class DefinitionTag

java.lang.Object

javax.servlet.jsp.tagext.SimpleTagSupport

org.apache.tiles.jsp.taglib.DefinitionTag

All Implemented Interfaces:

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

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

Create a definition at runtime.

Create a new definition at runtime. Newly created definition will be available across the entire request.

Constructor Summary

Constructors

Constructor	Description
DefinitionTag()

Method Summary

Modifier and Type	Method	Description
void	doTag()
java.lang.String	getExtends()	Getter for extends property.
java.lang.String	getName()	Getter for name property.
java.lang.String	getPreparer()	Getter for preparer property.
java.lang.String	getRole()	Getter for role property.
java.lang.String	getTemplate()	Getter for template property.
void	setExtends(java.lang.String extendsParam)	Setter for extends property.
void	setName(java.lang.String name)	Setter for name property.
void	setPreparer(java.lang.String preparer)	Setter for preparer property.
void	setRole(java.lang.String role)	Setter for role property.
void	setTemplate(java.lang.String template)	Setter for template property.

Methods inherited from class java.lang.Object

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

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

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

Constructor Detail

DefinitionTag

public DefinitionTag()

Method Detail

getName

public java.lang.String getName()

Getter for name property.

Returns:

The name of the definition to create. If not specified, an anonymous definition will be created.

setName

public void setName(java.lang.String name)

Setter for name property.

Parameters:

name - The name of the definition to create. If not specified, an anonymous definition will be created.

getTemplate

public java.lang.String getTemplate()

Getter for template property.

Returns:

The template of this definition.

setTemplate

public void setTemplate(java.lang.String template)

Setter for template property.

Parameters:

template - The template of this definition.

getRole

public java.lang.String getRole()

Getter for role property.

Returns:

A comma-separated list of roles. If present, the definition will be rendered only if the current user belongs to one of the roles.

setRole

public void setRole(java.lang.String role)

Setter for role property.

Parameters:

role - A comma-separated list of roles. If present, the definition will be rendered only if the current user belongs to one of the roles.

getExtends

public java.lang.String getExtends()

Getter for extends property.

Returns:

The definition name that this definition extends.

setExtends

public void setExtends(java.lang.String extendsParam)

Setter for extends property.

Parameters:

extendsParam - The definition name that this definition extends.

getPreparer

public java.lang.String getPreparer()

Getter for preparer property.

Returns:

The preparer to use to invoke before the definition is rendered.

setPreparer

public void setPreparer(java.lang.String preparer)

Setter for preparer property.

Parameters:

preparer - The preparer to use to invoke before the definition is rendered.

doTag

public void doTag()
           throws javax.servlet.jsp.JspException,
                  java.io.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

java.io.IOException