(Quick Reference)

1 Introduction

FilterPane Plugin

Help Grails be an active, open community! If you use this plugin and haven't rated it, please do so. If you've rated this plugin anything but 5 stars, please let me know why (See for how). I'm striving to make this plugin the best that it can be, and constructive feedback is always appreciated.

Build Status

View Build Status

1.1 Current Version Changes

Version 2.2.5 Release Notes

• Filter by subclass attributes
• Filter by class

1.2 Change Log

Change Log

Date	Version	Notes	Grails Versions	Template Changes
2014-05-12	2.4.3	Migrating to grails 2.3.8 support	1.3.x	No
2014-03-12	2.3.3	Merging fix for exception thrown in IllegalArgumentException, JIRA 118	1.3.x	No
2013-12-23	2.3.2	Merging fix for filtering by class attribute and adding swedish i18 updates	1.3.x	No
2013-12-02	2.3.1	Resolving issue with grails 2.3.3 and sorting and adding spanizh i18	1.3.x	No
2013-10-30	2.2.6	Fixing another issue for filters starting with 'op'	1.3.x	No
2013-10-30	2.2.5	Add support for filtering by subclass properties. Allow filter by associated properties (last persistent property can be in subclass) as well as direct persistent properties of subclasses. Support filtering by a class attribute when filtered domain class has its implementers (sub classes).	1.3.x	No
2013-07-02	2.2.4	Fix for http://jira.grails.org/browse/GPFILTERPANE-113	1.3.x +	No
2013-07-02	2.1.9	Template refactor. Rename dir to _filterpane and do not install locally. Ability to override as needed like Fields plugin. Added support for InList and NotInList for enum types.	1.3.x +	Yes
2013-06-18	2.1.8	Adding support for Joda time.	1.3.x +	Yes
2013-05-22	2.1.7	Adding ability to define post or get filter form. Adding french messaging support	1.3.x +	Yes
2013-05-02	2.1.6	Added fix GPFILTERPANE-109, moved to use resources plugin include deprecated filterpane:include tag and updated docs	1.3.x +	Yes
2013-04-25	2.1.5	Added fix GPFILTERPANE-108 and cleaned up utils for finding classes without package	1.3.x +	Yes
2013-04-16	2.1.4	Removed grails 2.x requirements and moved to 1.3.x. Shored up nested queries and added tests and examples to example project.	1.3.x +	Yes
2013-04-12	2.1	Fixed 2.2.x compiler error. Added install script to copy templates locally for customization.	2.1.x	Yes
2013-03-19	2.0	Complete rewrite of the plugin See JIRA notes for changes.	2.0	No
2010-07-26	0.7	Bug fixes.	1.1.1 +	Unknown
2010-03-24	0.6.8	Bug fix for boolean 'false' value not working	1.1.1 +	Unknown
2010-03-23	0.6.7	Some bug fixes and improvements to Grails-1.2.1 compatibility	1.1.1 +	Unknown
2010-02-17	0.6.6	Should now work with Grails-1.2.1 and 1.1.1	1.1.1 +	Unknown
2010-02-03	0.6.5	Fixed several issues. See	1.1.1 +	Unknown
2009-11-17	0.6.4	Added customForm attribute to filterPane tag. See docs for details in the reference section below.	1.1.1	Unknown
2009-10-27	0.6.3	Fixed	1.1.1	Unknown
2009-09-13	0.6.2	Child collection filtering fixed (GRAILSPLUGINS-1503). Filter service reworked to use Grails API instead of Groovy meta classes. Several integration tests added.	1.1.1	Unknown
2009-07-28	0.6.1	Fixed a minor issue when rendering dropdowns for enums in associated properties.	1.1.1	Unknown
2009-07-27	0.6	Completed several JIRA issues. See for details.	1.1	Unknown
2009-04-07	0.5	Fixed JIRA issues 836, 988, and 1045. Form action is now POST. Entering in a filter value will now auto-select the first operator in its associated dropdown if none is selected (except for date properties). More info on issues at	1.1	Unknown
2009-03-22	0.4.3	JIRA GRAILSPLUGINS-985 fixed.	1.1	Unknown
2009-03-22	0.4.2	Now compatible with Grails 1.1. See JIRA GRAILSPLUGINS-999	1.0.4, 1.1	Unknown
2009-03-22	0.4.1	Completed JIRAs GRAILSPLUGINS-822 and GRAILSPLUGINS-903	1.0.4	Unknown
2009-01-27	0.3.1	Moved debug output to log.debug statements.	1.0.4	Unknown
2009-01-26	0.3	Fixed packaging glitches. Updated example app.	1.0.4	Unknown
2009-01-25	0.2	No major changes. Mainly code cleanup. Classes are now in packages, as per plugin specs.	1.0.4	Unknown
2009-01-16	0.1	First release.	1.0.4	Unknown

