Class ComboWidget
- java.lang.Object
-
- org.csstudio.display.builder.model.Widget
-
- org.csstudio.display.builder.model.widgets.VisibleWidget
-
- org.csstudio.display.builder.model.widgets.PVWidget
-
- org.csstudio.display.builder.model.widgets.WritablePVWidget
-
- org.csstudio.display.builder.model.widgets.ComboWidget
-
public class ComboWidget extends WritablePVWidget
Widget that writes to PV from selection of items
-
-
Field Summary
Fields Modifier and Type Field Description static org.csstudio.display.builder.model.WidgetPropertyDescriptor<java.lang.String>
propItem
'item' property: element for list of 'items' propertystatic org.csstudio.display.builder.model.ArrayWidgetProperty.Descriptor<WidgetProperty<java.lang.String>>
propItems
'items' property: list of items (string properties) for combo boxstatic org.csstudio.display.builder.model.WidgetDescriptor
WIDGET_DESCRIPTOR
Widget descriptor-
Fields inherited from class org.csstudio.display.builder.model.widgets.PVWidget
RUNTIME_VALUE_NO_PV
-
Fields inherited from class org.csstudio.display.builder.model.Widget
BASE_WIDGET_VERSION, USER_DATA_REPRESENTATION, USER_DATA_RUNTIME, USER_DATA_SCRIPT_SUPPORT, USER_DATA_TOOLKIT_PARENT
-
-
Constructor Summary
Constructors Constructor Description ComboWidget()
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description org.csstudio.display.builder.model.WidgetConfigurator
getConfigurator(org.csstudio.display.builder.model.Version persisted_version)
Obtain configurator.java.util.Collection<java.lang.String>
getItems()
Convenience routine for script to fetch itemsWidgetProperty<org.csstudio.display.builder.model.properties.WidgetColor>
propBackgroundColor()
WidgetProperty<java.lang.Boolean>
propConfirmDialog()
WidgetProperty<java.lang.String>
propConfirmMessage()
WidgetProperty<java.lang.Boolean>
propEditable()
WidgetProperty<java.lang.Boolean>
propEnabled()
WidgetProperty<org.csstudio.display.builder.model.properties.WidgetFont>
propFont()
WidgetProperty<org.csstudio.display.builder.model.properties.WidgetColor>
propForegroundColor()
org.csstudio.display.builder.model.ArrayWidgetProperty<WidgetProperty<java.lang.String>>
propItems()
WidgetProperty<java.lang.Boolean>
propItemsFromPV()
WidgetProperty<java.lang.String>
propPassword()
void
setItems(java.util.Collection<java.lang.String> new_items)
Convenience routine for script to set items-
Methods inherited from class org.csstudio.display.builder.model.widgets.WritablePVWidget
runtimePropPVWritable
-
Methods inherited from class org.csstudio.display.builder.model.widgets.PVWidget
propBorderAlarmSensitive, propPVName, runtimePropValue
-
Methods inherited from class org.csstudio.display.builder.model.widgets.VisibleWidget
propTooltip, propVisible, runtimePropConnected
-
Methods inherited from class org.csstudio.display.builder.model.Widget
checkDisplayModel, checkProperty, checkProperty, clearUserData, expandPropertyNames, getDisplayModel, getEffectiveMacros, getID, getMacrosOrProperties, getName, getParent, getProperties, getProperty, getProperty, getPropertyByPath, getPropertyValue, getPropertyValue, getTopDisplayModel, getType, getUserData, getVersion, getWidgetClass, isClean, propActions, propClass, propHeight, propName, propRules, propScripts, propWidth, propX, propY, setConfiguratorResult, setPropertyValue, setPropertyValue, setUserData, toString
-
-
-
-
Field Detail
-
WIDGET_DESCRIPTOR
public static final org.csstudio.display.builder.model.WidgetDescriptor WIDGET_DESCRIPTOR
Widget descriptor
-
propItem
public static final org.csstudio.display.builder.model.WidgetPropertyDescriptor<java.lang.String> propItem
'item' property: element for list of 'items' property
-
propItems
public static final org.csstudio.display.builder.model.ArrayWidgetProperty.Descriptor<WidgetProperty<java.lang.String>> propItems
'items' property: list of items (string properties) for combo box
-
-
Method Detail
-
getConfigurator
public org.csstudio.display.builder.model.WidgetConfigurator getConfigurator(org.csstudio.display.builder.model.Version persisted_version) throws java.lang.Exception
Description copied from class:Widget
Obtain configurator.While typically using the default
WidgetConfigurator
, widget may provide a different configurator for reading older persisted date.- Overrides:
getConfigurator
in classWidget
- Parameters:
persisted_version
- Version of the persisted data.- Returns:
- Widget configurator for that version
- Throws:
java.lang.Exception
- if persisted version cannot be handled
-
propForegroundColor
public WidgetProperty<org.csstudio.display.builder.model.properties.WidgetColor> propForegroundColor()
- Returns:
- 'foreground_color' property
-
propBackgroundColor
public WidgetProperty<org.csstudio.display.builder.model.properties.WidgetColor> propBackgroundColor()
- Returns:
- 'background_color' property
-
propFont
public WidgetProperty<org.csstudio.display.builder.model.properties.WidgetFont> propFont()
- Returns:
- 'font' property
-
propItems
public org.csstudio.display.builder.model.ArrayWidgetProperty<WidgetProperty<java.lang.String>> propItems()
- Returns:
- 'items' property
-
getItems
public java.util.Collection<java.lang.String> getItems()
Convenience routine for script to fetch items- Returns:
- Items currently offered by the combo
-
setItems
public void setItems(java.util.Collection<java.lang.String> new_items)
Convenience routine for script to set items- Parameters:
new_items
- Items to offer in combo
-
propItemsFromPV
public WidgetProperty<java.lang.Boolean> propItemsFromPV()
- Returns:
- 'items_from_PV' property
-
propEditable
public WidgetProperty<java.lang.Boolean> propEditable()
- Returns:
- 'editable' property
-
propEnabled
public WidgetProperty<java.lang.Boolean> propEnabled()
- Returns:
- 'enabled' property
-
propConfirmDialog
public WidgetProperty<java.lang.Boolean> propConfirmDialog()
- Returns:
- 'confirm_dialog' property
-
propConfirmMessage
public WidgetProperty<java.lang.String> propConfirmMessage()
- Returns:
- 'confirm_message' property
-
propPassword
public WidgetProperty<java.lang.String> propPassword()
- Returns:
- 'password' property
-
-