User Documentation

One Minute Introduction

Two Minute Introduction

Your own plugin

Coffee Break Introduction

Property substitution

FAQ

IDE Integration

Doclipse

Maven Integration

Maven2 Plugin

Maven1 Plugin

Plugins

Project Information

Mailing lists

Source Repositories

Open Issues

Team

Developer Documentation

Feeds
Print
TapestryTags

@tapestry tags

@contrib.checkbox-group

A component defining a group of checkboxes that will be controlled together.

Typically the ControlCheckbox and ControlledCheckbox components are placed in the body of this component.

Unique false

Allowed locations

class method constructor field
true false false false
Parameter Required Allowed values Default value Array Token separator Description
id true Any value   no   The id of the component

@contrib.choose

Provides the context for mutually exclusive conditional evaluation.

Unique false

Allowed locations

class method constructor field
true false false false
Parameter Required Allowed values Default value Array Token separator Description
id true Any value   no   The id of the component
condition false Any value   no   The condition to evaluate.
element false Any value   no   The element to emulate.

@contrib.control-checkbox

Selecting or deselecting this checkbox will automatically select or deselect all controlled checkboxes in the checkbox group.

Unique false

Allowed locations

class method constructor field
true false false false
Parameter Required Allowed values Default value Array Token separator Description
id true Any value   no   The id of the component
group false Any value   no   This is an optional parameter.

If provided, it specifies the CheckboxGroup this component belongs to.

If it is not specified, then the component is a a part of the CheckboxGroup that wraps it.

Please note that if this parameter is used, then the CheckboxGroup it refers to must either enclose the current component, or must be defined after it.

@contrib.controlled-checkbox

A checkbox whose state may be controlled by other checkboxes using JavaScript.

The checkbox rendered by this component may be automatically selected or deselected by a ControlCheckbox within the same group.

Unique false

Allowed locations

class method constructor field
true false false false
Parameter Required Allowed values Default value Array Token separator Description
id true Any value   no   The id of the component
group false Any value   no   This is an optional parameter.

If provided, it specifies the CheckboxGroup this component belongs to.

If it is not specified, then the component is a a part of the CheckboxGroup that wraps it.

Please note that if this parameter is used, then the CheckboxGroup it refers to must either enclose the current component, or must be defined after it.
value true Any value   no   No description available yet.
disabled false Any value   no   No description available yet.

@contrib.date-field

Unique false

Allowed locations

class method constructor field
true false false false
Parameter Required Allowed values Default value Array Token separator Description
id true Any value   no   The id of the component
disabled false Any value   no   No description available yet.
hidden false Any value   no   No description available yet.
display-width false Any value   no   No description available yet.
maximum-length false Any value   no   No description available yet.
date true Any value   no   No description available yet.
display-name true Any value   no   No description available yet.
maximum false Any value   no   No description available yet.
minimum false Any value   no   No description available yet.
required false Any value   no   No description available yet.
format false Any value   no   No description available yet.
display-format false Any value   no   No description available yet.

@contrib.dump-object

Displays the properties of an object as an HTML table or a simple string.

Unique false

Allowed locations

class method constructor field
true false false false
Parameter Required Allowed values Default value Array Token separator Description
id true Any value   no   The id of the component
object false Any value   no   The object to be displayed as HTML.

@contrib.form-conditional

Conditionally emulates an element and its attributes (if element is specified) and/or includes a block of content if a condition is met.

Unique false

Allowed locations

class method constructor field
true false false false
Parameter Required Allowed values Default value Array Token separator Description
id true Any value   no   The id of the component
condition true Any value   no   The condition to evaluate.
element false Any value   no   The element to emulate.
condition-value false Any value   no   The value of the condition.

During render this is obtained from the condition parameter.

During rewind it is the submitted condition.
listener false Any value   no   No description available yet.

@contrib.form-table

The main Table component that is implemented using the lower-level Table components such as TableView and TableRows.

The component does not render its body, which makes it a good place to declare Blocks defining the column appearances.

Unique false

