Class CaptureFieldProp

java.lang.Object
com.iizix.prop.GProp<GProp<?>[]>
com.iizix.prop.PropCnr
com.iizigo.term.capture.prop.CaptureFieldProp
All Implemented Interfaces:
IPropDesigner, IScreenRectangle, EventListener, IGProp<GProp<?>[]>, IPropCnr, Cloneable, Comparable<CaptureFieldProp>, org.eclipse.core.runtime.IAdaptable

public class CaptureFieldProp extends PropCnr implements IPropDesigner, IScreenRectangle, Comparable<CaptureFieldProp>
This Capture Field property container holds the screen identifications and fields for a terminal host screen.
  • Constructor Details

    • CaptureFieldProp

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

      public CaptureFieldProp(Atom propertyAtom)
      Creates the Capture Field 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

    • createEEField

      public EEField createEEField(boolean is3270, int width)
      Creates an EEField for this property.
      Parameters:
      is3270 - Flag for 3270 mode.
      width - Width of screen.
      Returns:
      The EE field created.
    • getTypeString

      public String getTypeString()
      Gets the type string.
      Returns:
      Type of field as descriptive text.
    • getDesigner

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

      public CaptureScreenProp getCapture()
      Gets the capture property.
      Returns:
      The screen capture.
    • clone

      public CaptureFieldProp clone()
      Clones the instance.
      Overrides:
      clone in class PropCnr
    • 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
    • getY

      public int getY()
      Gets the Y position.
      Specified by:
      getY in interface IScreenRectangle
    • 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
    • getColorType

      public int getColorType()
      Gets the type for colors, see the PluginPreference.TERM_RECTANGLE_TYPES.
      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
    • isShown

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

      public boolean isVerifiedSuccessfully()
      Checks for verification success.
      Specified by:
      isVerifiedSuccessfully 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
    • 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.
    • compareTo

      public int compareTo(CaptureFieldProp cfp)
      Used for sorting.
      Specified by:
      compareTo in interface Comparable<CaptureFieldProp>