Package IshmaelDetector.layoutFX

Class IshPaneFX

java.lang.Object

PamController.SettingsPane<IshDetParams>

IshmaelDetector.layoutFX.IshPaneFX

Direct Known Subclasses:

IshEnergyPaneFX, IshSpecCorrPaneFX

public abstract class IshPaneFX
extends SettingsPane<IshDetParams>

FX implementation of the Ishmael detector.

Author:

Jamie Macaulay

Field Summary

Fields

Modifier and Type	Field	Description
protected IshDetControl	ishDetControl	Reference to the control.

Constructor Summary

Constructors

Constructor	Description
IshPaneFX(IshDetControl ishDetControl)	Constructor for Ishmael pane.

Method Summary

Modifier and Type	Method	Description
javafx.scene.Node	getContentNode()	Get node for GUI change of settings.
abstract SettingsPane<IshDetParams>	getDetectorPane()	Get the detector specific pane.
String	getHelpPoint()	Get a help point address to use in help buttons in dialogs.
String	getName()	Get the name of the pane.
IshDetParams	getParams(IshDetParams currParams)	Get settings from the pane.
void	paneInitialized()	Called when settings pane is first initialised.
void	setParams(IshDetParams input)	Called whenever the pane is first shown/open to set pane to show current settings.

Methods inherited from class PamController.SettingsPane

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

Methods inherited from class java.lang.Object

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

Field Details

ishDetControl

protected IshDetControl ishDetControl

Reference to the control.

Constructor Details

IshPaneFX

public IshPaneFX(IshDetControl ishDetControl)

Constructor for Ishmael pane. Since different Ishmael detector share a lot of params the pane is abstract and sub-classed by different Ishamel detectors.

Parameters:

ownerWindow - - the ownder window

Method Details

getDetectorPane

public abstract SettingsPane<IshDetParams> getDetectorPane()

Get the detector specific pane.

Returns:

pane with detector specific controls.

getParams

public IshDetParams getParams(IshDetParams currParams)

Description copied from class: SettingsPane

Get settings from the pane.

Specified by:

getParams in class SettingsPane<IshDetParams>

Returns:

settings class

setParams

public void setParams(IshDetParams input)

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<IshDetParams>

Parameters:

input - - current settings class.

getName

public String getName()

Description copied from class: SettingsPane

Get the name of the pane.

Specified by:

getName in class SettingsPane<IshDetParams>

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<IshDetParams>

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<IshDetParams>

getHelpPoint

public String getHelpPoint()

Description copied from class: SettingsPane

Get a help point address to use in help buttons in dialogs.

Overrides:

getHelpPoint in class SettingsPane<IshDetParams>

Returns:

help point address within PAMGuard help system.