wicket.extensions.markup.html.repeater.data.table.filter
Class ChoiceFilteredPropertyColumn

java.lang.Object
  wicket.extensions.markup.html.repeater.data.table.AbstractColumn
      wicket.extensions.markup.html.repeater.data.table.PropertyColumn
          wicket.extensions.markup.html.repeater.data.table.filter.FilteredPropertyColumn
              wicket.extensions.markup.html.repeater.data.table.filter.ChoiceFilteredPropertyColumn

All Implemented Interfaces:

ICellPopulator, IColumn, IFilteredColumn, java.io.Serializable

public class ChoiceFilteredPropertyColumn

extends FilteredPropertyColumn

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

ChoiceFilteredPropertyColumn(wicket.model.IModel displayModel, java.lang.String propertyExpression, wicket.model.IModel filterChoices)

ChoiceFilteredPropertyColumn(wicket.model.IModel displayModel, java.lang.String sortProperty, java.lang.String propertyExpression, wicket.model.IModel filterChoices)

Method Summary

protected boolean	enableAutoSubmit() Returns true if the constructed choice filter should autosubmit the form when its value is changed.
protected wicket.markup.html.form.IChoiceRenderer	getChoiceRenderer() Returns choice renderer that will be used to create the choice filter
wicket.Component	getFilter(java.lang.String componentId, FilterForm form) Returns the component used by user to filter the column.
protected wicket.model.IModel	getFilterModel(FilterForm form) Returns the model that will be passed on to the text filter.

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

createLabelModel, getPropertyExpression, populateItem

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

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 wicket.extensions.markup.html.repeater.data.table.IColumn

getHeader, getSortProperty, isSortable

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

populateItem

Constructor Detail

ChoiceFilteredPropertyColumn

public ChoiceFilteredPropertyColumn(wicket.model.IModel displayModel,
                                    java.lang.String sortProperty,
                                    java.lang.String propertyExpression,
                                    wicket.model.IModel filterChoices)

Parameters:

displayModel -

sortProperty -

propertyExpression -

filterChoices - collection choices used in the choice filter

ChoiceFilteredPropertyColumn

public ChoiceFilteredPropertyColumn(wicket.model.IModel displayModel,
                                    java.lang.String propertyExpression,
                                    wicket.model.IModel filterChoices)

Parameters:

displayModel -

propertyExpression -

filterChoices - collection of choices used in the choice filter

Method Detail

getFilter

public wicket.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, wicket.extensions.markup.html.repeater.data.table.filter.FilterForm)

getFilterModel

protected wicket.model.IModel 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

enableAutoSubmit

protected boolean enableAutoSubmit()

Returns true if the constructed choice filter should autosubmit the form when its value is changed.

Returns:

true to make choice filter autosubmit, false otherwise

getChoiceRenderer

protected wicket.markup.html.form.IChoiceRenderer getChoiceRenderer()

Returns choice renderer that will be used to create the choice filter

Returns:

choice renderer that will be used to create the choice filter