Package org.csstudio.opibuilder.properties

Class ColorProperty

java.lang.Object

org.csstudio.opibuilder.properties.AbstractWidgetProperty<OPIColor>

org.csstudio.opibuilder.properties.ColorProperty

public class ColorProperty
extends AbstractWidgetProperty<OPIColor>

The widget property for color.

Field Summary

Fields

Modifier and Type	Field	Description
static final String	XML_ATTRIBUTE_BLUE	XML attribute name blue.
static final String	XML_ATTRIBUTE_GREEN	XML attribute name green.
static final String	XML_ATTRIBUTE_NAME	XML attribute name color.
static final String	XML_ATTRIBUTE_RED	XML attribute name red.
static final String	XML_ELEMENT_COLOR	XML attribute name color.

Fields inherited from class org.csstudio.opibuilder.properties.AbstractWidgetProperty

category, defaultValue, description, executionMode, prop_id, propertyValue, visibleInPropSheet, widgetModel

Constructor Summary

Constructors

Constructor	Description
ColorProperty(String prop_id, String description, WidgetPropertyCategory category, String defaultValue)	Color Property Constructor.
ColorProperty(String prop_id, String description, WidgetPropertyCategory category, RGB defaultValue)	Color Property Constructor.

Method Summary

Modifier and Type	Method	Description
OPIColor	checkValue(Object value)	Check if the requestNewValue is convertible or legal.
boolean	configurableByRule()	Subclass should override this method if it is configurable by rule.
protected PropertyDescriptor	createPropertyDescriptor()	Create the IPropertyDescriptor
OPIColor	readValueFromXML(org.jdom2.Element propElement)	Read the property value from a XML element.
String	toStringInRuleScript(OPIColor opiColor)	Convert to the property value string in the script generated by rule.
void	writeToXML(org.jdom2.Element propElement)	Write the property value into a XML element.

Methods inherited from class org.csstudio.opibuilder.properties.AbstractWidgetProperty

addPropertyChangeListener, firePropertyChange, getAllPropertyChangeListeners, getCategory, getDefaultValue, getDescription, getExecutionMode, getPropertyDescriptor, getPropertyID, getPropertyValue, getRawPropertyValue, isDefaultValue, isSavable, isVisibleInPropSheet, onlyAcceptExpressionInRule, removeAllPropertyChangeListeners, removePropertyChangeListener, setCategory, setDefaultValue, setDescription, setExecutionMode, setPropertyValue, setPropertyValue, setPropertyValue_IgnoreOldValue, setSavable, setVisibleInPropSheet, setWidgetModel, toString

Methods inherited from class java.lang.Object

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

Field Details

XML_ELEMENT_COLOR

public static final String XML_ELEMENT_COLOR

XML attribute name color.

See Also:

• Constant Field Values

XML_ATTRIBUTE_NAME

public static final String XML_ATTRIBUTE_NAME

XML attribute name color.

See Also:

• Constant Field Values

XML_ATTRIBUTE_RED

public static final String XML_ATTRIBUTE_RED

XML attribute name red.

See Also:

• Constant Field Values

XML_ATTRIBUTE_GREEN

public static final String XML_ATTRIBUTE_GREEN

XML attribute name green.

See Also:

• Constant Field Values

XML_ATTRIBUTE_BLUE

public static final String XML_ATTRIBUTE_BLUE

XML attribute name blue.

See Also:

• Constant Field Values

Constructor Details

ColorProperty

public ColorProperty(String prop_id,
 String description,
 WidgetPropertyCategory category,
 RGB defaultValue)

Color Property Constructor. The property value type is OPIColor.

Parameters:

prop_id - the property id which should be unique in a widget model.

description - the description of the property, which will be shown as the property name in property sheet.

category - the category of the widget.

defaultValue - the default value when the widget is first created.

ColorProperty

public ColorProperty(String prop_id,
 String description,
 WidgetPropertyCategory category,
 String defaultValue)

Color Property Constructor. The property value type is OPIColor.

Parameters:

prop_id - the property id which should be unique in a widget model.

description - the description of the property, which will be shown as the property name in property sheet.

category - the category of the widget.

defaultValue - the default value when the widget is first created. It must be a color macro name in color file.

Method Details

checkValue

public OPIColor checkValue(Object value)

Description copied from class: AbstractWidgetProperty

Check if the requestNewValue is convertible or legal.

Specified by:

checkValue in class AbstractWidgetProperty<OPIColor>

Parameters:

value - the value to be checked.

Returns:

The value after being checked. It might be coerced if the requestValue is illegal. return null if it is not convertible or illegal.

createPropertyDescriptor

protected PropertyDescriptor createPropertyDescriptor()

Description copied from class: AbstractWidgetProperty

Create the IPropertyDescriptor

Specified by:

createPropertyDescriptor in class AbstractWidgetProperty<OPIColor>

writeToXML

public void writeToXML(org.jdom2.Element propElement)

Description copied from class: AbstractWidgetProperty

Write the property value into a XML element.

Specified by:

writeToXML in class AbstractWidgetProperty<OPIColor>

readValueFromXML

public OPIColor readValueFromXML(org.jdom2.Element propElement)

Description copied from class: AbstractWidgetProperty

Read the property value from a XML element.

Specified by:

readValueFromXML in class AbstractWidgetProperty<OPIColor>

configurableByRule

public boolean configurableByRule()

Description copied from class: AbstractWidgetProperty

Subclass should override this method if it is configurable by rule. If this returns true, the method AbstractWidgetProperty.toStringInRuleScript(Object) should be properly overridden too.

Overrides:

configurableByRule in class AbstractWidgetProperty<OPIColor>

Returns:

true if this property is configurable by rule.

toStringInRuleScript

public String toStringInRuleScript(OPIColor opiColor)

Description copied from class: AbstractWidgetProperty

Convert to the property value string in the script generated by rule.

Overrides:

toStringInRuleScript in class AbstractWidgetProperty<OPIColor>