wicket.extensions.markup.html.repeater.data.table.filter
Interface IFilteredColumn

All Superinterfaces:

ICellPopulator, IColumn, java.io.Serializable

All Known Implementing Classes:

ChoiceFilteredPropertyColumn, FilteredAbstractColumn, FilteredPropertyColumn, TextFilteredPropertyColumn

public interface IFilteredColumn
extends IColumn

Represents a data table column that can be filtered. The filter is represented by a component returned from the getFilter() method.

Author:

Igor Vaynberg (ivaynberg)

See Also:

IColumn

Method Summary

wicket.Component

getFilter(java.lang.String componentId, FilterForm form) Returns the component used by user to filter the column.

Methods inherited from interface wicket.extensions.markup.html.repeater.data.table.IColumn

getHeader, getSortProperty, isSortable

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

populateItem

Method Detail

getFilter

wicket.Component getFilter(java.lang.String componentId,
                           FilterForm form)

Returns the component used by user to filter the column. If null is returned, no filter will be added.

Parameters:

componentId - component id for returned filter component

form - FilterForm object for the toolbar. components can use this form's model to access properties of the state object (PropertyModel(form.getModel(), "property") or retrieve the IFilterStateLocator object by using FilterForm.getStateLocator()

Returns:

component that will be used to represent a filter for this column, or null if no such component is desired