Package com.nomagic.magicdraw.properties

Class ColorProperty

java.lang.Object

com.nomagic.magicdraw.properties.Property

com.nomagic.magicdraw.properties.ColorProperty

All Implemented Interfaces:

PropertyVisitorAcceptor, Cloneable

@OpenApiAll
public class ColorProperty
extends Property

The property for storing and editing some Color value.

Field Summary

Fields

Modifier and Type	Field	Description
static final String	ALLOW_NONE

Fields inherited from class com.nomagic.magicdraw.properties.Property

DEFAULT_PROPERTY_RESOURCE_PROVIDER, EDITABLE, NULL, NULL_ID_PROPERTY_RESOURCE_PROVIDER, TO, UNDEFINED, VALUE, VALUE_ANNOTATIONS

Constructor Summary

Constructors

Constructor	Description
ColorProperty()	Default constructor.
ColorProperty(String id, Color value)	The property constructor.

Method Summary

Modifier and Type	Method	Description
void	accept(PropertyVisitor v)	Accepts the given visitor.
ColorProperty	clone()	Clones the property.
String	getClassType()	Returns property class type.
Color	getColor()	Returns value as color object.
static String	getStringRepresentation(Color c)
String	getValueStringRepresentation()	Returns value's string representation.
protected boolean	isValueCompatible(Object value)

Methods inherited from class com.nomagic.magicdraw.properties.Property

_getValue, _isFrozen, _setFrozen, _setValue, addAnnotation, addPropertyChangeListener, addSource, addSources, areEqualByValue, areValuesEqual, checkFrozen, checkFrozen, equals, firePropertyChange, generateDefaultDescriptionID, getAdditionalProperties, getAdditionalProperty, getAnnotation, getAnnotations, getDescription, getDescriptionID, getFirstElementFromSources, getGroup, getID, getIntroductoryVersion, getName, getNonEditableReason, getProjectFromSourcesOrActive, getPureDescription, getResourceProvider, getResourceProviderID, getSortableValueStringRepresentation, getSourceAsElement, getSources, getSourcesAsStream, getUndefinedString, getUndefinedString, getValue, hashCode, isEditable, isUndefinedState, removeAnnotation, removePropertyChangeListener, setAdditionalProperties, setAdditionalProperty, setAnnotations, setDescription, setDescriptionID, setEditable, setGroup, setID, setIntroductoryVersion, setNonEditableReason, setResourceProvider, setResourceProviderID, setSources, setUndefinedState, setValue, toString

Methods inherited from class java.lang.Object

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

Field Details

ALLOW_NONE

public static final String ALLOW_NONE

See Also:

• Constant Field Values

Constructor Details

ColorProperty

public ColorProperty()

Default constructor. Value of the property will be null. ID will be empty string.

ColorProperty

public ColorProperty(String id,
 @CheckForNull
 Color value)

The property constructor.

Parameters:

id - the ID of property.

value - the color value of the property.

Method Details

getValueStringRepresentation

public String getValueStringRepresentation()

Returns value's string representation.

Overrides:

getValueStringRepresentation in class Property

Returns:

value's string representation - "RGB [red, green, blue]". If value null, returns "".

getStringRepresentation

public static String getStringRepresentation(Color c)

isValueCompatible

protected boolean isValueCompatible(Object value)

Overrides:

isValueCompatible in class Property

Returns:

true if given object can be assigned as value to this property

accept

public void accept(PropertyVisitor v)
            throws Exception

Accepts the given visitor.

Specified by:

accept in interface PropertyVisitorAcceptor

Overrides:

accept in class Property

Parameters:

v - the PropertyVisitor.

Throws:

Exception

getColor

public Color getColor()

Returns value as color object.

Returns:

value as color.

getClassType

public String getClassType()

Returns property class type.

Specified by:

getClassType in interface PropertyVisitorAcceptor

Overrides:

getClassType in class Property

Returns:

PropertyID.COLOR_PROPERTY

See Also:

• PropertyID.COLOR_PROPERTY

clone

public ColorProperty clone()

Description copied from class: Property

Clones the property. Clone is not deep, the clone will have the same instance of value. The clone will not have registered PropertyChangeListeners.

Overrides:

clone in class Property

Returns:

the cloned property.