Package org.apache.tiles.jsp.taglib

Class UseAttributeTag

java.lang.Object

javax.servlet.jsp.tagext.SimpleTagSupport

org.apache.tiles.jsp.taglib.UseAttributeTag

All Implemented Interfaces:

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

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

Exposes am attribute as a scripting variable within the page.

Since:

Tiles 1.0

Version:

$Rev: 1360373 $ $Date: 2012-07-12 05:52:00 +1000 (Thu, 12 Jul 2012) $

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	UseAttributeTag.Tei	Implementation of TagExtraInfo which identifies the scripting object(s) to be made visible.

Constructor Summary

Constructors

Constructor	Description
UseAttributeTag()

Method Summary

Modifier and Type	Method	Description
void	doTag()
java.lang.String	getClassname()	Get class name.
java.lang.String	getId()	Returns the id of the imported scripting variable.
java.lang.String	getName()	Get the name.
java.lang.String	getScope()	Get scope.
java.lang.String	getScriptingVariable()	Returns the scripting variable to use.
boolean	isIgnore()	Get ignore flag.
void	setClassname(java.lang.String name)	Set the class name.
void	setId(java.lang.String id)	Sets the id of the imported scripting variable.
void	setIgnore(boolean ignore)	Set ignore flag.
void	setName(java.lang.String name)	Set the name.
void	setScope(java.lang.String scope)	Set the scope.

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

UseAttributeTag

public UseAttributeTag()

Method Detail

getId

public java.lang.String getId()

Returns the id of the imported scripting variable.

Returns:

The id of the imported scripting variable.

Since:

2.2.0

setId

public void setId(java.lang.String id)

Sets the id of the imported scripting variable.

Parameters:

id - The id of the imported scripting variable.

Since:

2.2.0

setScope

public void setScope(java.lang.String scope)

Set the scope.

Parameters:

scope - Scope.

getScope

public java.lang.String getScope()

Get scope.

Returns:

Scope.

getName

public java.lang.String getName()

Get the name.

Returns:

Name.

setName

public void setName(java.lang.String name)

Set the name.

Parameters:

name - The new name

setIgnore

public void setIgnore(boolean ignore)

Set ignore flag.

Parameters:

ignore - default: false: Exception is thrown when attribute is not found, set to true to ignore missing attributes silently

isIgnore

public boolean isIgnore()

Get ignore flag.

Returns:

default: false: Exception is thrown when attribute is not found, set to true to ignore missing attributes silently

getClassname

public java.lang.String getClassname()

Get class name.

Returns:

class name

setClassname

public void setClassname(java.lang.String name)

Set the class name.

Parameters:

name - The new class name.

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

getScriptingVariable

public java.lang.String getScriptingVariable()

Returns the scripting variable to use.

Returns:

The scripting variable.