bdv.ui.settings

Class SelectAndEditProfileSettingsPage<T extends SelectAndEditProfileSettingsPage.Profile>

java.lang.Object

bdv.ui.settings.SelectAndEditProfileSettingsPage<T>

Type Parameters:

T - type of thing being edited, e.g., TrackSchemeStyle.

All Implemented Interfaces:

SettingsPage

Direct Known Subclasses:

KeymapSettingsPage

public class SelectAndEditProfileSettingsPage<T extends SelectAndEditProfileSettingsPage.Profile>
extends Object
implements SettingsPage

A SettingsPage for the following common scenario: There are multiple "profiles" (e.g., keymaps, trackscheme styles, ...) to select from, and its possible to edit each individual profile.

To instantiate such a SettingsPage, a ProfileManager and a ProfileEditPanel have to be provided. The SelectAndEditProfileSettingsPage.ProfileManager is responsible for selecting/renaming/etc profile. The SelectAndEditProfileSettingsPage.ProfileEditPanel is responsible for editing an individual profile.

The SelectAndEditProfileSettingsPage provides UI for selecting, duplicating, renaming, and deleting profiles. If a Profile is built-in it is unmodifiable. When the user edits it, a duplicate is made automatically.

Author:

Tobias Pietzsch

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	SelectAndEditProfileSettingsPage.Profile Interface for the objects that are edited and selected in a SelectAndEditProfileSettingsPage.
static interface	SelectAndEditProfileSettingsPage.ProfileEditPanel<T> Class that edits a profile of type T in a JPanel.
static interface	SelectAndEditProfileSettingsPage.ProfileManager<T extends SelectAndEditProfileSettingsPage.Profile> Interface for classes that manage a collection of profiles.

Constructor Summary

Constructors

Constructor and Description
SelectAndEditProfileSettingsPage(String treePath, SelectAndEditProfileSettingsPage.ProfileManager<T> profileManager, SelectAndEditProfileSettingsPage.ProfileEditPanel<T> profileEditPanel) Creates a new SelectAndEditProfileSettingsPage for the specified profile manager and the specified editor panel.

Method Summary

Modifier and Type	Method and Description
void	apply() Called by the SettingsPanel if user presses "OK" or "Apply".
void	cancel() Called by the SettingsPanel if user presses "Cancel".
static <M extends StyleManager<M,S>,S extends Style<S>> SelectAndEditProfileSettingsPage<StyleProfile<S>>	forStyle(M manager, M editingManager, SelectAndEditProfileSettingsPage.ProfileEditPanel<StyleProfile<S>> settingsPage, String treePath)
JPanel	getJPanel()
String	getTreePath() Get the path of this page in the settings tree.
org.scijava.listeners.Listeners<ModificationListener>	modificationListeners()

Methods inherited from class java.lang.Object

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

Constructor Detail

SelectAndEditProfileSettingsPage

public SelectAndEditProfileSettingsPage(String treePath,
                                        SelectAndEditProfileSettingsPage.ProfileManager<T> profileManager,
                                        SelectAndEditProfileSettingsPage.ProfileEditPanel<T> profileEditPanel)

Creates a new SelectAndEditProfileSettingsPage for the specified profile manager and the specified editor panel.

Parameters:

treePath - path of this page in the settings tree.

profileManager - the profile manager.

profileEditPanel - the profile edit panel.

Method Detail

forStyle

public static <M extends StyleManager<M,S>,S extends Style<S>> SelectAndEditProfileSettingsPage<StyleProfile<S>> forStyle(M manager,
                                                                                                                          M editingManager,
                                                                                                                          SelectAndEditProfileSettingsPage.ProfileEditPanel<StyleProfile<S>> settingsPage,
                                                                                                                          String treePath)

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

modificationListeners

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

Specified by:

modificationListeners 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

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