Package org.csstudio.opibuilder.properties

Class StringMapProperty

java.lang.Object

org.csstudio.opibuilder.properties.AbstractWidgetProperty<Map<String,String>>

org.csstudio.opibuilder.properties.StringMapProperty

public class StringMapProperty
extends AbstractWidgetProperty<Map<String,String>>

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
StringMapProperty(String prop_id, String description, WidgetPropertyCategory category, Map<String,String> defaultValue)

Method Summary

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

Constructor Details

StringMapProperty

public StringMapProperty(String prop_id,
 String description,
 WidgetPropertyCategory category,
 Map<String,String> defaultValue)

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. It can be null.

Method Details

checkValue

public Map<String,String> checkValue(Object value)

Description copied from class: AbstractWidgetProperty

Check if the requestNewValue is convertible or legal.

Specified by:

checkValue in class AbstractWidgetProperty<Map<String,String>>

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 Map<String,String> getPropertyValue()

Overrides:

getPropertyValue in class AbstractWidgetProperty<Map<String,String>>

createPropertyDescriptor

protected PropertyDescriptor createPropertyDescriptor()

Description copied from class: AbstractWidgetProperty

Create the IPropertyDescriptor

Specified by:

createPropertyDescriptor in class AbstractWidgetProperty<Map<String,String>>

readValueFromXML

public Map<String,String> readValueFromXML(org.jdom2.Element propElement)

Description copied from class: AbstractWidgetProperty

Read the property value from a XML element.

Specified by:

readValueFromXML in class AbstractWidgetProperty<Map<String,String>>

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<Map<String,String>>