com.canto.cumulus.ui

Class MultiItemPane

java.lang.Object

com.canto.cumulus.ui.Pane

com.canto.cumulus.ui.MultiItemPane

All Implemented Interfaces:

java.lang.Iterable<Item>

Direct Known Subclasses:

FilteredMultiItemPane

public class MultiItemPane
extends Pane
implements java.lang.Iterable<Item>

This class represents a pane of a collection window that is able to display multiple items.

Since:

8.0

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	MultiItemPane.ViewMode

Method Summary

Methods

Modifier and Type	Method and Description
Menu	getContextMenu() Get the context menu for this pane.
MultiItemCollection	getMultiItemCollection() Get the collection that contains the items to be displayed in this pane.
int	getSelectedItemCount() Get the number of items that are currently selected in this pane.
java.util.List<ItemIdentifier>	getSelection(int startIdx, int numIDs) Get the identifiers of the selected items of this pane.
MultiItemPane.ViewMode	getViewMode() Get the current view mode of this pane.
java.util.Iterator<Item>	iterator() Return an iterator that iterates over all selected items in this pane.
void	setSelection(java.util.Collection<ItemIdentifier> selection) Overwrite the selection with the given collection of item identifiers.
void	setViewMode(MultiItemPane.ViewMode viewMode) Change the view mode of this pane.

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

getViewMode

public MultiItemPane.ViewMode getViewMode()

Get the current view mode of this pane.

Returns:

The current view mode of this pane

setViewMode

public void setViewMode(MultiItemPane.ViewMode viewMode)

Change the view mode of this pane.

Parameters:

viewMode - The new view mode for this pane.

getMultiItemCollection

public MultiItemCollection getMultiItemCollection()

Get the collection that contains the items to be displayed in this pane.

Returns:

The pane's collection object.

getSelectedItemCount

public int getSelectedItemCount()

Get the number of items that are currently selected in this pane.

Returns:

The number of items selected.

getSelection

public java.util.List<ItemIdentifier> getSelection(int startIdx,
                                          int numIDs)

Get the identifiers of the selected items of this pane. You can either get all selected item identifiers or you can specify a starting index and a count.

Parameters:

startIdx - The starting zero-based index to start with.

numIDs - The number of item identifiers to get. You can specify more items than the collection contains. This method will limit the number automatically to the available number of selected items.

Returns:

A list of selected items.

See Also:

getSelectedItemCount(), setSelection(java.util.Collection)

setSelection

public void setSelection(java.util.Collection<ItemIdentifier> selection)

Overwrite the selection with the given collection of item identifiers.

Parameters:

selection - The new selection of items.

See Also:

getSelection(int, int)

getContextMenu

public Menu getContextMenu()

Get the context menu for this pane.

Returns:

This pane's context menu.

iterator

public java.util.Iterator<Item> iterator()

Return an iterator that iterates over all selected items in this pane. This allows you to use Java 5 for-each loops that simplify your source code:

 for (Item item : multiItemPane)
 {
    // work on the selected item
 }
 

Specified by:

iterator in interface java.lang.Iterable<Item>

Returns:

An iterator for all selected items of this pane.