org.apache.tiles.jsp.taglib

Class InsertDefinitionTag

java.lang.Object

javax.servlet.jsp.tagext.SimpleTagSupport

org.apache.tiles.jsp.taglib.InsertDefinitionTag

All Implemented Interfaces:

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

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

This is the tag handler for <tiles:insertDefinition>, which includes a name, eventually overriding or filling attributes of its template.

Version:

$Rev: 929598 $ $Date: 2010-03-31 17:53:02 +0200 (mer, 31 mar 2010) $

Constructor Summary

Constructors

Constructor and Description
InsertDefinitionTag()

Method Summary

Modifier and Type	Method and Description
void	doTag()
String	getName() Returns the name of the definition to insert.
String	getPreparer() Returns the preparer name.
String	getRole() Returns the role to check.
String	getTemplate() Returns a string representing the URI of a template (for example, a JSP page).
String	getTemplateExpression() Returns the expression to evaluate to get the value of the template.
String	getTemplateType() Returns the type of the template attribute.
boolean	isFlush() Returns the flush flag.
boolean	isIgnore() Returns the ignore flag.
void	setFlush(boolean flush) Sets the flush flag.
void	setIgnore(boolean ignore) Sets the ignore flag.
void	setName(String name) Sets the name of the definition to insert.
void	setPreparer(String preparer) Sets the preparer name.
void	setRole(String role) Sets the role to check.
void	setTemplate(String template) Sets a string representing the URI of a template (for example, a JSP page).
void	setTemplateExpression(String templateExpression) Sets the expression to evaluate to get the value of the template.
void	setTemplateType(String templateType) Sets the type of the template attribute.

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

InsertDefinitionTag

public InsertDefinitionTag()

Method Detail

getName

public String getName()

Returns the name of the definition to insert.

Returns:

The name of the definition.

setName

public void setName(String name)

Sets the name of the definition to insert.

Parameters:

name - The name of the definition.

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.

Since:

2.1.1

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.

Since:

2.1.1

getPreparer

public String getPreparer()

Returns the preparer name.

Returns:

The preparer name.

Since:

2.1.1

setPreparer

public void setPreparer(String preparer)

Sets the preparer name.

Parameters:

preparer - The preparer name.

Since:

2.1.1

isFlush

public boolean isFlush()

Returns the flush flag. If true, current page out stream is flushed after insertion.

Returns:

The flush flag.

Since:

2.1.1

setFlush

public void setFlush(boolean flush)

Sets the flush flag. If true, current page out stream is flushed after insertion.

Parameters:

flush - The flush flag.

Since:

2.1.1

isIgnore

public boolean isIgnore()

Returns the ignore flag. If it is set to true, and the attribute specified by the name does not exist, simply return without writing anything. The default value is false, which will cause a runtime exception to be thrown.

Returns:

The ignore flag.

Since:

2.1.1

setIgnore

public void setIgnore(boolean ignore)

Sets the ignore flag. If this attribute is set to true, and the attribute specified by the name does not exist, simply return without writing anything. The default value is false, which will cause a runtime exception to be thrown.

Parameters:

ignore - The ignore flag.

Since:

2.1.1

getTemplate

public String getTemplate()

Returns a string representing the URI of a template (for example, a JSP page).

Returns:

The template URI.

Since:

2.1.0

setTemplate

public void setTemplate(String template)

Sets a string representing the URI of a template (for example, a JSP page).

Parameters:

template - The template URI.

Since:

2.1.0

getTemplateType

public String getTemplateType()

Returns the type of the template attribute.

Returns:

The template type.

Since:

2.2.0

setTemplateType

public void setTemplateType(String templateType)

Sets the type of the template attribute.

Parameters:

templateType - The template type.

Since:

2.2.0

getTemplateExpression

public String getTemplateExpression()

Returns the expression to evaluate to get the value of the template.

Returns:

The template expression.

Since:

2.2.0

setTemplateExpression

public void setTemplateExpression(String templateExpression)

Sets the expression to evaluate to get the value of the template.

Parameters:

templateExpression - The template expression.

Since:

2.2.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