Package org.csstudio.opibuilder.properties

Class StringTableProperty

java.lang.Object

org.csstudio.opibuilder.properties.AbstractWidgetProperty<String[][]>

org.csstudio.opibuilder.properties.StringTableProperty

public class StringTableProperty
extends AbstractWidgetProperty<String[][]>

The property for string table.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
class	StringTableProperty.TitlesProvider

Field Summary

Fields

Modifier and Type	Field	Description
static final String	XML_ELEMENT_COLUMN	XML ELEMENT name for a column.
static final String	XML_ELEMENT_ROW	XML ELEMENT name for a row.

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

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

Constructor Summary

Constructors

Constructor	Description
StringTableProperty(String prop_id, String description, WidgetPropertyCategory category, String[][] defaultValue, String[] titles)	StringList Property Constructor.
StringTableProperty(String prop_id, String description, WidgetPropertyCategory category, String[][] defaultValue, String[] titles, StringTableEditor.CellEditorType[] cellEditorTypes, Object[] cellEditorDatas)	StringList Property Constructor.

Method Summary

Modifier and Type	Method	Description
String[][]	checkValue(Object value)	Check if the requestNewValue is convertible or legal.
protected PropertyDescriptor	createPropertyDescriptor()	Create the IPropertyDescriptor
String[][]	getPropertyValue()
String[][]	readValueFromXML(org.jdom2.Element propElement)	Read the property value from a XML element.
void	setTitles(String[] titles)
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_ROW

public static final String XML_ELEMENT_ROW

XML ELEMENT name for a row.

See Also:

• Constant Field Values

XML_ELEMENT_COLUMN

public static final String XML_ELEMENT_COLUMN

XML ELEMENT name for a column.

See Also:

• Constant Field Values

Constructor Details

StringTableProperty

public StringTableProperty(String prop_id,
 String description,
 WidgetPropertyCategory category,
 String[][] defaultValue,
 String[] titles)

StringList Property Constructor. The property value type is 2D string array.

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 cannot be null.

titles - the title for each column. The length of titles array is the number of columns. it can be null if the property is not visible.

StringTableProperty

public StringTableProperty(String prop_id,
 String description,
 WidgetPropertyCategory category,
 String[][] defaultValue,
 String[] titles,
 StringTableEditor.CellEditorType[] cellEditorTypes,
 Object[] cellEditorDatas)

StringList Property Constructor. The property value type is 2D string array.

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 cannot be null.

titles - the title for each column. The length of titles array is the number of columns. it can be null if the property is not visible.

Method Details

checkValue

public String[][] checkValue(Object value)

Description copied from class: AbstractWidgetProperty

Check if the requestNewValue is convertible or legal.

Specified by:

checkValue in class AbstractWidgetProperty<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 String[][] getPropertyValue()

Overrides:

getPropertyValue in class AbstractWidgetProperty<String[][]>

setTitles

public void setTitles(String[] titles)

Parameters:

titles - the titles for each column.

createPropertyDescriptor

protected PropertyDescriptor createPropertyDescriptor()

Description copied from class: AbstractWidgetProperty

Create the IPropertyDescriptor

Specified by:

createPropertyDescriptor in class AbstractWidgetProperty<String[][]>

readValueFromXML

public 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<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<String[][]>