|
3.2.4: 2013-12-06 | ||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface ListColumnAction<I,V>
Action that inserts a new column into a table listing. The action is used multiple
times while generating the table. The first use is creating a column definition.
This uses the id, title, value type, properties, sortable and filterable flags,
formatter, etc. Then, for each row in the table, the getValue(DbControl, Object)
is used to get the actual value that should be displayed in the table. If
a formatter has been defined, it is used to format the value, otherwise
the Object.toString()
method is used.
Method Summary | |
---|---|
String |
getClazz()
Optional HTML class attribute that is used to style the column through CSS. |
Enumeration<String,String> |
getEnumeration()
Get an enumeration of possible values that can be found in the column. |
Formatter |
getExportFormatter()
Get a formatter that converts the exported value to a string that is written to the file. |
String |
getExportProperty()
Override the default property when this column is used for exporting. |
Object |
getExportValue(DbControl dc,
I item)
Get the value that should be used when exporting to a file. |
String |
getFilterProperty()
Override the default property when this column is used for filtering. |
Formatter<? super V> |
getFormatter()
Get a formatter that converts the current value to a string that is displayed in the column. |
String |
getId()
ID attribute of the column. |
String |
getProperty()
The property name for referencing data in the column. |
String |
getSortProperty()
Override the default property when this column is used for sorting. |
String |
getStyle()
Optional HTML style attribute that is used to style the column through CSS. |
String |
getTitle()
The column title. |
String |
getTooltip()
An optional tooltip that is displayed when the mouse is over the column header. |
V |
getValue(DbControl dc,
I item)
Get the value that should be displayed in the column. |
Type |
getValueType()
The data type of the values that are referenced by the property. |
boolean |
isExportable()
A flag to indicate if it is possible to export this column with the generic table exporter or not. |
boolean |
isFilterable()
A flag to indicate if filtering on this column is enabled or not. |
boolean |
isSortable()
A flag to indicate if sorting by this column is enabled for not. |
Method Detail |
---|
String getId()
String getClazz()
String getStyle()
String getTitle()
String getTooltip()
String getProperty()
Type getValueType()
boolean isSortable()
getSortProperty()
.
String getSortProperty()
boolean isFilterable()
getFilterProperty()
.
String getFilterProperty()
boolean isExportable()
getExportProperty()
.
String getExportProperty()
Formatter getExportFormatter()
Formatter.format(Object)
method is called once for
every item that is listed in the table.
Object.toString()
Object getExportValue(DbControl dc, I item)
getExportFormatter()
.
dc
- An open DbControl than can be used to query the databaseitem
- The current item
Enumeration<String,String> getEnumeration()
Formatter<? super V> getFormatter()
Formatter.format(Object)
method is called once for
every item that is listed in the table.
Object.toString()
V getValue(DbControl dc, I item)
getFormatter()
.
dc
- An open DbControl than can be used to query the databaseitem
- The current item
|
3.2.4: 2013-12-06 | ||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |