org.apache.struts.taglib.tiles
Class DefinitionTagSupport

java.lang.Object
  |
  +--javax.servlet.jsp.tagext.TagSupport
        |
        +--org.apache.struts.taglib.tiles.DefinitionTagSupport
All Implemented Interfaces:
javax.servlet.jsp.tagext.IterationTag, java.io.Serializable, javax.servlet.jsp.tagext.Tag
Direct Known Subclasses:
DefinitionTag, InsertTag

public class DefinitionTagSupport
extends javax.servlet.jsp.tagext.TagSupport
implements java.io.Serializable

Common base class for tags dealing with Tile Definition. This class define properties used in Definition Tags. It also extends TagSupport.

See Also:
Serialized Form

Field Summary
protected  java.lang.String controllerName
          Associated Controller name (classname or url)
protected  java.lang.String controllerType
          Associated Controller type
protected  java.lang.String page
          Uri of page assoicated to this definition.
protected  java.lang.String role
          Role associated to definition.
 
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
DefinitionTagSupport()
           
 
Method Summary
 java.lang.String getControllerName()
          Get controller name.
 java.lang.String getControllerType()
          Get controller type.
 java.lang.String getPage(java.lang.String page)
          Gets the value of the page property.
 java.lang.String getRole()
          Access method for the role property.
 java.lang.String getTemplate()
          Access method for the template property.
 void release()
          Release class properties.
 void setController(java.lang.String controller)
          Set associated controller name.
 void setControllerClass(java.lang.String controller)
          Set associated controller name as a classtype, and controller type as "classname".
 void setControllerName(java.lang.String controller)
          Set associated controller name.
 void setControllerType(java.lang.String controllerType)
          Set associated controller type.
 void setControllerUrl(java.lang.String controller)
          Set associated controller name as an url, and controller type as "url".
 void setPage(java.lang.String page)
          Sets the value of the page property.
 void setRole(java.lang.String role)
          Sets the value of the role property.
 void setTemplate(java.lang.String template)
          Sets the value of the template property.
 
Methods inherited from class javax.servlet.jsp.tagext.TagSupport
doAfterBody, doEndTag, doStartTag, 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
 
Methods inherited from interface javax.servlet.jsp.tagext.IterationTag
 

Field Detail

controllerType

protected java.lang.String controllerType
Associated Controller type


controllerName

protected java.lang.String controllerName
Associated Controller name (classname or url)


role

protected java.lang.String role
Role associated to definition.


page

protected java.lang.String page
Uri of page assoicated to this definition.

Constructor Detail

DefinitionTagSupport

public DefinitionTagSupport()
Method Detail

release

public void release()
Release class properties.

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

getControllerType

public java.lang.String getControllerType()
Get controller type. Type can be 'classname', 'url'


getControllerName

public java.lang.String getControllerName()
Get controller name. Name denote a fully qualified classname, or an url. Exact type can be specified with setControllerType.


setControllerType

public void setControllerType(java.lang.String controllerType)
Set associated controller type. Type denote a fully qualified classname.

Parameters:
controllerType - Typeof associated controller

setController

public void setController(java.lang.String controller)
Set associated controller name. Name denote a fully qualified classname, or an url. Exact type can be specified with setControllerType.

Parameters:
controller - Controller classname or url

setControllerName

public void setControllerName(java.lang.String controller)
Set associated controller name. Name denote a fully qualified classname, or an url. Exact type can be specified with setControllerType.

Parameters:
controller - Controller classname or url

setControllerUrl

public void setControllerUrl(java.lang.String controller)
Set associated controller name as an url, and controller type as "url". Name must be an url (not checked). Convenience method.

Parameters:
controller - Controller url

setControllerClass

public void setControllerClass(java.lang.String controller)
Set associated controller name as a classtype, and controller type as "classname". Name denote a fully qualified classname Convenience method.

Parameters:
controller - Controller classname.

getRole

public java.lang.String getRole()
Access method for the role property.

Returns:
the current value of the role property

setRole

public void setRole(java.lang.String role)
Sets the value of the role property.

Parameters:
role - the new value of the role property

setPage

public void setPage(java.lang.String page)
Sets the value of the page property.

Parameters:
page - the new value of the template property

getPage

public java.lang.String getPage(java.lang.String page)
Gets the value of the page property.

Parameters:
page - the new value of the template property

getTemplate

public java.lang.String getTemplate()
Access method for the template property.

Returns:
the current value of the template property

setTemplate

public void setTemplate(java.lang.String template)
Sets the value of the template property. Same as setPage()

Parameters:
template - the new value of the template property


Copyright 2000-2002 - Cedric Dumoulin and Apache Software Foundation