DefinitionTagSupport (Struts Tiles 1.3.10 API)

Overview | Package | Class | Use | Tree | Deprecated | Index | Help

PREV CLASS NEXT CLASS | FRAMES NO FRAMES
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD

## org.apache.struts.tiles.taglib
Class DefinitionTagSupport

    java.lang.Object
      javax.servlet.jsp.tagext.TagSupport
          org.apache.struts.tiles.taglib.DefinitionTagSupport

All Implemented Interfaces:
  Serializable, IterationTag, Tag

Direct Known Subclasses:
  DefinitionTag, InsertTag

    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.

See Also:
  Serialized Form

Field Summary
`protected String` | `controllerName` Associated Controller name (classname or url)
`protected String` | `controllerType` Associated Controller type
`protected String` | `page` Uri of page assoicated to this definition.
`protected 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
`String` | `getControllerName()` Get controller name.
`String` | `getControllerType()` Get controller type.
`String` | `getPage()` Get the page.
`String` | `getRole()` Get associated role.
`String` | `getTemplate()` Get the template.
`void` | `release()` Release class properties.
`void` | `setController(String controller)` Set associated controller name.
`void` | `setControllerClass(String controller)` Set associated controller name as a classtype and controller type as "classname".
`void` | `setControllerName(String controller)` Set associated controller name.
`void` | `setControllerType(String controllerType)` Set associated controller type.
`void` | `setControllerUrl(String controller)` Set associated controller name as an url, and controller type as "url".
`void` | `setPage(String page)` Set the page.
`void` | `setRole(String role)` Set associated role.
`void` | `setTemplate(String template)` Set the template.

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`

Field Detail

### controllerType

    protected String controllerType

  Associated Controller type

### controllerName

    protected String controllerName

  Associated Controller name (classname or url)

### role

    protected String role

  Role associated to definition.

### page

    protected 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 `Tag`
  Overrides:
    `release` in class `TagSupport`

### getControllerType

    public String getControllerType()

  Get controller type. Type can be 'classname', 'url'.

  Returns:
    Controller type.

### getControllerName

    public String getControllerName()

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

  Returns:
    Controller name.

### setControllerType

    public void setControllerType(String controllerType)

  Set associated controller type. Type denotes a fully qualified classname.

  Parameters:
    `controllerType` - Type of associated controller.

### 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 `setControllerType(java.lang.String)`.

  Parameters:
    `controller` - Controller classname or url.

### 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

### 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

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

### getRole

    public String getRole()

  Get associated role.

  Returns:
    Associated role.

### setRole

    public void setRole(String role)

  Set associated role.

  Parameters:
    `role` - Associated role.

### setPage

    public void setPage(String page)

  Set the page.

  Parameters:
    `page` - Page.

### getPage

    public String getPage()

  Get the page.

  Returns:
    Page.

### getTemplate

    public String getTemplate()

  Get the template. Same as getPage().

  Returns:
    Template.

### setTemplate

    public void setTemplate(String template)

  Set the template. Same as setPage().

  Parameters:
    `template` - Template.

Overview | Package | Class | Use | Tree | Deprecated | Index | Help

PREV CLASS NEXT CLASS | FRAMES NO FRAMES
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD

Copyright © 2000-2008 Apache Software Foundation. All Rights Reserved.