Package Array.layoutFX

Class HydrophoneSettingsPane

java.lang.Object

PamController.SettingsPane<Hydrophone>

pamViewFX.fxSettingsPanes.DynamicSettingsPane<Hydrophone>

Array.layoutFX.HydrophoneSettingsPane

All Implemented Interfaces:

DynamicSettings

public class HydrophoneSettingsPane
extends DynamicSettingsPane<Hydrophone>

The settings pane for a single hydrophones.

Author:

Jamie Macaulay

Constructor Summary

Constructors

Constructor	Description
HydrophoneSettingsPane()

Method Summary

Modifier and Type	Method	Description
protected static void	addTextValidator(javafx.scene.control.TextField userTextField, String description, net.synedra.validatorfx.Validator validator)	Creates a text filed and adds a validator to check that the input is OK.
javafx.scene.Node	getContentNode()	Get node for GUI change of settings.
String	getName()	Get the name of the pane.
Hydrophone	getParams(Hydrophone hydrophone)	Get settings from the pane.
void	paneInitialized()	Called when settings pane is first initialised.
void	setCurrentArray(PamArray currentArray)	Set the current array associated with the hydrophone.
void	setParams(Hydrophone hydrophone)	Called whenever the pane is first shown/open to set pane to show current settings.
void	setRecieverLabels()

Methods inherited from class pamViewFX.fxSettingsPanes.DynamicSettingsPane

addSettingsListener, isAllowNotify, notifySettingsListeners, removeSettingsListener, setAllowNotify

Methods inherited from class PamController.SettingsPane

getAWTWindow, getFXWindow, getHelpPoint, getOwnerWindow, notifyChange, repackContents, setDefaults, setOwnerWindow

Methods inherited from class java.lang.Object

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

Constructor Details

HydrophoneSettingsPane

public HydrophoneSettingsPane()

Method Details

getName

public String getName()

Description copied from class: SettingsPane

Get the name of the pane.

Specified by:

getName in class SettingsPane<Hydrophone>

Returns:

name of the pane

getContentNode

public javafx.scene.Node getContentNode()

Description copied from class: SettingsPane

Get node for GUI change of settings.

Specified by:

getContentNode in class SettingsPane<Hydrophone>

paneInitialized

public void paneInitialized()

Description copied from class: SettingsPane

Called when settings pane is first initialised. This can be used if for example, a the size of a pane is needed for a param. (Sizes are only initialised when Nodes are shown);

Specified by:

paneInitialized in class SettingsPane<Hydrophone>

addTextValidator

protected static void addTextValidator(javafx.scene.control.TextField userTextField,
 String description,
 net.synedra.validatorfx.Validator validator)

Creates a text filed and adds a validator to check that the input is OK.

setParams

public void setParams(Hydrophone hydrophone)

Description copied from class: SettingsPane

Called whenever the pane is first shown/open to set pane to show current settings.

Specified by:

setParams in class SettingsPane<Hydrophone>

Parameters:

hydrophone - - current settings class.

getParams

public Hydrophone getParams(Hydrophone hydrophone)

Description copied from class: SettingsPane

Get settings from the pane.

Specified by:

getParams in class SettingsPane<Hydrophone>

Returns:

settings class

setCurrentArray

public void setCurrentArray(PamArray currentArray)

Set the current array associated with the hydrophone.

Parameters:

currentArray - - the current array.

setRecieverLabels

public void setRecieverLabels()