org.apache.wicket.extensions.markup.html.repeater.data.table.filter
Interface IFilteredColumn<T>

Type Parameters:
T -
All Superinterfaces:
ICellPopulator<T>, IClusterable, IColumn<T>, IDetachable, Serializable
All Known Implementing Classes:
ChoiceFilteredPropertyColumn, FilteredAbstractColumn, FilteredPropertyColumn, TextFilteredPropertyColumn

public interface IFilteredColumn<T>
extends IColumn<T>

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
 Component getFilter(String componentId, FilterForm<?> form)
          Returns the component used by user to filter the column.
 
Methods inherited from interface org.apache.wicket.extensions.markup.html.repeater.data.table.IColumn
getHeader, getSortProperty, isSortable
 
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

getFilter

Component getFilter(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


Copyright © 2004-2011 Apache Software Foundation. All Rights Reserved.