de.caff.util.settings.swing

Class SwingLongPreferenceProperty

java.lang.Object

de.caff.util.settings.AbstractBasicChangeableItem

de.caff.util.settings.AbstractBasicLocalizableChangeableItem

de.caff.util.settings.swing.AbstractBasicSimpleEditableChangeableItem

de.caff.util.settings.swing.SwingNumberProperty

de.caff.util.settings.swing.SwingLongPreferenceProperty

All Implemented Interfaces:

ChangeableItem, LongPreferenceProperty, PreferenceProperty, Property<java.lang.Long>, EditablePreferenceProperty, EditableProperty, java.io.Serializable

public class SwingLongPreferenceProperty
extends SwingNumberProperty
implements LongPreferenceProperty, EditablePreferenceProperty

Editable long preference property.

Author:

Rammi

See Also:

Serialized Form

Field Summary

Fields inherited from interface de.caff.util.settings.PreferenceProperty

PROPERTY_VALUE

Constructor Summary

Constructors

Constructor and Description
SwingLongPreferenceProperty(java.lang.String basicName, java.lang.String baseTag, long value) Create a integer preference property with maximum range, step 1 and the given default value.
SwingLongPreferenceProperty(java.lang.String basicName, java.lang.String baseTag, long value, boolean autoSave) Create a integer preference property with maximum range, step 1 and the given default value.
SwingLongPreferenceProperty(java.lang.String basicName, java.lang.String baseTag, long value, long step) Create a integer preference property with maximum range, step and the given default value.
SwingLongPreferenceProperty(java.lang.String basicName, java.lang.String baseTag, long value, long step, boolean autoSave) Create a integer preference property with maximum range, step and the given default value.
SwingLongPreferenceProperty(java.lang.String basicName, java.lang.String baseTag, long value, long minValue, long maxValue) Create a integer preference property with the given range, step 1 and the given default value.
SwingLongPreferenceProperty(java.lang.String basicName, java.lang.String baseTag, long value, long minValue, long maxValue, boolean autoSave) Create a integer preference property with the given range, step 1 and the given default value.
SwingLongPreferenceProperty(java.lang.String basicName, java.lang.String baseTag, long value, long minValue, long maxValue, long step) Create a integer preference property with the given range, step and the given default value.
SwingLongPreferenceProperty(java.lang.String basicName, java.lang.String baseTag, long value, long minValue, long maxValue, long step, boolean autoSave) Create a integer preference property with the given range, step and the given default value.

Method Summary

Modifier and Type	Method and Description
long	getMaxValue() Get the maximal allowed value.
java.lang.Number	getMaxValueNumber() Get the maximal allowed value.
long	getMinValue() Get the minimal allowed value.
java.lang.Number	getMinValueNumber() Get the minimal allowed value.
long	getStep() Get the step used in steppers.
java.lang.Number	getStepNumber() Get the step used in steppers.
java.lang.Long	getValue() Get the property's value.
java.lang.Number	getValueNumber() Get the properties value.
void	readFrom(java.util.prefs.Preferences preferences) Read the property value from the preferences.
void	setValue(long value) Set the property's value.
void	setValue(java.lang.Long value) Set the property's value.
void	setValueNumber(java.lang.Number value) Set the property value.
void	storeTo(java.util.prefs.Preferences preferences) Store the current property value in the preferences.

Methods inherited from class de.caff.util.settings.swing.SwingNumberProperty

getEditorProvider

Methods inherited from class de.caff.util.settings.AbstractBasicLocalizableChangeableItem

getBaseTag, getLabelString, getMenuString, getName, getString

Methods inherited from class de.caff.util.settings.AbstractBasicChangeableItem

addValueChangeListener, addValueChangeListenerWeakly, firePropertyChange, fireValueChange, fireValueChange, fireValueChange, getBasicName, getPropertyName, removeValueChangeListener, removeValueChangeListenerWeakly

Methods inherited from class java.lang.Object

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

Methods inherited from interface de.caff.util.settings.swing.EditableProperty

getEditorProvider, getName

Methods inherited from interface de.caff.util.settings.ChangeableItem

addValueChangeListener, addValueChangeListenerWeakly, removeValueChangeListener, removeValueChangeListenerWeakly

Constructor Detail

SwingLongPreferenceProperty

public SwingLongPreferenceProperty(@NotNull
                                   java.lang.String basicName,
                                   @NotNull
                                   java.lang.String baseTag,
                                   long value)

Create a integer preference property with maximum range, step 1 and the given default value.

Parameters:

basicName - property name

baseTag - basic i18n tag

value - default value

SwingLongPreferenceProperty

public SwingLongPreferenceProperty(@NotNull
                                   java.lang.String basicName,
                                   @NotNull
                                   java.lang.String baseTag,
                                   long value,
                                   boolean autoSave)

Create a integer preference property with maximum range, step 1 and the given default value.

Parameters:

basicName - property name

baseTag - basic i18n tag

value - default value

autoSave - save changes immediately?

SwingLongPreferenceProperty

