com.client.core.datatables.model.column

Interface Column

All Known Implementing Classes:

AbstractColumn, StandardColumn

public interface Column

One instance of Column represents one column position on one specific row in the data table. For each row there will be created a number of DataTablesFields that correspond to the number of column in the table. fieldName has to be the exact name of the field on the Entity fieldLabel is the label that will be used for the column in the data table value is the actual value (in String, Date, Integer etc). displayValue this is the value that will be displayed in the data table

Method Summary

Modifier and Type	Method and Description
java.lang.String	createColumnConfigForDataTables()
java.lang.String	createColumnConfigForDataTablesEditable()
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 visable)

Method Detail

createColumnConfigForDataTables

java.lang.String createColumnConfigForDataTables()

createColumnConfigForDataTablesEditable

java.lang.String createColumnConfigForDataTablesEditable()

getFieldName

java.lang.String getFieldName()

Returns the unique name of the field on the jpa entity

Returns:

setFieldName

void setFieldName(java.lang.String fieldName)

getFieldLabel

java.lang.String getFieldLabel()

Returns the field label to use for display purposes

Returns:

setFieldLabel

void setFieldLabel(java.lang.String fieldLabel)

getValue

java.lang.Object getValue()

Returns the actual value for this column

Returns:

setValue

void setValue(java.lang.Object value)

getDisplayValue

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

Returns:

setDisplayValue

void setDisplayValue(java.lang.String displayValue)

getValueForDisplayOnEditForm

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

Returns:

getFieldType

FieldType getFieldType()

Returns the type of field.

Returns:

See Also:

for the different type of fields avaiable

setFieldType

void setFieldType(FieldType fieldType)

isEditable

boolean isEditable()

Specifies if the column can be edited

Returns:

setEditable

void setEditable(boolean editable)

isSortable

boolean isSortable()

Specifies if the column can be sorted

Returns:

setSortable

void setSortable(boolean sortable)

isVisible

boolean isVisible()

Specifies if the column is visible

Returns:

setVisible

void setVisible(boolean visable)

isSearchable

boolean isSearchable()

Specifies if the column is searchable

Returns:

setSearchable

void setSearchable(boolean searchable)

getShowOnForm

ShowOnForm getShowOnForm()

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

Returns:

setShowOnForm

void setShowOnForm(ShowOnForm showOnForm)

getRequired

boolean getRequired()

Specifies if the column/values is required

Returns:

setRequired

void setRequired(boolean required)

getEntity

Entity getEntity()

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

Returns:

setEntity

void setEntity(Entity entity)

getUrl

java.lang.String getUrl()

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

Returns:

setUrl

void setUrl(java.lang.String url)