Allowed locations

class method constructor field
true false false false
Parameter Required Allowed values Default value Array Token separator Description
id true Any value   no   The id of the component
table-model false Any value   no   The model describing the data to be presented by the Table component.

This parameter is optional, but either the 'tableModel' or both 'source' and 'columns' parameters must be provided.
source false Any value   no   The data to be displayed by the component.

This parameter is available as an alternative to 'tableModel' and must be used in combination with the 'columns' parameter.

The parameter must be an array of values, a collection, an iterator, or an object implementing the IBasicTableModel interface.
columns false Any value   no   The table columns to be displayed.

The parameter must be an array, a list, or an Iterator of ITableColumn objects, an ITableColumnModel, or a String describing the columns (see documentation).
page-size false Any value   no   The number of records displayed per page when source/columns are used.

The page size is 10 by default.
initial-page false Any value   no   The initial page to be displayed.

This is the first page by default.
initial-sort-column false Any value   no   The id of the column to initially sort the table by.

The column is set to null by default, i.

e.

there is no sorting.
initial-sort-order false Any value   no   The order of the initial sorting.

Set this parameter to 'false' to sort in an ascending order and to 'true' to sort in a descending one.
table-session-state-manager false Any value   no   The manager that controls what part of the table model will be stored in the session.
table-session-store-manager false Any value   no   The manager that controls where the session data will be stored.
persist false Any value   no   Defines how the table state (paging and sorting) will be persisted if no tableSessionStoreManager is defined.

The possible values are 'session' (the default), 'client', 'client:page', and 'client:app'.
column-settings-container false Any value   no   The component where Block and messages are pulled from when using source/columns.
convertor false Any value   no   An interface defining how the items iterated upon by this component will be stored in the form as Hidden values.

This interface allows only the primary key of the items to be stored, rather than the whole item.
pages-displayed false Any value   no   The maximum number of pages that will be displayed in the list of table pages.

By default, only seven of the pages around the current one are shown.
column false Any value   no   The column that is being rendered.

This value is updated when both the column headers and column values are rendered.
row false Any value   no   The row that is being rendered.

This value is null when the column headers are rendered.
arrow-up-asset false Any value   no   The image to use to describe a column sorted in an ascending order.
arrow-down-asset false Any value   no   The image to use to describe a column sorted in a descending order.
pages-class false Any value   no   The CSS class of the table pages
columns-class false Any value   no   The CSS class of the table columns
rows-class false Any value   no   The CSS class of the table rows
values-class false Any value   no   The CSS class of the table values

@contrib.inspector-button

If true, then the InspectorButton will not be displayed (this saves the trouble of wrapping the InspectorButton in a conditional, as it generally should only be displayed when developing an application, not in deployment).

Unique false

Allowed locations

class method constructor field
true false false false
Parameter Required Allowed values Default value Array Token separator Description
id true Any value   no   The id of the component
disabled false Any value   no   If true, then the InspectorButton will not be displayed (this saves the trouble of wrapping the InspectorButton in a conditional, as it generally should only be displayed when developing an application, not in deployment).

@contrib.mask-edit

Unique false

Allowed locations

class method constructor field
true false false false
Parameter Required Allowed values Default value Array Token separator Description
id true Any value   no   The id of the component
mask false Any value   no   No description available yet.
value true Any value   no   No description available yet.
disabled false Any value   no   No description available yet.

@contrib.multiple-property-selection

Unique false

Allowed locations

class method constructor field
true false false false
Parameter Required Allowed values Default value Array Token separator Description
id true Any value   no   The id of the component
model true Any value   no   No description available yet.
selected-list true Any value   no   No description available yet.
disabled false Any value   no   No description available yet.
renderer false Any value   no   No description available yet.
display-name false Any value   no   No description available yet.
validators false Any value   no   No description available yet.
htmlid false Any value   no   No description available yet.

@contrib.numeric-field

Unique false

Allowed locations

