com.alee.managers.settings

Class SettingsProcessorData

java.lang.Object

com.alee.managers.settings.SettingsProcessorData

public class SettingsProcessorData
extends java.lang.Object

Base data class for any SettingsProcessor.

See Also:

How to use SettingsManager, SettingsManager, ComponentSettingsManager, SettingsProcessor

Constructor Summary

Constructors

Constructor and Description
SettingsProcessorData() Constructs empty SettingsProcessorData.
SettingsProcessorData(javax.swing.JComponent component, java.lang.String group, java.lang.String key, java.lang.Object defaultValue, boolean loadInitialSettings, boolean applySettingsChanges) Constructs SettingsProcessorData with the specified data.

Method Summary

Modifier and Type	Method and Description
javax.swing.JComponent	getComponent() Returns component which settings are being managed.
java.lang.Object	getDefaultValue() Returns component default value.
java.lang.String	getGroup() Returns component settings group.
java.lang.String	getKey() Returns component settings key.
boolean	isApplySettingsChanges() Returns whether settings changes should be applied to the component or not.
boolean	isLoadInitialSettings() Returns whether initial available settings should be loaded into the component or not.
void	setApplySettingsChanges(boolean applySettingsChanges) Sets whether to apply settings changes to the component or not.
void	setComponent(javax.swing.JComponent component) Sets component which settings are being managed.
void	setDefaultValue(java.lang.Object defaultValue) Sets component default value.
void	setGroup(java.lang.String group) Sets component settings group.
void	setKey(java.lang.String key) Sets component settings key.
void	setLoadInitialSettings(boolean loadInitialSettings) Sets whether to load initial available settings into the component or not.

Methods inherited from class java.lang.Object

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

Constructor Detail

SettingsProcessorData

public SettingsProcessorData()

Constructs empty SettingsProcessorData.

SettingsProcessorData

public SettingsProcessorData(javax.swing.JComponent component,
                             java.lang.String group,
                             java.lang.String key,
                             java.lang.Object defaultValue,
                             boolean loadInitialSettings,
                             boolean applySettingsChanges)

Constructs SettingsProcessorData with the specified data.

Parameters:

component - component which settings are being managed

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

Method Detail

getComponent

public javax.swing.JComponent getComponent()

Returns component which settings are being managed.

Returns:

component which settings are being managed

setComponent

public void setComponent(javax.swing.JComponent component)

Sets component which settings are being managed.

Parameters:

component - component which settings are being managed

getGroup

public java.lang.String getGroup()

Returns component settings group.

Returns:

component settings group

setGroup

public void setGroup(java.lang.String group)

Sets component settings group.

Parameters:

group - component settings group

getKey

public java.lang.String getKey()

Returns component settings key.

Returns:

component settings key

setKey

public void setKey(java.lang.String key)

Sets component settings key.

Parameters:

key - component settings key

getDefaultValue

public java.lang.Object getDefaultValue()

Returns component default value.

Returns:

component default value

setDefaultValue

public void setDefaultValue(java.lang.Object defaultValue)

Sets component default value.

Parameters:

defaultValue - component default value

isLoadInitialSettings

public boolean isLoadInitialSettings()

Returns whether initial available settings should be loaded into the component or not.

Returns:

true if initial available settings should be loaded into the component, false otherwise

setLoadInitialSettings

public void setLoadInitialSettings(boolean loadInitialSettings)

Sets whether to load initial available settings into the component or not.

Parameters:

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

isApplySettingsChanges

public boolean isApplySettingsChanges()

Returns whether settings changes should be applied to the component or not.

Returns:

true if settings changes should be applied to the component, false otherwise

setApplySettingsChanges

public void setApplySettingsChanges(boolean applySettingsChanges)

Sets whether to apply settings changes to the component or not.

Parameters:

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