Package clickTrainDetector.layout

Class ClickTrainAlgorithmPaneFX

java.lang.Object

PamController.SettingsPane<ClickTrainParams>

clickTrainDetector.layout.ClickTrainAlgorithmPaneFX

public class ClickTrainAlgorithmPaneFX
extends SettingsPane<ClickTrainParams>

Main settings pane for the click train detector.

Author:

Jamie Macaulay

Constructor Summary

Constructors

Constructor	Description
ClickTrainAlgorithmPaneFX(ClickTrainControl clickTrainControl)

Method Summary

Modifier and Type	Method	Description
javafx.scene.Node	getContentNode()	Get node for GUI change of settings.
String	getHelpPoint()	Get a help point address to use in help buttons in dialogs.
String	getName()	Get the name of the pane.
ClickTrainParams	getParams(ClickTrainParams currParams)	Get settings from the pane.
void	paneInitialized()	Called when settings pane is first initialised.
void	setParams(ClickTrainParams clickTrainParams)	Called whenever the pane is first shown/open to set pane to show current settings.
void	setTab(int index)	Set the tab to open.
void	showAdvPane()	Creates pane allowing the user to change fine scale things such as error limits.
static boolean	showWarning(Window owner, String warningTitle, String warningText)	Show warning

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

Constructor Details

ClickTrainAlgorithmPaneFX

public ClickTrainAlgorithmPaneFX(ClickTrainControl clickTrainControl)

Method Details

setTab

public void setTab(int index)

Set the tab to open.

Parameters:

index - - the tab index (0 for detection tab, 1 for classification tab)

showAdvPane

public void showAdvPane()

Creates pane allowing the user to change fine scale things such as error limits.

getParams

public ClickTrainParams getParams(ClickTrainParams currParams)

Description copied from class: SettingsPane

Get settings from the pane.

Specified by:

getParams in class SettingsPane<ClickTrainParams>

Returns:

settings class

showWarning

public static boolean showWarning(Window owner,
 String warningTitle,
 String warningText)

Show warning

Parameters:

owner -

warningTitle -

warningText -

Returns:

setParams

public void setParams(ClickTrainParams clickTrainParams)

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

Parameters:

clickTrainParams - - current settings class.

getName

public String getName()

Description copied from class: SettingsPane

Get the name of the pane.

Specified by:

getName in class SettingsPane<ClickTrainParams>

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

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

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

Returns:

help point address within PAMGuard help system.