Upgrading to 2.0.

Version 2.0 is a complete rewrite / refactoring of the plugin to make better use of modern Grails practices (and a better working knowledge of Grails). All tags are now rendered via templates instead of string builders in code. This should make the plugin more extensible in the future. Many bugs and feature enhancements were also completed for the release.

Release Notes - Grails Plugins - Version Grails-FilterPane 2.0

Bug

• GRAILSPLUGINS-1256 - plugin overrides default order of domain objects
• GRAILSPLUGINS-1717 - Filterpane "java.lang.ClassCastException: java.lang.String" with Long and Integer properties
• GRAILSPLUGINS-2446 - i18n missing for sortable criteria combobox
• GRAILSPLUGINS-2447 - Missing input field for associated properties if between criteria is selected
• GRAILSPLUGINS-2483 - Missing input field for type Currency
• GRAILSPLUGINS-2807 - GSP-tag filterpane:includes generates wrong path for java-script files.
• GRAILSPLUGINS-2808 - Associated properties not displayed correctly in currentCriteria tag
• GRAILSPLUGINS-2813 - The currentCriteria tag looses the sort and order params when using remove link

Improvement

• GRAILSPLUGINS-1476 - Support filtering of collections
• GRAILSPLUGINS-1979 - Specify fetchMode In FilterPane
• GRAILSPLUGINS-2448 - German properties
• GRAILSPLUGINS-2802 - Swedish messages
• GRAILSPLUGINS-2809 - Make it possible to filter on "id" property

New Feature

• GRAILSPLUGINS-1909 - Support for deeper assocations

There are several breaking changes when migrating to 2.0. Please take note!

• Package names for all classes have changed to a more standard one: org.grails.plugin.filterpane
• Class Renames
1. FilterService has been renamed to FilterPaneService to match the plugin name and to remove ambiguity with other plugins / services
2. FilterUtils has been renamed to FilterPaneUtils for the same reasons as above.
• Tag Library Changes
1. filePaneIncludes tag has been removed. It has been deprecated for some time. Use includes tag instead.

1. filterButton no longer uses an ID attribute, as it was unclear what it was for. It has been renamed to filterPaneId, to denote the id of the filterpane you wish to display.
2. filterPane tag domainBean attribute is now just "domain"
3. A couple years of practical use has shown that most users are NOT using the filter form as a dialog. As such, a new required attribute to the filterPane tag has been added: dialog. It defaults to false, so if you want to maintain the use of the form as a popup dialog, you must add this attribute and set it to true.

This plugin adds filtering capabilities to any Grails application. The primary goals of this plugin include:

• Easy integration with Grails list pages via custom tags
• Smart operator display. Only practical filter operations are available for a property's data type. (e.g. no "like" operators for numeric properties)
• Support for major operators including =, <>, >, <, >=, <=, like, ilike, between, is null, and is not null.
• Smart filter value entry. Date properties display a date picker, boolean's display radio buttons, etc.
• Support for a custom list of values, such as a filtering a text property with a constrained list of values.
• Works with Grails list sorting out of the box with only minor modification to your list gsp.
• Works with Grails pagination out of the box with only minor modification to your list gsp.
• Honors domain constraints: nullable, blank, inList ( Since 0.4 )

Please note that you may experience duplicate rows if you use eager fetching. See GRAILSPLUGINS-2063 for more information.

null