/*
* Licensed to the Apache Software Foundation (ASF) under one or more
* contributor license agreements. See the NOTICE file distributed with
* this work for additional information regarding copyright ownership.
* The ASF licenses this file to You under the Apache License, Version 2.0
* (the "License"); you may not use this file except in compliance with
* the License. You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package org.apache.wicket.extensions.markup.html.repeater.data.table.filter;
import org.apache.wicket.Component;
import org.apache.wicket.markup.html.form.IChoiceRenderer;
import org.apache.wicket.model.IModel;
import org.apache.wicket.model.PropertyModel;
/**
* 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)
*
*/
public class ChoiceFilteredPropertyColumn extends FilteredPropertyColumn
{
private static final long serialVersionUID = 1L;
private IModel filterChoices;
/**
* @param displayModel
* @param sortProperty
* @param propertyExpression
* @param filterChoices
* collection choices used in the choice filter
*/
public ChoiceFilteredPropertyColumn(IModel displayModel, String sortProperty,
String propertyExpression, IModel filterChoices)
{
super(displayModel, sortProperty, propertyExpression);
this.filterChoices = filterChoices;
}
/**
* @param displayModel
* @param propertyExpression
* @param filterChoices
* collection of choices used in the choice filter
*/
public ChoiceFilteredPropertyColumn(IModel displayModel, String propertyExpression,
IModel filterChoices)
{
super(displayModel, propertyExpression);
this.filterChoices = filterChoices;
}
/**
* @see org.apache.wicket.model.IDetachable#detach()
*/
public void detach()
{
super.detach();
if (filterChoices != null)
{
filterChoices.detach();
}
}
/**
* @see org.apache.wicket.extensions.markup.html.repeater.data.table.filter.IFilteredColumn#getFilter(java.lang.String,
* org.apache.wicket.extensions.markup.html.repeater.data.table.filter.FilterForm)
*/
public Component getFilter(String componentId, FilterForm form)
{
ChoiceFilter filter = new ChoiceFilter(componentId, getFilterModel(form), form,
filterChoices, enableAutoSubmit());
IChoiceRenderer renderer = getChoiceRenderer();
if (renderer != null)
{
filter.getChoice().setChoiceRenderer(renderer);
}
return filter;
}
/**
* Returns the model that will be passed on to the text filter. Users can
* override this method to change the model.
*
* @param form
* filter form
* @return model passed on to the text filter
*/
protected IModel getFilterModel(FilterForm form)
{
return new PropertyModel(form.getModel(), getPropertyExpression());
}
/**
* Returns true if the constructed choice filter should autosubmit the form
* when its value is changed.
*
* @return true to make choice filter autosubmit, false otherwise
*/
protected boolean enableAutoSubmit()
{
return true;
}
/**
* Returns choice renderer that will be used to create the choice filter
*
* @return choice renderer that will be used to create the choice filter
*/
protected IChoiceRenderer getChoiceRenderer()
{
return null;
}
}