userDisplay
Class UserDisplayControl

java.lang.Object
  PamController.PamControlledUnit
      userDisplay.UserDisplayControl

All Implemented Interfaces:

PamSettings

public class UserDisplayControl
extends PamControlledUnit
implements PamSettings

Nested Class Summary

(package private) class	UserDisplayControl.MenuNewRadar
(package private) class	UserDisplayControl.MenuNewSpectrogram
(package private) class	UserDisplayControl.SpectrogramDependency

Field Summary

(package private) UserDisplayControl.SpectrogramDependency	spectrogramDependency
(package private) javax.swing.JMenuBar	spectrogramTabMenu
(package private) UserDisplayTabPanelControl	tabPanelControl

Fields inherited from class PamController.PamControlledUnit

isViewer

Constructor Summary

UserDisplayControl(java.lang.String name)

Method Summary

(package private) void	AddRadar(RadarParameters radarParameters)
(package private) void	AddSpectrogram(SpectrogramParameters spectrogramParameters)
javax.swing.JMenu	createDisplayMenu(java.awt.Frame parentFrame) Create a JMenu object containing MenuItems associated with the view
java.io.Serializable	getSettingsReference()
long	getSettingsVersion()
javax.swing.JMenuBar	getTabSpecificMenuBar(java.awt.Frame parentFrame, javax.swing.JMenuBar standardMenu, PamGui pamGui) Create a tab specific menu to go with this PamControlledUnit.
void	notifyModelChanged(int changeType) General notification when the PAMGAURD model changes.
void	pamToStart() called just before data acquisition starts.
boolean	restoreSettings(PamControlledUnitSettings pamControlledUnitSettings)

Methods inherited from class PamController.PamControlledUnit

addOtherRelatedMenuItems, addPamProcess, addRelatedMenuItems, canClose, createDetectionMenu, createFileMenu, createHelpMenu, fillXMLElement, fillXMLParameters, getFrameNumber, getNumPamProcesses, getPamController, getPamModuleInfo, getPamProcess, getPamView, getSidePanel, getTabClipCopier, getTabPanel, getUnitName, getUnitType, gotoTab, notifyArrayChanged, pamHasStopped, removePamProcess, removeUnit, rename, saveViewerData, setFrameNumber, setPamController, setPamModuleInfo, setPamView, setSidePanel, setTabPanel, setupControlledUnit, toString

Methods inherited from class java.lang.Object

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

Methods inherited from interface PamController.PamSettings

getUnitName, getUnitType

Field Detail

tabPanelControl

UserDisplayTabPanelControl tabPanelControl

spectrogramDependency

UserDisplayControl.SpectrogramDependency spectrogramDependency

spectrogramTabMenu

javax.swing.JMenuBar spectrogramTabMenu

Constructor Detail

UserDisplayControl

public UserDisplayControl(java.lang.String name)

Method Detail

notifyModelChanged

public void notifyModelChanged(int changeType)

Description copied from class: PamControlledUnit

General notification when the PAMGAURD model changes.

Overrides:

notifyModelChanged in class PamControlledUnit

Parameters:

changeType - type of change

AddSpectrogram

void AddSpectrogram(SpectrogramParameters spectrogramParameters)

AddRadar

void AddRadar(RadarParameters radarParameters)

createDisplayMenu

public javax.swing.JMenu createDisplayMenu(java.awt.Frame parentFrame)

Description copied from class: PamControlledUnit

Create a JMenu object containing MenuItems associated with the view

Overrides:

createDisplayMenu in class PamControlledUnit

Returns:

reference to a JMenu which can be added to an existing menu or menu bar

Note that if multiple views are to use the same menu, then they should each create a new menu (by setting Create to true) the first time they call this method.

getSettingsVersion

public long getSettingsVersion()

Specified by:

getSettingsVersion in interface PamSettings

Returns:

An integer version number for the settings

getSettingsReference

public java.io.Serializable getSettingsReference()

Specified by:

getSettingsReference in interface PamSettings

Returns:

The serialisable object that will be stored

restoreSettings

public boolean restoreSettings(PamControlledUnitSettings pamControlledUnitSettings)

Specified by:

restoreSettings in interface PamSettings

Returns:

true if successful The object performs final checks (if needed) and then casts the settings data pamcontrolledunitSettings.settings into the correct type and uses as required

getTabSpecificMenuBar

public javax.swing.JMenuBar getTabSpecificMenuBar(java.awt.Frame parentFrame,
                                                  javax.swing.JMenuBar standardMenu,
                                                  PamGui pamGui)

Description copied from class: PamControlledUnit

Create a tab specific menu to go with this PamControlledUnit.

Default is to throw back the standard menu to be used. This function should clone the standard menu and then modify the clone (usually by replacing the Display sub menu)

Overrides:

getTabSpecificMenuBar in class PamControlledUnit

standardMenu - the standard menu for the Pam GUI.

Returns:

a complete menu bar to be shown while a particular tab is selected

pamToStart

public void pamToStart()

Description copied from class: PamControlledUnit

called just before data acquisition starts. Note that PamObservers get a call to setSampleRate anyway so this mainly needs to be used for display elements that may need their scales adjusted before startup.

Overrides:

pamToStart in class PamControlledUnit