class method constructor field
true false false false
Parameter Required Allowed values Default value Array Token separator Description
id true Any value   no   The id of the component
disabled false Any value   no   No description available yet.
hidden false Any value   no   No description available yet.
display-width false Any value   no   No description available yet.
maximum-length false Any value   no   No description available yet.
value true Any value   no   No description available yet.
display-name true Any value   no   No description available yet.
maximum false Any value   no   No description available yet.
minimum false Any value   no   No description available yet.
required false Any value   no   No description available yet.
type true Any value   no   No description available yet.

@contrib.otherwise

Otherwise is just a When component that always tries to render its body and/or emulate an element and its attributes (if element is specified) .

Unique false

Allowed locations

class method constructor field
true false false false
Parameter Required Allowed values Default value Array Token separator Description
id true Any value   no   The id of the component
element false Any value   no   The element to emulate.

@contrib.palette

A complex component used to manage multiple selection of items from a list.

Unique false

Allowed locations

class method constructor field
true false false false
Parameter Required Allowed values Default value Array Token separator Description
id true Any value   no   The id of the component
selected-title-block false Any value   no   No description available yet.
available-title-block false Any value   no   No description available yet.
model true Any value   no   No description available yet.
selected true Any value   no   No description available yet.
sort false Any value   no   No description available yet.
rows false Any value   no   No description available yet.
table-class false Any value   no   No description available yet.
select-image false Any value   no   No description available yet.
disabled-image false Any value   no   No description available yet.
deselect-image false Any value   no   No description available yet.
select-disabled-image false Any value   no   No description available yet.
deselect-disabled-image false Any value   no   No description available yet.
up-image false Any value   no   No description available yet.
up-disabled-image false Any value   no   No description available yet.
down-image false Any value   no   No description available yet.
down-disabled-image false Any value   no   No description available yet.
display-name false Any value   no   No description available yet.
htmlid false Any value   no   No description available yet.
validators false Any value   no   No description available yet.

@contrib.selector

Unique false

Allowed locations

class method constructor field
true false false false
Parameter Required Allowed values Default value Array Token separator Description
id true Any value   no   The id of the component

@contrib.show-description

Unique false

Allowed locations

class method constructor field
true false false false
Parameter Required Allowed values Default value Array Token separator Description
id true Any value   no   The id of the component
description true Any value   no   No description available yet.

@contrib.show-engine

Unique false

Allowed locations

class method constructor field
true false false false
Parameter Required Allowed values Default value Array Token separator Description
id true Any value   no   The id of the component

@contrib.show-properties

Unique false

Allowed locations

class method constructor field
true false false false
Parameter Required Allowed values Default value Array Token separator Description
id true Any value   no   The id of the component

@contrib.show-specification

Unique false

Allowed locations

class method constructor field
true false false false
Parameter Required Allowed values Default value Array Token separator Description
id true Any value   no   The id of the component

@contrib.show-template

Unique false

Allowed locations

class method constructor field
true false false false
Parameter Required Allowed values Default value Array Token separator Description
id true Any value   no   The id of the component

@contrib.simple-table-column-component

Unique false

Allowed locations

class method constructor field
true false false false
Parameter Required Allowed values Default value Array Token separator Description
id true Any value   no   The id of the component

@contrib.simple-table-column-form-component

Unique false

Allowed locations

class method constructor field
true false false false
Parameter Required Allowed values Default value Array Token separator Description
id true Any value   no   The id of the component

@contrib.table-columns

A low level Table component that renders the column headers in the table.

This component must be wrapped by TableView.

Unique false

Allowed locations

class method constructor field
true false false false
Parameter Required Allowed values Default value Array Token separator Description
id true Any value   no   The id of the component
column false Any value   no   The column currently being rendered [out]
element false Any value   no   The tag to use to wrap the column headers.
arrow-up-asset false Any value   no   The image to use to describe a column sorted in an ascending order.
arrow-down-asset false Any value   no   The image to use to describe a column sorted in a descending order.
class false Any value   no   The CSS class of the table columns

@contrib.table-form-pages

A version of TablePages that is designed for operation in a form.

