tiles-config_1_1.dtd

tiles-config_1_1.dtd

DTD for the Tile Definition File, Version 1.1



<component-definitions>

deprecated: use tiles-definitions instead.

<component-definitions>'s children
NameCardinality
definitionAt least one
Element's model :

(definition+)


<tiles-definitions>

The "tiles-definitions" element is the root of the configuration file hierarchy, and contains nested elements for all of the other configuration settings.

<tiles-definitions>'s children
NameCardinality
definitionAt least one
Element's model :

(definition+)


<definition> Child of component-definitions,tiles-definitions

The "definition" element describes a definition that can be inserted in a jsp page. This definition is identified by its logical name. A definition allows to define all the attributes that can be set in <insert> tag from a jsp page.

controllerClass
The fully qualified Java class name of the controller subclass to call immediately before the tiles is inserted. Only one of controllerClass or controllerUrl should be specified.

controllerUrl
The context-relative path to the resource used as controller called immediately before the tiles is inserted. Only one of controllerClass or controllerUrl should be specified.

extends
Name of a definition that is used as ancestor of this definition. All attributes from the ancestor are available to the new definition. Any attribute inherited from the ancestor can be overloaded by providing a new value.

name
The unique identifier for this definition.

page
Same as path.

path
The context-relative path to the resource used as tiles to insert. This tiles will be inserted and a tiles context containing appropriate attributes will be available.

role
Security role name that is allowed access to this definition object. The definition is inserted only if the role name is allowed.

template
Same as path. For compatibility with the template tag library.

<definition>'s children
NameCardinality
descriptionOne or none
display-nameOne or none
iconOne or none
putAny number
putListAny number
<definition>'s attributes
NameValuesDefault
controllerClass
controllerUrl
extends
idID
name
page
path
role
template
Element's model :

(icon?,display-name?,description?,put*,putList*)


id Attribute of definition

Sorry, no documentation.

Possible values : ID


controllerClass Attribute of definition

The fully qualified Java class name of the controller subclass to call immediately before the tiles is inserted. Only one of controllerClass or controllerUrl should be specified.


controllerUrl Attribute of definition

The context-relative path to the resource used as controller called immediately before the tiles is inserted. Only one of controllerClass or controllerUrl should be specified.


extends Attribute of definition

Name of a definition that is used as ancestor of this definition. All attributes from the ancestor are available to the new definition. Any attribute inherited from the ancestor can be overloaded by providing a new value.


name Attribute of definition

The unique identifier for this definition.

Required


page Attribute of definition

Same as path.


path Attribute of definition

The context-relative path to the resource used as tiles to insert. This tiles will be inserted and a tiles context containing appropriate attributes will be available.


role Attribute of definition

Security role name that is allowed access to this definition object. The definition is inserted only if the role name is allowed.


template Attribute of definition

Same as path. For compatibility with the template tag library.


<put> Child of definition

The "put" element describes an attribute of a definition. It allows to specify the tiles attribute name and its value. The tiles value can be specified as an xml attribute, or in the body of the <put> tag.

content
Same as value. For compatibility with the template tag library.

direct
Same as type="string". For compatibility with the template tag library.

name
The unique identifier for this put.

type
The type of the value. Can be: string, page, template or definition. By default, no type is associated to a value. If a type is associated, it will be used as a hint to process the value when the attribute will be used in the inserted tiles.

value
The value associated to this tiles attribute. The value should be specified with this tag attribute, or in the body of the tag.

<put>'s attributes
NameValuesDefault
content
directtrue, false
idID
name
typestring, page, template, definition
value

id Attribute of put

Sorry, no documentation.

Possible values : ID


content Attribute of put

Same as value. For compatibility with the template tag library.


direct Attribute of put

Same as type="string". For compatibility with the template tag library.

Possible values : true, false


name Attribute of put

The unique identifier for this put.

Required


type Attribute of put

The type of the value. Can be: string, page, template or definition. By default, no type is associated to a value. If a type is associated, it will be used as a hint to process the value when the attribute will be used in the inserted tiles.

Possible values : string, page, template, definition


value Attribute of put

The value associated to this tiles attribute. The value should be specified with this tag attribute, or in the body of the tag.


<putList> Child of definition

The "putList" element describes a list attribute of a definition. It allows to specify an attribute that is a java List containing any kind of values. In the config file, the list elements are specified by nested <add>, <item> or <putList>.

name
The unique identifier for this put list.

<putList>'s children
NameCardinality
addAny number
beanAny number
itemAny number
putListAny number
<putList>'s attributes
NameValuesDefault
idID
name
Element's model :

((add* | item* | bean* | putList*)+)


id Attribute of putList

Sorry, no documentation.

Possible values : ID


name Attribute of putList

The unique identifier for this put list.

Required


<add>

The "add" element describes an element of a list. It is similar to the <put> element.

