org.apache.struts.taglib.tiles

Class DefinitionTagSupport

public class DefinitionTagSupport extends TagSupport implements Serializable

Common base class for tags dealing with Tiles definitions. This class defines properties used in Definition Tags. It also extends TagSupport.
Field Summary
protected StringcontrollerName
Associated Controller name (classname or url)
protected StringcontrollerType
Associated Controller type
protected Stringpage
Uri of page assoicated to this definition.
protected Stringrole
Role associated to definition.
Method Summary
StringgetControllerName()
Get controller name.
StringgetControllerType()
Get controller type.
StringgetPage()
Get the page.
StringgetRole()
Get associated role.
StringgetTemplate()
Get the template.
voidrelease()
Release class properties.
voidsetController(String controller)
Set associated controller name.
voidsetControllerClass(String controller)
Set associated controller name as a classtype and controller type as "classname".
voidsetControllerName(String controller)
Set associated controller name.
voidsetControllerType(String controllerType)
Set associated controller type.
voidsetControllerUrl(String controller)
Set associated controller name as an url, and controller type as "url".
voidsetPage(String page)
Set the page.
voidsetRole(String role)
Set associated role.
voidsetTemplate(String template)
Set the template.

Field Detail

controllerName

protected String controllerName
Associated Controller name (classname or url)

controllerType

protected String controllerType
Associated Controller type

page

protected String page
Uri of page assoicated to this definition.

role

protected String role
Role associated to definition.

Method Detail

getControllerName

public String getControllerName()
Get controller name. Name denotes a fully qualified classname, or an url. Exact type can be specified with {@link #setControllerType}.

Returns: Controller name.

getControllerType

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

Returns: Controller type.

getPage

public String getPage()
Get the page.

Returns: Page.

getRole

public String getRole()
Get associated role.

Returns: Associated role.

getTemplate

public String getTemplate()
Get the template. Same as getPage().

Returns: Template.

release

public void release()
Release class properties.

setController

public void setController(String controller)
Set associated controller name. Name denotes a fully qualified classname, or an url. Exact type can be specified with {@link #setControllerType}.

Parameters: controller Controller classname or url.

setControllerClass

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

Parameters: controller Controller classname.

setControllerName

public void setControllerName(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

setControllerType

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

Parameters: controllerType Type of associated controller.

setControllerUrl

public void setControllerUrl(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

setPage

public void setPage(String page)
Set the page.

Parameters: page Page.

setRole

public void setRole(String role)
Set associated role.

Parameters: role Associated role.

setTemplate

public void setTemplate(String template)
Set the template. Same as setPage().

Parameters: template Template.

Copyright B) 2000-2007 - The Apache Software Foundation