org.lsst.ccs.gconsole.plugins.monitor

Interface MonitorView

All Superinterfaces:

AgentStatusListener

All Known Implementing Classes:

AbstractMonitorView1, AbstractMonitorView2, CellTableView, CellView, CompoundView, ConfigView, DefaultView, ImageView, SectionedTableView, TabbedView, TreeTableView, TreeView

public interface MonitorView
extends AgentStatusListener

View of monitoring data. AgentStatusListener methods are called on the AgentStatusAggregator thread. All other methods declared by this interface should be called on AWT Event Dispatch Thread.

Author:

onoprien

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static interface	MonitorView.Descriptor JavaBean that contains information required to re-create this view in its current state.

Method Summary

Modifier and Type	Method and Description
AgentChannelsFilter	getFilter() Returns the filter associated with this view, or null if there is none.
default String	getName() Returns the name of this view.
JComponent	getPanel() Returns the graphical component maintained by this view.
default void	install() Installs this view, connecting it to the data source.
default boolean	isEmpty() Returns true if this view has no content to display at the moment.
default void	restore(MonitorView.Descriptor descriptor) Restores this view to the state described by the provided descriptor, to the extent possible.
default MonitorView.Descriptor	save() Returns a descriptor that contains information required to re-create this view in its current state.
void	setFilter(AgentChannelsFilter filter) Sets the channels filter to be used by this view.
default void	setName(String name) Sets the name of this view.
default void	uninstall() Un-installs this view, disconnecting it from the data source.

Methods inherited from interface org.lsst.ccs.gconsole.agent.AgentStatusListener

configure, connect, disconnect, statusChanged

Method Detail

getPanel

JComponent getPanel()

Returns the graphical component maintained by this view.

Returns:

Graphical component to be displayed by the GUI.

getName

default String getName()

Returns the name of this view.

Returns:

View name.

setName

default void setName(String name)

Sets the name of this view.

Parameters:

name - View name.

getFilter

AgentChannelsFilter getFilter()

Returns the filter associated with this view, or null if there is none.

Returns:

Channels filter.

setFilter

void setFilter(AgentChannelsFilter filter)

Sets the channels filter to be used by this view. The filter determines what channels are displayed by this view, and how they are displayed.

Parameters:

filter - Filter to be associated with this view.

isEmpty

default boolean isEmpty()

Returns true if this view has no content to display at the moment. This can be used report that the view can be closed, for example. The default implementation returns false.

Returns:

True if this view has no content to display.

install

default void install()

Installs this view, connecting it to the data source.

uninstall

default void uninstall()

Un-installs this view, disconnecting it from the data source.

save

default MonitorView.Descriptor save()

Returns a descriptor that contains information required to re-create this view in its current state. The default implementation returns null.

Returns:

View descriptor, or null is this view does not support saving.

restore

default void restore(MonitorView.Descriptor descriptor)

Restores this view to the state described by the provided descriptor, to the extent possible. The default implementation does nothing.

Parameters:

descriptor - View descriptor.