It is a low level Table component that renders the pages in the table.

This component must be wrapped by TableView.

Unique false

Allowed locations

class method constructor field
true false false false
Parameter Required Allowed values Default value Array Token separator Description
id true Any value   no   The id of the component
pages-displayed false Any value   no   Determines the maximum number of pages to be displayed in the page list when the table has more than one page.

@contrib.table-form-rows

A version of the TableRows designed for operation in a form.

This is a low level Table component that generates the rows of the current page in the table.

Each row is stored as a hidden value in the form, which eliminates the chance of a stale link during rewinding.

This component must be wrapped by TableView.

Unique false

Allowed locations

class method constructor field
true false false false
Parameter Required Allowed values Default value Array Token separator Description
id true Any value   no   The id of the component
row false Any value   no   The value object of the row currently being rendered.
convertor false Any value   no   An interface defining how the items iterated upon by this component will be stored in the form as Hidden values.

This interface allows only the primary key of the items to be stored, rather than the whole item.
element false Any value   no   The tag to use to wrap the rows in, 'tr' by default.

@contrib.table-pages

A low level Table component that renders the pages in the table.

This component must be wrapped by TableView.

Unique false

Allowed locations

class method constructor field
true false false false
Parameter Required Allowed values Default value Array Token separator Description
id true Any value   no   The id of the component
pages-displayed false Any value   no   Determines the maximum number of pages to be displayed in the page list when the table has more than one page.

@contrib.table-rows

A low level Table component that generates the rows of the current page in the table.

This component must be wrapped by TableView.

Unique false

Allowed locations

class method constructor field
true false false false
Parameter Required Allowed values Default value Array Token separator Description
id true Any value   no   The id of the component
row false Any value   no   The current row being rendered.
index false Any value   no   If provided, the parameter is updated with the index of the loop on each iteration.
element false Any value   no   The tag to use to wrap the rows in, 'tr' by default.
key-expression false Any value   no   Only active in a form.

An OGNL expression that returns the primary key of the iterated value.

The primary keys are stored in hidden fields during rendering and are loaded from the form during a rewind to ensure that the iterations remain the same.

This is a simpler, but a less efficient alternative of the 'converter' parameter.

If needed, please use in conjuction with 'fullSource' to reference objects not currently present in 'source'.

Also, use the 'defaultValue' parameter to define the object to be returned if a value corresponding to a particular primary key cannot be found.
full-source false Any value   no   Only active in a form and in combination with the 'keyExpression' parameter.

If an object corresponding to a primary key stored in the form cannot be found in the 'source' parameter, then the objects provided by this parameter are searched for a match next.
default-value false Any value   no   Only active in a form.

The value to be used when no match for a given primary key is found.
converter false Any value   no   Only active in a form.

Defines how the items iterated upon will be stored in the form as hidden values and how the stored information will be converted back to objects.

This interface allows only the primary key of the items to be stored, rather than the whole item.
primary-keys false Any value   no   Only active in a form.

If provided, the parameter is automatically updated before a rewind with the list of primary keys stored in the form.

The parameter is updated right before the iterations begin in a rewind and could be used to preload the relevant objects in a provided 'converter'.
volatile false Any value   no   Only active in a form.

Determines whether to avoid creating hidden fields within a form.

Using this parameter may make the form structure different during render and rewind, and cause exceptions as a result.

Please use with caution.

@contrib.table

The main Table component that is implemented using the lower-level Table components such as TableView and TableRows.

The component does not render its body, which makes it a good place to declare Blocks defining the column appearances.

Unique false

Allowed locations

class method constructor field
true false false false
Parameter Required Allowed values Default value Array Token separator Description
id true Any value   no   The id of the component
table-model false Any value   no   The model describing the data to be presented by the Table component.

This parameter is optional, but either the 'tableModel' or both 'source' and 'columns' parameters must be provided.
source false Any value   no   The data to be displayed by the component.

This parameter is available as an alternative to 'tableModel' and must be used in combination with the 'columns' parameter.

