com.client.core.datatables.model.configuration.column

Interface ColumnConfiguration

All Known Implementing Classes:

StandardColumnConfiguration

public interface ColumnConfiguration

Represents a row as a map, where each entry in the map is a column in that row.

Method Summary

Modifier and Type	Method and Description
java.lang.String	assembleColumnConfigForDataTables() Assembles the javascript/datatables configurations for all the columns: this value will be used on the jsp page to determine a number of setting for the datatables plugins.
java.lang.String	assembleColumnConfigForDataTablesEditable() Assembles the javascript/datatables configurations for all the columns: this value will be used on the jsp page to determine a number of setting for the datatables editable plugins.
Column	getColumn(java.lang.Integer columnPosition) Returns the Column for the passed in position
Column	getColumnByFieldName(java.lang.String fieldName)
java.util.TreeMap<java.lang.Integer,Column>	getColumnConfigMap() Get the map of all column configurations for this table
int	getColumnPositionByFieldLabel(java.lang.String fieldLabel, boolean visibleOnly) Returns the position of a column based on the field label.
int	getColumnPositionByFieldName(java.lang.String fieldName, boolean visibleOnly) Returns the position of a column based on the field name.
java.lang.Object	getColumnValue(java.lang.Integer columnPosition) Returns the value for the column on the specified position
java.lang.String	getJsonValuesForFormEdit() Returns a json representation of all the values for one record, to be used in populating the form when editing a record using the form instead of inline editing.
java.lang.String	getLabelForFieldName(java.lang.String fieldName) Gets the field label for passed in field name
void	setColumn(java.lang.Integer columnPosition, Column column) Add column configuration for specified column position

Method Detail

setColumn

void setColumn(java.lang.Integer columnPosition,
               Column column)

Add column configuration for specified column position

Parameters:

columnPosition - the column position to set, column 0 must be the primary key of entity

column -

getColumn

Column getColumn(java.lang.Integer columnPosition)

Returns the Column for the passed in position

Parameters:

columnPosition - the postion of the column in the datatable

Returns:

the Column

getColumnValue

java.lang.Object getColumnValue(java.lang.Integer columnPosition)

Returns the value for the column on the specified position

Parameters:

columnPosition - the position of the column in the datatable

Returns:

the value for the column

getLabelForFieldName

java.lang.String getLabelForFieldName(java.lang.String fieldName)

Gets the field label for passed in field name

Parameters:

fieldName - name of field to get the label for

Returns:

the field label

getColumnConfigMap

java.util.TreeMap<java.lang.Integer,Column> getColumnConfigMap()

Get the map of all column configurations for this table

Returns:

a TreeMap with column position as key and column as value

assembleColumnConfigForDataTables

java.lang.String assembleColumnConfigForDataTables()

Assembles the javascript/datatables configurations for all the columns: this value will be used on the jsp page to determine a number of setting for the datatables plugins.

Returns:

a string containing the settings needed for the datatables plugin

assembleColumnConfigForDataTablesEditable

java.lang.String assembleColumnConfigForDataTablesEditable()

Assembles the javascript/datatables configurations for all the columns: this value will be used on the jsp page to determine a number of setting for the datatables editable plugins.

Returns:

a string containing the settings needed for the datatables editable plugin

getColumnPositionByFieldName

int getColumnPositionByFieldName(java.lang.String fieldName,
                                 boolean visibleOnly)

Returns the position of a column based on the field name.

Parameters:

fieldName - The fieldName of the column

visibleOnly - True if only visible column will be taken into consideration. False if all columns will be taken in consideration

Returns:

The position of the column

getColumnPositionByFieldLabel

int getColumnPositionByFieldLabel(java.lang.String fieldLabel,
                                  boolean visibleOnly)

Returns the position of a column based on the field label.

Parameters:

fieldLabel - The Label of the column

visibleOnly - True if only visible column will be taken into consideration. False if all columns will be taken in consideration

Returns:

The position of the column

getJsonValuesForFormEdit

java.lang.String getJsonValuesForFormEdit()

Returns a json representation of all the values for one record, to be used in populating the form when editing a record using the form instead of inline editing. The json formatted string will contain an array of json objects, one for each column in the column configuration Example: {"result":[{"id":"nameOfField","value":"valueForSaidField"},{"id":"nameOfField","value":"valueForSaidField"}]}

Returns:

json formatted string

getColumnByFieldName

Column getColumnByFieldName(java.lang.String fieldName)