Package pamViewFX.fxSettingsPanes

Class DynamicSettingsPane<T>

java.lang.Object

PamController.SettingsPane<T>

pamViewFX.fxSettingsPanes.DynamicSettingsPane<T>

Type Parameters:

T - - the settings file.

All Implemented Interfaces:

DynamicSettings

Direct Known Subclasses:

AdvMHTVarPane, ClickSelectPaneFX, CompoundDialogPaneFX, CPODDataSelectorPane, CTDataSelectPane, DataMapSettingsPane, DataSelectorDialogPaneFX, DLPredictonPane, DLSelectPaneFX, FFTSettingsPane, FXSymbolOptionsPane, HydrophoneSettingsPane, RefractionMethodPane, SimpleFilterPaneFX, TDGraphSettingsPane, TDScrollerSettingsPane, VRSettingsPane, WMDSelectPaneFX

public abstract class DynamicSettingsPane<T>
extends SettingsPane<T>
implements DynamicSettings

A dynamic settings is a settings pane which allows users to change settings instantly. i.e. when a control is pressed the setting is instantly changed rather than, for example, an OK button being pressed and all settings then saving.

This is often is slider panes.

Author:

Jamie Macaulay

Constructor Summary

Constructors

Constructor	Description
DynamicSettingsPane(Object ownerWindow)

Method Summary

Modifier and Type	Method	Description
void	addSettingsListener(SettingsListener settingsListener)	Add a settings listener to the pane.
boolean	isAllowNotify()	Check whether the pane can notify settings listeners
void	notifySettingsListeners()	Notify all settings listeners of a settings change.
void	removeSettingsListener(SettingsListener settingsListener)	Remove a settings listener
void	setAllowNotify(boolean allowNotify)	Set settings listeners to be notified.

Methods inherited from class PamController.SettingsPane

getAWTWindow, getContentNode, getFXWindow, getHelpPoint, getName, getOwnerWindow, getParams, notifyChange, paneInitialized, repackContents, setDefaults, setOwnerWindow, setParams

Methods inherited from class java.lang.Object

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

Constructor Details

DynamicSettingsPane

public DynamicSettingsPane(Object ownerWindow)

Method Details

addSettingsListener

public void addSettingsListener(SettingsListener settingsListener)

Add a settings listener to the pane. This will register any change in controls which changes settings.

Specified by:

addSettingsListener in interface DynamicSettings

Parameters:

settingsListener - - the settings listener to add

removeSettingsListener

public void removeSettingsListener(SettingsListener settingsListener)

Remove a settings listener

Specified by:

removeSettingsListener in interface DynamicSettings

Parameters:

settingsListener - - the settings to remove.

notifySettingsListeners

public void notifySettingsListeners()

Notify all settings listeners of a settings change.

Specified by:

notifySettingsListeners in interface DynamicSettings

Parameters:

obsVal - - the observable value

oldVal - - the old value

newVal - - the new value.

isAllowNotify

public boolean isAllowNotify()

Check whether the pane can notify settings listeners

Specified by:

isAllowNotify in interface DynamicSettings

Returns:

true if settings listeners are notified on calling notifySettingsListeners()

setAllowNotify

public void setAllowNotify(boolean allowNotify)

Set settings listeners to be notified. Set to false to disable all listeners.

Specified by:

setAllowNotify in interface DynamicSettings

Parameters:

allowNotify - - true to allow notifucation of settings listeners.