CollectionWindow (Cumulus Java Classes Documentation)

java.lang.Object
- com.canto.cumulus.ui.CollectionWindow

```
public class CollectionWindow
extends java.lang.Object
```
This class represents a collection window in the Cumulus client. Inside the application each collection window is identified by an ID that is unique during the run of the client. A collection window consists of panes with either fixed IDs or dynamically generated IDs. Each pane that can exist only once has a fixed ID which is defined as a constant in this class. The dynamically created split-view panes get dynamically generated IDs. This class allows to access the panes it contains and is also able to show and hide each of the panes.

Since:

8.0

Field Summary

Fields
Modifier and Type	Field and Description
`static GUID`	`PANE_ID_CALENDAR` The unique ID of the calendar pane.
`static GUID`	`PANE_ID_CATEGORIES` The unique ID of the categories pane.
`static GUID`	`PANE_ID_CATEGORY_ITEM_INFO` The unique ID of the category information pane.
`static GUID`	`PANE_ID_COLLECTION_BASKET` The unique ID of the collection basket pane.
`static GUID`	`PANE_ID_MAIN_RECORD_VIEW` The unique ID of the main record pane.
`static GUID`	`PANE_ID_PREVIEW` The unique ID of the preview pane.
`static GUID`	`PANE_ID_RECORD_ITEM_INFO` The unique ID of the record information pane.
`static GUID`	`PANE_ID_THUMBNAIL` The unique ID of the thumbnail pane.

Method Summary

Methods
Modifier and Type	Method and Description
`void`	`addCatalog(int catalogID)` Adds the given catalog to this collection window.
`CollectionWindow`	`clone()`
`void`	`close()` Close this collection window.
`FilteredMultiItemPane`	`createFilteredMultiItemPane()` Create a new split-pane at the bottom of the hierarchy.
`boolean`	`equals(java.lang.Object obj)`
`GUID`	`getFocusedPaneID()` Get the ID of the pane that currently has the focus.
`int`	`getID()` Get the ID of this window
`GUID`	`getLastFocusedRecordItemPaneID()` Get the record item pane that had the focus just before the current pane got it.
`MultiItemPane`	`getMainRecordPane()` get the main record pane that is always available.
`java.util.List<GUID>`	`getMainRecordPaneHierarchy()` Get the list of record panes that form a hierarchy of filtered panes.
`Pane`	`getPane(GUID paneID)` Get a specific pane.
`java.util.List<GUID>`	`getVisiblePaneIDs()` Get a list of visible panes.
`int`	`hashCode()`
`void`	`removeCatalog(int catalogID)` Remove catalog from the collection window.
`int`	`startLogDuration(java.lang.String message)` Starts time logging
`void`	`stopLogDuration(int logReference)` Stops time logging

Methods inherited from class java.lang.Object
getClass, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - PANE_ID_CALENDAR
```
public static final GUID PANE_ID_CALENDAR
```
    The unique ID of the calendar pane.
    
    See Also:
    getPane(com.canto.cumulus.GUID)
  - PANE_ID_THUMBNAIL
```
public static final GUID PANE_ID_THUMBNAIL
```
    The unique ID of the thumbnail pane.
    
    See Also:
    getPane(com.canto.cumulus.GUID)
  - PANE_ID_PREVIEW
```
public static final GUID PANE_ID_PREVIEW
```
    The unique ID of the preview pane.
    
    See Also:
    getPane(com.canto.cumulus.GUID)
  - PANE_ID_MAIN_RECORD_VIEW
```
public static final GUID PANE_ID_MAIN_RECORD_VIEW
```
    The unique ID of the main record pane.
    
    See Also:
    getMainRecordPane()
  - PANE_ID_COLLECTION_BASKET
```
public static final GUID PANE_ID_COLLECTION_BASKET
```
    The unique ID of the collection basket pane.
    
    See Also:
    getPane(com.canto.cumulus.GUID)
  - PANE_ID_CATEGORIES
```
public static final GUID PANE_ID_CATEGORIES
```
    The unique ID of the categories pane.
    
    See Also:
    getPane(com.canto.cumulus.GUID)
  - PANE_ID_RECORD_ITEM_INFO
```
public static final GUID PANE_ID_RECORD_ITEM_INFO
```
    The unique ID of the record information pane.
    
    See Also:
    getPane(com.canto.cumulus.GUID)
  - PANE_ID_CATEGORY_ITEM_INFO
