Package org.csstudio.opibuilder.properties

Class MacrosProperty

java.lang.Object

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

org.csstudio.opibuilder.properties.MacrosProperty

public class MacrosProperty
extends AbstractWidgetProperty<MacrosInput>

The property for macros.

Field Summary

Fields

Modifier and Type	Field	Description
static final String	XML_ELEMENT_INCLUDE_PARENT_MACROS	XML ELEMENT name INCLUDE_PARENT_MACROS.

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

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

Constructor Summary

Constructors

Constructor	Description
MacrosProperty(String prop_id, String description, WidgetPropertyCategory category, MacrosInput default_macros)	Macros Property Constructor.

Method Summary

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

public static final String XML_ELEMENT_INCLUDE_PARENT_MACROS

XML ELEMENT name INCLUDE_PARENT_MACROS.

See Also:

• Constant Field Values

Constructor Details

MacrosProperty

public MacrosProperty(String prop_id,
 String description,
 WidgetPropertyCategory category,
 MacrosInput default_macros)

Macros Property Constructor. The property value type is MacrosInput.

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.

default_macros - the default macros when the widget is first created.

Method Details

checkValue

public MacrosInput checkValue(Object value)

Description copied from class: AbstractWidgetProperty

Check if the requestNewValue is convertible or legal.

Specified by:

checkValue in class AbstractWidgetProperty<MacrosInput>

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

Overrides:

getPropertyValue in class AbstractWidgetProperty<MacrosInput>

createPropertyDescriptor

protected PropertyDescriptor createPropertyDescriptor()

Description copied from class: AbstractWidgetProperty

Create the IPropertyDescriptor

Specified by:

createPropertyDescriptor in class AbstractWidgetProperty<MacrosInput>

readValueFromXML

public MacrosInput readValueFromXML(org.jdom2.Element propElement)

Description copied from class: AbstractWidgetProperty

Read the property value from a XML element.

Specified by:

readValueFromXML in class AbstractWidgetProperty<MacrosInput>

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