com.canto.cumulus.ui

Class Pane

java.lang.Object

com.canto.cumulus.ui.Pane

Direct Known Subclasses:

CalendarPane, CategoriesPane, MultiItemPane, SingleItemPane

public class Pane
extends java.lang.Object

This class represents the base class for all panes in the collection window. Each pane is identified in the collection window by its unique ID.

Since:

8.0

Method Summary

Methods

Modifier and Type	Method and Description
boolean	equals(java.lang.Object obj)
CollectionWindow	getCollectionWindow() Get the collection window that this pane is displayed in.
GUID	getID() Get the unique ID of this pane.
java.lang.String	getViewSet() Get the current view set that this pane uses.
void	grabFocus() Make this pane the currently focused pane.
boolean	isFocusOwner() Return whether this pane has the current focus.
boolean	isVisible() Return whether this pane is visible.
void	setViewSet(java.lang.String viewSet) change the view set of this pane.
void	setVisible(boolean visible) Show or hide this pane.
boolean	supportsViewSets() Return whether this pane supports getting and setting the pane's view set.

Methods inherited from class java.lang.Object

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

Method Detail

getID

public GUID getID()

Get the unique ID of this pane.

Returns:

The pane's ID

isVisible

public boolean isVisible()

Return whether this pane is visible.

Returns:

true if this pane is currently visible, false otherwise.

setVisible

public void setVisible(boolean visible)

Show or hide this pane.

Parameters:

visible - Pass true to make this pane visible, false to hide it.

isFocusOwner

public boolean isFocusOwner()

Return whether this pane has the current focus.

Returns:

true if this pane currently has the input focus, false otherwise.

grabFocus

public void grabFocus()

Make this pane the currently focused pane.

supportsViewSets

public boolean supportsViewSets()

Return whether this pane supports getting and setting the pane's view set.

Returns:

true if this pane supports getting and setting the view set, false otherwise.

See Also:

getViewSet(), setViewSet(String)

getViewSet

public java.lang.String getViewSet()

Get the current view set that this pane uses.

Returns:

The name of the current view set of this pane.

setViewSet

public void setViewSet(java.lang.String viewSet)

change the view set of this pane.

Parameters:

viewSet - The name of the new view set to be used by this pane.

getCollectionWindow

public CollectionWindow getCollectionWindow()

Get the collection window that this pane is displayed in.

Returns:

This pane's collection window

equals

public boolean equals(java.lang.Object obj)

Overrides:

equals in class java.lang.Object