Package annotationMark.spectrogram

Class SpectrogramAnnotationModule

java.lang.Object

PamController.PamControlledUnit

annotationMark.MarkModule

annotationMark.spectrogram.SpectrogramAnnotationModule

All Implemented Interfaces:

PamSettings, SettingsNameProvider

Direct Known Subclasses:

QuickAnnotationModule

public class SpectrogramAnnotationModule
extends MarkModule
implements PamSettings

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
class	SpectrogramAnnotationModule.DisplayObserver

Field Summary

Fields inherited from class annotationMark.MarkModule

unitType

Constructor Summary

Constructors

Constructor	Description
SpectrogramAnnotationModule(String unitName)

Method Summary

Modifier and Type	Method	Description
JMenuItem	createDetectionMenu(Frame parentFrame)	Create a JMenu object containing MenuItems associated with PamProcesses
MarkDataUnit	findAnnotationUnit(int channel, long startMilliseconds, double f1)	Find an existing annotation data unit.
AnnotationChoices	getAnnotationChoices()
SpectrogramMarkAnnotationHandler	getAnnotationHandler()
String	getMarkType()
Serializable	getSettingsReference()
long	getSettingsVersion()
boolean	removeUnit()	Called to remove a unit.
boolean	restoreSettings(PamControlledUnitSettings pamControlledUnitSettings)
void	showSettingsMenu(Frame parentFrame)

Methods inherited from class annotationMark.MarkModule

addAnnotationType, getAnnotationDataBlock, getAnnotationProcess

Methods inherited from class PamController.PamControlledUnit

addOfflineTaskGroup, addOtherRelatedMenuItems, addPamProcess, addPamProcess, addRelatedMenuItems, canClose, canPlayViewerSound, createDisplayMenu, createFileMenu, createHelpMenu, flushDataBlockBuffers, getBackupInformation, getFrameNumber, getGUI, getGuiFrame, getInstanceIndex, getModuleStatus, getModuleStatusManager, getModuleSummary, getModuleSummary, getNumOfflineTaskGroups, getNumPamProcesses, getOfflineState, getOfflineTaskGroup, getPamConfiguration, getPamController, getPamModuleInfo, getPamProcess, getPamView, getPlugin, getShortUnitType, getSidePanel, getTabClipCopier, getTabPanel, getTabSpecificMenuBar, getToolbarComponent, getUnitName, getUnitType, getVerboseLevel, gotoTab, isInMainConfiguration, isNetRx, isViewer, notifyModelChanged, pamClose, pamHasStopped, pamToStart, playViewerSound, removePamProcess, rename, saveViewerData, setFrameNumber, setModuleStatusManager, setPamConfiguration, setPamController, setPamModuleInfo, setPamView, setSidePanel, setTabPanel, setToolbarComponent, setupControlledUnit, stopViewerSound, tellModule, terminalPrint, terminalPrintln, toString

Methods inherited from class java.lang.Object

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

Methods inherited from interface PamController.PamSettings

getUnitType

Methods inherited from interface PamController.SettingsNameProvider

getUnitName

Constructor Details

SpectrogramAnnotationModule

public SpectrogramAnnotationModule(String unitName)

Method Details

removeUnit

public boolean removeUnit()

Description copied from class: PamControlledUnit

Called to remove a unit.

Overrides:

removeUnit in class PamControlledUnit

Returns:

try (not used)

getMarkType

public String getMarkType()

createDetectionMenu

public JMenuItem createDetectionMenu(Frame parentFrame)

Description copied from class: PamControlledUnit

Create a JMenu object containing MenuItems associated with PamProcesses

Overrides:

createDetectionMenu in class PamControlledUnit

Parameters:

parentFrame - The owner frame of the menu

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.

showSettingsMenu

public void showSettingsMenu(Frame parentFrame)

findAnnotationUnit

public MarkDataUnit findAnnotationUnit(int channel,
 long startMilliseconds,
 double f1)

Find an existing annotation data unit.

Parameters:

channel -

startMilliseconds -

f1 -

Returns:

existing unit, or null.

getAnnotationChoices

public AnnotationChoices getAnnotationChoices()

getAnnotationHandler

public SpectrogramMarkAnnotationHandler getAnnotationHandler()

Returns:

the annotationHandler

getSettingsReference

public Serializable getSettingsReference()

Specified by:

getSettingsReference in interface PamSettings

Returns:

The serialisable object that will be stored

getSettingsVersion

public long getSettingsVersion()

Specified by:

getSettingsVersion in interface PamSettings

Returns:

An integer version number for the settings

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