org.apache.tapestry.contrib.table.components
Interface TableColumnModelSource

All Known Implementing Classes:

TableColumnModelSourceImpl

public interface TableColumnModelSource

Service used to generate a ITableColumnModelfrom a string description.

Since:

4.0

Author:

Howard M. Lewis Ship

Method Summary

ITableColumnModel

generateTableColumnModel(IAdvancedTableColumnSource objColumnSource, String strDesc, IComponent objComponent, IComponent objColumnSettingsContainer) Generate a table column model out of the description string provided.

Method Detail

generateTableColumnModel

ITableColumnModel generateTableColumnModel(IAdvancedTableColumnSource objColumnSource,
                                           String strDesc,
                                           IComponent objComponent,
                                           IComponent objColumnSettingsContainer)

Generate a table column model out of the description string provided. Entries in the description string are separated by commas. Each column entry is of the format name, name:expression, or name:displayName:expression. An entry prefixed with ! represents a non-sortable column. If the whole description string is prefixed with *, it represents columns to be included in a Form.

Parameters:

strDesc - the description of the column model to be generated

objComponent - the component ordering the generation

objColumnSettingsContainer - the component containing the column settings

Returns:

a table column model based on the provided parameters