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

Class AbstractColumn<T,S>

java.lang.Object

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

Type Parameters:

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

S - the type of the sort property

All Implemented Interfaces:

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

Direct Known Subclasses:

AbstractExportableColumn, AbstractTreeColumn, FilteredAbstractColumn, HeaderlessColumn, PropertyColumn

public abstract class AbstractColumn<T,S>
extends Object
implements IStyledColumn<T,S>

A helper implementation for the IColumn interface

Author:

Igor Vaynberg ( ivaynberg )

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
AbstractColumn(IModel<String> displayModel)
AbstractColumn(IModel<String> displayModel, S sortProperty)

Method Summary

Methods

Modifier and Type	Method and Description
void	detach()
String	getCssClass() Returns the css class for this column.
IModel<String>	getDisplayModel()
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 class java.lang.Object

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

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

populateItem

Constructor Detail

AbstractColumn

public AbstractColumn(IModel<String> displayModel,
              S sortProperty)

Parameters:

displayModel - model used to generate header text

sortProperty - sort property this column represents

AbstractColumn

public AbstractColumn(IModel<String> displayModel)

Parameters:

displayModel - model used to generate header text

Method Detail

getDisplayModel

public IModel<String> getDisplayModel()

Returns:

returns display model to be used for the header component

getSortProperty

public S getSortProperty()

Description copied from interface: IColumn

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

Specified by:

getSortProperty in interface IColumn<T,S>

Returns:

the sort property

See Also:

IColumn.getSortProperty()

isSortable

public boolean isSortable()

Description copied from interface: IColumn

Returns true if the header of the column should be sortable

Specified by:

isSortable in interface IColumn<T,S>

Returns:

true if header should be sortable

See Also:

IColumn.isSortable()

getHeader

public Component getHeader(String componentId)

Description copied from interface: IColumn

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

Specified by:

getHeader in interface IColumn<T,S>

Parameters:

componentId - component id for the returned Component

Returns:

component that will be used as the header for the column

See Also:

IColumn.getHeader(java.lang.String)

detach

public void detach()

Specified by:

detach in interface IDetachable

See Also:

IDetachable.detach()

getCssClass

public String getCssClass()

Description copied from interface: IStyledColumn

Returns the css class for this column.

Specified by:

getCssClass in interface IStyledColumn<T,S>

Returns:

CSS class name