org.apache.wicket.extensions.markup.html.repeater.data.table
Interface IColumn<T,S>

Type Parameters:
T -
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,D>, 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
 Component getHeader(String componentId)
          Returns the component that will be used as the header for the column.
 S getSortProperty()
          Returns the name of the property that this header sorts.
 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 name of the property that this header sorts. If null is returned the header will be unsortable.

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


Copyright © 2006-2013 Apache Software Foundation. All Rights Reserved.