Package beamformer

Class BeamformerSettingsPane

java.lang.Object

PamController.SettingsPane<BeamFormerParams>

beamformer.BeamformerSettingsPane

public class BeamformerSettingsPane
extends SettingsPane<BeamFormerParams>

Constructor Summary

Constructors

Constructor	Description
BeamformerSettingsPane(Object owner, BeamFormerBaseControl beamformerControl)

Method Summary

Modifier and Type	Method	Description
javafx.scene.Node	createAlgoPane()
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.
PamTabPane	getPamTabbedPane()
BeamFormerParams	getParams(BeamFormerParams bfParams)	Saves the values in the GUI to the parameters object
void	paneInitialized()	Always go to the first (source) pane when opening the dialog.
void	repackContents()	An opportunity to re-pack settings pane contents.
void	saveAlgorithmList(BeamFormerParams bfParams)	Saves the current state of the algorithm tab to the hashtable.
void	setParams(BeamFormerParams input)	Loads the passed beamformer parameters into the GUi

Methods inherited from class PamController.SettingsPane

getAWTWindow, getFXWindow, getOwnerWindow, notifyChange, setDefaults, setOwnerWindow

Methods inherited from class java.lang.Object

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

Constructor Details

BeamformerSettingsPane

public BeamformerSettingsPane(Object owner,
 BeamFormerBaseControl beamformerControl)

Parameters:

arg0 -

Method Details

createAlgoPane

public javafx.scene.Node createAlgoPane()

Returns:

getParams

public BeamFormerParams getParams(BeamFormerParams bfParams)

Saves the values in the GUI to the parameters object

Specified by:

getParams in class SettingsPane<BeamFormerParams>

Parameters:

bfParams - is a parameters object passed into this function by PamDialogFX2AWT, but ignored

Returns:

settings class

saveAlgorithmList

public void saveAlgorithmList(BeamFormerParams bfParams)

Saves the current state of the algorithm tab to the hashtable.

Parameters:

bfParams -

setParams

public void setParams(BeamFormerParams input)

Loads the passed beamformer parameters into the GUi

Specified by:

setParams in class SettingsPane<BeamFormerParams>

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

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

paneInitialized

public void paneInitialized()

Always go to the first (source) pane when opening the dialog. Without this, the window will open on whatever tab was last selected. The algorithm pane was sometimes not repainting properly if it was the current pane, so this way the createAlgoPane() method will always be run because the user will have to switch to the tab manually

Specified by:

paneInitialized in class SettingsPane<BeamFormerParams>

repackContents

public void repackContents()

Description copied from class: SettingsPane

An opportunity to re-pack settings pane contents.

Overrides:

repackContents in class SettingsPane<BeamFormerParams>

getPamTabbedPane

public PamTabPane getPamTabbedPane()

Returns:

the pamTabbedPane

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

Returns:

help point address within PAMGuard help system.