The parameter must be an array of values, a collection, an iterator, or an object implementing the IBasicTableModel interface.
columns false Any value   no   The table columns to be displayed.

The parameter must be an array, a list, or an Iterator of ITableColumn objects, an ITableColumnModel, or a String describing the columns (see documentation).
page-size false Any value   no   The number of records displayed per page when source/columns are used.

The page size is 10 by default.
initial-page false Any value   no   The initial page to be displayed.

This is the first page by default.
initial-sort-column false Any value   no   The id of the column to initially sort the table by.

The column is set to null by default, i.

e.

there is no sorting.
initial-sort-order false Any value   no   The order of the initial sorting.

Set this parameter to 'false' to sort in an ascending order and to 'true' to sort in a descending one.
table-session-state-manager false Any value   no   The manager that controls what part of the table model will be stored in the session.
table-session-store-manager false Any value   no   The manager that controls where the session data will be stored.
persist false Any value   no   Defines how the table state (paging and sorting) will be persisted if no tableSessionStoreManager is defined.

The possible values are 'session' (the default), 'client', 'client:page', and 'client:app'.
column-settings-container false Any value   no   The component where Block and messages are pulled from when using source/columns.
pages-displayed false Any value   no   The maximum number of pages that will be displayed in the list of table pages.

By default, only seven of the pages around the current one are shown.
column false Any value   no   The column that is being rendered.

This value is updated when both the column headers and column values are rendered.
row false Any value   no   The row that is being rendered.

This value is null when the column headers are rendered.
index false Any value   no   If provided, the parameter is updated with the index of the loop on each iteration.
key-expression false Any value   no   Only active in a form.

An OGNL expression that returns the primary key of the iterated value.

The primary keys are stored in hidden fields during rendering and are loaded from the form during a rewind to ensure that the iterations remain the same.

This is a simpler, but a less efficient alternative of the 'converter' parameter.

If needed, please use in conjuction with 'fullSource' to reference objects not currently present in 'source'.

Also, use the 'defaultValue' parameter to define the object to be returned if a value corresponding to a particular primary key cannot be found.
full-source false Any value   no   Only active in a form and in combination with the 'keyExpression' parameter.

If an object corresponding to a primary key stored in the form cannot be found in the 'source' parameter, then the objects provided by this parameter are searched for a match next.
default-value false Any value   no   Only active in a form.

The value to be used when no match for a given primary key is found.
converter false Any value   no   Only active in a form.

Defines how the items iterated upon will be stored in the form as hidden values and how the stored information will be converted back to objects.

This interface allows only the primary key of the items to be stored, rather than the whole item.
primary-keys false Any value   no   Only active in a form.

If provided, the parameter is automatically updated before a rewind with the list of primary keys stored in the form.

The parameter is updated right before the iterations begin in a rewind and could be used to preload the relevant objects in a provided 'converter'.
volatile false Any value   no   Only active in a form.

Determines whether to avoid creating hidden fields within a form.

Using this parameter may make the form structure different during render and rewind, and cause exceptions as a result.

Please use with caution.
arrow-up-asset false Any value   no   The image to use to describe a column sorted in an ascending order.
arrow-down-asset false Any value   no   The image to use to describe a column sorted in a descending order.
pages-class false Any value   no   The CSS class of the table pages
columns-class false Any value   no   The CSS class of the table columns
rows-class false Any value   no   The CSS class of the table rows
values-class false Any value   no   The CSS class of the table values

@contrib.table-values

A low level Table component that generates the columns for the current row in the table.

This component must be wrapped by TableRows.

Unique false

Allowed locations

class method constructor field
true false false false
Parameter Required Allowed values Default value Array Token separator Description
id true Any value   no   The id of the component
column false Any value   no   The current column being rendered
element false Any value   no   The tag to use to wrap the values in, 'td' by default.
class false Any value   no   The CSS class of the table values

@contrib.table-view

The main lower-level Table component.

This component should wrap all other lower-level Table components such as

