org.apache.wicket.extensions.markup.html.repeater.data.table.filter
Class TextFilteredPropertyColumn<T,F>

java.lang.Object
  org.apache.wicket.extensions.markup.html.repeater.data.table.AbstractColumn<T>
      org.apache.wicket.extensions.markup.html.repeater.data.table.PropertyColumn<T>
          org.apache.wicket.extensions.markup.html.repeater.data.table.filter.FilteredPropertyColumn<T>
              org.apache.wicket.extensions.markup.html.repeater.data.table.filter.TextFilteredPropertyColumn<T,F>

Type Parameters:

T - The column's model object type

F - Filter's model object type

All Implemented Interfaces:

java.io.Serializable, ICellPopulator<T>, IFilteredColumn<T>, IColumn<T>, IStyledColumn<T>, IClusterable, IDetachable

public class TextFilteredPropertyColumn<T,F>
extends FilteredPropertyColumn<T>

A filtered property column that creates a textfield filter component. The default model of the created textfield is a property model with the same property expression as the one used to display data. This works well when the filter state object is of the same type as the objects in the data table.

Author:

Igor Vaynberg (ivaynberg)

See Also:

Serialized Form

Constructor Summary

TextFilteredPropertyColumn(IModel<java.lang.String> displayModel, java.lang.String propertyExpression)

TextFilteredPropertyColumn(IModel<java.lang.String> displayModel, java.lang.String sortProperty, java.lang.String propertyExpression)

Method Summary

Component	getFilter(java.lang.String componentId, FilterForm<?> form) Returns the component used by user to filter the column.
protected IModel<F>	getFilterModel(FilterForm<?> form) Returns the model that will be passed on to the text filter.

Methods inherited from class org.apache.wicket.extensions.markup.html.repeater.data.table.PropertyColumn

createLabelModel, getPropertyExpression, populateItem

Methods inherited from class org.apache.wicket.extensions.markup.html.repeater.data.table.AbstractColumn

detach, getCssClass, getDisplayModel, getHeader, getSortProperty, isSortable

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.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

Constructor Detail

TextFilteredPropertyColumn

public TextFilteredPropertyColumn(IModel<java.lang.String> displayModel,
                                  java.lang.String sortProperty,
                                  java.lang.String propertyExpression)

Parameters:

displayModel -

sortProperty -

propertyExpression -

TextFilteredPropertyColumn

public TextFilteredPropertyColumn(IModel<java.lang.String> displayModel,
                                  java.lang.String propertyExpression)

Parameters:

displayModel -

propertyExpression -

Method Detail

getFilter

public Component getFilter(java.lang.String componentId,
                           FilterForm<?> form)

Description copied from interface: IFilteredColumn

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

See Also:

IFilteredColumn.getFilter(java.lang.String, org.apache.wicket.extensions.markup.html.repeater.data.table.filter.FilterForm)

getFilterModel

protected IModel<F> getFilterModel(FilterForm<?> form)

Returns the model that will be passed on to the text filter. Users can override this method to change the model.

Parameters:

form - filter form

Returns:

model passed on to the text filter