ipiDemo

Class IpiPluginPanelProvider.IpiPluginPanel

java.lang.Object

Layout.DisplayPanel

ipiDemo.IpiPluginPanelProvider.IpiPluginPanel

All Implemented Interfaces:

PamSettings, PamObserver

Enclosing class:

IpiPluginPanelProvider

public class IpiPluginPanelProvider.IpiPluginPanel
extends DisplayPanel
implements PamObserver, PamSettings

Constructor Summary

Constructors

Constructor and Description
IpiPluginPanelProvider.IpiPluginPanel(IpiPluginPanelProvider ipiPluginPanelProvider, DisplayPanelContainer displayPanelContainer)

Method Summary

Methods

Modifier and Type	Method and Description
void	containerNotification(DisplayPanelContainer displayContainer, int noteType) Called by the DisplayPanelContainer whenever the scales change - e.g.
void	destroyPanel() The displayPanelContainer should call destroyPanel when the panel is no longer required so that the displayPanel can unsubscribe to any data it was observing.
java.lang.String	getObserverName()
PamObserver	getObserverObject()
long	getRequiredDataHistory(PamObservable o, java.lang.Object arg)
java.io.Serializable	getSettingsReference()
long	getSettingsVersion()
PamAxis	getSouthAxis()
java.lang.String	getUnitName()
java.lang.String	getUnitType()
PamAxis	getWestAxis()
void	masterClockUpdate(long milliSeconds, long sampleNumber)
void	noteNewSettings()
void	removeObservable(PamObservable o) called when an Observable (PamDataBlock) is removed from the system
boolean	restoreSettings(PamControlledUnitSettings pamControlledUnitSettings)
void	setSampleRate(float sampleRate, boolean notify) New sample rate
void	update(PamObservable o, PamDataUnit arg) Informs the PamObserver that new data have been added to the Observable class

Methods inherited from class Layout.DisplayPanel

clearImage, clearImage, clearImage, getDisplayImage, getDisplayPanelContainer, getDisplayPanelProvider, getEastAxis, getInnerHeight, getInnerPanel, getInnerWidth, getNorthAxis, getPanel, getPanelBorder, repaint, repaint, setPanelBorder, spectrogramMousePosition

Methods inherited from class java.lang.Object

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

Constructor Detail

IpiPluginPanelProvider.IpiPluginPanel

public IpiPluginPanelProvider.IpiPluginPanel(IpiPluginPanelProvider ipiPluginPanelProvider,
                                     DisplayPanelContainer displayPanelContainer)

Method Detail

getWestAxis

public PamAxis getWestAxis()

Overrides:

getWestAxis in class DisplayPanel

getSouthAxis

public PamAxis getSouthAxis()

Overrides:

getSouthAxis in class DisplayPanel

containerNotification

public void containerNotification(DisplayPanelContainer displayContainer,
                         int noteType)

Description copied from class: DisplayPanel

Called by the DisplayPanelContainer whenever the scales change - e.g. every time new data is drawn on the spectrogram.

The display panel can use this information in two ways:

Firstly, it should clear the region of the display just ahead of the current spectrogram x coordinate. Secondly, it may draw additional data on the display.

Specified by:

containerNotification in class DisplayPanel

destroyPanel

public void destroyPanel()

Description copied from class: DisplayPanel

The displayPanelContainer should call destroyPanel when the panel is no longer required so that the displayPanel can unsubscribe to any data it was observing.

Specified by:

destroyPanel in class DisplayPanel

getObserverName

public java.lang.String getObserverName()

Specified by:

getObserverName in interface PamObserver

getRequiredDataHistory

public long getRequiredDataHistory(PamObservable o,
                          java.lang.Object arg)

Specified by:

getRequiredDataHistory in interface PamObserver

Parameters:

o - PamObservable class requiring the data

arg - optional argument from PamObservable

Returns:

time in milliseconds requried by data held in PamObservable

noteNewSettings

public void noteNewSettings()

Specified by:

noteNewSettings in interface PamObserver

removeObservable

public void removeObservable(PamObservable o)

Description copied from interface: PamObserver

called when an Observable (PamDataBlock) is removed from the system

Specified by:

removeObservable in interface PamObserver

setSampleRate

public void setSampleRate(float sampleRate,
                 boolean notify)

Description copied from interface: PamObserver

New sample rate

Specified by:

setSampleRate in interface PamObserver

notify - Notify other PamObservers and PamObservables in the chain.

masterClockUpdate

public void masterClockUpdate(long milliSeconds,
                     long sampleNumber)

Specified by:

masterClockUpdate in interface PamObserver

update

public void update(PamObservable o,
          PamDataUnit arg)

Description copied from interface: PamObserver

Informs the PamObserver that new data have been added to the Observable class

Specified by:

update in interface PamObserver

Parameters:

o - Reference to the Observable (a PamDataBlock)

arg - Reference to the new PamDataUnit

getSettingsReference

public java.io.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

getUnitName

public java.lang.String getUnitName()

Specified by:

getUnitName in interface PamSettings

Returns:

A Name specific to this instance of the particular class, e.g. Sperm whale detector, Beaked whale detector, etc.

getUnitType

public java.lang.String getUnitType()

Specified by:

getUnitType in interface PamSettings

Returns:

A Name specific to the type, e.g. Glick detector

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

getObserverObject

public PamObserver getObserverObject()

Specified by:

getObserverObject in interface PamObserver

Returns:

the actual observer. In most cases concrete classes will just return 'this' in response. The exception is the Threaded observer, which will return the single thread observer.