org.lsst.ccs.gconsole.plugins.commandbrowser

Class Browser

java.lang.Object

org.lsst.ccs.gconsole.plugins.commandbrowser.Browser

All Implemented Interfaces:

Savable

Direct Known Subclasses:

BrowserFull, BrowserOneSubsystem

public abstract class Browser
extends Object
implements Savable

Interface to be implemented by all types of command browsers. A Browser handles the root page of the command browser tool. All access to implementations of this class should happen on EDT.

Author:

onoprien

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Browser.Descriptor
protected static class	Browser.RenderedLock

Field Summary

Fields

Modifier and Type	Field and Description
protected JPanel	browserPanel
protected org.lsst.ccs.utilities.logging.Logger	logger
protected LockService	service
protected JLabel	stateLabel

Constructor Summary

Constructors

Constructor and Description
Browser()

Method Summary

Modifier and Type	Method and Description
JComponent	getPanel() Initializes the browser if necessary, and returns its root graphics component.
static boolean	isCommandLocked(org.lsst.ccs.command.DictionaryCommand command, Locker agent) Returns true if the specified command is currently unavailable for use based on lock and level settings.
protected Browser.RenderedLock	renderLock(Locker agent) Computes information for rendering lock icon and enabling actions associated with the specified agent.
abstract Browser.Descriptor	save() Returns JavaBean describing the current state of this component.
void	shutdown() Releases resources and shuts down this browser.
protected void	updateStateDisplay()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

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

restore

Field Detail

logger

protected final org.lsst.ccs.utilities.logging.Logger logger

service

protected final LockService service

browserPanel

protected JPanel browserPanel

stateLabel

protected JLabel stateLabel

Constructor Detail

Browser

public Browser()

Method Detail

getPanel

public JComponent getPanel()

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

Returns:

Root graphics component for this browser.

shutdown

public void shutdown()

Releases resources and shuts down this browser.

isCommandLocked

public static boolean isCommandLocked(org.lsst.ccs.command.DictionaryCommand command,
                                      Locker agent)

Returns true if the specified command is currently unavailable for use based on lock and level settings.

Parameters:

command - Command to check.

agent - Lock service proxy for a remote agent.

Returns:

true If the command is locked or agent is null.

updateStateDisplay

protected void updateStateDisplay()

renderLock

protected Browser.RenderedLock renderLock(Locker agent)

Computes information for rendering lock icon and enabling actions associated with the specified agent.

Parameters:

agent - Remote agent.

Returns:

Rendered lock parameters.

save

public abstract 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.