org.openstreetmap.josm.data.preferences

Class NamedColorProperty

java.lang.Object

org.openstreetmap.josm.data.preferences.AbstractProperty<java.awt.Color>

org.openstreetmap.josm.data.preferences.NamedColorProperty

public class NamedColorProperty
extends AbstractProperty<java.awt.Color>

A property containing a Color value with additional information associated to it. The additional information is used to describe the color in the ColorPreference, so it can be recognized and customized by the user.

Since:

12987

Nested Class Summary

Nested classes/interfaces inherited from class org.openstreetmap.josm.data.preferences.AbstractProperty

AbstractProperty.InvalidPreferenceValueException, AbstractProperty.ValueChangeEvent<T>, AbstractProperty.ValueChangeListener<T>

Field Summary

Fields

Modifier and Type	Field and Description
private java.lang.String	category
static java.lang.String	COLOR_CATEGORY_GENERAL
static java.lang.String	COLOR_CATEGORY_LAYER
static java.lang.String	COLOR_CATEGORY_MAPPAINT
private java.lang.String	name
static java.lang.String	NAMED_COLOR_PREFIX
private java.lang.String	source

Fields inherited from class org.openstreetmap.josm.data.preferences.AbstractProperty

defaultValue, key, preferences

Constructor Summary

Constructors

Constructor and Description
NamedColorProperty(java.lang.String name, java.awt.Color defaultValue) Construct a new NamedColorProperty.
NamedColorProperty(java.lang.String category, java.lang.String source, java.lang.String name, java.awt.Color defaultValue) Construct a new NamedColorProperty.

Method Summary

Modifier and Type	Method and Description
java.awt.Color	get() Replies the value of this property.
java.lang.String	getCategory() Get the category for this color.
FallbackProperty<java.awt.Color>	getChildColor(java.lang.String name) Return a more specialized color, that will fall back to this color, if not set explicitly.
FallbackProperty<java.awt.Color>	getChildColor(java.lang.String category, java.lang.String source, java.lang.String name) Return a more specialized color, that will fall back to this color, if not set explicitly.
private java.util.List<java.lang.String>	getDefaultValuePref()
private static java.lang.String	getKey(java.lang.String category, java.lang.String source, java.lang.String name)
java.lang.String	getName() Get the color name (a short description of the color).
java.lang.String	getSource() Get the source, i.e. a filename or layer name associated with the color.
private static java.util.List<java.lang.String>	getValuePref(java.awt.Color color, java.lang.String category, java.lang.String source, java.lang.String name)
boolean	isSet() Determines if this property is currently set in JOSM preferences.
boolean	put(java.awt.Color value) Sets this property to the specified value.

Methods inherited from class org.openstreetmap.josm.data.preferences.AbstractProperty

addListener, addListenerImpl, addWeakListener, cached, equals, getDefaultValue, getKey, getPreferences, hashCode, remove, removeListener, removeListenerImpl, storeDefaultValue

Methods inherited from class java.lang.Object

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

Field Detail

NAMED_COLOR_PREFIX

public static final java.lang.String NAMED_COLOR_PREFIX

See Also:

Constant Field Values

COLOR_CATEGORY_GENERAL

public static final java.lang.String COLOR_CATEGORY_GENERAL

See Also:

Constant Field Values

COLOR_CATEGORY_MAPPAINT

public static final java.lang.String COLOR_CATEGORY_MAPPAINT

See Also:

Constant Field Values

COLOR_CATEGORY_LAYER

public static final java.lang.String COLOR_CATEGORY_LAYER

See Also:

Constant Field Values

category

private final java.lang.String category

source

private final java.lang.String source

name

private final java.lang.String name

Constructor Detail

NamedColorProperty

public NamedColorProperty(java.lang.String category,
                          java.lang.String source,
                          java.lang.String name,
                          java.awt.Color defaultValue)

Construct a new NamedColorProperty.

Parameters:

category - a category, can be any identifier, but the following values are recognized by the GUI preferences: COLOR_CATEGORY_GENERAL, COLOR_CATEGORY_MAPPAINT and COLOR_CATEGORY_LAYER

source - a filename or similar associated with the color, can be null if not applicable

name - a short description of the color

defaultValue - the default value, can be null

NamedColorProperty

public NamedColorProperty(java.lang.String name,
                          java.awt.Color defaultValue)

Construct a new NamedColorProperty.

Parameters:

name - a short description of the color

defaultValue - the default value, can be null

Method Detail

getKey

private static java.lang.String getKey(java.lang.String category,
                                       java.lang.String source,
                                       java.lang.String name)

getDefaultValuePref

private java.util.List<java.lang.String> getDefaultValuePref()

get

public java.awt.Color get()

Description copied from class: AbstractProperty

Replies the value of this property.

Specified by:

get in class AbstractProperty<java.awt.Color>

Returns:

the value of this property

isSet

public boolean isSet()

Description copied from class: AbstractProperty

Determines if this property is currently set in JOSM preferences.

Overrides:

isSet in class AbstractProperty<java.awt.Color>

Returns:

true if getPreferences() contains this property.

getCategory

public java.lang.String getCategory()

Get the category for this color.

Returns:

the category

getSource

public java.lang.String getSource()

Get the source, i.e. a filename or layer name associated with the color. May return null if not applicable.

Returns:

the source

getName

public java.lang.String getName()

Get the color name (a short description of the color).

Returns:

the color name

getValuePref

private static java.util.List<java.lang.String> getValuePref(java.awt.Color color,
                                                             java.lang.String category,
                                                             java.lang.String source,
                                                             java.lang.String name)

put

public boolean put(java.awt.Color value)

Description copied from class: AbstractProperty

Sets this property to the specified value.

Specified by:

put in class AbstractProperty<java.awt.Color>

Parameters:

value - The new value of this property

Returns:

true if something has changed (i.e. value is different than before)

getChildColor

public FallbackProperty<java.awt.Color> getChildColor(java.lang.String category,
                                                      java.lang.String source,
                                                      java.lang.String name)

Return a more specialized color, that will fall back to this color, if not set explicitly.

Parameters:

category - the category of the specialized color

source - the source of the specialized color

name - the name of the specialized color

Returns:

a FallbackProperty that will the return the specialized color, if set, but fall back to this property as default value

getChildColor

public FallbackProperty<java.awt.Color> getChildColor(java.lang.String name)

Return a more specialized color, that will fall back to this color, if not set explicitly.

Parameters:

name - the name of the specialized color

Returns:

a FallbackProperty that will the return the specialized color, if set, but fall back to this property as default value