Class EPIFieldRecordImpl

java.lang.Object
com.ibm.jakarta.connector2.cics.EPIFieldRecordImpl
All Implemented Interfaces:
com.ibm.connector2.screen.IExtendedAttributes, com.ibm.connector2.screen.IFieldInfo, EPIFieldRecord, jakarta.resource.cci.Record, Serializable, Cloneable

public class EPIFieldRecordImpl extends Object implements EPIFieldRecord, com.ibm.connector2.screen.IFieldInfo, Serializable
  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    static final String
     

    Fields inherited from interface com.ibm.connector2.screen.IExtendedAttributes

    black, blinkHlt, blue, cyan, darkblue, defaultColor, defaultHlt, defaultTran, gray, green, intenseHlt, neutral, neutralBGrnd, normalHlt, opaqueTran, orange, orTran, paleCyan, paleGreen, pink, purple, red, reverseHlt, underscoreHlt, white, xorTran, yellow
  • Constructor Summary

    Constructors
    Constructor
    Description
    EPIFieldRecordImpl(int position, int depth, int width, String text, int maximumLength, com.ibm.connector2.screen.IFieldAttrInfo fieldAttributes)
     
  • Method Summary

    Modifier and Type
    Method
    Description
    void
    appendText(String newText)
    Append the given string to this field.
     
    boolean
     
    int
    Returns a constant which represents the background color of the screen.
    int
    Returns a constant which represents the foreground color of the field text.
    int
    Returns a constant which indicates the type of highlight for the field.
    int
    Returns the maximum length of the field.
     
     
     
    int
     
    int
     
    int
     
    Get the text of the field.
    int
    Return the current column of the text for the field.
    int
    Return the current position of the text for the field.
    int
    Return the current row of the text for the field.
    int
    Returns a constant which indicates the type of transparency for the field.
    boolean
    Returns whether a field has any attribute bytes (ie it is a formatted field or not).
    int
     
    boolean
    Returns a flag indicating whether the field should be displayed or not.
    boolean
    Returns a flag indicating whether the field is high intensity.
    boolean
    Returns a flag indicating whether the field has been modified.
    boolean
    Returns a flag indicating whether the field is only numeric.
    boolean
    Returns a flag indicating whether the field is protected.
    void
     
    void
     
    void
    setText(String newText)
    Set the text of the field to the given string.

    Methods inherited from class java.lang.Object

    getClass, notify, notifyAll, toString, wait, wait, wait
  • Field Details

  • Constructor Details

    • EPIFieldRecordImpl

      public EPIFieldRecordImpl(int position, int depth, int width, String text, int maximumLength, com.ibm.connector2.screen.IFieldAttrInfo fieldAttributes) throws com.ibm.connector2.screen.ScreenException
      Throws:
      com.ibm.connector2.screen.ScreenException
  • Method Details

    • getRecordName

      public String getRecordName()
      Specified by:
      getRecordName in interface jakarta.resource.cci.Record
    • setRecordName

      public void setRecordName(String newName)
      Specified by:
      setRecordName in interface jakarta.resource.cci.Record
    • setRecordShortDescription

      public void setRecordShortDescription(String newDesc)
      Specified by:
      setRecordShortDescription in interface jakarta.resource.cci.Record
    • getRecordShortDescription

      public String getRecordShortDescription()
      Specified by:
      getRecordShortDescription in interface jakarta.resource.cci.Record
    • clone

      public Object clone() throws CloneNotSupportedException
      Specified by:
      clone in interface jakarta.resource.cci.Record
      Throws:
      CloneNotSupportedException
    • equals

      public boolean equals(Object obj)
      Specified by:
      equals in interface jakarta.resource.cci.Record
      Overrides:
      equals in class Object
    • appendText

      public void appendText(String newText) throws com.ibm.connector2.screen.ScreenException
      Description copied from interface: EPIFieldRecord
      Append the given string to this field.
      Specified by:
      appendText in interface EPIFieldRecord
      Parameters:
      newText - The text to append
      Throws:
      com.ibm.connector2.screen.ScreenException - If the complete text of the field is too long.
    • hasAttribute

      public boolean hasAttribute()
      Description copied from interface: EPIFieldRecord
      Returns whether a field has any attribute bytes (ie it is a formatted field or not).
      Specified by:
      hasAttribute in interface EPIFieldRecord
    • getBackGroundColor

      public int getBackGroundColor()
      Description copied from interface: EPIFieldRecord
      Returns a constant which represents the background color of the screen.
      Specified by:
      getBackGroundColor in interface EPIFieldRecord
      Returns:
      Background color.
    • getForeGroundColor

      public int getForeGroundColor()
      Description copied from interface: EPIFieldRecord
      Returns a constant which represents the foreground color of the field text.
      Specified by:
      getForeGroundColor in interface EPIFieldRecord
      Returns:
      The foreground color.
    • getHighlight

      public int getHighlight()
      Description copied from interface: EPIFieldRecord
      Returns a constant which indicates the type of highlight for the field.
      Specified by:
      getHighlight in interface EPIFieldRecord
      Returns:
      The highlight.
    • getMaxTextLength

      public int getMaxTextLength()
      Description copied from interface: EPIFieldRecord
      Returns the maximum length of the field. This does not include the attribute byte. It is the maximum length of text allowed.
      Specified by:
      getMaxTextLength in interface EPIFieldRecord
      Returns:
      Maximum length of the field.
    • getTextCol

      public int getTextCol()
      Description copied from interface: EPIFieldRecord
      Return the current column of the text for the field. This does not include the attribute byte, but rather the actual text position.
      Specified by:
      getTextCol in interface EPIFieldRecord
      Returns:
      The text column.
    • getTextPos

      public int getTextPos()
      Description copied from interface: EPIFieldRecord
      Return the current position of the text for the field. This does not include the attribute byte, but rather the actual text position.
      Specified by:
      getTextPos in interface EPIFieldRecord
      Returns:
      The text position.
    • getTextRow

      public int getTextRow()
      Description copied from interface: EPIFieldRecord
      Return the current row of the text for the field.
      Specified by:
      getTextRow in interface EPIFieldRecord
      Returns:
      The text row.
    • getText

      public String getText()
      Description copied from interface: EPIFieldRecord
      Get the text of the field.
      Specified by:
      getText in interface EPIFieldRecord
      Specified by:
      getText in interface com.ibm.connector2.screen.IFieldInfo
      Returns:
      The text of the field.
    • getTransparency

      public int getTransparency()
      Description copied from interface: EPIFieldRecord
      Returns a constant which indicates the type of transparency for the field.
      Specified by:
      getTransparency in interface EPIFieldRecord
      Returns:
      The transparency.
    • isDisplay

      public boolean isDisplay()
      Description copied from interface: EPIFieldRecord
      Returns a flag indicating whether the field should be displayed or not.
      Specified by:
      isDisplay in interface EPIFieldRecord
      Returns:
      True if the field is displayable.
    • isHighIntensity

      public boolean isHighIntensity()
      Description copied from interface: EPIFieldRecord
      Returns a flag indicating whether the field is high intensity.
      Specified by:
      isHighIntensity in interface EPIFieldRecord
      Returns:
      True if the field is high intensity.
    • isModified

      public boolean isModified()
      Description copied from interface: EPIFieldRecord
      Returns a flag indicating whether the field has been modified.
      Specified by:
      isModified in interface EPIFieldRecord
      Returns:
      True if the field has it's modified flag set.
    • isNumeric

      public boolean isNumeric()
      Description copied from interface: EPIFieldRecord
      Returns a flag indicating whether the field is only numeric.
      Specified by:
      isNumeric in interface EPIFieldRecord
      Returns:
      True if the field only supports numeric data.
    • isProtected

      public boolean isProtected()
      Description copied from interface: EPIFieldRecord
      Returns a flag indicating whether the field is protected.
      Specified by:
      isProtected in interface EPIFieldRecord
      Returns:
      True if the field is protected.
    • setText

      public void setText(String newText) throws com.ibm.connector2.screen.ScreenException
      Description copied from interface: EPIFieldRecord
      Set the text of the field to the given string.
      Specified by:
      setText in interface EPIFieldRecord
      Parameters:
      newText - The text to set the field to.
      Throws:
      com.ibm.connector2.screen.ScreenException - If the text is too long.
    • getStartCol

      public int getStartCol()
      Specified by:
      getStartCol in interface com.ibm.connector2.screen.IFieldInfo
    • getStartPos

      public int getStartPos()
      Specified by:
      getStartPos in interface com.ibm.connector2.screen.IFieldInfo
    • getStartRow

      public int getStartRow()
      Specified by:
      getStartRow in interface com.ibm.connector2.screen.IFieldInfo
    • getName

      public String getName()
      Specified by:
      getName in interface com.ibm.connector2.screen.IFieldInfo
    • hashCode

      public int hashCode()
      Specified by:
      hashCode in interface jakarta.resource.cci.Record
      Overrides:
      hashCode in class Object