public SwingLongPreferenceProperty(@NotNull
                                   java.lang.String basicName,
                                   @NotNull
                                   java.lang.String baseTag,
                                   long value,
                                   long step)

Create a integer preference property with maximum range, step and the given default value.

Parameters:

basicName - property name

baseTag - basic i18n tag

value - default value

step - step to be used for value when stepping

SwingLongPreferenceProperty

public SwingLongPreferenceProperty(@NotNull
                                   java.lang.String basicName,
                                   @NotNull
                                   java.lang.String baseTag,
                                   long value,
                                   long step,
                                   boolean autoSave)

Create a integer preference property with maximum range, step and the given default value.

Parameters:

basicName - property name

baseTag - basic i18n tag

value - default value

step - step to be used for value when stepping

autoSave - save changes immediately?

SwingLongPreferenceProperty

public SwingLongPreferenceProperty(@NotNull
                                   java.lang.String basicName,
                                   @NotNull
                                   java.lang.String baseTag,
                                   long value,
                                   long minValue,
                                   long maxValue)

Create a integer preference property with the given range, step 1 and the given default value.

Parameters:

basicName - property name

baseTag - basic i18n tag

value - default value

minValue - minimal allowed value (included)

maxValue - maximal allowed value (included)

SwingLongPreferenceProperty

public SwingLongPreferenceProperty(@NotNull
                                   java.lang.String basicName,
                                   @NotNull
                                   java.lang.String baseTag,
                                   long value,
                                   long minValue,
                                   long maxValue,
                                   boolean autoSave)

Create a integer preference property with the given range, step 1 and the given default value.

Parameters:

basicName - property name

baseTag - basic i18n tag

value - default value

minValue - minimal allowed value (included)

maxValue - maximal allowed value (included)

autoSave - save changes immediately?

SwingLongPreferenceProperty

public SwingLongPreferenceProperty(@NotNull
                                   java.lang.String basicName,
                                   @NotNull
                                   java.lang.String baseTag,
                                   long value,
                                   long minValue,
                                   long maxValue,
                                   long step)

Create a integer preference property with the given range, step and the given default value.

Parameters:

basicName - property name

baseTag - basic i18n tag

value - default value

minValue - minimal allowed value (included)

maxValue - maximal allowed value (included)

step - step to be used for value when stepping

SwingLongPreferenceProperty

public SwingLongPreferenceProperty(@NotNull
                                   java.lang.String basicName,
                                   @NotNull
                                   java.lang.String baseTag,
                                   long value,
                                   long minValue,
                                   long maxValue,
                                   long step,
                                   boolean autoSave)

Create a integer preference property with the given range, step and the given default value.

Parameters:

basicName - property name

baseTag - basic i18n tag

value - default value

minValue - minimal allowed value (included)

maxValue - maximal allowed value (included)

step - step to be used for value when stepping

autoSave - save changes immediately?

Method Detail

readFrom

public void readFrom(@NotNull
                     java.util.prefs.Preferences preferences)

Read the property value from the preferences.

Specified by:

readFrom in interface PreferenceProperty

Parameters:

preferences - preferences from where to read the property value

storeTo

public void storeTo(@NotNull
                    java.util.prefs.Preferences preferences)

Store the current property value in the preferences.

Specified by:

storeTo in interface PreferenceProperty

Parameters:

preferences - preferences where to store the property value

getMinValue

public long getMinValue()

Get the minimal allowed value.

Returns:

minimal value

getMaxValue

public long getMaxValue()

Get the maximal allowed value.

Returns:

maximal value

getStep

public long getStep()

Get the step used in steppers.

Returns:

step

getValue

@NotNull
public java.lang.Long getValue()

Get the property's value.

Specified by:

getValue in interface Property<java.lang.Long>

Returns:

property value

setValue

public void setValue(long value)

Set the property's value.

Parameters:

value - value to set

setValue

public void setValue(@NotNull
                     java.lang.Long value)

Set the property's value.

Specified by:

setValue in interface Property<java.lang.Long>

Parameters:

value - new value

getMinValueNumber

@NotNull
public java.lang.Number getMinValueNumber()

Get the minimal allowed value.

Specified by:

getMinValueNumber in class SwingNumberProperty

Returns:

minimal value

getMaxValueNumber

@NotNull
public java.lang.Number getMaxValueNumber()

Get the maximal allowed value.

Specified by:

getMaxValueNumber in class SwingNumberProperty

Returns:

maximal value

getStepNumber

@NotNull
public java.lang.Number getStepNumber()

Get the step used in steppers.

Specified by:

getStepNumber in class SwingNumberProperty

Returns:

step

getValueNumber

@NotNull
public java.lang.Number getValueNumber()

Get the properties value.

Specified by:

getValueNumber in class SwingNumberProperty

Returns:

property value

setValueNumber

public void setValueNumber(@NotNull
                           java.lang.Number value)

Set the property value.

Specified by:

setValueNumber in class SwingNumberProperty

Parameters:

value - new value