`tiles-config_1_3.dtd`: Elements - Entities - Source | Intro - Index
FRAMES / NO FRAMES

# tiles-config_1_3.dtd

$Id: tiles-config_1_3.dtd 481833 2006-12-03 17:32:52Z niallp $

Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements. See the NOTICE file distributed with this work for additional information regarding copyright ownership. The ASF licenses this file to You under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.

<component-definitions> | Root element

deprecated: use tiles-definitions instead.

> <component-definitions>'s children
> Name | Cardinality
> --- | ---
> definition | At least one

Element's model:

(definition+)

<tiles-definitions> | Root element

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
> Name | Cardinality
> --- | ---
> definition | At least one

Element's model:

(definition+)

<definition> | Child of tiles-definitions, component-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
> Name | Cardinality
> --- | ---
> description | One or none
> display-name | One or none
> icon | One or none
> put | Any number
> putList | Any number
> <definition>'s attributes
> Name | Values | Default
> --- | --- | ---
> controllerClass |  |
> controllerUrl |  |
> extends |  |
> id | Match the ID rules. |
> name |  |
> page |  |
> path |  |
> role |  |
> template |  |

Element's model:

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

@id | Attribute of definition

Element identifier.

Possible values: Match the ID rules.

@controllerClass | Attribute of definition

Sorry, no documentation.

@controllerUrl | Attribute of definition

Sorry, no documentation.

@extends | Attribute of definition

Sorry, no documentation.

@name | Attribute of definition

Sorry, no documentation.

Required

@page | Attribute of definition

Sorry, no documentation.

@path | Attribute of definition

Sorry, no documentation.

@role | Attribute of definition

Sorry, no documentation.

@template | Attribute of definition

Sorry, no documentation.

<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
> Name | Values | Default
> --- | --- | ---
> content |  |
> direct | true, false |
> id | Match the ID rules. |
> name |  |
> type | string, page, template, definition |
> value |  |

@id | Attribute of put

Element identifier.

Possible values: Match the ID rules.

@content | Attribute of put

Sorry, no documentation.

@direct | Attribute of put

Sorry, no documentation.

Possible values: true, false

@name | Attribute of put

Sorry, no documentation.

Required

@type | Attribute of put

Sorry, no documentation.

Possible values: string, page, template, definition

@value | Attribute of put

Sorry, no documentation.

<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
> Name | Cardinality
> --- | ---
> add | Any number
> bean | Any number
> item | Any number
> putList | Any number
> <putList>'s attributes
> Name | Values | Default
> --- | --- | ---
> id | Match the ID rules. |
> name |  |

Element's model:

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

@id | Attribute of putList

Element identifier.

Possible values: Match the ID rules.

@name | Attribute of putList

Sorry, no documentation.

Required

<add> | Child of putList

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
> Name | Values | Default
> --- | --- | ---
> content |  |
> direct | true, false |
> id | Match the ID rules. |
> type | string, page, template, definition |
> value |  |

@id | Attribute of add

Element identifier.

Possible values: Match the ID rules.

@content | Attribute of add

Sorry, no documentation.

@direct | Attribute of add

Sorry, no documentation.

Possible values: true, false

@type | Attribute of add

Sorry, no documentation.

Possible values: string, page, template, definition

@value | Attribute of add

Sorry, no documentation.

<bean> | Child of putList

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
> Name | Cardinality
> --- | ---
> set-property | Any number
> <bean>'s attributes
> Name | Values | Default
> --- | --- | ---
> classtype |  |
> id | Match the ID rules. |

Element's model:

(set-property*)

@id | Attribute of bean

Element identifier.

Possible values: Match the ID rules.

@classtype | Attribute of bean

Sorry, no documentation.

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
> Name | Values | Default
> --- | --- | ---
> id | Match the ID rules. |
> property |  |
> value |  |

This element is always empty.

@id | Attribute of set-property

Element identifier.

Possible values: Match the ID rules.

@property | Attribute of set-property

Sorry, no documentation.

Required

@value | Attribute of set-property

Sorry, no documentation.

Required

<item> | Child of putList

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
> Name | Values | Default
> --- | --- | ---
> classtype |  |
> icon |  |
> id | Match the ID rules. |
> link |  |
> tooltip |  |
> value |  |

@id | Attribute of item

Element identifier.

Possible values: Match the ID rules.

@classtype | Attribute of item

Sorry, no documentation.

@icon | Attribute of item

Sorry, no documentation.

@link | Attribute of item

Sorry, no documentation.

Required

@tooltip | Attribute of item

Sorry, no documentation.

@value | Attribute of item

Sorry, no documentation.

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
> Name | Values | Default
> --- | --- | ---
> id | Match the ID rules. |

@id | Attribute of description

Element identifier.

Possible values: Match the ID rules.

<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
> Name | Values | Default
> --- | --- | ---
> id | Match the ID rules. |

@id | Attribute of display-name

Element identifier.

Possible values: Match the ID rules.

<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
> Name | Cardinality
> --- | ---
> large-icon | One or none
> small-icon | One or none
> <icon>'s attributes
> Name | Values | Default
> --- | --- | ---
> id | Match the ID rules. |

Element's model:

(small-icon?, large-icon?)

@id | Attribute of icon

Element identifier.

Possible values: Match the ID rules.

<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
> Name | Values | Default
> --- | --- | ---
> id | Match the ID rules. |

@id | Attribute of large-icon

Element identifier.

Possible values: Match the ID rules.

<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
> Name | Values | Default
> --- | --- | ---
> id | Match the ID rules. |

@id | Attribute of small-icon

Element identifier.

Possible values: Match the ID rules.