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

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.ChoiceFilteredPropertyColumn<T,Y>

Type Parameters:

T - The model object type

Y - The column model object type

All Implemented Interfaces:

Serializable, ICellPopulator<T>, IFilteredColumn<T>, IColumn<T>, IStyledColumn<T>, IClusterable, IDetachable

public class ChoiceFilteredPropertyColumn<T,Y>
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

ChoiceFilteredPropertyColumn(IModel<String> displayModel, String propertyExpression, IModel<List<? extends Y>> filterChoices)

ChoiceFilteredPropertyColumn(IModel<String> displayModel, String sortProperty, String propertyExpression, IModel<List<? extends Y>> filterChoices)

Method Summary

void	detach() Detaches model after use.
protected boolean	enableAutoSubmit() Returns true if the constructed choice filter should autosubmit the form when its value is changed.
protected IChoiceRenderer<Y>	getChoiceRenderer() Returns choice renderer that will be used to create the choice filter
Component	getFilter(String componentId, FilterForm<?> form) Returns the component used by user to filter the column.
protected IModel<List<? extends Y>>	getFilterChoices()
protected IModel<Y>	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

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

Constructor Detail

ChoiceFilteredPropertyColumn

public ChoiceFilteredPropertyColumn(IModel<String> displayModel,
                                    String sortProperty,
                                    String propertyExpression,
                                    IModel<List<? extends Y>> filterChoices)

Parameters:

displayModel -

sortProperty -

propertyExpression -

filterChoices - collection choices used in the choice filter

ChoiceFilteredPropertyColumn

public ChoiceFilteredPropertyColumn(IModel<String> displayModel,
                                    String propertyExpression,
                                    IModel<List<? extends Y>> filterChoices)

Parameters:

displayModel -

propertyExpression -

filterChoices - collection of choices used in the choice filter

Method Detail

detach

public void detach()

Description copied from interface: IDetachable

Detaches model after use. This is generally used to null out transient references that can be re-attached later.

Specified by:

detach in interface IDetachable

Overrides:

detach in class AbstractColumn<T>

See Also:

IDetachable.detach()

getFilter

public Component getFilter(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<Y> 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 IChoiceRenderer<Y> 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

getFilterChoices

protected final IModel<List<? extends Y>> getFilterChoices()

Returns:

filter choices model