Package Array.sensors.swing

Class ArraySensorComponent

java.lang.Object

Array.sensors.swing.ArraySensorComponent

All Implemented Interfaces:

ArrayDisplayParamsProvider, PamSettings, SettingsNameProvider, UserDisplayComponent

public class ArraySensorComponent
extends Object
implements UserDisplayComponent, PamSettings, ArrayDisplayParamsProvider

HPR on a user display.

Author:

dg50

Constructor Summary

Constructors

Constructor	Description
ArraySensorComponent(ArraySensorPanelProvider arraySensorPanelProvider, UserDisplayControl userDisplayControl, String uniqueName)

Method Summary

Modifier and Type	Method	Description
void	closeComponent()	Called when the component is removed from the display.
Component	getComponent()
ArrayDisplayParameters	getDisplayParameters()
String	getFrameTitle()	Get a title for the frame the component will be added to.
Serializable	getSettingsReference()
long	getSettingsVersion()
String	getUniqueName()
String	getUnitName()
String	getUnitType()
void	newSensorData(PamDataUnit pamDataUnit)
void	notifyModelChanged(int changeType)	Pick up model changed notifications from a parent user display.
void	openComponent()	Called when the component is first displayed.
boolean	restoreSettings(PamControlledUnitSettings pamControlledUnitSettings)
void	scrollChanged(long valueMillis)
void	setDisplayParameters(ArrayDisplayParameters displayParameters)
void	setUniqueName(String uniqueName)	Set a unique name for every display.
boolean	showDisplayParamsDialog(Window window)

Methods inherited from class java.lang.Object

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

Constructor Details

ArraySensorComponent

public ArraySensorComponent(ArraySensorPanelProvider arraySensorPanelProvider,
 UserDisplayControl userDisplayControl,
 String uniqueName)

Method Details

getComponent

public Component getComponent()

Specified by:

getComponent in interface UserDisplayComponent

Returns:

The Swing component to add to the frame

scrollChanged

public void scrollChanged(long valueMillis)

newSensorData

public void newSensorData(PamDataUnit pamDataUnit)

openComponent

public void openComponent()

Description copied from interface: UserDisplayComponent

Called when the component is first displayed.

Specified by:

openComponent in interface UserDisplayComponent

closeComponent

public void closeComponent()

Description copied from interface: UserDisplayComponent

Called when the component is removed from the display.

Specified by:

closeComponent in interface UserDisplayComponent

notifyModelChanged

public void notifyModelChanged(int changeType)

Description copied from interface: UserDisplayComponent

Pick up model changed notifications from a parent user display.

Specified by:

notifyModelChanged in interface UserDisplayComponent

getUniqueName

public String getUniqueName()

Specified by:

getUniqueName in interface UserDisplayComponent

Returns:

a unique name (across all of PAMGuard) which will be used for mark overlays and settings storage.

setUniqueName

public void setUniqueName(String uniqueName)

Description copied from interface: UserDisplayComponent

Set a unique name for every display. This is important for saving settings and for managing things that need a unique name such as overlay marks and markers.

Specified by:

setUniqueName in interface UserDisplayComponent

getFrameTitle

public String getFrameTitle()

Description copied from interface: UserDisplayComponent

Get a title for the frame the component will be added to.

Specified by:

getFrameTitle in interface UserDisplayComponent

Returns:

a title for the components frame.

getUnitName

public String getUnitName()

Specified by:

getUnitName in interface SettingsNameProvider

Returns:

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

getUnitType

public String getUnitType()

Specified by:

getUnitType in interface PamSettings

Returns:

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

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

getDisplayParameters

public ArrayDisplayParameters getDisplayParameters()

Specified by:

getDisplayParameters in interface ArrayDisplayParamsProvider

showDisplayParamsDialog

public boolean showDisplayParamsDialog(Window window)

Specified by:

showDisplayParamsDialog in interface ArrayDisplayParamsProvider

setDisplayParameters

public void setDisplayParameters(ArrayDisplayParameters displayParameters)

Specified by:

setDisplayParameters in interface ArrayDisplayParamsProvider