com.googlecode.wicket.kendo.ui.datatable.column

Interface IColumn

All Superinterfaces:

org.apache.wicket.util.io.IClusterable, Serializable

All Known Subinterfaces:

IExportableColumn

All Known Implementing Classes:

AbstractColumn, AjaxPropertyColumn, CommandColumn, CurrencyPropertyColumn, DatePropertyColumn, IdPropertyColumn, LinkPropertyColumn, NumberPropertyColumn, PropertyColumn

public interface IColumn
extends org.apache.wicket.util.io.IClusterable

Specifies the column definition of a DataTable

Author:

Sebastien Briquet - sebfz1

Method Summary

Modifier and Type	Method and Description
List<String>	getAggregates() The aggregate(s) which are calculated when the grid is grouped by the columns field.
String	getAttributes() HTML attributes of the table cell rendered for the column.
IKendoEditor	getEditor() Provides a way to specify a custom editing UI for the column.
String	getField() Get the field in the data set that this column should be bound to.
String	getFilterable() If set to true a filter menu will be displayed for this column when filtering is enabled. If set to false the filter menu will not be displayed. By default a filter menu is displayed for all columns when filtering is enabled via the filterable option.
String	getFooterTemplate() The template which renders the footer table cell for the column.
String	getFormat() The format that is applied to the value before it is displayed.
String	getGroupFooterTemplate() The template which renders the group footer when the grid is grouped by the column field.
String	getGroupHeaderTemplate() The template which renders the group header when the grid is grouped by the column field.
String	getMenu() If set to true the column will be visible in the grid column menu.
int	getMinScreenWidth() The pixel screen width below which the column will be hidden. The setting takes precedence over the hidden setting, so the two should not be used at the same time.
String	getTemplate() The template which renders the column content. ie: return "<a href='?id=#:data.id#'>#:data.id#</a>" TODO: make it work for function(?)
String	getTitle() Gets the text of the column header
String	getType() Get the field's type Available options are "string", "number", "boolean", "date".
int	getWidth() Gets the desired width of the column.
Boolean	isEditable() Indicates whether the model field and the column is editable
Boolean	isEncoded() If set to true the column value will be HTML-encoded before it is displayed. If set to false the column value will be displayed as is. By default the column value is HTML-encoded.
Boolean	isNullable() Indicates whether the model field is nullable

Method Detail

getTitle

String getTitle()

Gets the text of the column header

Returns:

the column title

getField

String getField()

Get the field in the data set that this column should be bound to.

Returns:

the field name

getWidth

int getWidth()

Gets the desired width of the column.

Returns:

the column's width

getMinScreenWidth

int getMinScreenWidth()

The pixel screen width below which the column will be hidden.
The setting takes precedence over the hidden setting, so the two should not be used at the same time.

Returns:

0 by default

isEncoded

Boolean isEncoded()

If set to true the column value will be HTML-encoded before it is displayed.
If set to false the column value will be displayed as is.
By default the column value is HTML-encoded.

Returns:

null by default

getEditor

IKendoEditor getEditor()

Provides a way to specify a custom editing UI for the column.

Returns:

a function or null if it does not apply

getFormat

String getFormat()

The format that is applied to the value before it is displayed. Takes the form "{0:format}" where "format" is a standard number format, custom number format, standard date format or a custom date format.

Returns:

the format or null if it does not apply

See Also:

standard-number-formats, custom-number-formats, standard-date-formats, custom-date-formats

getTemplate

String getTemplate()

The template which renders the column content.
ie: return "<a href='?id=#:data.id#'>#:data.id#</a>"
TODO: make it work for function(?)

Returns:

the template or null if it does not apply

getAttributes

String getAttributes()

HTML attributes of the table cell rendered for the column.

Returns:

a JSON string object

getFooterTemplate

String getFooterTemplate()

The template which renders the footer table cell for the column.

Returns:

the template or null if it does not apply

See Also:

columns.footerTemplate

getFilterable

String getFilterable()

If set to true a filter menu will be displayed for this column when filtering is enabled.
If set to false the filter menu will not be displayed.
By default a filter menu is displayed for all columns when filtering is enabled via the filterable option.

Returns:

the filterable object; ie: true or { extra: false }

See Also:

configuration-columns.filterable

getMenu

String getMenu()

If set to true the column will be visible in the grid column menu. By default the column menu includes all data-bound columns (ones that have their field set).

Returns:

the menu object; ie: false or { extra: false }

See Also:

configuration-columns.menu

getAggregates

List<String> getAggregates()

The aggregate(s) which are calculated when the grid is grouped by the columns field. The supported aggregates are "average", "count", "max", "min" and "sum".

Returns:

the list of aggregates

See Also:

configuration-columns.aggregates

getGroupHeaderTemplate

String getGroupHeaderTemplate()

The template which renders the group header when the grid is grouped by the column field. By default the name of the field and the current group value is displayed.

Returns:

the text template

See Also:

configuration-columns.groupHeaderTemplate

getGroupFooterTemplate

String getGroupFooterTemplate()

The template which renders the group footer when the grid is grouped by the column field. By default the group footer is not displayed.

Returns:

the text template

See Also:

configuration-columns.groupFooterTemplate

isEditable

Boolean isEditable()

Indicates whether the model field and the column is editable

Returns:

null by default, meaning not specified

isNullable

Boolean isNullable()

Indicates whether the model field is nullable

Returns:

null by default, meaning not specified

getType

String getType()

Get the field's type
Available options are "string", "number", "boolean", "date".

Returns:

the the field's type