userDisplay

Class UserDisplayControl

java.lang.Object

PamController.PamControlledUnit

userDisplay.UserDisplayControl

All Implemented Interfaces:

PamSettings

public class UserDisplayControl
extends PamControlledUnit
implements PamSettings

Constructor Summary

Constructors

Constructor and Description
UserDisplayControl(java.lang.String name)

Method Summary

Methods

Modifier and Type	Method and Description
static void	addUserDisplayProvider(UserDisplayProvider userDisplayProvider) Add a reference to the list of providers of user displays.
boolean	canPlayViewerSound()
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.
void	playViewerSound() Start playing sound in reponse to a call from the viewer top toolbar.
static void	removeDisplayProvider(UserDisplayProvider userDisplayProvider) Remove a reference to a list of user display provider
boolean	restoreSettings(PamControlledUnitSettings pamControlledUnitSettings)
void	stopViewerSound() Stop playing sound in response to a call from the viewer top toolbar.

Methods inherited from class PamController.PamControlledUnit

addOfflineTaskGroup, addOtherRelatedMenuItems, addPamProcess, addRelatedMenuItems, addXMLParameter, addXMLParameter, addXMLParameter, addXMLParameter, canClose, createDetectionMenu, createFileMenu, createHelpMenu, fillXMLElement, flushDataBlockBuffers, getFrameNumber, getGuiFrame, getModuleSummary, getNumOfflineTaskGroups, getNumPamProcesses, getOfflineTaskGroup, getPamController, getPamModuleInfo, getPamProcess, getPamView, getShortUnitType, getSidePanel, getTabClipCopier, getTabPanel, getToolbarComponent, getUnitName, getUnitType, getVerboseLevel, gotoTab, isViewer, pamClose, pamHasStopped, removePamProcess, removeUnit, rename, saveViewerData, setFrameNumber, setPamController, setPamModuleInfo, setPamView, setSidePanel, setTabPanel, setupControlledUnit, terminalPrint, terminalPrintln, toString

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface PamController.PamSettings

getUnitName, getUnitType

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

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

canPlayViewerSound

public boolean canPlayViewerSound()

Overrides:

canPlayViewerSound in class PamControlledUnit

Returns:

true if this module can play sound in reponse to a play command from the top toolbar.

playViewerSound

public void playViewerSound()

Description copied from class: PamControlledUnit

Start playing sound in reponse to a call from the viewer top toolbar.

Overrides:

playViewerSound in class PamControlledUnit

stopViewerSound

public void stopViewerSound()

Description copied from class: PamControlledUnit

Stop playing sound in response to a call from the viewer top toolbar.

Overrides:

stopViewerSound in class PamControlledUnit

addUserDisplayProvider

public static void addUserDisplayProvider(UserDisplayProvider userDisplayProvider)

Add a reference to the list of providers of user displays.

Parameters:

userDisplayProvider - reference to a provider of user displays.

removeDisplayProvider

public static void removeDisplayProvider(UserDisplayProvider userDisplayProvider)

Remove a reference to a list of user display provider

Parameters:

userDisplayProvider - reference to a provider of user displays.