Package com.iizigo.term.prop

Class EditorScreenIdentificationProp

java.lang.Object
com.iizix.prop.GProp<GProp<?>[]>
com.iizix.prop.PropCnr
com.iizix.term.prop.ScreenIdentificationProp
com.iizigo.term.prop.EditorScreenIdentificationProp
All Implemented Interfaces:
IPropDesigner, IScreenRectangle, EventListener, IGProp<GProp<?>[]>, IPropCnr, Cloneable, Comparable<ScreenIdentificationProp>, IAdaptable
public class EditorScreenIdentificationProp extends ScreenIdentificationProp implements IPropDesigner, IScreenRectangle
This Screen identification property container for a terminal host screen property.

  • Field Details Link icon

    • TYPES Link icon

      public static final String[] TYPES
      The strings for the type.

  • Constructor Details Link icon

    • EditorScreenIdentificationProp Link icon

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

    • EditorScreenIdentificationProp Link icon

      public EditorScreenIdentificationProp(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 Link icon

    • getDesigner Link icon

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

    • clone Link icon

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

    • mustWrap Link icon

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

    • getX Link icon

      public int getX()
      Gets the X position.
      Specified by:
      getX in interface IScreenRectangle
      Overrides:
      getX in class ScreenIdentificationProp
      Returns:
      X, zero based.

    • getY Link icon

      public int getY()
      Gets the Y position.
      Specified by:
      getY in interface IScreenRectangle
      Overrides:
      getY in class ScreenIdentificationProp
      Returns:
      Y, zero based.

    • getCX Link icon

      public int getCX()
      Gets the width.
      Overrides:
      getCX in class ScreenIdentificationProp
      Returns:
      Character width.

    • getWidth Link icon

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

    • getCY Link icon

      public int getCY()
      Gets the height.
      Overrides:
      getCY in class ScreenIdentificationProp
      Returns:
      Character height.

    • getHeight Link icon

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

    • getRectangle Link icon

      public Rectangle getRectangle()
      Gets the Rectangle.
      Specified by:
      getRectangle in interface IScreenRectangle

    • setRectangle Link icon

      public void setRectangle(Rectangle r)
      Sets the Rectangle.
      Specified by:
      setRectangle in interface IScreenRectangle

    • getColorType Link icon

      public int getColorType()
      Gets the type. The type value below is offset by 3 (range will be 3-11), see the PluginPreferences.TERM_RECTANGLE_TYPES.
       0=exact rectangle,
 1=alphanumeric,
 2=alphanumeric without space,
 3=numeric digits,
 4=numeric signed value,
 5=no space,only space,
 6=field: same position and length,
 7=not rectangle contents,
 8=not pop-up window.
      Specified by:
      getColorType in interface IScreenRectangle

    • getRectInfo Link icon

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

    • saveRectInfo Link icon

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

    • createToolTip Link icon

      public Composite createToolTip(Composite parent, ITermEditor editor)
      Creates the tooltip composite.
      Specified by:
      createToolTip in interface IScreenRectangle

    • isShown Link icon

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

    • getCNText Link icon

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

    • appendCNStyledTextAdditions Link icon

      public void appendCNStyledTextAdditions(StyledString ss)
      Appends optional items to styled text.
      Parameters:
      ss - The StyledString.

    • isVerifiedSuccessfully Link icon

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

    • getMatchString Link icon

      public String getMatchString(HostScreen screen, int xPopupOffset, int yPopupOffset)
      Get the current match string from host screen.

    • getMatchString Link icon

      public String getMatchString(HostScreen screen, int xPopupOffset, int yPopupOffset, int x, int y, int cx, int cy)
      Get the match string from host screen for an identification at x,y with size cx,cy.

    • verify Link icon

      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.