001/*
002 * Licensed to the Apache Software Foundation (ASF) under one or more
003 * contributor license agreements.  See the NOTICE file distributed with
004 * this work for additional information regarding copyright ownership.
005 * The ASF licenses this file to You under the Apache License, Version 2.0
006 * (the "License"); you may not use this file except in compliance with
007 * the License.  You may obtain a copy of the License at
008 *
009 *      http://www.apache.org/licenses/LICENSE-2.0
010 *
011 * Unless required by applicable law or agreed to in writing, software
012 * distributed under the License is distributed on an "AS IS" BASIS,
013 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
014 * See the License for the specific language governing permissions and
015 * limitations under the License.
016 */
017package org.apache.wicket.extensions.markup.html.repeater.data.table.filter;
018
019import org.apache.wicket.markup.html.form.TextField;
020import org.apache.wicket.model.IModel;
021
022/**
023 * Filter that can be represented by a text field
024 * 
025 * @author Igor Vaynberg (ivaynberg)
026 * @param <T>
027 *            The {@link TextField}'s model object
028 * 
029 */
030public class TextFilter<T> extends AbstractFilter
031{
032        private static final long serialVersionUID = 1L;
033
034        private final TextField<T> filter;
035
036        /**
037         * Constructor
038         * 
039         * @param id
040         *            component id
041         * @param model
042         *            model for the underlying form component
043         * @param form
044         *            filter form this filter will be added to
045         */
046        public TextFilter(final String id, final IModel<T> model, final FilterForm<?> form)
047        {
048                super(id, form);
049                filter = new TextField<>("filter", model);
050                enableFocusTracking(filter);
051                add(filter);
052        }
053
054        /**
055         * @return underlying {@link TextField} form component that represents this filter
056         */
057        public final TextField<T> getFilter()
058        {
059                return filter;
060        }
061}