fr.paris.lutece.util.datatable
Class FilterPanel

java.lang.Object
  extended by fr.paris.lutece.util.datatable.FilterPanel

public class FilterPanel
extends Object

Class to manage filter panel


Field Summary
static String PARAM_FILTER_PANEL_PREFIX
           
static String PARAM_RESET_FILTERS
           
static String PARAM_UPDATE_FILTERS
           
 
Constructor Summary
protected FilterPanel()
          Instantiates a new filter panel.
  FilterPanel(String strFormUrl)
          Creates a new FilterPanel.
 
Method Summary
 void addDropDownListFilter(String strParameterName, String strFilterLabel, ReferenceList refList)
          Add a drop down list filter.
 void addFilter(DataTableFilterType filterType, String strParameterName, String strFilterLabel)
          Add a filter to this filter panel
 String getFormUrl()
          Get the url of the action of the form
 List<DataTableFilter> getListFilter()
          Get the list of filters of the FilterPanel
 void setFormUrl(String strFormUrl)
          Set the url of the action of the form
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

PARAM_FILTER_PANEL_PREFIX

public static final String PARAM_FILTER_PANEL_PREFIX
See Also:
Constant Field Values

PARAM_UPDATE_FILTERS

public static final String PARAM_UPDATE_FILTERS
See Also:
Constant Field Values

PARAM_RESET_FILTERS

public static final String PARAM_RESET_FILTERS
See Also:
Constant Field Values
Constructor Detail

FilterPanel

protected FilterPanel()
Instantiates a new filter panel.


FilterPanel

public FilterPanel(String strFormUrl)
Creates a new FilterPanel.

Parameters:
strFormUrl - The url to validate the form of filters
Method Detail

addFilter

public void addFilter(DataTableFilterType filterType,
                      String strParameterName,
                      String strFilterLabel)
Add a filter to this filter panel

Parameters:
filterType - data type of the filter. For drop down list, use addDropDownListFilter instead
strParameterName - Name of the parameter of the object to filter.
For example, if this filter should be applied on the parameter "title" of a class named "Data", then the value of the parameter strParameterName should be "title".
strFilterLabel - Label describing the filter

addDropDownListFilter

public void addDropDownListFilter(String strParameterName,
                                  String strFilterLabel,
                                  ReferenceList refList)
Add a drop down list filter.

Parameters:
strParameterName - Name of the parameter of the object to filter.
For example, if this filter should be applied on the parameter "title" of a class named "Data", then the value of the parameter strParameterName should be "title".
strFilterLabel - Label describing the filter
refList - Reference list containing data of the drop down list

getFormUrl

public String getFormUrl()
Get the url of the action of the form

Returns:
The url of the action of the form

setFormUrl

public void setFormUrl(String strFormUrl)
Set the url of the action of the form

Parameters:
strFormUrl - The url of the action of the form

getListFilter

public List<DataTableFilter> getListFilter()
Get the list of filters of the FilterPanel

Returns:
The list of filters of the FilterPanel


Copyright © 2014 Mairie de Paris. All Rights Reserved.