Class DisplayModel


  • public class DisplayModel
    extends Widget
    Display Model.

    Describes overall size of display, global settings, and holds widgets.

    • Field Detail

      • VERSION

        public static final org.csstudio.display.builder.model.Version VERSION
        Version
        • 1.0.0 - Legacy BOY format, and initial display builder files where widgets started to use their new XML, but no support for classes.
        • 2.0.0 - Supports widget classes and honors the 'use_class' attribute of properties.
      • FILE_EXTENSION

        public static final java.lang.String FILE_EXTENSION
        File extension used for display files
        See Also:
        Constant Field Values
      • LEGACY_FILE_EXTENSION

        public static final java.lang.String LEGACY_FILE_EXTENSION
        File extension used for legacy display files
        See Also:
        Constant Field Values
      • FILE_EXTENSIONS

        public static final java.util.List<java.lang.String> FILE_EXTENSIONS
        All supported file extensions
      • WIDGET_TYPE

        public static final java.lang.String WIDGET_TYPE
        Widget type used by the display model
        See Also:
        Constant Field Values
      • USER_DATA_INPUT_FILE

        public static final java.lang.String USER_DATA_INPUT_FILE
        Reserved DisplayModel user data key for name of input file
        See Also:
        Constant Field Values
      • USER_DATA_READONLY

        public static final java.lang.String USER_DATA_READONLY
        Reserved DisplayModel user data key for 'read only' flag, "true" to set, anything else means false
        See Also:
        Constant Field Values
      • USER_DATA_INPUT_VERSION

        public static final java.lang.String USER_DATA_INPUT_VERSION
        Reserved DisplayModel user data key for version of input file

        Holds Version.

        See Also:
        Constant Field Values
      • USER_DATA_TOOLKIT

        public static final java.lang.String USER_DATA_TOOLKIT
        Reserved DisplayModel user data key for storing toolkit used as representation.

        Holds ToolkitRepresentation.

        See Also:
        Constant Field Values
      • propGridVisible

        public static final org.csstudio.display.builder.model.WidgetPropertyDescriptor<java.lang.Boolean> propGridVisible
        'grid_visible' property
      • propGridColor

        public static final org.csstudio.display.builder.model.WidgetPropertyDescriptor<org.csstudio.display.builder.model.properties.WidgetColor> propGridColor
        'grid_color' property
      • propGridStepX

        public static final org.csstudio.display.builder.model.WidgetPropertyDescriptor<java.lang.Integer> propGridStepX
        'grid_step_x' property
      • propGridStepY

        public static final org.csstudio.display.builder.model.WidgetPropertyDescriptor<java.lang.Integer> propGridStepY
        'grid_step_y' property
    • Constructor Detail

      • DisplayModel

        public DisplayModel()
        Create display model
    • Method Detail

      • getVersion

        public org.csstudio.display.builder.model.Version getVersion()
        Overrides:
        getVersion in class Widget
        Returns:
        Widget version number
      • getDisplayName

        public java.lang.String getDisplayName()
        Get display name

        Provides the configured 'name', falling back to the input file if name is empty.

        Returns:
        Display name
      • isClassModel

        public final boolean isClassModel()
        Is this display model for a class file?
        Returns:
        true if this is the display model for a class file.
      • isTopDisplayModel

        public final boolean isTopDisplayModel()
        Returns:
        true if this display is a top-level display, false if it's held by an embedded widget
      • setReaderResult

        public final void setReaderResult​(org.csstudio.display.builder.model.persist.ModelReader modelReader)
      • isClean

        public final boolean isClean()
        Overrides:
        isClean in class Widget
        Returns:
        true if this display was loaded without errors, false if there were widget errors
      • 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
      • runtimeChildren

        public org.csstudio.display.builder.model.ChildrenProperty runtimeChildren()
        Returns:
        Runtime 'children'
      • getChildren

        public java.util.List<Widget> getChildren()
        Get read-only list of children

        Convenience method. Use runtimeChildren() for full access.

        Returns:
        Child widgets
      • propBackgroundColor

        public WidgetProperty<org.csstudio.display.builder.model.properties.WidgetColor> propBackgroundColor()
        Returns:
        'background_color' property
      • propGridColor

        public WidgetProperty<org.csstudio.display.builder.model.properties.WidgetColor> propGridColor()
        Returns:
        'grid_color' property
      • propGridStepX

        public WidgetProperty<java.lang.Integer> propGridStepX()
        Returns:
        'grid_step_x' property
      • propGridStepY

        public WidgetProperty<java.lang.Integer> propGridStepY()
        Returns:
        'grid_step_y' property
      • propGridVisible

        public WidgetProperty<java.lang.Boolean> propGridVisible()
        Returns:
        'grid_visible' property
      • dispose

        public void dispose()
        Dispose the model

        Removes all widgets and prevents adding new widgets

      • toString

        public java.lang.String toString()
        Overrides:
        toString in class Widget