org.lsst.ccs.gconsole.plugins.commandbrowser

Interface Browser

All Superinterfaces:

Savable

All Known Implementing Classes:

BrowserFull, BrowserOneSubsystem

public interface Browser
extends Savable

Interface to be implemented by all types of command browsers. A Browser handles the root page of the command browser tool.

Author:

onoprien

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	Browser.Descriptor

Field Summary

Fields

Modifier and Type	Field and Description
static ImageIcon	ICON_LOCKED
static ImageIcon	ICON_UNAVAILABLE
static ImageIcon	ICON_UNLOCKED

Method Summary

Modifier and Type	Method and Description
String	getName() Returns the name of this command browser.
JComponent	getPanel() Initializes the browser if necessary, and returns its root graphics component.
static boolean	isCommandLocked(org.lsst.ccs.command.DictionaryCommand command, org.lsst.ccs.command.Dictionary dictionary) Returns true if the specified command is currently unavailable for use based on lock and level settings.
Browser.Descriptor	save() Returns JavaBean describing the current state of this component.
void	shutdown() Releases resources and shuts down this browser.

Methods inherited from interface org.lsst.ccs.gconsole.services.persist.Savable

restore

Field Detail

ICON_UNLOCKED

static final ImageIcon ICON_UNLOCKED

ICON_LOCKED

static final ImageIcon ICON_LOCKED

ICON_UNAVAILABLE

static final ImageIcon ICON_UNAVAILABLE

Method Detail

getName

String getName()

Returns the name of this command browser.

Returns:

Browser name.

getPanel

JComponent getPanel()

Initializes the browser if necessary, and returns its root graphics component.

Returns:

Root graphics component for this browser.

shutdown

void shutdown()

Releases resources and shuts down this browser.

isCommandLocked

static boolean isCommandLocked(org.lsst.ccs.command.DictionaryCommand command,
                               org.lsst.ccs.command.Dictionary dictionary)

Returns true if the specified command is currently unavailable for use based on lock and level settings. If the specified dictionary is null, always returns true (for compatibility with legacy code).

Parameters:

command - Command to check.

dictionary - Dictionary the command belongs to.

Returns:

true If the command is locked.

save

Browser.Descriptor save()

Description copied from interface: Savable

Returns JavaBean describing the current state of this component. The default implementation returns null.

Specified by:

save in interface Savable

Returns:

JavaBean encapsulating the state, or null if no state information needs to be saved.