Class EmbeddedDisplayWidget


  • public class EmbeddedDisplayWidget
    extends MacroWidget
    Widget that shows another display inside itself
    • Field Detail

      • WIDGET_DESCRIPTOR

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

        public static final org.csstudio.display.builder.model.WidgetPropertyDescriptor<DisplayModel> runtimeModel
    • Constructor Detail

      • EmbeddedDisplayWidget

        public EmbeddedDisplayWidget()
    • Method Detail

      • 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)
      • propFile

        public WidgetProperty<java.lang.String> propFile()
        Returns:
        'file' property
      • propGroupName

        public WidgetProperty<java.lang.String> propGroupName()
        Returns:
        'group_name' property
      • runtimePropEmbeddedModel

        public WidgetProperty<DisplayModel> runtimePropEmbeddedModel()
        Returns:
        Runtime 'model' property for the embedded display
      • propTransparent

        public WidgetProperty<java.lang.Boolean> propTransparent()
        Returns:
        'transparent' property
      • 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