Package org.csstudio.opibuilder.properties

Class ScriptProperty

java.lang.Object

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

org.csstudio.opibuilder.properties.ScriptProperty

public class ScriptProperty
extends AbstractWidgetProperty<ScriptsInput>

The property for script.

Field Summary

Fields

Modifier and Type	Field	Description
static final String	EMBEDDEDJS
static final String	EMBEDDEDPY
static final String	XML_ATTRIBUTE_CHECKCONNECT
static final String	XML_ATTRIBUTE_PATHSTRING	XML ATTRIBUTE name PATHSTRING.
static final String	XML_ATTRIBUTE_STOP_EXECUTE_ON_ERROR
static final String	XML_ATTRIBUTE_TRIGGER
static final String	XML_ELEMENT_PATH	XML ELEMENT name PATH.
static final String	XML_ELEMENT_PV	XML Element name PV.
static final String	XML_ELEMENT_SCRIPT_TEXT

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

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

Constructor Summary

Constructors

Constructor	Description
ScriptProperty(String prop_id, String description, WidgetPropertyCategory category)	Script Property Constructor.

Method Summary

Modifier and Type	Method	Description
ScriptsInput	checkValue(Object value)	Check if the requestNewValue is convertible or legal.
protected PropertyDescriptor	createPropertyDescriptor()	Create the IPropertyDescriptor
ScriptsInput	getPropertyValue()
ScriptsInput	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_PATH

public static final String XML_ELEMENT_PATH

XML ELEMENT name PATH.

See Also:

• Constant Field Values

XML_ATTRIBUTE_PATHSTRING

public static final String XML_ATTRIBUTE_PATHSTRING

XML ATTRIBUTE name PATHSTRING.

See Also:

• Constant Field Values

XML_ATTRIBUTE_CHECKCONNECT

public static final String XML_ATTRIBUTE_CHECKCONNECT

See Also:

• Constant Field Values

XML_ATTRIBUTE_STOP_EXECUTE_ON_ERROR

public static final String XML_ATTRIBUTE_STOP_EXECUTE_ON_ERROR

See Also:

• Constant Field Values

EMBEDDEDJS

public static final String EMBEDDEDJS

See Also:

• Constant Field Values

EMBEDDEDPY

public static final String EMBEDDEDPY

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

XML_ELEMENT_SCRIPT_TEXT

public static final String XML_ELEMENT_SCRIPT_TEXT

See Also:

• Constant Field Values

Constructor Details

ScriptProperty

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

Script Property Constructor. The property value type is ScriptsInput.

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 ScriptsInput checkValue(Object value)

Description copied from class: AbstractWidgetProperty

Check if the requestNewValue is convertible or legal.

Specified by:

checkValue in class AbstractWidgetProperty<ScriptsInput>

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 ScriptsInput getPropertyValue()

Overrides:

getPropertyValue in class AbstractWidgetProperty<ScriptsInput>

createPropertyDescriptor

protected PropertyDescriptor createPropertyDescriptor()

Description copied from class: AbstractWidgetProperty

Create the IPropertyDescriptor

Specified by:

createPropertyDescriptor in class AbstractWidgetProperty<ScriptsInput>

readValueFromXML

public ScriptsInput readValueFromXML(org.jdom2.Element propElement)

Description copied from class: AbstractWidgetProperty

Read the property value from a XML element.

Specified by:

readValueFromXML in class AbstractWidgetProperty<ScriptsInput>

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