com.canto.cumulus.ui

Class FilteredMultiItemPane

java.lang.Object

com.canto.cumulus.ui.Pane

com.canto.cumulus.ui.MultiItemPane

com.canto.cumulus.ui.FilteredMultiItemPane

All Implemented Interfaces:

java.lang.Iterable<Item>

public class FilteredMultiItemPane
extends MultiItemPane

This class represents a pane showing the filtered records that depend on a parent pane. Whenever the selection of the parent pane changes the Cumulus client applies the filter of the filtered pane to the selected items to get the contents of this filtered pane. This class allows to access the record filter that is used in the pane.

Since:

8.0

Nested Class Summary

Nested classes/interfaces inherited from class com.canto.cumulus.ui.MultiItemPane

MultiItemPane.ViewMode

Method Summary

Methods

Modifier and Type	Method and Description
java.lang.String	getFilter() Get the name of the record filter currently used in this pane.
GUID	getParentPaneID() Get the parent pane that this pane is depending on.
void	setFilter(java.lang.String filter) Change the record filter currently used in this pane.

Methods inherited from class com.canto.cumulus.ui.MultiItemPane

getContextMenu, getMultiItemCollection, getSelectedItemCount, getSelection, getViewMode, iterator, setSelection, setViewMode

Methods inherited from class com.canto.cumulus.ui.Pane

equals, getCollectionWindow, getID, getViewSet, grabFocus, isFocusOwner, isVisible, setViewSet, setVisible, supportsViewSets

Methods inherited from class java.lang.Object

getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

getParentPaneID

public GUID getParentPaneID()

Get the parent pane that this pane is depending on.

Returns:

The unique ID of the parent pane.

getFilter

public java.lang.String getFilter()

Get the name of the record filter currently used in this pane.

Returns:

The currently selected record filter of this pane.

setFilter

public void setFilter(java.lang.String filter)

Change the record filter currently used in this pane.

Parameters:

filter - The name of the record filter to be used.