org.lsst.ccs.gconsole.services.optpage

Class LsstOptionalPageService

java.lang.Object

org.lsst.ccs.gconsole.base.ConsolePlugin

org.lsst.ccs.gconsole.services.optpage.LsstOptionalPageService

All Implemented Interfaces:

ConsoleService

@Plugin(name="Optional Page Service Plugin",
        id="opt-page",
        description="Support for optional pages utility.")
public class LsstOptionalPageService
extends ConsolePlugin
implements ConsoleService

Service plugin that provides support for optional pages utility.

Author:

onoprien

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	LsstOptionalPageService.Descriptor

Constructor Summary

Constructors

Constructor and Description
LsstOptionalPageService()

Method Summary

Modifier and Type	Method and Description
void	add(OptionalPage descriptor) Registers an optional page descriptor with the console.
void	remove(OptionalPage descriptor) Removes a previously registered optional page.
boolean	restore(ComponentDescriptor storageBean, boolean lastRound) Called by the framework to restore this plugin configuration.
void	restore(OptionalPage descriptor, HashMap<String,DataPanelDescriptor> storageBean)
ComponentDescriptor	save() Called by the framework when this plugin configuration needs to be saved.
HashMap<String,DataPanelDescriptor>	save(OptionalPage descriptor)
void	setOpen(OptionalPage descriptor, org.lsst.ccs.bus.data.AgentInfo agent, boolean isOpen)

Methods inherited from class org.lsst.ccs.gconsole.base.ConsolePlugin

getConsole, getServices, initialize, propertiesChanged, setServicesProvider, shutdown, start, stop

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.base.ConsoleService

startService, stopService

Constructor Detail

LsstOptionalPageService

public LsstOptionalPageService()

Method Detail

add

public void add(OptionalPage descriptor)

Registers an optional page descriptor with the console. Once registered, the descriptor will trigger creation of console pages whenever compatible subsystems are discovered on the buses. See OptionalPage documentation for details. The demo subsystem GUI provides an example of use: org.lsst.ccs.subsystem.demo.gui.plugins.OptionalPagePlugin.

Parameters:

descriptor - Page descriptor.

remove

public void remove(OptionalPage descriptor)

Removes a previously registered optional page. See add(OptionalPage).

Parameters:

descriptor - Descriptor of the page to be removed

setOpen

public void setOpen(OptionalPage descriptor,
                    org.lsst.ccs.bus.data.AgentInfo agent,
                    boolean isOpen)

save

public HashMap<String,DataPanelDescriptor> save(OptionalPage descriptor)

restore

public void restore(OptionalPage descriptor,
                    HashMap<String,DataPanelDescriptor> storageBean)

save

public ComponentDescriptor save()

Description copied from class: ConsolePlugin

Called by the framework when this plugin configuration needs to be saved.

Overrides:

save in class ConsolePlugin

Returns:

JavaBean that holds information on the current configuration of this plugin.

restore

public boolean restore(ComponentDescriptor storageBean,
                       boolean lastRound)

Description copied from class: ConsolePlugin

Called by the framework to restore this plugin configuration.

Overrides:

restore in class ConsolePlugin

Parameters:

storageBean - JavaBean that holds configuration information.

lastRound - True if this is the last call to this method, regardless of the return value.

Returns:

False if this method should be called again in the next round.