Package pamViewFX.symbol

Class StandardSymbolOptionsPane

java.lang.Object

PamController.SettingsPane<StandardSymbolOptions>

pamViewFX.fxSettingsPanes.DynamicSettingsPane<StandardSymbolOptions>

pamViewFX.symbol.FXSymbolOptionsPane<StandardSymbolOptions>

pamViewFX.symbol.StandardSymbolOptionsPane

All Implemented Interfaces:

DynamicSettings

public class StandardSymbolOptionsPane
extends FXSymbolOptionsPane<StandardSymbolOptions>

A symbol options pane which allows users to select a list of symbol modifiers.

Author:

Jamie Macaulay

Constructor Summary

Constructors

Constructor	Description
StandardSymbolOptionsPane(StandardSymbolManager standardSymbolManager, StandardSymbolChooser standardSymbolChooser)

Method Summary

Modifier and Type	Method	Description
void	addSettingsListener(SettingsListener settingsListener)	Add a settings listener to the pane.
javafx.scene.Node	getContentNode()	Get node for GUI change of settings.
StandardSymbolModifierPane	getDefaultSymbolPane()
javafx.scene.layout.BorderPane	getMainPane()
String	getName()	Get the name of the pane.
StandardSymbolOptions	getParams(StandardSymbolOptions currParams)	Get settings from the pane.
javafx.scene.layout.VBox	getVBoxHolder()	VBox holder.
void	newSettings(int type)	Called whenever settings are updated.
void	paneInitialized()	Called when settings pane is first initialised.
void	setParams(StandardSymbolOptions input)	Called whenever the pane is first shown/open to set pane to show current settings.

Methods inherited from class pamViewFX.fxSettingsPanes.DynamicSettingsPane

isAllowNotify, notifySettingsListeners, removeSettingsListener, setAllowNotify

Methods inherited from class PamController.SettingsPane

getAWTWindow, getFXWindow, getHelpPoint, 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

StandardSymbolOptionsPane

public StandardSymbolOptionsPane(StandardSymbolManager standardSymbolManager,
 StandardSymbolChooser standardSymbolChooser)

Method Details

getParams

public StandardSymbolOptions getParams(StandardSymbolOptions currParams)

Description copied from class: SettingsPane

Get settings from the pane.

Specified by:

getParams in class SettingsPane<StandardSymbolOptions>

Returns:

settings class

setParams

public void setParams(StandardSymbolOptions 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<StandardSymbolOptions>

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

Returns:

name of the pane

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

newSettings

public void newSettings(int type)

Called whenever settings are updated.

Parameters:

type - - the settings update type.

getContentNode

public javafx.scene.Node getContentNode()

Description copied from class: SettingsPane

Get node for GUI change of settings.

Specified by:

getContentNode in class SettingsPane<StandardSymbolOptions>

addSettingsListener

public void addSettingsListener(SettingsListener settingsListener)

Description copied from class: DynamicSettingsPane

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

Specified by:

addSettingsListener in interface DynamicSettings

Overrides:

addSettingsListener in class DynamicSettingsPane<StandardSymbolOptions>

Parameters:

settingsListener - - the settings listener to add

getVBoxHolder

public javafx.scene.layout.VBox getVBoxHolder()

VBox holder.

Returns:

the vBox holder.

getMainPane

public javafx.scene.layout.BorderPane getMainPane()

getDefaultSymbolPane

public StandardSymbolModifierPane getDefaultSymbolPane()