Package org.csstudio.opibuilder.properties

Class UnsavableListProperty

java.lang.Object

org.csstudio.opibuilder.properties.AbstractWidgetProperty<List<?>>

org.csstudio.opibuilder.properties.UnsavableListProperty

public class UnsavableListProperty
extends AbstractWidgetProperty<List<?>>

The widget property for list. This property is only used for property change communication between model and editpart, so it is not savable and viewable in property sheet.

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
UnsavableListProperty(String prop_id, String description, WidgetPropertyCategory category, List<?> defaultValue)	String Property Constructor.

Method Summary

Modifier and Type	Method	Description
List<?>	checkValue(Object value)	Check if the requestNewValue is convertible or legal.
protected PropertyDescriptor	createPropertyDescriptor()	Create the IPropertyDescriptor
boolean	isSavable()	If the property should be saved to xml file.
List<?>	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, getPropertyValue, getRawPropertyValue, isDefaultValue, 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

Constructor Details

UnsavableListProperty

public UnsavableListProperty(String prop_id,
 String description,
 WidgetPropertyCategory category,
 List<?> defaultValue)

String Property Constructor. The property value type is List.

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.

defaultValue - the default value when the widget is first created. Can be NULL.

Method Details

checkValue

public List<?> checkValue(Object value)

Description copied from class: AbstractWidgetProperty

Check if the requestNewValue is convertible or legal.

Specified by:

checkValue in class AbstractWidgetProperty<List<?>>

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<List<?>>

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<List<?>>

readValueFromXML

public List<?> readValueFromXML(org.jdom2.Element propElement)

Description copied from class: AbstractWidgetProperty

Read the property value from a XML element.

Specified by:

readValueFromXML in class AbstractWidgetProperty<List<?>>

isSavable

public boolean isSavable()

Description copied from class: AbstractWidgetProperty

If the property should be saved to xml file.

Overrides:

isSavable in class AbstractWidgetProperty<List<?>>