Class ComboWidget


  • public class ComboWidget
    extends WritablePVWidget
    Widget that writes to PV from selection of items
    • 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
    • Constructor Detail

      • ComboWidget

        public ComboWidget()
    • 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 class Widget
        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