1 /*
2 * Copyright (c) 2002-2014, Mairie de Paris
3 * All rights reserved.
4 *
5 * Redistribution and use in source and binary forms, with or without
6 * modification, are permitted provided that the following conditions
7 * are met:
8 *
9 * 1. Redistributions of source code must retain the above copyright notice
10 * and the following disclaimer.
11 *
12 * 2. Redistributions in binary form must reproduce the above copyright notice
13 * and the following disclaimer in the documentation and/or other materials
14 * provided with the distribution.
15 *
16 * 3. Neither the name of 'Mairie de Paris' nor 'Lutece' nor the names of its
17 * contributors may be used to endorse or promote products derived from
18 * this software without specific prior written permission.
19 *
20 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
21 * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
22 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
23 * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDERS OR CONTRIBUTORS BE
24 * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
25 * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
26 * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
27 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
28 * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
29 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
30 * POSSIBILITY OF SUCH DAMAGE.
31 *
32 * License 1.0
33 */
34 package fr.paris.lutece.util.datatable;
35
36 import fr.paris.lutece.util.ReferenceList;
37
38 import java.io.Serializable;
39
40 import java.util.ArrayList;
41 import java.util.List;
42
43
44 /**
45 * Class to manage filter panel
46 */
47 public class FilterPanel implements Serializable
48 {
49 public static final String PARAM_FILTER_PANEL_PREFIX = "filter_panel_";
50 public static final String PARAM_UPDATE_FILTERS = "updateFilters";
51 public static final String PARAM_RESET_FILTERS = "resetFilters";
52 private static final long serialVersionUID = 761740458592056772L;
53 private String _strFormUrl;
54 private ArrayList<DataTableFilter> _listFilter = new ArrayList<DataTableFilter>( );
55
56 /**
57 * Instantiates a new filter panel.
58 */
59 protected FilterPanel( )
60 {
61 }
62
63 /**
64 * Creates a new FilterPanel.
65 * @param strFormUrl The url to validate the form of filters
66 */
67 public FilterPanel( String strFormUrl )
68 {
69 _strFormUrl = strFormUrl;
70 }
71
72 /**
73 * Add a filter to this filter panel
74 * @param filterType data type of the filter. For drop down list, use {@link FilterPanel#addDropDownListFilter(String, String, ReferenceList) addDropDownListFilter} instead
75 * @param strParameterName Name of the parameter of the object to filter.<br/>
76 * For example, if this filter should be applied on the parameter "title" of a class named "Data", then the value of the parameter <i>strParameterName</i> should be "title".
77 * @param strFilterLabel Label describing the filter
78 */
79 public void addFilter( DataTableFilterType filterType, String strParameterName, String strFilterLabel )
80 {
81 _listFilter.add( new DataTableFilter( filterType, strParameterName, strFilterLabel ) );
82 }
83
84 /**
85 * Add a drop down list filter.
86 * @param strParameterName Name of the parameter of the object to filter.<br/>
87 * For example, if this filter should be applied on the parameter "title" of a class named "Data", then the value of the parameter <i>strParameterName</i> should be "title".
88 * @param strFilterLabel Label describing the filter
89 * @param refList Reference list containing data of the drop down list
90 */
91 public void addDropDownListFilter( String strParameterName, String strFilterLabel, ReferenceList refList )
92 {
93 DataTableFilter filter = new DataTableFilter( DataTableFilterType.DROPDOWNLIST, strParameterName, strFilterLabel );
94 filter.setRefList( refList );
95 _listFilter.add( filter );
96 }
97
98 /**
99 * Get the url of the action of the form
100 * @return The url of the action of the form
101 */
102 public String getFormUrl( )
103 {
104 return _strFormUrl;
105 }
106
107 /**
108 * Set the url of the action of the form
109 * @param strFormUrl The url of the action of the form
110 */
111 public void setFormUrl( String strFormUrl )
112 {
113 _strFormUrl = strFormUrl;
114 }
115
116 /**
117 * Get the list of filters of the FilterPanel
118 * @return The list of filters of the FilterPanel
119 */
120 public List<DataTableFilter> getListFilter( )
121 {
122 return _listFilter;
123 }
124 }