1 /*
2 * Copyright (c) 2002-2022, City of 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 * Class to manage filter panel
45 */
46 public class FilterPanel implements Serializable
47 {
48 public static final String PARAM_FILTER_PANEL_PREFIX = "filter_panel_";
49 public static final String PARAM_UPDATE_FILTERS = "updateFilters";
50 public static final String PARAM_RESET_FILTERS = "resetFilters";
51 private static final long serialVersionUID = 761740458592056772L;
52 private String _strFormUrl;
53 private ArrayList<DataTableFilter> _listFilter = new ArrayList<>( );
54
55 /**
56 * Instantiates a new filter panel.
57 */
58 protected FilterPanel( )
59 {
60 }
61
62 /**
63 * Creates a new FilterPanel.
64 *
65 * @param strFormUrl
66 * The url to validate the form of filters
67 */
68 public FilterPanel( String strFormUrl )
69 {
70 _strFormUrl = strFormUrl;
71 }
72
73 /**
74 * Add a filter to this filter panel
75 *
76 * @param filterType
77 * data type of the filter. For drop down list, use {@link FilterPanel#addDropDownListFilter(String, String, ReferenceList)
78 * addDropDownListFilter} instead
79 * @param strParameterName
80 * Name of the parameter of the object to filter.<br>
81 * For example, if this filter should be applied on the parameter "title" of a class named "Data", then the value of the parameter
82 * <i>strParameterName</i> should be "title".
83 * @param strFilterLabel
84 * Label describing the filter
85 */
86 public void addFilter( DataTableFilterType filterType, String strParameterName, String strFilterLabel )
87 {
88 _listFilter.add( new DataTableFilter( filterType, strParameterName, strFilterLabel ) );
89 }
90
91 /**
92 * Add a drop down list filter.
93 *
94 * @param strParameterName
95 * Name of the parameter of the object to filter.<br>
96 * For example, if this filter should be applied on the parameter "title" of a class named "Data", then the value of the parameter
97 * <i>strParameterName</i> should be "title".
98 * @param strFilterLabel
99 * Label describing the filter
100 * @param refList
101 * Reference list containing data of the drop down list
102 */
103 public void addDropDownListFilter( String strParameterName, String strFilterLabel, ReferenceList refList )
104 {
105 DataTableFilteraTableFilter.html#DataTableFilter">DataTableFilter filter = new DataTableFilter( DataTableFilterType.DROPDOWNLIST, strParameterName, strFilterLabel );
106 filter.setRefList( refList );
107 _listFilter.add( filter );
108 }
109
110 /**
111 * Get the url of the action of the form
112 *
113 * @return The url of the action of the form
114 */
115 public String getFormUrl( )
116 {
117 return _strFormUrl;
118 }
119
120 /**
121 * Set the url of the action of the form
122 *
123 * @param strFormUrl
124 * The url of the action of the form
125 */
126 public void setFormUrl( String strFormUrl )
127 {
128 _strFormUrl = strFormUrl;
129 }
130
131 /**
132 * Get the list of filters of the FilterPanel
133 *
134 * @return The list of filters of the FilterPanel
135 */
136 public List<DataTableFilter> getListFilter( )
137 {
138 return _listFilter;
139 }
140 }