com.canto.cumulus.ui

Class CategoriesPane

java.lang.Object

com.canto.cumulus.ui.Pane

com.canto.cumulus.ui.CategoriesPane

All Implemented Interfaces:

java.lang.Iterable<CategoryItem>

public class CategoriesPane
extends Pane
implements java.lang.Iterable<CategoryItem>

The pane showing the categories. This pane contains a number of category trees identified by their master category name. This class allows to access all the category tabs available in the client.

Since:

8.0

Method Summary

Methods

Modifier and Type	Method and Description
void	expandAll(java.lang.String masterCategory)
java.util.Set<java.lang.String>	getAllMasterCategoryTabs() Get a list of names of all available master categories.
Menu	getContextMenu(java.lang.String masterCategory, boolean selectionMenu) Get the context menu for the given master category tab.
java.util.Set<ItemIdentifier>	getExpandedCategories(java.lang.String masterCategory) Get the set of expanded category items in the given master category tab.
MultiCategoryItemCollection	getMultiCategoryItemCollection(java.lang.String masterCategory) Get the collection containing the category items of a given master category tab.
int	getSelectedCategoryCount(java.lang.String masterCategory) Return the number of category items selected in the given master category tab.
java.lang.String	getSelectedMasterCategoryTab() Return the name of the currently visible master category tab.
java.util.List<ItemIdentifier>	getSelection(java.lang.String masterCategory, int startIdx, int numIDs) Get the identifiers of the selected category items of the given master category tab.
java.util.Iterator<CategoryItem>	iterator() Return an iterator that iterates over all selected category items in the current master category tab.
java.util.Iterator<CategoryItem>	iterator(java.lang.String masterCategoryTab) Return an iterator that iterates over all selected category items in the given master category tab.
void	setExpandedCategories(java.lang.String masterCategory, java.util.Collection<ItemIdentifier> expandedCategories) Overwrite the set of expanded category items.
void	setSelectedMasterCategoryTab(java.lang.String masterCategory) Show one of the available master category tabs.
void	setSelection(java.lang.String masterCategory, java.util.Collection<ItemIdentifier> selection) Overwrite the selection with the given collection of category item identifiers.
void	showCategories(java.lang.String masterCategory, java.util.Collection<ItemIdentifier> categoriesToShow) Expand all category items necessary to show the given category items the given master category tab.

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

getAllMasterCategoryTabs

public java.util.Set<java.lang.String> getAllMasterCategoryTabs()

Get a list of names of all available master categories.

Returns:

The list of available master category names.

getSelectedMasterCategoryTab

public java.lang.String getSelectedMasterCategoryTab()

Return the name of the currently visible master category tab.

Returns:

The name of the current master category tab.

setSelectedMasterCategoryTab

public void setSelectedMasterCategoryTab(java.lang.String masterCategory)

Show one of the available master category tabs. This automatically hides all other tabs.

Parameters:

masterCategory - The name of the master category tab to show.

getMultiCategoryItemCollection

public MultiCategoryItemCollection getMultiCategoryItemCollection(java.lang.String masterCategory)

Get the collection containing the category items of a given master category tab.

Parameters:

masterCategory - The name of the master category tab to access.

Returns:

The collection of category items for the given master category tab.

getSelectedCategoryCount

public int getSelectedCategoryCount(java.lang.String masterCategory)

Return the number of category items selected in the given master category tab.

Parameters:

masterCategory - The name of the master category tab to access.

Returns:

The number of category items selected in the given master category tab.

getSelection

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

Get the identifiers of the selected category items of the given master category tab. You can either get all selected category item identifiers or you can specify a starting index and a count.

Parameters:

masterCategory - The name of the master category tab to access.

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

numIDs - The number of category 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 category items. The list is ordered according to the order of the items in the category tree.

See Also:

getSelectedCategoryCount(String), setSelection(String, java.util.Collection)

setSelection

public void setSelection(java.lang.String masterCategory,
                java.util.Collection<ItemIdentifier> selection)

Overwrite the selection with the given collection of category item identifiers.

Parameters:

masterCategory - The name of the master category tab to access.

selection - The new selection of category items.

See Also:

getSelection(String, int, int)

getExpandedCategories

public java.util.Set<ItemIdentifier> getExpandedCategories(java.lang.String masterCategory)

Get the set of expanded category items in the given master category tab.

Parameters:

masterCategory - The name of the master category tab to access.

Returns:

The category item identifiers of all expanded category items.

See Also:

setExpandedCategories(String, java.util.Collection)

setExpandedCategories

public void setExpandedCategories(java.lang.String masterCategory,
                         java.util.Collection<ItemIdentifier> expandedCategories)

Overwrite the set of expanded category items. If you only want to expand a specific category item in addition to the currently expanded ones you need to call getExpandedCategories(String) first.

Parameters:

masterCategory - The name of the master category tab to access.

expandedCategories - The new set of expanded category items.

See Also:

getExpandedCategories(String)

expandAll

public void expandAll(java.lang.String masterCategory)

showCategories

public void showCategories(java.lang.String masterCategory,
                  java.util.Collection<ItemIdentifier> categoriesToShow)

Expand all category items necessary to show the given category items the given master category tab.

Parameters:

masterCategory - The name of the master category tab to work on.

categoriesToShow - The category items to show

getContextMenu

public Menu getContextMenu(java.lang.String masterCategory,
                  boolean selectionMenu)

Get the context menu for the given master category tab. The pane keeps two distinct context menus for selected categories and for the case where no category item is selected.

Parameters:

masterCategory - The name of the master category tab to work on.

selectionMenu - Specify true if you want to get the context menu for the selected category case, false otherwise.

Returns:

The context menu.

iterator

public java.util.Iterator<CategoryItem> iterator(java.lang.String masterCategoryTab)

Return an iterator that iterates over all selected category items in the given master category tab. This allows you to use Java 5 for-each loops that simplify your source code:

 Iterator  it = iterator ("$Sources");
 while (it.hasNext ())
 {
     CategoryItem categoryItem = it.next ();
     // work on the selected categoryItem
 }
 

Parameters:

masterCategoryTab - The name of the master category tab to work on.

Returns:

An iterator for all selected category items of the given master category tab.

iterator

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

Return an iterator that iterates over all selected category items in the current master category tab. This allows you to use Java 5 for-each loops that simplify your source code:

 for (CategoryItem categoryItem : categoriesPane)
 {
    // work on the selected categoryItem
 }
 

The iterator returned allows you to remove an item consistently:

 Iterator  it = categoriesPane.iterator ();
 while (it.hasNext ())
 {
     CategoryItem categoryItem = it.next ();
     // work on the selected categoryItem
 }
 

Specified by:

iterator in interface java.lang.Iterable<CategoryItem>

Returns:

An iterator for all selected category items of the current master category tab.