org.lsst.ccs.gconsole.base

Interface OptionalPage

public interface OptionalPage

Descriptor of a page that can be automatically opened by the graphical console. See Console.addOptionalPage(OptionalPage).

Author:

onoprien

Method Summary

Modifier and Type	Method and Description
default boolean	agentDisconnected(org.lsst.ccs.bus.data.AgentInfo agent) Called whenever an agent for which a page has been opened disconnects from the buses.
default void	close(String page) Called when the page is closed by the user.
String	getPage(org.lsst.ccs.bus.data.AgentInfo agent) Called whenever a new subsystem is detected on the buses.
String	getPath() Returns a unique slash-separated path that determines placement of the menu item that opens this page.
default boolean	isAutoOpen() Returns the default auto-open value.
JComponent	open(org.lsst.ccs.bus.data.AgentInfo agent, JComponent existingComponent) Called when a page is being opened.

Method Detail

getPath

String getPath()

Returns a unique slash-separated path that determines placement of the menu item that opens this page.

Returns:

Menu path.

isAutoOpen

default boolean isAutoOpen()

Returns the default auto-open value. If true, the page(s) will be open automatically on compatible subsystem discovery.

The default implementation returns true.

Returns:

Default auto-open value.

getPage

String getPage(org.lsst.ccs.bus.data.AgentInfo agent)

Called whenever a new subsystem is detected on the buses. The function should return the page name if the subsystem is compatible with this optional page. If not, it should return null. If an empty string is returned, the subsystem name is used.

If auto-open is true, the open(...) function will be called immediately following this call. Otherwise, a menu item with the page name is added to the graphical console "Window" menu with a path determined by getPath().

Parameters:

agent - Agent that has been discovered on the buses.

Returns:

Page name.

open

JComponent open(org.lsst.ccs.bus.data.AgentInfo agent,
                JComponent existingComponent)

Called when a page is being opened. The function should return the graphical component to be displayed. If null is returned, the page is not displayed. If a page with the name returned by getPage(AgentInfo) already exists (this can happen if a single page communicates with multiple subsystems), it is passed to this method as existingComponent. In this case, the component returned by this method is ignored.

Parameters:

agent - Agent.

existingComponent - Existing component with the specified name.

Returns:

Graphical component to be open.

agentDisconnected

default boolean agentDisconnected(org.lsst.ccs.bus.data.AgentInfo agent)

Called whenever an agent for which a page has been opened disconnects from the buses. Should return true to request closing the page. Regardless of the return value, the page is closed if there are no more active agents associated with it.

The default implementation returns false.

Parameters:

agent - Agent.

Returns:

true to close the page.

close

default void close(String page)

Called when the page is closed by the user.

Parameters:

page - Name of the closed page.