Field Detail

• TYPES

  public static final java.lang.String[] TYPES

  The strings for the type.

Constructor Detail

• EditorScreenIdentificationProp

  public EditorScreenIdentificationProp()

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

• EditorScreenIdentificationProp

  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 Detail

• getDesigner

  public ScreenDesignerProp getDesigner()

  Gets the Designer Extension for Properties.

  Specified by:

  getDesigner in interface IPropDesigner

  Returns:

  The instance of the Designer Extension.

• clone

  public EditorScreenIdentificationProp clone()
                                       throws java.lang.CloneNotSupportedException

  Clone must be overridden.

  Overrides:

  clone in class PropCnr

  Throws:

  java.lang.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 ScreenIdentificationProp

  Returns:

  X, zero based.

• getY

  public int getY()

  Gets the Y position.

  Specified by:

  getY in interface IScreenRectangle

  Overrides:

  getY in class ScreenIdentificationProp

  Returns:

  Y, zero based.

• getCX

  public int getCX()

  Gets the width.

  Overrides:

  getCX in class ScreenIdentificationProp

  Returns:

  Character width.

• getWidth

  public int getWidth()

  Gets the width.

  Specified by:

  getWidth in interface IScreenRectangle

• getCY

  public int getCY()

  Gets the height.

  Overrides:

  getCY in class ScreenIdentificationProp

  Returns:

  Character height.

• 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

• getColorType

  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

  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 java.lang.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.

• isVerifiedSuccessfully

  public boolean isVerifiedSuccessfully()

  Checks for verification success.

  Specified by:

  isVerifiedSuccessfully in interface IScreenRectangle

• getMatchString

  public java.lang.String getMatchString​(HostScreen screen,
                                         int xPopupOffset,
                                         int yPopupOffset)

  Get the current match string from host screen.

• getMatchString

  public java.lang.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

  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.