Class EditorScreenProp

All Implemented Interfaces:
IPropDesigner, IPropUndoContext, IVSLinkEnabler, IVSParticipantLinkEnabler, EventListener, IGProp<GProp<?>[]>, IPropCnr, IReferrerParticipant, IVSAccessor, IVSParticipant, Cloneable, Comparable<ScreenProp>, IAdaptable

public class EditorScreenProp extends ScreenProp implements IPropDesigner, IPropUndoContext, IVSParticipantLinkEnabler
This Screen property container holds the screen identifications and fields for a terminal host screen.
  • Field Details

    • EMPTY_ARRAY

      public static final EditorScreenProp[] EMPTY_ARRAY
      An empty array of ScreenProp's.
  • Constructor Details

    • EditorScreenProp

      public EditorScreenProp()
      Creates the screen property container without a name. The name must be set in all cases using the setPropertyAtom call.
    • EditorScreenProp

      public EditorScreenProp(Atom propertyAtom)
      Creates the screen property container with the specified name. All system-reserved names for components begins with "$".
      Parameters:
      propertyAtom - the name of the component, unique within it's parent.
  • Method Details

    • addPredefinedPropsImpl

      protected void addPredefinedPropsImpl() throws PropException
      Adds the predefined containers for identifications, fields and actions. This method is overridden fully by the Editor versions of the class.
      Overrides:
      addPredefinedPropsImpl in class ScreenProp
      Throws:
      PropException
    • getPredefinedProps

      protected void getPredefinedProps()
      Adds the predefined containers for identifications, fields and actions. This method is overridden fully by the Editor versions of the class.
      Overrides:
      getPredefinedProps in class ScreenProp
    • getDesigner

      public ScreenDesignerProp getDesigner()
      Gets the Designer Extension for Properties.
      Specified by:
      getDesigner in interface IPropDesigner
      Returns:
      The instance of the Designer Extension.
    • getUndoContext

      public IUndoContext getUndoContext()
      Gets the undo context.
      Specified by:
      getUndoContext in interface IPropUndoContext
      Returns:
      The undo context for the Editor part(s) for this container.
    • clone

      Clone must be overridden.
      Overrides:
      clone in class PropCnr
      Throws:
      CloneNotSupportedException - If a subclass doesn't allow cloning, e.g. the client properties.
    • isPropPopupWindow

      public boolean isPropPopupWindow()
      Checks if the screen is a pop-up window by means of checking the current properties.
      Returns:
      true for pop-up, false for full-screen.
    • getIdentifications

      public EditorScreenIdentificationsProp getIdentifications()
      Gets the identifications container.
      Overrides:
      getIdentifications in class ScreenProp
      Returns:
      The screen identifications container.
    • getFields

      public EditorScreenFieldsProp getFields()
      Gets the fields container.
      Overrides:
      getFields in class ScreenProp
      Returns:
      The screen fields container.
    • getActions

      public EditorScreenActionsProp getActions()
      Gets the actions container.
      Overrides:
      getActions in class ScreenProp
      Returns:
      The screen actions container.
    • getIdentificationRects

      public IScreenRectangle[] getIdentificationRects()
      Gets the screen identifications screen rectangles.
      Returns:
      The identifications, not null.
    • canSelectPopupWindow

      public boolean canSelectPopupWindow()
      Check if the pop-up window can be chosen, i.e. the screen is of pop-up type and that there are no identifications and fields.
      Returns:
      true if there are more than one rectangle.
    • getFieldRects

      public IScreenRectangle[] getFieldRects()
      Gets the screen identifications screen rectangles.
      Returns:
      The screen fields as rectangles, never null.
    • getSettingsContainer

      public EditorPropCnr getSettingsContainer()
      Gets the settings container.
      Returns:
      The editor property container for settings.
    • createToolTip

      public Composite createToolTip(Composite parent)
      Creates the tooltip composite.
      Parameters:
      parent - The parent composite.
      Returns:
      The created tooltip composite.
    • verify

      public boolean verify(PropVerification verification)
      Verifies this property container. The check performed is the extension of classes and that no circular reference is present.
      Specified by:
      verify in interface IGProp<GProp<?>[]>
      Overrides:
      verify in class PropCnr
      Parameters:
      verification - The property verification class.
      Returns:
      true if verification should proceed, false if disposed of and verification should not take place.