/*
* 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.extensions.markup.html.repeater.data.table.AbstractToolbar;
import org.apache.wicket.extensions.markup.html.repeater.data.table.DataTable;
import org.apache.wicket.extensions.markup.html.repeater.data.table.IColumn;
import org.apache.wicket.markup.html.WebMarkupContainer;
import org.apache.wicket.markup.repeater.RepeatingView;
/**
* Toolbar that creates a form to hold form components used to filter data in
* the data table. Form components are provided by columns that implement
* IFilteredColumn.
*
* @author Igor Vaynberg (ivaynber)
*
*/
public class FilterToolbar extends AbstractToolbar
{
private static final long serialVersionUID = 1L;
private static final String FILTER_COMPONENT_ID = "filter";
/**
* Constructor
*
* @param table
* data table this toolbar will be added to
* @param stateLocator
* locator responsible for finding object used to store filter's
* state
*/
public FilterToolbar(final DataTable table, final FilterForm form, final IFilterStateLocator stateLocator)
{
super(table);
if (table == null)
{
throw new IllegalArgumentException("argument [table] cannot be null");
}
if (stateLocator == null)
{
throw new IllegalArgumentException("argument [stateLocator] cannot be null");
}
// populate the toolbar with components provided by filtered columns
RepeatingView filters = new RepeatingView("filters");
filters.setRenderBodyOnly(true);
add(filters);
IColumn[] cols = table.getColumns();
for (int i = 0; i < cols.length; i++)
{
WebMarkupContainer item = new WebMarkupContainer(filters.newChildId());
item.setRenderBodyOnly(true);
IColumn col = cols[i];
Component filter = null;
if (col instanceof IFilteredColumn)
{
IFilteredColumn filteredCol = (IFilteredColumn)col;
filter = filteredCol.getFilter(FILTER_COMPONENT_ID, form);
}
if (filter == null)
{
filter = new NoFilter(FILTER_COMPONENT_ID);
}
else
{
if (!filter.getId().equals(FILTER_COMPONENT_ID))
{
throw new IllegalStateException(
"filter component returned with an invalid component id. invalid component id ["
+ filter.getId() + "] required component id ["
+ FILTER_COMPONENT_ID + "] generating column ["
+ col.toString() + "] ");
}
}
item.add(filter);
filters.add(item);
}
}
protected void onBeforeRender()
{
if (findParent(FilterForm.class)==null)
{
throw new IllegalStateException("FilterToolbar must be contained within a Form");
}
super.onBeforeRender();
}
}