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

Class AbstractColumn

java.lang.Object

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

All Implemented Interfaces:

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

Direct Known Subclasses:

CommandColumn, PropertyColumn

public abstract class AbstractColumn
extends Object
implements IColumn

Base class for IColumns implementation

Author:

Sebastien Briquet - sebfz1

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
AbstractColumn(org.apache.wicket.model.IModel<String> title) Constructor
AbstractColumn(org.apache.wicket.model.IModel<String> title, int width) Constructor
AbstractColumn(org.apache.wicket.model.IModel<String> title, String field) Constructor
AbstractColumn(org.apache.wicket.model.IModel<String> title, String field, int width) Constructor
AbstractColumn(String title) Constructor
AbstractColumn(String title, int width) Constructor
AbstractColumn(String title, String field) Constructor
AbstractColumn(String title, String field, int width) Constructor

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.
protected String	getAggregatesAsString() Gets the list of aggregates as json array
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
Boolean	isPopupVisible() Indicates whether the column/field is visible in popup-mode Warning: the field should *still* be editable
boolean	isVisible() Indicates whether the column is visible
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

AbstractColumn

public AbstractColumn(String title)

Constructor

Parameters:

title - the text of the column header

AbstractColumn

public AbstractColumn(String title,
                      int width)

Constructor

Parameters:

title - the text of the column header

width - the desired width of the column

AbstractColumn

public AbstractColumn(String title,
                      String field)

Constructor

Parameters:

title - the text of the column header

field - the object field name

AbstractColumn

public AbstractColumn(String title,
                      String field,
                      int width)

Constructor

Parameters:

title - the text of the column header

field - the object field name

width - the desired width of the column

AbstractColumn

public AbstractColumn(org.apache.wicket.model.IModel<String> title)

Constructor

Parameters:

title - the text of the column header

AbstractColumn

public AbstractColumn(org.apache.wicket.model.IModel<String> title,
                      int width)

Constructor

Parameters:

title - the text of the column header

width - the desired width of the column

AbstractColumn

public AbstractColumn(org.apache.wicket.model.IModel<String> title,
                      String field)

Constructor

Parameters:

title - the text of the column header

field - the object field name

AbstractColumn

public AbstractColumn(org.apache.wicket.model.IModel<String> title,
                      String field,
                      int width)

Constructor

Parameters:

title - the text of the column header

field - the object field name

width - the desired width of the column

Method Detail

getTitle

public String getTitle()

Description copied from interface: IColumn

Gets the text of the column header

Specified by:

getTitle in interface IColumn

Returns:

the column title

getField

public String getField()

Description copied from interface: IColumn

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

Specified by:

getField in interface IColumn

Returns:

the field name

getWidth

public int getWidth()

Description copied from interface: IColumn

Gets the desired width of the column.

Specified by:

getWidth in interface IColumn

Returns:

the column's width

getMinScreenWidth

public int getMinScreenWidth()

Description copied from interface: IColumn

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.

Specified by:

getMinScreenWidth in interface IColumn

Returns:

0 by default

isVisible

public boolean isVisible()

Indicates whether the column is visible

Returns:

true by default

isEncoded

public Boolean isEncoded()

Description copied from interface: IColumn

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.

Specified by:

isEncoded in interface IColumn

Returns:

null by default

getEditor

public IKendoEditor getEditor()

Description copied from interface: IColumn

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

Specified by:

getEditor in interface IColumn

Returns:

a function or null if it does not apply

getFormat

public String getFormat()

Description copied from interface: IColumn

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.

Specified by:

getFormat in interface IColumn

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

public String getTemplate()

Description copied from interface: IColumn

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

Specified by:

getTemplate in interface IColumn

Returns:

the template or null if it does not apply

getAttributes

public String getAttributes()

Description copied from interface: IColumn

HTML attributes of the table cell rendered for the column.

Specified by:

getAttributes in interface IColumn

Returns:

a JSON string object

getFooterTemplate

public String getFooterTemplate()

Description copied from interface: IColumn

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

Specified by:

getFooterTemplate in interface IColumn

Returns:

the template or null if it does not apply

See Also:

columns.footerTemplate

getFilterable

public String getFilterable()

Description copied from interface: IColumn

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.

Specified by:

getFilterable in interface IColumn

Returns:

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

See Also:

configuration-columns.filterable

getMenu

public String getMenu()

Description copied from interface: IColumn

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).

Specified by:

getMenu in interface IColumn

Returns:

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

See Also:

configuration-columns.menu

getAggregates

public List<String> getAggregates()

Description copied from interface: IColumn

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".

Specified by:

getAggregates in interface IColumn

Returns:

the list of aggregates

See Also:

configuration-columns.aggregates

getAggregatesAsString

protected final String getAggregatesAsString()

Gets the list of aggregates as json array

Returns:

the list of aggregates as json array

getGroupHeaderTemplate

public String getGroupHeaderTemplate()

Description copied from interface: IColumn

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.

Specified by:

getGroupHeaderTemplate in interface IColumn

Returns:

the text template

See Also:

configuration-columns.groupHeaderTemplate

getGroupFooterTemplate

public String getGroupFooterTemplate()

Description copied from interface: IColumn

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

Specified by:

getGroupFooterTemplate in interface IColumn

Returns:

the text template

See Also:

configuration-columns.groupFooterTemplate

isEditable

public Boolean isEditable()

Description copied from interface: IColumn

Indicates whether the model field and the column is editable

Specified by:

isEditable in interface IColumn

Returns:

null by default, meaning not specified

isNullable

public Boolean isNullable()

Description copied from interface: IColumn

Indicates whether the model field is nullable

Specified by:

isNullable in interface IColumn

Returns:

null by default, meaning not specified

getType

public String getType()

Description copied from interface: IColumn

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

Specified by:

getType in interface IColumn

Returns:

the the field's type

isPopupVisible

public Boolean isPopupVisible()

Indicates whether the column/field is visible in popup-mode
Warning: the field should *still* be editable

Returns:

isVisible() by default;

toString

public String toString()

Overrides:

toString in class Object