Package org.csstudio.opibuilder.widgets.properties

Class ColorMapProperty

java.lang.Object

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

org.csstudio.opibuilder.widgets.properties.ColorMapProperty

public class ColorMapProperty
extends AbstractWidgetProperty<ColorMap>

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_RED	XML attribute name red.
static final String	XML_ELEMENT_AUTOSCALE	XML Element name AUTOSCALE.
static final String	XML_ELEMENT_E	XML ELEMENT name MAP.
static final String	XML_ELEMENT_INTERPOLATE	XML Element name INTERPOLATE.
static final String	XML_ELEMENT_MAP	XML ELEMENT name PREDEFINEDCOLOR.

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

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

Constructor Summary

Constructors

Constructor	Description
ColorMapProperty(String prop_id, String description, WidgetPropertyCategory category, ColorMap defaultValue)

Method Summary

Modifier and Type	Method	Description
ColorMap	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
boolean	onlyAcceptExpressionInRule()	Subclass should override this method if it only accept output expression.
ColorMap	readValueFromXML(org.jdom2.Element propElement)	Read the property value from a XML element.
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, removeAllPropertyChangeListeners, removePropertyChangeListener, setCategory, setDefaultValue, setDescription, setExecutionMode, setPropertyValue, setPropertyValue, setPropertyValue_IgnoreOldValue, setSavable, setVisibleInPropSheet, setWidgetModel, toString, toStringInRuleScript

Methods inherited from class java.lang.Object

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

Field Details

XML_ELEMENT_MAP

public static final String XML_ELEMENT_MAP

XML ELEMENT name PREDEFINEDCOLOR.

See Also:

• Constant Field Values

XML_ELEMENT_E

public static final String XML_ELEMENT_E

XML ELEMENT name MAP.

See Also:

• Constant Field Values

XML_ELEMENT_INTERPOLATE

public static final String XML_ELEMENT_INTERPOLATE

XML Element name INTERPOLATE.

See Also:

• Constant Field Values

XML_ELEMENT_AUTOSCALE

public static final String XML_ELEMENT_AUTOSCALE

XML Element name AUTOSCALE.

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

ColorMapProperty

public ColorMapProperty(String prop_id,
 String description,
 WidgetPropertyCategory category,
 ColorMap defaultValue)

Method Details

checkValue

public ColorMap checkValue(Object value)

Description copied from class: AbstractWidgetProperty

Check if the requestNewValue is convertible or legal.

Specified by:

checkValue in class AbstractWidgetProperty<ColorMap>

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<ColorMap>

readValueFromXML

public ColorMap readValueFromXML(org.jdom2.Element propElement)

Description copied from class: AbstractWidgetProperty

Read the property value from a XML element.

Specified by:

readValueFromXML in class AbstractWidgetProperty<ColorMap>

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<ColorMap>

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<ColorMap>

Returns:

true if this property is configurable by rule.

onlyAcceptExpressionInRule

public boolean onlyAcceptExpressionInRule()

Description copied from class: AbstractWidgetProperty

Subclass should override this method if it only accept output expression.

Overrides:

onlyAcceptExpressionInRule in class AbstractWidgetProperty<ColorMap>

Returns:

true if this property only accept output expression.