org.yamcs.ui.archivebrowser

Class NavigatorItem

java.lang.Object

org.yamcs.ui.archivebrowser.NavigatorItem

Direct Known Subclasses:

DataViewer

public abstract class NavigatorItem
extends Object

Defines a ContentPanel to be included in the SideNavigator. Optionally includes an inset JComponent as well for display in the lower region of the side navigator. Provides access to an API similar to ArchiveIndexListener but with a finished event that only triggers when *both* tags and regular records are received.

Field Summary

Fields

Modifier and Type	Field and Description
protected JComponent	contentPanel
protected ArchiveIndexReceiver	indexReceiver
protected JComponent	navigatorInset
protected YamcsConnector	yconnector

Constructor Summary

Constructors

Constructor and Description
NavigatorItem(YamcsConnector yconnector, ArchiveIndexReceiver indexReceiver)

Method Summary

Modifier and Type	Method and Description
void	archiveLoadFinished() Triggered when *both* tags and archive records have been received.
abstract JComponent	createContentPanel() Build the GUI component for the content panel (called only once)
JComponent	createNavigatorInset() Build the GUI component for the navigator inset (called only once)
int	getIndent()
abstract String	getLabelName()
void	onClose() Called when this item is closed Defaults to NOP.
void	onOpen() Called when this item is opened Defaults to NOP.
void	receiveArchiveRecords(Yamcs.IndexResult ir)
void	receiveArchiveRecordsError(String errorMessage)
void	receiveTags(List<Yamcs.ArchiveTag> tagList)
void	startReloading()
void	tagAdded(Yamcs.ArchiveTag ntag)
void	tagChanged(Yamcs.ArchiveTag oldTag, Yamcs.ArchiveTag newTag)
void	tagRemoved(Yamcs.ArchiveTag rtag)
void	windowResized()

Methods inherited from class java.lang.Object

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

Field Detail

yconnector

protected YamcsConnector yconnector

indexReceiver

protected ArchiveIndexReceiver indexReceiver

contentPanel

protected JComponent contentPanel

navigatorInset

protected JComponent navigatorInset

Constructor Detail

NavigatorItem

public NavigatorItem(YamcsConnector yconnector,
                     ArchiveIndexReceiver indexReceiver)

Method Detail

getLabelName

public abstract String getLabelName()

Returns:

the label name of this item in the SideNavigator

getIndent

public int getIndent()

Returns:

a multiplier indicating the indent level of the label name in the SideNavigator (defaults to 0)

createContentPanel

public abstract JComponent createContentPanel()

Build the GUI component for the content panel (called only once)

Returns:

the content pane to be visualized when the item is selected from the SideNavigator

createNavigatorInset

public JComponent createNavigatorInset()

Build the GUI component for the navigator inset (called only once)

Returns:

optional panel to be put in the lower part of the SideNavigator when this NavigatorItem is active

onOpen

public void onOpen()

Called when this item is opened Defaults to NOP.

onClose

public void onClose()

Called when this item is closed Defaults to NOP.

windowResized

public void windowResized()

startReloading

public void startReloading()

receiveArchiveRecords

public void receiveArchiveRecords(Yamcs.IndexResult ir)

receiveArchiveRecordsError

public void receiveArchiveRecordsError(String errorMessage)

receiveTags

public void receiveTags(List<Yamcs.ArchiveTag> tagList)

archiveLoadFinished

public void archiveLoadFinished()

Triggered when *both* tags and archive records have been received.

tagAdded

public void tagAdded(Yamcs.ArchiveTag ntag)

tagRemoved

public void tagRemoved(Yamcs.ArchiveTag rtag)

tagChanged

public void tagChanged(Yamcs.ArchiveTag oldTag,
                       Yamcs.ArchiveTag newTag)