Class TextUpdateWidget


  • public class TextUpdateWidget
    extends PVWidget
    Widget that displays a changing text
    • Field Detail

      • WIDGET_DESCRIPTOR

        public static final org.csstudio.display.builder.model.WidgetDescriptor WIDGET_DESCRIPTOR
        Widget descriptor
    • Constructor Detail

      • TextUpdateWidget

        public TextUpdateWidget()
    • 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
      • getProperty

        public WidgetProperty<?> getProperty​(java.lang.String name)
                                      throws java.lang.IllegalArgumentException,
                                             java.lang.IndexOutOfBoundsException
        Description copied from class: Widget
        Get widget property.

        Meant for rules, scripts and similar code which does not know the exact widget type and thus fetches properties by name.

        Supports access to complex properties by path name, for example "y_axes[1].minimum" to get the minimum property of the second Y axis of a plot.

        To allow use of legacy scripts and rules, the widget implementation may override to handle deprecated property names.

        Caller presumes that the widget actually has the requested property, otherwise throwing Exception.

        Overrides:
        getProperty in class Widget
        Parameters:
        name - Property name
        Returns:
        WidgetProperty
        Throws:
        java.lang.IllegalArgumentException - if property is unknown
        java.lang.IndexOutOfBoundsException
        See Also:
        Widget.checkProperty(String)
      • 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
      • propTransparent

        public WidgetProperty<java.lang.Boolean> propTransparent()
        Returns:
        'transparent' property
      • propFont

        public WidgetProperty<org.csstudio.display.builder.model.properties.WidgetFont> propFont()
        Returns:
        'font' property
      • propFormat

        public WidgetProperty<org.phoebus.ui.vtype.FormatOption> propFormat()
        Returns:
        'format' property
      • propPrecision

        public WidgetProperty<java.lang.Integer> propPrecision()
        Returns:
        'precision' property
      • propShowUnits

        public WidgetProperty<java.lang.Boolean> propShowUnits()
        Returns:
        'show_units' property
      • propHorizontalAlignment

        public WidgetProperty<org.csstudio.display.builder.model.properties.HorizontalAlignment> propHorizontalAlignment()
        Returns:
        'horizontal_alignment' property
      • propVerticalAlignment

        public WidgetProperty<org.csstudio.display.builder.model.properties.VerticalAlignment> propVerticalAlignment()
        Returns:
        'vertical_alignment' property
      • propWrapWords

        public WidgetProperty<java.lang.Boolean> propWrapWords()
        Returns:
        'wrap_words' property
      • propRotationStep

        public WidgetProperty<org.csstudio.display.builder.model.properties.RotationStep> propRotationStep()
        Returns:
        'rotation_step' property
      • propInteractive

        public WidgetProperty<java.lang.Boolean> propInteractive()
        Returns:
        'interactive' property