org.apache.wicket.extensions.markup.html.repeater.data.table

Interface IColumn<T,S>

Type Parameters:

T - the type of the object that will be rendered in this column's cells

S - the type of the sorting parameter

All Superinterfaces:

ICellPopulator<T>, org.apache.wicket.util.io.IClusterable, IDetachable, Serializable

All Known Subinterfaces:

IExportableColumn<T,S>, IFilteredColumn<T,S>, IStyledColumn<T,S>, ITreeColumn<T,S>

All Known Implementing Classes:

AbstractColumn, AbstractExportableColumn, AbstractTreeColumn, ChoiceFilteredPropertyColumn, FilteredAbstractColumn, FilteredPropertyColumn, HeaderlessColumn, PropertyColumn, TextFilteredPropertyColumn, TreeColumn

public interface IColumn<T,S>
extends ICellPopulator<T>

An interface that represents a column in the DefaultDataTable

Author:

Igor Vaynberg ( ivaynberg )

Method Summary

Methods

Modifier and Type	Method and Description
Component	getHeader(String componentId) Returns the component that will be used as the header for the column.
S	getSortProperty() Returns the property that this header sorts on.
boolean	isSortable() Returns true if the header of the column should be sortable

Methods inherited from interface org.apache.wicket.extensions.markup.html.repeater.data.grid.ICellPopulator

populateItem

Methods inherited from interface org.apache.wicket.model.IDetachable

detach

Method Detail

getHeader

Component getHeader(String componentId)

Returns the component that will be used as the header for the column. This component will be contained in <span> tags.

Parameters:

componentId - component id for the returned Component

Returns:

component that will be used as the header for the column

getSortProperty

S getSortProperty()

Returns the property that this header sorts on. If null is returned the header will be not sortable.

Returns:

the sort property

isSortable

boolean isSortable()

Returns true if the header of the column should be sortable

Returns:

true if header should be sortable