Package pamViewFX.fxNodes.utilityPanes

Class SettingsDialog<T>

java.lang.Object

javafx.scene.control.Dialog<T>

pamViewFX.fxNodes.pamDialogFX.PamDialogFX<T>

pamViewFX.fxNodes.utilityPanes.SettingsDialog<T>

Type Parameters:

T - - settings class for the module.

All Implemented Interfaces:

javafx.event.EventTarget

public class SettingsDialog<T>
extends PamDialogFX<T>

Create a dialog to show module settings pane. Use this version for dialogs which should look similar to the standard PAMGuard Swing dialogs.

Author:

Jamie Macaulay

Property Summary

Properties inherited from class javafx.scene.control.Dialog

contentText, dialogPane, graphic, headerText, height, onCloseRequest, onHidden, onHiding, onShowing, onShown, resizable, resultConverter, result, showing, title, width, x, y

Constructor Summary

Constructors

Constructor	Description
SettingsDialog(SettingsPane<T> settingsPane)

Method Summary

Modifier and Type	Method	Description
T	getParams()	This is called whenever the dialog is successfully closes.
void	setParams(T input)	Optional function used to set controls in the dialog to the correct setting for input params.

Methods inherited from class pamViewFX.fxNodes.pamDialogFX.PamDialogFX

pack, setContent, setExpandableContent, setOpeningLocation, showDialog, showError, showError, showMessageDialog, showMessageDialog, showMessageDialog, showMessageDialog, showMessageDialog, showParamsWarning, showWarning, showWarning

Methods inherited from class javafx.scene.control.Dialog

addEventFilter, addEventHandler, buildEventDispatchChain, close, contentTextProperty, dialogPaneProperty, getContentText, getDialogPane, getGraphic, getHeaderText, getHeight, getModality, getOnCloseRequest, getOnHidden, getOnHiding, getOnShowing, getOnShown, getOwner, getResult, getResultConverter, getTitle, getWidth, getX, getY, graphicProperty, headerTextProperty, heightProperty, hide, initModality, initOwner, initStyle, isResizable, isShowing, onCloseRequestProperty, onHiddenProperty, onHidingProperty, onShowingProperty, onShownProperty, removeEventFilter, removeEventHandler, resizableProperty, resultConverterProperty, resultProperty, setContentText, setDialogPane, setGraphic, setHeaderText, setHeight, setOnCloseRequest, setOnHidden, setOnHiding, setOnShowing, setOnShown, setResizable, setResult, setResultConverter, setTitle, setWidth, setX, setY, show, showAndWait, showingProperty, titleProperty, widthProperty, xProperty, yProperty

Methods inherited from class java.lang.Object

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

Constructor Details

SettingsDialog

public SettingsDialog(SettingsPane<T> settingsPane)

Method Details

setParams

public void setParams(T input)

Description copied from class: PamDialogFX

Optional function used to set controls in the dialog to the correct setting for input params.

Specified by:

setParams in class PamDialogFX<T>

Parameters:

input - - the input params.

getParams

public T getParams()

Description copied from class: PamDialogFX

This is called whenever the dialog is successfully closes.

Specified by:

getParams in class PamDialogFX<T>

Returns:

the new params