Package org.csstudio.opibuilder.properties

Class PVValueProperty

java.lang.Object

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

org.csstudio.opibuilder.properties.PVValueProperty

public class PVValueProperty
extends AbstractWidgetProperty<VType>

The property which contains a IValue. This property won't be shown in property view.

Field Summary

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

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

Constructor Summary

Constructors

Constructor	Description
PVValueProperty(String prop_id, VType defaultValue)	The property is used to store pv values.

Method Summary

Modifier and Type	Method	Description
VType	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.
VType	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

Constructor Details

PVValueProperty

public PVValueProperty(String prop_id,
 VType defaultValue)

The property is used to store pv values. The value type is VType.

Parameters:

prop_id - the property ID.

defaultValue - the default value.

Method Details

checkValue

public VType checkValue(Object value)

Description copied from class: AbstractWidgetProperty

Check if the requestNewValue is convertible or legal.

Specified by:

checkValue in class AbstractWidgetProperty<VType>

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

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

readValueFromXML

public VType readValueFromXML(org.jdom2.Element propElement)

Description copied from class: AbstractWidgetProperty

Read the property value from a XML element.

Specified by:

readValueFromXML in class AbstractWidgetProperty<VType>

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

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

Returns:

true if this property only accept output expression.