content
Same as value. For compatibility with the template tag library.

direct
Same as type="string". For compatibility with the template tag library.

type
The type of the value. Can be: string, page, template or definition. By default, no type is associated to a value. If a type is associated, it will be used as a hint to process the value when the attribute will be used in the inserted tiles.

value
The value associated to this tiles attribute. The value should be specified with this tag attribute, or in the body of the tag.

<add>'s attributes
NameValuesDefault
content
directtrue, false
idID
typestring, page, template, definition
value

id Attribute of add

Sorry, no documentation.

Possible values : ID


content Attribute of add

Same as value. For compatibility with the template tag library.


direct Attribute of add

Same as type="string". For compatibility with the template tag library.

Possible values : true, false


type Attribute of add

The type of the value. Can be: string, page, template or definition. By default, no type is associated to a value. If a type is associated, it will be used as a hint to process the value when the attribute will be used in the inserted tiles.

Possible values : string, page, template, definition


value Attribute of add

The value associated to this tiles attribute. The value should be specified with this tag attribute, or in the body of the tag.


<bean>

The "bean" element describes an element of a list. It create a bean of the specified java classtype. This bean is initialized with appropriate nested <set-property>.

classtype
The fully qualified classname for this bean.

<bean>'s children
NameCardinality
set-propertyAny number
<bean>'s attributes
NameValuesDefault
classtype
idID
Element's model :

(set-property*)


id Attribute of bean

Sorry, no documentation.

Possible values : ID


classtype Attribute of bean

The fully qualified classname for this bean.

Required


<set-property/> Child of bean

The "set-property" element specifies the method name and initial value of a bean property. When the object representing the surrounding element is instantiated, the accessor for the indicated property is called and passed the indicated value.

property
Name of the JavaBeans property whose setter method will be called.

value
String representation of the value to which this property will be set, after suitable type conversion

<set-property>'s attributes
NameValuesDefault
idID
property
value

This tag is always empty.


id Attribute of set-property

Sorry, no documentation.

Possible values : ID


property Attribute of set-property

Name of the JavaBeans property whose setter method will be called.

Required


value Attribute of set-property

String representation of the value to which this property will be set, after suitable type conversion

Required


<item>

The "item" element describes an element of a list. It create a bean added as element to the list. Each bean can contain different properties: value, link, icon, tooltip. These properties are to be interpreted by the jsp page using them. By default the bean is of type "org.apache.struts.tiles.beans.SimpleMenuItem". This bean is useful to create a list of beans used as menu items.

classtype
The fully qualified classtype for this bean. If specified, the classtype must be a subclass of the interface "org.apache.struts.tiles.beans.MenuItem".

icon
The bean 'icon' property.

link
The bean 'link' property.

tooltip
The bean 'tooltip' property.

value
The bean 'value' property.

<item>'s attributes
NameValuesDefault
classtype
icon
idID
link
tooltip
value

id Attribute of item

Sorry, no documentation.

Possible values : ID


classtype Attribute of item

The fully qualified classtype for this bean. If specified, the classtype must be a subclass of the interface "org.apache.struts.tiles.beans.MenuItem".


icon Attribute of item

The bean 'icon' property.


link Attribute of item

The bean 'link' property.

Required


tooltip Attribute of item

The bean 'tooltip' property.


value Attribute of item

The bean 'value' property.

Required


<description> Child of definition

The "description" element contains descriptive (paragraph length) text about the surrounding element, suitable for use in GUI tools.

<description>'s attributes
NameValuesDefault
idID

id Attribute of description

Sorry, no documentation.

Possible values : ID


<display-name> Child of definition

The "display-name" element contains a short (one line) description of the surrounding element, suitable for use in GUI tools.

<display-name>'s attributes
NameValuesDefault
idID

id Attribute of display-name

Sorry, no documentation.

Possible values : ID


<icon> Child of definition

The "icon" element contains a small-icon and large-icon element which specify the location, relative to the Struts configuration file, for small and large images used to represent the surrounding element in GUI tools.

<icon>'s children
NameCardinality
large-iconOne or none
small-iconOne or none
<icon>'s attributes
NameValuesDefault
idID
Element's model :

(small-icon?,large-icon?)


id Attribute of icon

Sorry, no documentation.

Possible values : ID


<large-icon> Child of icon

The "large-icon" element specifies the location, relative to the Struts configuration file, of a resource containing a large (32x32 pixel) icon image.

<large-icon>'s attributes
NameValuesDefault
idID

id Attribute of large-icon

Sorry, no documentation.

Possible values : ID


<small-icon> Child of icon

The "small-icon" element specifies the location, relative to the Struts configuration file, of a resource containing a small (16x16 pixel) icon image.

<small-icon>'s attributes
NameValuesDefault
idID

id Attribute of small-icon

Sorry, no documentation.

Possible values : ID