org.openstreetmap.josm.data.preferences

Class ColorProperty

java.lang.Object

org.openstreetmap.josm.data.preferences.AbstractProperty<T>

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

org.openstreetmap.josm.data.preferences.ColorProperty

public class ColorProperty
extends AbstractToStringProperty<java.awt.Color>

A property containing a Color value.

Since:

5464

Nested Class Summary

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

AbstractToStringProperty.ChildProperty<T>

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	name

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

defaultValue, key, preferences

Constructor Summary

Constructors

Constructor and Description
ColorProperty(java.lang.String colName, java.awt.Color defaultValue) Constructs a new ColorProperty.
ColorProperty(java.lang.String colName, java.lang.String defaultValue) Constructs a new ColorProperty.

Method Summary

Modifier and Type	Method and Description
protected java.awt.Color	fromString(java.lang.String string) Converts the string to an object of the given type.
java.awt.Color	get() Replies the value of this property.
AbstractToStringProperty<java.awt.Color>	getChildColor(java.lang.String colorName) Gets a color of which the value can be set.
static java.lang.String	getColorKey(java.lang.String colName) Replies the color key used in JOSM preferences for this property.
java.lang.String	getName() Gets the name this color was registered with.
boolean	put(java.awt.Color value) Sets this property to the specified value.
java.lang.String	toString()
protected java.lang.String	toString(java.awt.Color t) Converts the string to an object of the given type.

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

cached, getAsString, getChildProperty, getSpecialized

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

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

Methods inherited from class java.lang.Object

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

Field Detail

name

private final java.lang.String name

Constructor Detail

ColorProperty

public ColorProperty(java.lang.String colName,
                     java.lang.String defaultValue)

Constructs a new ColorProperty.

Parameters:

colName - The color name

defaultValue - The default value as HTML string

ColorProperty

public ColorProperty(java.lang.String colName,
                     java.awt.Color defaultValue)

Constructs a new ColorProperty.

Parameters:

colName - The color name

defaultValue - The default value

Method Detail

get

public java.awt.Color get()

Description copied from class: AbstractProperty

Replies the value of this property.

Overrides:

get in class AbstractToStringProperty<java.awt.Color>

Returns:

the value of this property

put

public boolean put(java.awt.Color value)

Description copied from class: AbstractProperty

Sets this property to the specified value.

Overrides:

put in class AbstractToStringProperty<java.awt.Color>

Parameters:

value - The new value of this property

Returns:

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

fromString

protected java.awt.Color fromString(java.lang.String string)

Description copied from class: AbstractToStringProperty

Converts the string to an object of the given type.

Specified by:

fromString in class AbstractToStringProperty<java.awt.Color>

Parameters:

string - The string

Returns:

The object.

toString

protected java.lang.String toString(java.awt.Color t)

Description copied from class: AbstractToStringProperty

Converts the string to an object of the given type.

Specified by:

toString in class AbstractToStringProperty<java.awt.Color>

Parameters:

t - The object.

Returns:

The string representing the object

getChildColor

public AbstractToStringProperty<java.awt.Color> getChildColor(java.lang.String colorName)

Gets a color of which the value can be set.

Parameters:

colorName - the name of the color.

Returns:

The child property that inherits this value if it is not set.

getName

public java.lang.String getName()

Gets the name this color was registered with.

Returns:

The name.

getColorKey

public static java.lang.String getColorKey(java.lang.String colName)

Replies the color key used in JOSM preferences for this property.

Parameters:

colName - The color name

Returns:

The color key for this property

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object