com.alee.managers.settings
Interface SettingsMethods

All Superinterfaces:

SwingMethods

All Known Implementing Classes:

GenericCellEditor, ImagePreviewFrame, LibraryInfoDialog, NinePatchEditorDialog, StyleEditor, TestFrame, ViewTabbedPane, WebAccordion, WebAsyncTreeFilterField, WebBooleanRenderer, WebBreadcrumbToggleButton, WebCheckBox, WebCheckBoxListElement, WebCheckBoxMenuItem, WebCollapsiblePane, WebColorChooserDialog, WebColorChooserField, WebComboBox, WebDateField, WebDialog, WebDirectoryChooser, WebEditorPane, WebExtendedOptionPane, WebFadeDialog, WebFormattedTextField, WebFrame, WebGradientColorChooser, WebHotkeyField, WebLookAndFeelDemo, WebPasswordField, WebPopOver, WebProgressDialog, WebRadioButton, WebRadioButtonMenuItem, WebSlider, WebTabbedPane, WebTextArea, WebTextField, WebTextPane, WebToggleButton, WebTristateCheckBox, WebWindow

public interface SettingsMethods
extends SwingMethods

This interface provides a set of methods that should be added into components which are supported by SettingsManager. Basically all these methods are already implemented in SettingsManager but it is much easier to call them directly from component.

Author:

Mikle Garin

See Also:

How to use SettingsManager, SettingsManager, SwingMethods

Method Summary

void	loadSettings() Loads saved settings into the component if it is registered.
void	registerSettings(SettingsProcessor settingsProcessor) Registers component for settings auto-save.
void	registerSettings(java.lang.String key) Registers component for settings auto-save.
void	registerSettings(java.lang.String key, boolean loadInitialSettings, boolean applySettingsChanges) Registers component for settings auto-save.
<T extends DefaultValue> void	registerSettings(java.lang.String key, java.lang.Class<T> defaultValueClass) Registers component for settings auto-save.
<T extends DefaultValue> void	registerSettings(java.lang.String key, java.lang.Class<T> defaultValueClass, boolean loadInitialSettings, boolean applySettingsChanges) Registers component for settings auto-save.
void	registerSettings(java.lang.String key, java.lang.Object defaultValue) Registers component for settings auto-save.
void	registerSettings(java.lang.String key, java.lang.Object defaultValue, boolean loadInitialSettings, boolean applySettingsChanges) Registers component for settings auto-save.
void	registerSettings(java.lang.String group, java.lang.String key) Registers component for settings auto-save.
<T extends DefaultValue> void	registerSettings(java.lang.String group, java.lang.String key, java.lang.Class<T> defaultValueClass) Registers component for settings auto-save.
<T extends DefaultValue> void	registerSettings(java.lang.String group, java.lang.String key, java.lang.Class<T> defaultValueClass, boolean loadInitialSettings, boolean applySettingsChanges) Registers component for settings auto-save.
void	registerSettings(java.lang.String group, java.lang.String key, java.lang.Object defaultValue) Registers component for settings auto-save.
void	registerSettings(java.lang.String group, java.lang.String key, java.lang.Object defaultValue, boolean loadInitialSettings, boolean applySettingsChanges) Registers component for settings auto-save.
void	saveSettings() Saves component settings.
void	unregisterSettings() Unregisters component from settings auto-save.

Method Detail

registerSettings

void registerSettings(java.lang.String key)

Registers component for settings auto-save.

Also registered component will be: - listened for settings changes to save them when requested - automatically updated with any loaded settings for that key if requested - automatically updated with any changes made in its settings if requested

Parameters:

key - component settings key

registerSettings

<T extends DefaultValue> void registerSettings(java.lang.String key,
                                               java.lang.Class<T> defaultValueClass)

Registers component for settings auto-save.

Also registered component will be: - listened for settings changes to save them when requested - automatically updated with any loaded settings for that key if requested - automatically updated with any changes made in its settings if requested

Type Parameters:

T - default value type

Parameters:

key - component settings key

defaultValueClass - component default value class

See Also:

DefaultValue

registerSettings

void registerSettings(java.lang.String key,
                      java.lang.Object defaultValue)

Registers component for settings auto-save.

Also registered component will be: - listened for settings changes to save them when requested - automatically updated with any loaded settings for that key if requested - automatically updated with any changes made in its settings if requested

Parameters:

key - component settings key

defaultValue - component default value

registerSettings

<T extends DefaultValue> void registerSettings(java.lang.String group,
                                               java.lang.String key,
                                               java.lang.Class<T> defaultValueClass)