TablePages and TableRows, as it provides the data they use.

Unique false

Allowed locations

class method constructor field
true false false false
Parameter Required Allowed values Default value Array Token separator Description
id true Any value   no   The id of the component
table-model false Any value   no   The model describing the data to be presented by the table components.

This parameter is optional, but either the 'tableModel' or both

'source' and 'columns' parameters must be provided.
source false Any value   no   The data to be displayed by the component. This parameter is available as

an alternative to tableModel and must be used in combination with the

'columns' parameter.

The parameter must be an array of values, a collection, an iterator,

or an object implementing the IBasicTableModel interface.
columns false Any value   no   The table columns to be displayed.

The parameter must be an array, a list, or an Iterator of ITableColumn objects,

an ITableColumnModel, or a String describing the columns (see documentation).
page-size false Any value   no   The number of records displayed per page when source/columns are used.

The page size is 10 by default.
initial-page false Any value   no   The initial page to be displayed.

This is the first page by default.
initial-sort-column false Any value   no   The id of the column to initially sort the table by.

The column is set to null by default, i.e. there is no sorting.
initial-sort-order false Any value   no   The order of the initial sorting.

Set this parameter to 'false' to sort in an ascending order

and to 'true' to sort in a descending one.
table-session-state-manager false Any value   no   The manager defining what part of the table model will be stored in

the session.
table-session-store-manager false Any value   no   The manager defining where the session data will be stored.
persist false Any value   no   Defines how the table state (paging and sorting) will be persisted

if no tableSessionStoreManager is defined.

The possible values are 'session' (the default), 'client', 'client:page',

and 'client:app'.
element false Any value   no   The tag with which the component will be inserted in the generated content.
column-settings-container false Any value   no   The component where Block and messages are pulled from when using source/columns.

@contrib.timeout

Displays a message to the user when a certain amount of time remains to the expiration of the session.

Unique false

Allowed locations

class method constructor field
true false false false
Parameter Required Allowed values Default value Array Token separator Description
id true Any value   no   The id of the component
warning-time false Any value   no   The number of seconds before session expiration when a warning message will appear.
auto-prolong-time false Any value   no   The number of seconds before session expiration when the session will be automatically prolonged upon user activity.
warning-message false Any value   no   The warning message that will appear when the session is about to exipre.

Here
Unknown macro: {0}
is replaced by the number of minutes that remain until expiration and
Unknown macro: {1}
is replaced with the time when the expiration will occur.
expiration-message false Any value   no   The message that will appear when the session exipres and the user needs to log in again.
disable-warning false Any value   no   Do not display a warning message after 'warningTime' seconds.
disable-auto-prolong false Any value   no   Disable the automatic prolonging of a session after 'autoProlongTime' seconds upon user activity.
expiration-function false Any value   no   The JavaScript function that will be invoked when the session expires.

@contrib.tree-data-view

Unique false

Allowed locations

class method constructor field
true false false false
Parameter Required Allowed values Default value Array Token separator Description
id true Any value   no   The id of the component
tree-view true Any value   no   No description available yet.
value false Any value   no   No description available yet.
show-root-node false Any value   no   No description available yet.

@contrib.tree-node-view

Unique false

Allowed locations

class method constructor field
true false false false
Parameter Required Allowed values Default value Array Token separator Description
id true Any value   no   The id of the component
show-node-images false Any value   no   No description available yet.
make-node-direct false Any value   no   No description available yet.
node-render-factory false Any value   no   No description available yet.

@contrib.tree-table-data-view

Unique false

Allowed locations

class method constructor field
true false false false
Parameter Required Allowed values Default value Array Token separator Description
id true Any value   no   The id of the component
tree-view false Any value   no   No description available yet.
node-view-component-address false Any value   no   No description available yet.
node-render-factory false Any value   no   No description available yet.
entries-per-table-page false Any value   no   No description available yet.
show-root-node false Any value   no   No description available yet.
table-colunms false Any value   no   No description available yet.

@contrib.tree-table-node-view-delegator

Unique false