Package org.csstudio.opibuilder.properties

Class RulesProperty

java.lang.Object

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

org.csstudio.opibuilder.properties.RulesProperty

public class RulesProperty
extends AbstractWidgetProperty<RulesInput>

The property for rules.

Field Summary

Fields

Modifier and Type	Field	Description
static final String	XML_ATTRIBUTE_BOOLEXP	XML ATTRIBUTE name BOOLEXP.
static final String	XML_ATTRIBUTE_NAME	XML ATTRIBUTE name NAME.
static final String	XML_ATTRIBUTE_OUTPUTEXPRESSION	XML ATTRIBUTE name OUTPUTEXPRESSION.
static final String	XML_ATTRIBUTE_PROPID	XML ATTRIBUTE name PROPID.
static final String	XML_ATTRIBUTE_TRIGGER
static final String	XML_ELEMENT_EXPRESSION	XML ELEMENT name EXPRESSION.
static final String	XML_ELEMENT_PV	XML Element name PV.
static final String	XML_ELEMENT_RULE	XML ELEMENT name RULE.
static final String	XML_ELEMENT_VALUE	XML ELEMENT name VALUE.

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

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

Constructor Summary

Constructors

Constructor	Description
RulesProperty(String prop_id, String description, WidgetPropertyCategory category)	Rules Property Constructor.

Method Summary

Modifier and Type	Method	Description
RulesInput	checkValue(Object value)	Check if the requestNewValue is convertible or legal.
protected PropertyDescriptor	createPropertyDescriptor()	Create the IPropertyDescriptor
RulesInput	getPropertyValue()
RulesInput	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, configurableByRule, firePropertyChange, getAllPropertyChangeListeners, getCategory, getDefaultValue, getDescription, getExecutionMode, getPropertyDescriptor, getPropertyID, getRawPropertyValue, isDefaultValue, isSavable, isVisibleInPropSheet, onlyAcceptExpressionInRule, 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_RULE

public static final String XML_ELEMENT_RULE

XML ELEMENT name RULE.

See Also:

• Constant Field Values

XML_ATTRIBUTE_NAME

public static final String XML_ATTRIBUTE_NAME

XML ATTRIBUTE name NAME.

See Also:

• Constant Field Values

XML_ATTRIBUTE_PROPID

public static final String XML_ATTRIBUTE_PROPID

XML ATTRIBUTE name PROPID.

See Also:

• Constant Field Values

XML_ATTRIBUTE_OUTPUTEXPRESSION

public static final String XML_ATTRIBUTE_OUTPUTEXPRESSION

XML ATTRIBUTE name OUTPUTEXPRESSION.

See Also:

• Constant Field Values

XML_ELEMENT_EXPRESSION

public static final String XML_ELEMENT_EXPRESSION

XML ELEMENT name EXPRESSION.

See Also:

• Constant Field Values

XML_ATTRIBUTE_BOOLEXP

public static final String XML_ATTRIBUTE_BOOLEXP

XML ATTRIBUTE name BOOLEXP.

See Also:

• Constant Field Values

XML_ELEMENT_VALUE

public static final String XML_ELEMENT_VALUE

XML ELEMENT name VALUE.

See Also:

• Constant Field Values

XML_ELEMENT_PV

public static final String XML_ELEMENT_PV

XML Element name PV.

See Also:

• Constant Field Values

XML_ATTRIBUTE_TRIGGER

public static final String XML_ATTRIBUTE_TRIGGER

See Also:

• Constant Field Values

Constructor Details

RulesProperty

public RulesProperty(String prop_id,
 String description,
 WidgetPropertyCategory category)

Rules Property Constructor. The property value type is RulesInput.

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.

Method Details

checkValue

public RulesInput checkValue(Object value)

Description copied from class: AbstractWidgetProperty

Check if the requestNewValue is convertible or legal.

Specified by:

checkValue in class AbstractWidgetProperty<RulesInput>

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.

getPropertyValue

public RulesInput getPropertyValue()

Overrides:

getPropertyValue in class AbstractWidgetProperty<RulesInput>

createPropertyDescriptor

protected PropertyDescriptor createPropertyDescriptor()

Description copied from class: AbstractWidgetProperty

Create the IPropertyDescriptor

Specified by:

createPropertyDescriptor in class AbstractWidgetProperty<RulesInput>

readValueFromXML

public RulesInput readValueFromXML(org.jdom2.Element propElement)
                            throws Exception

Description copied from class: AbstractWidgetProperty

Read the property value from a XML element.

Specified by:

readValueFromXML in class AbstractWidgetProperty<RulesInput>

Throws:

Exception

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