com.client.core.datatables.model.column

Class AbstractColumn

java.lang.Object

com.client.core.datatables.model.column.AbstractColumn

All Implemented Interfaces:

Column

Direct Known Subclasses:

StandardColumn

public abstract class AbstractColumn
extends java.lang.Object
implements Column

Constructor Summary

Constructors

Constructor and Description
AbstractColumn()
AbstractColumn(java.lang.String fieldName, java.lang.String fieldLabel, java.lang.Object value, java.lang.String displayValue, FieldType fieldType, Entity entity, boolean editable, boolean visible, boolean sortable, boolean searchable, boolean required, ShowOnForm showOnForm, java.lang.String url)
AbstractColumn(java.lang.String fieldName, java.lang.String fieldLabel, java.lang.Object value, java.lang.String displayValue, FieldType fieldType, Entity entity, boolean editable, boolean visible, boolean sortable, boolean searchable, boolean required, ShowOnForm showOnForm, java.lang.String url, java.lang.String width)

Method Summary

Modifier and Type	Method and Description
java.lang.String	createColumnConfigForDataTables() Creates the configuration used in the javascript setup for dataTables.
java.lang.String	createColumnConfigForDataTablesEditable() This method creates the configuration used in the javascript setup for dataTables.editable().
java.lang.String	createDataTablesColumnSetting()
java.lang.String	getDisplayValue() Returns the display value for this column, the display value could be the same as the value or it could be a different value
Entity	getEntity() Specifies if the column/value is part of the form backing entity
java.lang.String	getFieldLabel() Returns the field label to use for display purposes
java.lang.String	getFieldName() Returns the unique name of the field on the jpa entity
FieldType	getFieldType() Returns the type of field.
boolean	getRequired() Specifies if the column/values is required
ShowOnForm	getShowOnForm() Specifies if the column/value should be visible on the add new entity form
java.lang.String	getUrl() turn this value into a link using the url, also used to populate select values
java.lang.Object	getValue() Returns the actual value for this column
java.lang.String	getValueForDisplayOnEditForm() Returns the string representation of the value in a format that could be displayed on the edit form, such as taking date format into account for Date and XmlGregorianCalendar
boolean	isEditable() Specifies if the column can be edited
boolean	isSearchable() Specifies if the column is searchable
boolean	isSortable() Specifies if the column can be sorted
boolean	isVisible() Specifies if the column is visible
void	setDisplayValue(java.lang.String displayValue)
void	setEditable(boolean editable)
void	setEntity(Entity entity)
void	setFieldLabel(java.lang.String fieldLabel)
void	setFieldName(java.lang.String fieldName)
void	setFieldType(FieldType fieldType)
void	setRequired(boolean required)
void	setSearchable(boolean searchable)
void	setShowOnForm(ShowOnForm showOnForm)
void	setSortable(boolean sortable)
void	setUrl(java.lang.String url)
void	setValue(java.lang.Object value)
void	setVisible(boolean visible)
java.lang.String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

AbstractColumn

public AbstractColumn()

AbstractColumn

public AbstractColumn(java.lang.String fieldName,
                      java.lang.String fieldLabel,
                      java.lang.Object value,
                      java.lang.String displayValue,
                      FieldType fieldType,
                      Entity entity,
                      boolean editable,
                      boolean visible,
                      boolean sortable,
                      boolean searchable,
                      boolean required,
                      ShowOnForm showOnForm,
                      java.lang.String url)

AbstractColumn

public AbstractColumn(java.lang.String fieldName,
                      java.lang.String fieldLabel,
                      java.lang.Object value,
                      java.lang.String displayValue,
                      FieldType fieldType,
                      Entity entity,
                      boolean editable,
                      boolean visible,
                      boolean sortable,
                      boolean searchable,
                      boolean required,
                      ShowOnForm showOnForm,
                      java.lang.String url,
                      java.lang.String width)

Method Detail

createColumnConfigForDataTables

public java.lang.String createColumnConfigForDataTables()

Creates the configuration used in the javascript setup for dataTables. The configuration will be inserted into "aoColumns" : [${columnConfigDataTables}] and will determine such things as is the column visible and/or sortable.

Specified by:

createColumnConfigForDataTables in interface Column

createColumnConfigForDataTablesEditable

