Package org.csstudio.opibuilder.properties

Class ComplexDataProperty

java.lang.Object

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

org.csstudio.opibuilder.properties.ComplexDataProperty

public class ComplexDataProperty
extends AbstractWidgetProperty<AbstractComplexData>

A property that can hold data with multiple properties.

Field Summary

Fields

Modifier and Type	Field	Description
static final String	XML_ATTRIBUTE_TYPE

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

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

Constructor Summary

Constructors

Constructor	Description
ComplexDataProperty(String prop_id, String description, WidgetPropertyCategory category, AbstractComplexData defaultData, String dialogTitle)	Widget Property Constructor

Method Summary

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

public static final String XML_ATTRIBUTE_TYPE

See Also:

• Constant Field Values

Constructor Details

ComplexDataProperty

public ComplexDataProperty(String prop_id,
 String description,
 WidgetPropertyCategory category,
 AbstractComplexData defaultData,
 String dialogTitle)

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.

defaultData - default value. It cannot be null.

dialogTitle - title of the dialog for editing the complex data.

Method Details

checkValue

public AbstractComplexData checkValue(Object value)

Description copied from class: AbstractWidgetProperty

Check if the requestNewValue is convertible or legal.

Specified by:

checkValue in class AbstractWidgetProperty<AbstractComplexData>

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

readValueFromXML

public AbstractComplexData readValueFromXML(org.jdom2.Element propElement)

Description copied from class: AbstractWidgetProperty

Read the property value from a XML element.

Specified by:

readValueFromXML in class AbstractWidgetProperty<AbstractComplexData>

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

setWidgetModel

public void setWidgetModel(AbstractWidgetModel widgetModel)

Overrides:

setWidgetModel in class AbstractWidgetProperty<AbstractComplexData>