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

Class StandardColumnConfiguration

java.lang.Object

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

All Implemented Interfaces:

ColumnConfiguration

public class StandardColumnConfiguration
extends java.lang.Object
implements ColumnConfiguration

Holds configurations for a data table. columnConfigMap represents a row as a map, where each entry in the map is a column in that row.

Constructor Summary

Constructors

Constructor and Description
StandardColumnConfiguration()

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

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

StandardColumnConfiguration

public StandardColumnConfiguration()

Method Detail

setColumn

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

Description copied from interface: ColumnConfiguration

Add column configuration for specified column position

Specified by:

setColumn in interface ColumnConfiguration

Parameters:

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

getColumn

public Column getColumn(java.lang.Integer columnPosition)

Description copied from interface: ColumnConfiguration

Returns the Column for the passed in position

Specified by:

getColumn in interface ColumnConfiguration

Parameters:

columnPosition - the postion of the column in the datatable

Returns:

the Column

getColumnValue

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

Description copied from interface: ColumnConfiguration

Returns the value for the column on the specified position

Specified by:

getColumnValue in interface ColumnConfiguration

Parameters:

columnPosition - the position of the column in the datatable

Returns:

the value for the column

getLabelForFieldName

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

Description copied from interface: ColumnConfiguration

Gets the field label for passed in field name

Specified by:

getLabelForFieldName in interface ColumnConfiguration

Parameters:

fieldName - name of field to get the label for

Returns:

the field label

getColumnConfigMap

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

Description copied from interface: ColumnConfiguration

Get the map of all column configurations for this table

Specified by:

getColumnConfigMap in interface ColumnConfiguration

Returns:

a TreeMap with column position as key and column as value

assembleColumnConfigForDataTables

public java.lang.String assembleColumnConfigForDataTables()

Description copied from interface: ColumnConfiguration

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.

Specified by:

assembleColumnConfigForDataTables in interface ColumnConfiguration

Returns:

a string containing the settings needed for the datatables plugin

assembleColumnConfigForDataTablesEditable

public java.lang.String assembleColumnConfigForDataTablesEditable()

Description copied from interface: ColumnConfiguration

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.

Specified by:

assembleColumnConfigForDataTablesEditable in interface ColumnConfiguration

Returns:

a string containing the settings needed for the datatables editable plugin

getColumnPositionByFieldName

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

Description copied from interface: ColumnConfiguration

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

Specified by:

getColumnPositionByFieldName in interface ColumnConfiguration

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

Throws:

java.lang.IllegalArgumentException

getColumnByFieldName

public Column getColumnByFieldName(java.lang.String fieldName)

Specified by:

getColumnByFieldName in interface ColumnConfiguration

getColumnPositionByFieldLabel

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

Description copied from interface: ColumnConfiguration

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

Specified by:

getColumnPositionByFieldLabel in interface ColumnConfiguration

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

Throws:

java.lang.IllegalArgumentException

getJsonValuesForFormEdit

public java.lang.String getJsonValuesForFormEdit()

Description copied from interface: ColumnConfiguration

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"}]}

Specified by:

getJsonValuesForFormEdit in interface ColumnConfiguration

Returns:

json formatted string