Registers component for settings auto-save.

Also registered component will be: - listened for settings changes to save them when requested - automatically updated with any loaded settings for that key if requested - automatically updated with any changes made in its settings if requested

Type Parameters:

T - default value type

Parameters:

group - component settings group

key - component settings key

defaultValueClass - component default value class

See Also:

DefaultValue

registerSettings

void registerSettings(java.lang.String group,
                      java.lang.String key,
                      java.lang.Object defaultValue)

Registers component for settings auto-save.

Also registered component will be: - listened for settings changes to save them when requested - automatically updated with any loaded settings for that key if requested - automatically updated with any changes made in its settings if requested

Parameters:

group - component settings group

key - component settings key

defaultValue - component default value

registerSettings

void registerSettings(java.lang.String group,
                      java.lang.String key)

Registers component for settings auto-save.

Also registered component will be: - listened for settings changes to save them when requested - automatically updated with any loaded settings for that key if requested - automatically updated with any changes made in its settings if requested

Parameters:

group - component settings group

key - component settings key

registerSettings

void registerSettings(java.lang.String key,
                      boolean loadInitialSettings,
                      boolean applySettingsChanges)

Registers component for settings auto-save.

Also registered component will be: - listened for settings changes to save them when requested - automatically updated with any loaded settings for that key if requested - automatically updated with any changes made in its settings if requested

Parameters:

key - component settings key

loadInitialSettings - whether to load initial available settings into the component or not

applySettingsChanges - whether to apply settings changes to the component or not

registerSettings

<T extends DefaultValue> void registerSettings(java.lang.String key,
                                               java.lang.Class<T> defaultValueClass,
                                               boolean loadInitialSettings,
                                               boolean applySettingsChanges)

Registers component for settings auto-save.

Also registered component will be: - listened for settings changes to save them when requested - automatically updated with any loaded settings for that key if requested - automatically updated with any changes made in its settings if requested

Type Parameters:

T - default value type

Parameters:

key - component settings key

defaultValueClass - component default value class

loadInitialSettings - whether to load initial available settings into the component or not

applySettingsChanges - whether to apply settings changes to the component or not

See Also:

DefaultValue

registerSettings

void registerSettings(java.lang.String key,
                      java.lang.Object defaultValue,
                      boolean loadInitialSettings,
                      boolean applySettingsChanges)

Registers component for settings auto-save.

Also registered component will be: - listened for settings changes to save them when requested - automatically updated with any loaded settings for that key if requested - automatically updated with any changes made in its settings if requested

Parameters:

key - component settings key

defaultValue - component default value

loadInitialSettings - whether to load initial available settings into the component or not

applySettingsChanges - whether to apply settings changes to the component or not

registerSettings

<T extends DefaultValue> void registerSettings(java.lang.String group,
                                               java.lang.String key,
                                               java.lang.Class<T> defaultValueClass,
                                               boolean loadInitialSettings,
                                               boolean applySettingsChanges)

Registers component for settings auto-save.

Also registered component will be: - listened for settings changes to save them when requested - automatically updated with any loaded settings for that key if requested - automatically updated with any changes made in its settings if requested

Type Parameters:

T - default value type

Parameters:

group - component settings group

key - component settings key

defaultValueClass - component default value class

loadInitialSettings - whether to load initial available settings into the component or not

applySettingsChanges - whether to apply settings changes to the component or not

See Also:

DefaultValue

registerSettings

void registerSettings(java.lang.String group,
                      java.lang.String key,
                      java.lang.Object defaultValue,
                      boolean loadInitialSettings,
                      boolean applySettingsChanges)

Registers component for settings auto-save.

Also registered component will be: - listened for settings changes to save them when requested - automatically updated with any loaded settings for that key if requested - automatically updated with any changes made in its settings if requested

Parameters:

group - component settings group

key - component settings key

defaultValue - component default value

loadInitialSettings - whether to load initial available settings into the component or not

applySettingsChanges - whether to apply settings changes to the component or not

registerSettings

void registerSettings(SettingsProcessor settingsProcessor)

Registers component for settings auto-save.

Also registered component will be: - listened for settings changes to save them when requested - automatically updated with any loaded settings for that key if requested - automatically updated with any changes made in its settings if requested

Parameters:

settingsProcessor - component settings processor

unregisterSettings

void unregisterSettings()

Unregisters component from settings auto-save.

loadSettings

void loadSettings()

Loads saved settings into the component if it is registered.

saveSettings

void saveSettings()

Saves component settings.