Module org.bigdataviewer.core

Package bdv.ui.settings

Class SimpleSettingsPage

java.lang.Object

bdv.ui.settings.SimpleSettingsPage

All Implemented Interfaces:

SettingsPage

public class SimpleSettingsPage
extends Object
implements SettingsPage

Helper class to easily put a JPanel as a page into a SettingsPanel.

Call notifyModified() when edits were made in your panel. (This will trigger correct "Cancel", "Apply", and "OK" behaviour by the SettingsPanel.)

To specify what should happen on "Apply" (propagate panel edits to your data model) add a #runOnApply callback. To specify what should happen on "Cancel" (reset panel contents to your data model) add a #runOnCancel callback.

Author:

Tobias Pietzsch

Field Summary

Fields

Modifier and Type	Field	Description
protected ArrayList<Runnable>	runOnApply
protected ArrayList<Runnable>	runOnCancel

Constructor Summary

Constructors

Constructor	Description
SimpleSettingsPage(String treePath, JPanel panel)

Method Summary

Modifier and Type	Method	Description
void	apply()	Called by the SettingsPanel if user presses "OK" or "Apply".
void	cancel()	Called by the SettingsPanel if user presses "Cancel".
JPanel	getJPanel()
String	getTreePath()	Get the path of this page in the settings tree.
org.scijava.listeners.Listeners<ModificationListener>	modificationListeners()
void	notifyModified()
void	onApply(Runnable runnable)
void	onCancel(Runnable runnable)

Methods inherited from class java.lang.Object

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

Field Detail

runOnApply

protected final ArrayList<Runnable> runOnApply

runOnCancel

protected final ArrayList<Runnable> runOnCancel

Constructor Detail

SimpleSettingsPage

public SimpleSettingsPage(String treePath,
                          JPanel panel)

Method Detail

getTreePath

public String getTreePath()

Description copied from interface: SettingsPage

Get the path of this page in the settings tree.

The path is split at ">" to get the nodes along the settings tree branch.

Specified by:

getTreePath in interface SettingsPage

Returns:

the path.

getJPanel

public JPanel getJPanel()

Specified by:

getJPanel in interface SettingsPage

notifyModified

public void notifyModified()

modificationListeners

public org.scijava.listeners.Listeners<ModificationListener> modificationListeners()

Specified by:

modificationListeners in interface SettingsPage

onApply

public void onApply(Runnable runnable)

onCancel

public void onCancel(Runnable runnable)

cancel

public void cancel()

Description copied from interface: SettingsPage

Called by the SettingsPanel if user presses "Cancel". Should restore any modified state to the original state.

Specified by:

cancel in interface SettingsPage

apply

public void apply()

Description copied from interface: SettingsPage

Called by the SettingsPanel if user presses "OK" or "Apply". Should commit any modified state.

Specified by:

apply in interface SettingsPage