public java.lang.String createColumnConfigForDataTablesEditable()

This method creates the configuration used in the javascript setup for dataTables.editable(). The configuration will be inserted into "aoColumns" : [${columnConfigDataTables}] and will determine such things as column data type.

Specified by:

createColumnConfigForDataTablesEditable in interface Column

getFieldName

public java.lang.String getFieldName()

Description copied from interface: Column

Returns the unique name of the field on the jpa entity

Specified by:

getFieldName in interface Column

Returns:

setFieldName

public void setFieldName(java.lang.String fieldName)

Specified by:

setFieldName in interface Column

getFieldLabel

public java.lang.String getFieldLabel()

Description copied from interface: Column

Returns the field label to use for display purposes

Specified by:

getFieldLabel in interface Column

Returns:

setFieldLabel

public void setFieldLabel(java.lang.String fieldLabel)

Specified by:

setFieldLabel in interface Column

getValue

public java.lang.Object getValue()

Description copied from interface: Column

Returns the actual value for this column

Specified by:

getValue in interface Column

Returns:

setValue

public void setValue(java.lang.Object value)

Specified by:

setValue in interface Column

getDisplayValue

public java.lang.String getDisplayValue()

Description copied from interface: Column

Returns the display value for this column, the display value could be the same as the value or it could be a different value

Specified by:

getDisplayValue in interface Column

Returns:

setDisplayValue

public void setDisplayValue(java.lang.String displayValue)

Specified by:

setDisplayValue in interface Column

getValueForDisplayOnEditForm

public java.lang.String getValueForDisplayOnEditForm()

Description copied from interface: Column

Returns the string representation of the value in a format that could be displayed on the edit form, such as taking date format into account for Date and XmlGregorianCalendar

Specified by:

getValueForDisplayOnEditForm in interface Column

Returns:

getFieldType

public FieldType getFieldType()

Description copied from interface: Column

Returns the type of field.

Specified by:

getFieldType in interface Column

Returns:

See Also:

for the different type of fields avaiable

setFieldType

public void setFieldType(FieldType fieldType)

Specified by:

setFieldType in interface Column

getEntity

public Entity getEntity()

Description copied from interface: Column

Specifies if the column/value is part of the form backing entity

Specified by:

getEntity in interface Column

Returns:

setEntity

public void setEntity(Entity entity)

Specified by:

setEntity in interface Column

isEditable

public boolean isEditable()

Description copied from interface: Column

Specifies if the column can be edited

Specified by:

isEditable in interface Column

Returns:

setEditable

public void setEditable(boolean editable)

Specified by:

setEditable in interface Column

isVisible

public boolean isVisible()

Description copied from interface: Column

Specifies if the column is visible

Specified by:

isVisible in interface Column

Returns:

setVisible

public void setVisible(boolean visible)

Specified by:

setVisible in interface Column

isSortable

public boolean isSortable()

Description copied from interface: Column

Specifies if the column can be sorted

Specified by:

isSortable in interface Column

Returns:

setSortable

public void setSortable(boolean sortable)

Specified by:

setSortable in interface Column

createDataTablesColumnSetting

public java.lang.String createDataTablesColumnSetting()

isSearchable

public boolean isSearchable()

Description copied from interface: Column

Specifies if the column is searchable

Specified by:

isSearchable in interface Column

Returns:

setSearchable

public void setSearchable(boolean searchable)

Specified by:

setSearchable in interface Column

getRequired

public boolean getRequired()

Description copied from interface: Column

Specifies if the column/values is required

Specified by:

getRequired in interface Column

Returns:

setRequired

public void setRequired(boolean required)

Specified by:

setRequired in interface Column

getShowOnForm

public ShowOnForm getShowOnForm()

Description copied from interface: Column

Specifies if the column/value should be visible on the add new entity form

Specified by:

getShowOnForm in interface Column

Returns:

setShowOnForm

public void setShowOnForm(ShowOnForm showOnForm)

Specified by:

setShowOnForm in interface Column

getUrl

public java.lang.String getUrl()

Description copied from interface: Column

turn this value into a link using the url, also used to populate select values

Specified by:

getUrl in interface Column

Returns:

setUrl

public void setUrl(java.lang.String url)

Specified by:

setUrl in interface Column

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object