Package org.csstudio.opibuilder.properties

Class CommandProperty

java.lang.Object

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

org.csstudio.opibuilder.properties.StringProperty

org.csstudio.opibuilder.properties.CommandProperty

public class CommandProperty
extends StringProperty

The widget property for a command name. It also accepts macro string $(macro).

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

Method Summary

Modifier and Type	Method	Description
protected PropertyDescriptor	createPropertyDescriptor()	Create the IPropertyDescriptor
void	setDetailedDescription(String detailDescription)	Set detailed description to be displayed on tooltip and status line

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

checkValue, configurableByRule, getPropertyValue, readValueFromXML, toStringInRuleScript, writeToXML

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

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

Methods inherited from class java.lang.Object

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

Constructor Details

CommandProperty

public CommandProperty(String prop_id,
 String description,
 WidgetPropertyCategory category,
 String defaultValue)

Command Property Constructor. The property value type is String.

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.

Method Details

setDetailedDescription

public void setDetailedDescription(String detailDescription)

Set detailed description to be displayed on tooltip and status line

createPropertyDescriptor

protected PropertyDescriptor createPropertyDescriptor()

Description copied from class: AbstractWidgetProperty

Create the IPropertyDescriptor

Overrides:

createPropertyDescriptor in class StringProperty