doc/src/ComponentReference/contrib.FormTable.html [149:309]:
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
The string describing the columns must be formatted in the following way:
- The column definitions in the string are separated by commas
- Each column definition must be of one of the following types:
- id
- id:expression
- id:description:expression
Here the id defines the identification of the column, the expression is an
OGNL expression that extracts the column value from the row object, and description
is the title of the column if it is not defined otherwise.
Each column definition may be prefixed by the ! character,
which identifies the column as non-sortable.
If defined, a Block with a name that is starts with the column id and
ends with ColumnValue will be used to render the column values.
Similarly, a Block with a name that starts with the column id and
ends with ColumnHeader will be used to render the column headers.
Finally, the title of the column will be taken from translation strings of the component
by using the column id as a key.
Please see the LocaleSelection component for examples.
- A column definition may also be of the type
- =expression
in which case it identifies an OGNL expression that returns an
ITableColumn
object defining the column.
- The full description string may be prefixed by the * character,
which means that the table is to be rendered within a form, and the
column headers must submit the form if they are clickable (i.e. if the column is sortable).
Here is an example of the use of a description string to define columns:
columns="locale:toString(), =currencyColumn, verbosity:Verbosity:currentRowVerbosity, !delete"
See Also
TableColumns,
TablePages,
TableRows,
TableValues,
TableView
|
Parameters
Name |
Type |
Direction |
Required |
Default |
Description |
source |
Object[]
Collection
Iterator
IBasicTableModel
|
in |
You must provide either both source and columns parameters
or the tableModel parameter |
|
The data to be displayed by the component. This parameter 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 |
String
ITableColumnModel
ITableColumn[]
List
Iterator
|
in |
|
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).
|
tableModel |
ITableModel |
in |
|
The ITableModel to be used to render the table.
The model contains all of the information needed to render the table and gives greatest flexibility,
but it may be harder to implement than simply using the source and columns parameters.
|
tableSessionStateManager |
ITableSessionStateManager |
in |
no |
A custom session state manager that reloads the data at each request if it is provided
via the source and columns parameters or stores all
of it in the session if it is provided via the tableModel parameter |
This is the session state manager that will control what part of the
table model will be saved in the session state.
It is then used to recreate the table model by
using what was saved in the session.
You can use one of the stock implementations of
ITableSessionStateManager
to determine the session state behaviour, or you can define your own.
|
tableSessionStoreManager |
ITableSessionStoreManager |
in |
no |
null |
Determines how the session state (returned by the session state manager)
will be saved in the session. If this parameter is null, then the state
will be saved as a persistent property. If it is not null, then the methods
of the interface will be used to save and load the state.
|
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
doc/src/ComponentReference/contrib.Table.html [154:314]:
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
The string describing the columns must be formatted in the following way:
- The column definitions in the string are separated by commas
- Each column definition must be of one of the following types:
- id
- id:expression
- id:description:expression
Here the id defines the identification of the column, the expression is an
OGNL expression that extracts the column value from the row object, and description
is the title of the column if it is not defined otherwise.
Each column definition may be prefixed by the ! character,
which identifies the column as non-sortable.
If defined, a Block with a name that is starts with the column id and
ends with ColumnValue will be used to render the column values.
Similarly, a Block with a name that starts with the column id and
ends with ColumnHeader will be used to render the column headers.
Finally, the title of the column will be taken from translation strings of the component
by using the column id as a key.
Please see the LocaleSelection component for examples.
- A column definition may also be of the type
- =expression
in which case it identifies an OGNL expression that returns an
ITableColumn
object defining the column.
- The full description string may be prefixed by the * character,
which means that the table is to be rendered within a form, and the
column headers must submit the form if they are clickable (i.e. if the column is sortable).
Here is an example of the use of a description string to define columns:
columns="locale:toString(), =currencyColumn, verbosity:Verbosity:currentRowVerbosity, !delete"
See Also
TableColumns,
TablePages,
TableRows,
TableValues,
TableView
|
Parameters
Name |
Type |
Direction |
Required |
Default |
Description |
source |
Object[]
Collection
Iterator
IBasicTableModel
|
in |
You must provide either both source and columns parameters
or the tableModel parameter |
|
The data to be displayed by the component. This parameter 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 |
String
ITableColumnModel
ITableColumn[]
List
Iterator
|
in |
|
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).
|
tableModel |
ITableModel |
in |
|
The ITableModel to be used to render the table.
The model contains all of the information needed to render the table and gives greatest flexibility,
but it may be harder to implement than simply using the source and columns parameters.
|
tableSessionStateManager |
ITableSessionStateManager |
in |
no |
A custom session state manager that reloads the data at each request if it is provided
via the source and columns parameters or stores all
of it in the session if it is provided via the tableModel parameter |
This is the session state manager that will control what part of the
table model will be saved in the session state.
It is then used to recreate the table model by
using what was saved in the session.
You can use one of the stock implementations of
ITableSessionStateManager
to determine the session state behaviour, or you can define your own.
|
tableSessionStoreManager |
ITableSessionStoreManager |
in |
no |
null |
Determines how the session state (returned by the session state manager)
will be saved in the session. If this parameter is null, then the state
will be saved as a persistent property. If it is not null, then the methods
of the interface will be used to save and load the state.
|
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
| |