Package org.csstudio.opibuilder.properties

Class ActionsProperty

java.lang.Object

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

org.csstudio.opibuilder.properties.ActionsProperty

public class ActionsProperty
extends AbstractWidgetProperty<ActionsInput>

The widget property for actions.

Field Summary

Fields

Modifier and Type	Field	Description
static final String	XML_ATTRIBUTE_ACTION_TYPE	XML ATTRIBUTE name PATHSTRING.
static final String	XML_ATTRIBUTE_HOOK_ALL
static final String	XML_ATTRIBUTE_HOOK_FIRST	XML ATTRIBUTE name HOOK.
static final String	XML_ELEMENT_ACTION	XML ELEMENT name ACTION.

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

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

Constructor Summary

Constructors

Constructor	Description
ActionsProperty(String prop_id, String description, WidgetPropertyCategory category)	Widget Property Constructor
ActionsProperty(String prop_id, String description, WidgetPropertyCategory category, boolean showHookOption)	Widget Property Constructor

Method Summary

Modifier and Type	Method	Description
ActionsInput	checkValue(Object value)	Check if the requestNewValue is convertible or legal.
protected PropertyDescriptor	createPropertyDescriptor()	Create the IPropertyDescriptor
ActionsInput	readValueFromXML(org.jdom2.Element propElement)	Read the property value from a XML element.
void	setWidgetModel(AbstractWidgetModel widgetModel)
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, getPropertyValue, getRawPropertyValue, isDefaultValue, isSavable, isVisibleInPropSheet, onlyAcceptExpressionInRule, removeAllPropertyChangeListeners, removePropertyChangeListener, setCategory, setDefaultValue, setDescription, setExecutionMode, setPropertyValue, setPropertyValue, setPropertyValue_IgnoreOldValue, setSavable, setVisibleInPropSheet, toString, toStringInRuleScript

Methods inherited from class java.lang.Object

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

Field Details

XML_ELEMENT_ACTION

public static final String XML_ELEMENT_ACTION

XML ELEMENT name ACTION.

See Also:

• Constant Field Values

XML_ATTRIBUTE_ACTION_TYPE

public static final String XML_ATTRIBUTE_ACTION_TYPE

XML ATTRIBUTE name PATHSTRING.

See Also:

• Constant Field Values

XML_ATTRIBUTE_HOOK_FIRST

public static final String XML_ATTRIBUTE_HOOK_FIRST

XML ATTRIBUTE name HOOK.

See Also:

• Constant Field Values

XML_ATTRIBUTE_HOOK_ALL

public static final String XML_ATTRIBUTE_HOOK_ALL

See Also:

• Constant Field Values

Constructor Details

ActionsProperty

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

Widget Property Constructor

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.

ActionsProperty

public ActionsProperty(String prop_id,
 String description,
 WidgetPropertyCategory category,
 boolean showHookOption)

Widget Property Constructor

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.

showHookOption - true if the hook option is visible in the dialog.

Method Details

checkValue

public ActionsInput checkValue(Object value)

Description copied from class: AbstractWidgetProperty

Check if the requestNewValue is convertible or legal.

Specified by:

checkValue in class AbstractWidgetProperty<ActionsInput>

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

readValueFromXML

public ActionsInput readValueFromXML(org.jdom2.Element propElement)

Description copied from class: AbstractWidgetProperty

Read the property value from a XML element.

Specified by:

readValueFromXML in class AbstractWidgetProperty<ActionsInput>

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

setWidgetModel

public void setWidgetModel(AbstractWidgetModel widgetModel)

Overrides:

setWidgetModel in class AbstractWidgetProperty<ActionsInput>