Class EditorScreenFieldProp

All Implemented Interfaces:
ILinkCapable, IJavaInterfaceLinkEnabler, IPropDesigner, IScreenRectangle, EventListener, IGProp<GProp<?>[]>, IPropCnr, IVSColumnBestValueListener, IVSColumnListener, IVSComponentListener, IVSComponentReferenceProvider, IVSComponentState, IVSFieldListener, Cloneable, org.eclipse.core.runtime.IAdaptable

public class EditorScreenFieldProp extends ScreenFieldProp implements IPropDesigner, IScreenRectangle, IJavaInterfaceLinkEnabler
This Screen identification property container for a terminal host screen property.
  • Constructor Details

    • EditorScreenFieldProp

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

      public EditorScreenFieldProp(Atom propertyAtom)
      Creates the screen identification 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

    • getDesigner

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

      public EditorScreenProp getScreen()
      Gets the screen property.
      Overrides:
      getScreen in class ScreenFieldProp
    • clone

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

      public boolean mustWrap()
      Check if the rectangle must wrap (for host fields).
      Specified by:
      mustWrap in interface IScreenRectangle
    • getX

      public int getX()
      Gets the X position.
      Specified by:
      getX in interface IScreenRectangle
      Overrides:
      getX in class ScreenFieldProp
    • getY

      public int getY()
      Gets the Y position.
      Specified by:
      getY in interface IScreenRectangle
      Overrides:
      getY in class ScreenFieldProp
    • getWidth

      public int getWidth()
      Gets the width.
      Specified by:
      getWidth in interface IScreenRectangle
    • getHeight

      public int getHeight()
      Gets the height.
      Specified by:
      getHeight in interface IScreenRectangle
    • getRectangle

      public org.eclipse.swt.graphics.Rectangle getRectangle()
      Gets the Rectangle.
      Specified by:
      getRectangle in interface IScreenRectangle
    • setRectangle

      public void setRectangle(org.eclipse.swt.graphics.Rectangle r)
      Sets the Rectangle.
      Specified by:
      setRectangle in interface IScreenRectangle
    • getType

      public int getType()
      Gets the type.
      Overrides:
      getType in class ScreenFieldProp
    • getColorType

      public int getColorType()
      Gets the "color type". Returned value is added with 12 for color index in preferences, see the PluginPreferences.TERM_RECTANGLE_TYPES.
       0 = Marked field
       2 = Alphanumeric                         
       3 = Numeric                              
       4 = Limited alphanumeric                 
       5 = Other numeric                        
       6 = Signed numeric                       
       7 = 3270 numeric                         
       
      Specified by:
      getColorType in interface IScreenRectangle
    • getRectInfo

      public ScreenRectangleInfo getRectInfo()
      Gets the screen rectangle info object. One is allocated if not present.
      Specified by:
      getRectInfo in interface IScreenRectangle
    • saveRectInfo

      public void saveRectInfo(ScreenRectangleInfo rectInfo)
      Saves the screen rectangle info object.
      Specified by:
      saveRectInfo in interface IScreenRectangle
    • createToolTip

      public org.eclipse.swt.widgets.Composite createToolTip(org.eclipse.swt.widgets.Composite parent, ITermEditor editor)
      Creates the tooltip composite.
      Specified by:
      createToolTip in interface IScreenRectangle
    • isShown

      public boolean isShown()
      Checks if shown on screen.
      Specified by:
      isShown in interface IScreenRectangle
    • getCNText

      public String getCNText()
      Gets the text for viewers.
      Returns:
      Text.
    • appendCNStyledTextAdditions

      public void appendCNStyledTextAdditions(org.eclipse.jface.viewers.StyledString ss)
      Appends optional items to styled text.
      Parameters:
      ss - The StyledString.
    • assignFieldType

      public void assignFieldType(HostScreen screen, int xOffset, int yOffset)
      Assigns the field type from the host field.
      Parameters:
      screen - The screen.
      xOffset - The X offset of pop-up window.
      yOffset - The Y offset of pop-up window.
    • isVerifiedSuccessfully

      public boolean isVerifiedSuccessfully()
      Checks for verification success.
      Specified by:
      isVerifiedSuccessfully in interface IScreenRectangle
    • getDragDropText

      public String getDragDropText()
      Gets the link text to display when drag-dropping into JavaScript Panel Editor.
      Specified by:
      getDragDropText in interface ILinkCapable
      Returns:
      The drag-drop text to use.
    • getPossibleChildren

      public Class<?>[] getPossibleChildren()
      Gets the acceptable children property classes that can be used in conjunction with e.g. a Paste operation.
      Specified by:
      getPossibleChildren in interface IPropCnr
      Overrides:
      getPossibleChildren in class PropCnr
      Returns:
      An array containing the classes of possible children, or null for no support.
    • getInterfaceDefinitions

      public IJavaInterfaceLinkEnabler.InterfaceDefinition[] getInterfaceDefinitions()
      Gets the interface definitions for the property used for drag-drop or linking in the Designer.
      Specified by:
      getInterfaceDefinitions in interface IJavaInterfaceLinkEnabler
      Returns:
      An array of the definitions, not null.
    • 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.