```
public static final GUID PANE_ID_CATEGORY_ITEM_INFO
```
    The unique ID of the category information pane.
    
    See Also:
    getPane(com.canto.cumulus.GUID)
- Method Detail
  - getPane
```
public Pane getPane(GUID paneID)
```
    Get a specific pane.
    
    Parameters:
    paneID - The unique ID of the pane. Either use one of the constants found in this class or one of the dynamically generated IDs returned by getMainRecordPaneHierarchy();
    
    Returns:
    The pane with the given unique ID.
  - createFilteredMultiItemPane
```
public FilteredMultiItemPane createFilteredMultiItemPane()
```
    Create a new split-pane at the bottom of the hierarchy. The pane is created invisible. You need to call Pane.setVisible(boolean) to show it.
    
    Returns:
    The newly created pane object.
  - getMainRecordPane
```
public MultiItemPane getMainRecordPane()
```
    get the main record pane that is always available.
    
    Returns:
    The main record pane of this window.
  - getVisiblePaneIDs
```
public java.util.List<GUID> getVisiblePaneIDs()
```
    Get a list of visible panes.
    
    Returns:
    The unique IDs of all visible panes.
  - getMainRecordPaneHierarchy
```
public java.util.List<GUID> getMainRecordPaneHierarchy()
```
    Get the list of record panes that form a hierarchy of filtered panes. The first item in the list is the main record pane.
    
    Returns:
    The list of unique IDs for all panes of the hierarchy of record panes.
  - getID
```
public int getID()
```
    Get the ID of this window
    
    Returns:
    This window's ID
  - getFocusedPaneID
```
public GUID getFocusedPaneID()
```
    Get the ID of the pane that currently has the focus.
    
    Returns:
    The currently focused pane.
  - getLastFocusedRecordItemPaneID
```
public GUID getLastFocusedRecordItemPaneID()
```
    Get the record item pane that had the focus just before the current pane got it. This method can be used to find out which two panes were focused by the user last. If for example you want to write an EJP that allows to work with selected categories and selected records you can find out which record pane was selected jsu before the user focused on the categories pane.
    
    Returns:
    The pane that had the focus prior to the currently focused record item pane.
  - addCatalog
```
public void addCatalog(int catalogID)
```
    Adds the given catalog to this collection window. This automatically adds the catalog to the record and the category collection.
    
    Parameters:
    catalogID - catalog to add
    Since:
    
    8.5.2
  - removeCatalog
```
public void removeCatalog(int catalogID)
```
    Remove catalog from the collection window.
    
    Parameters:
    catalogID - catalog to remove
    Since:
    
    8.5.2
  - close
```
public void close()
```
    Close this collection window.
  - clone
```
public CollectionWindow clone()
```
    Overrides:
    
    clone in class java.lang.Object
  - startLogDuration
```
public int startLogDuration(java.lang.String message)
```
    Starts time logging
    
    Parameters:
    message - the message string that should be logged
    
    Returns:
    the generated reference number that needs to be used in stopLogDuration(int)
    Since:
    
    10.2.5
  - stopLogDuration
```
public void stopLogDuration(int logReference)
```
    Stops time logging
    
    Parameters:
    logReference - the reference number returned by startLogDuration(java.lang.String)
    Since:
    
    10.2.5
  - equals
```
public boolean equals(java.lang.Object obj)
```
    Overrides:
    
    equals in class java.lang.Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class java.lang.Object

www.canto.com
Canto, the Canto logo, the Cumulus logo, and Cumulus are registered trademarks of Canto GmbH, registered in the U.S. and other countries.

Class CollectionWindow

Field Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

PANE_ID_CALENDAR

PANE_ID_THUMBNAIL

PANE_ID_PREVIEW

PANE_ID_MAIN_RECORD_VIEW

PANE_ID_COLLECTION_BASKET

PANE_ID_CATEGORIES

PANE_ID_RECORD_ITEM_INFO

PANE_ID_CATEGORY_ITEM_INFO

Method Detail

getPane

createFilteredMultiItemPane

getMainRecordPane

getVisiblePaneIDs

getMainRecordPaneHierarchy

getID

getFocusedPaneID

getLastFocusedRecordItemPaneID

addCatalog

removeCatalog

close

clone

startLogDuration

stopLogDuration

equals

hashCode