Interface SearchFieldGroup
- All Known Implementing Classes:
DefaultSearchFieldGroup
public interface SearchFieldGroup
A search field group allows multi-level grouping of
search fields and other search groups.-
Method Summary
Modifier and TypeMethodDescriptionReturns a list containing this group (if hidden) and all the hidden groups held by thisSearchFieldGroupand its sub groups.Returns all hiddensearch fieldsin thisSearchFieldGroupand its sub groups.Returns a list containing this group (if it has hidden fields and/or groups) and all the sub groups of this group and its sub groups, which contains hidden fields or groups.Returns a list containing this group and all the groups held by thisSearchFieldGroupand its sub groups.Returns allsearch fieldsin thisSearchFieldGroupand its sub groups.Returns a list containing this group (if visible) and all the visible groups held by thisSearchFieldGroupand its sub groups.Returns all visiblesearch fieldsin thisSearchFieldGroupand its sub groups.Returns all the hidden sub groups directly held by thisSearchFieldGroup.Returns all hiddensearch fieldsdirectly held by thisSearchFieldGroup.getLabel()Returns the label of this search field group.Returns this group's parent group.Returns a list containing all the sub groups of this group, which contains hidden fields or groups.Returns all the sub groups directly held by thisSearchFieldGroup.Returns allsearch fieldsdirectly held by thisSearchFieldGroup.Returns all the visible sub groups directly held by thisSearchFieldGroup.Returns all visiblesearch fieldsdirectly held by thisSearchFieldGroup.booleanReturns whether this group is visible or not i.e.
-
Method Details
-
getLabel
String getLabel()Returns the label of this search field group.- Returns:
- the label of this group
-
isVisible
boolean isVisible()Returns whether this group is visible or not i.e. if any of the fields held by this group or its sub groups are visible.- Returns:
trueif this group is visible,falseotherwise
-
getParentSearchFieldGroup
SearchFieldGroup getParentSearchFieldGroup()Returns this group's parent group.- Returns:
- this group's parent group or
nullif this is the root group
-
getSearchFieldGroups
List<SearchFieldGroup> getSearchFieldGroups()Returns all the sub groups directly held by thisSearchFieldGroup.- Returns:
- the direct sub groups of this group
- See Also:
-
getAllSearchFieldGroups
List<SearchFieldGroup> getAllSearchFieldGroups()Returns a list containing this group and all the groups held by thisSearchFieldGroupand its sub groups.- Returns:
- the sub groups of this
SearchFieldGroupand their sub groups - See Also:
-
getVisibleSearchFieldGroups
List<SearchFieldGroup> getVisibleSearchFieldGroups()Returns all the visible sub groups directly held by thisSearchFieldGroup.- Returns:
- the visible sub groups directly held by this group
- See Also:
-
getAllVisibleSearchFieldGroups
List<SearchFieldGroup> getAllVisibleSearchFieldGroups()Returns a list containing this group (if visible) and all the visible groups held by thisSearchFieldGroupand its sub groups.- Returns:
- the visible sub groups of this
SearchFieldGroupand their sub groups - See Also:
-
getHiddenSearchFieldGroups
List<SearchFieldGroup> getHiddenSearchFieldGroups()Returns all the hidden sub groups directly held by thisSearchFieldGroup.- Returns:
- the hidden sub groups directly held by this group
- See Also:
-
getAllHiddenSearchFieldGroups
List<SearchFieldGroup> getAllHiddenSearchFieldGroups()Returns a list containing this group (if hidden) and all the hidden groups held by thisSearchFieldGroupand its sub groups.- Returns:
- the hidden sub groups of this
SearchFieldGroupand their sub groups - See Also:
-
getAllPartiallyVisibleGroups
List<SearchFieldGroup> getAllPartiallyVisibleGroups()Returns a list containing this group (if it has hidden fields and/or groups) and all the sub groups of this group and its sub groups, which contains hidden fields or groups.- Returns:
- the partially visible sub groups of this group i.e. all the groups which have hidden fields and/or sub groups
-
getPartiallyVisibleGroups
List<SearchFieldGroup> getPartiallyVisibleGroups()Returns a list containing all the sub groups of this group, which contains hidden fields or groups.- Returns:
- the partially visible sub groups of this group i.e. all the groups which have hidden fields and/or sub groups
-
getSearchFields
List<SearchField> getSearchFields()Returns allsearch fieldsdirectly held by thisSearchFieldGroup.- Returns:
- all search fields assigned directly to this group
- See Also:
-
getAllSearchFields
List<SearchField> getAllSearchFields()Returns allsearch fieldsin thisSearchFieldGroupand its sub groups.- Returns:
- all search fields assigned to this group or any of its sub groups
-
getVisibleSearchFields
List<SearchField> getVisibleSearchFields()Returns all visiblesearch fieldsdirectly held by thisSearchFieldGroup.- Returns:
- all visible search fields assigned directly to this group
- See Also:
-
getAllVisibleSearchFields
List<SearchField> getAllVisibleSearchFields()Returns all visiblesearch fieldsin thisSearchFieldGroupand its sub groups.- Returns:
- all visible search fields assigned to this group or any of its sub groups
- See Also:
-
getHiddenSearchFields
List<SearchField> getHiddenSearchFields()Returns all hiddensearch fieldsdirectly held by thisSearchFieldGroup.- Returns:
- all hidden search fields assigned directly to this group
- See Also:
-
getAllHiddenSearchFields
List<SearchField> getAllHiddenSearchFields()Returns all hiddensearch fieldsin thisSearchFieldGroupand its sub groups.- Returns:
- all hidden search fields assigned to this group or any of its sub groups
- See Also:
-