Package org.csstudio.opibuilder.properties

Class BooleanProperty

java.lang.Object

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

org.csstudio.opibuilder.properties.BooleanProperty

public final class BooleanProperty
extends AbstractWidgetProperty<Boolean>

A boolean widget property.

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
BooleanProperty(String propId, String description, WidgetPropertyCategory category, boolean defaultValue)	Boolean Property Constructor

Method Summary

Modifier and Type	Method	Description
Boolean	checkValue(Object value)	Check if the requestNewValue is convertible or legal.
boolean	configurableByRule()	Subclass should override this method if it is configurable by rule.
protected PropertyDescriptor	createPropertyDescriptor()	Create the IPropertyDescriptor
Boolean	readValueFromXML(org.jdom2.Element propElement)	Read the property value from a XML element.
String	toStringInRuleScript(Boolean propValue)	Convert to the property value string in the script generated by rule.
void	writeToXML(org.jdom2.Element propElement)	Write the property value into a XML element.

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

addPropertyChangeListener, 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, setWidgetModel, toString

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Details

BooleanProperty

public BooleanProperty(String propId,
 String description,
 WidgetPropertyCategory category,
 boolean defaultValue)

Boolean Property Constructor

Parameters:

propId - 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.

Method Details

checkValue

public Boolean checkValue(Object value)

Description copied from class: AbstractWidgetProperty

Check if the requestNewValue is convertible or legal.

Specified by:

checkValue in class AbstractWidgetProperty<Boolean>

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

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

readValueFromXML

public Boolean readValueFromXML(org.jdom2.Element propElement)

Description copied from class: AbstractWidgetProperty

Read the property value from a XML element.

Specified by:

readValueFromXML in class AbstractWidgetProperty<Boolean>

configurableByRule

public boolean configurableByRule()

Description copied from class: AbstractWidgetProperty

Subclass should override this method if it is configurable by rule. If this returns true, the method AbstractWidgetProperty.toStringInRuleScript(Object) should be properly overridden too.

Overrides:

configurableByRule in class AbstractWidgetProperty<Boolean>

Returns:

true if this property is configurable by rule.

toStringInRuleScript

public String toStringInRuleScript(Boolean propValue)

Description copied from class: AbstractWidgetProperty

Convert to the property value string in the script generated by rule.

Overrides:

toStringInRuleScript in class AbstractWidgetProperty<Boolean>