Package com.jidesoft.grouper
Class GrouperContext
java.lang.Object
com.jidesoft.converter.AbstractContext
com.jidesoft.grouper.GrouperContext
- All Implemented Interfaces:
Serializable
The context object used by ObjectGrouper. For the same type, we may need different way to group them. This context is
used so that user can register different groupers for the same type.
- See Also:
-
Field Summary
FieldsModifier and TypeFieldDescriptionstatic GrouperContext
Default converter context with empty name and no user object. -
Constructor Summary
ConstructorsConstructorDescriptionGrouperContext
(String name) Creates a converter context with a name.GrouperContext
(String name, Object object) Creates a converter context with a name and an object. -
Method Summary
Modifier and TypeMethodDescriptionboolean
Checks if the grouper will be used on the auto-filter drop down list.boolean
Checks if the grouper will be used on the custom filter editor.void
setUseOnAutoFilter
(boolean useOnAutoFilter) Sets the flag to tell the auto-filter drop down list to use the grouper or not.void
setUseOnCustomFilter
(boolean useOnCustomFilter) Sets the flag to tell the custom filter editor to use the grouper or not.Methods inherited from class com.jidesoft.converter.AbstractContext
equals, getName, getUserObject, hashCode, setName, setUserObject, toString
-
Field Details
-
DEFAULT_CONTEXT
Default converter context with empty name and no user object.
-
-
Constructor Details
-
GrouperContext
Creates a converter context with a name.- Parameters:
name
- the name of the grouper context.
-
GrouperContext
Creates a converter context with a name and an object.- Parameters:
name
- the name of the grouper context.object
- the user object. It can be used as any object to pass information along.
-
-
Method Details
-
isUseOnAutoFilter
public boolean isUseOnAutoFilter()Checks if the grouper will be used on the auto-filter drop down list.- Returns:
- true or false.
- Since:
- 3.5.14
-
setUseOnAutoFilter
public void setUseOnAutoFilter(boolean useOnAutoFilter) Sets the flag to tell the auto-filter drop down list to use the grouper or not.- Parameters:
useOnAutoFilter
- true or false. Default is true.- Since:
- 3.5.14
-
isUseOnCustomFilter
public boolean isUseOnCustomFilter()Checks if the grouper will be used on the custom filter editor.- Returns:
- true or false.
- Since:
- 3.5.14
-
setUseOnCustomFilter
public void setUseOnCustomFilter(boolean useOnCustomFilter) Sets the flag to tell the custom filter editor to use the grouper or not.- Parameters:
useOnCustomFilter
- true or false. Default is true.- Since:
- 3.5.14
-