HATS 7.5.1 Web API Reference

Publicly accessible methods not documented here are for IBM internal use only and may change in a future release of the product.

com.ibm.hats.common
Class HostScreenField

java.lang.Object
  extended by com.ibm.hsr.screen.HsrScreenField
      extended by com.ibm.hats.common.HostScreenField

public class HostScreenField
extends HsrScreenField

This is the HATS implementation of an ECLField. Please refer to the ECLField javadoc for information on usage.

See Also:
ECLField

Field Summary
static int COLOR_PLANE
           
static String Copyright
          Embeds a copyright statement into the class file.
static int DBCS_PLANE
           
static int EXFIELD_PLANE
           
static int EXTFIELD_PLANE
           
static int FIELD_PLANE
           
static int GRID_PLANE
           
static int HOST_PLANE
           
static int TEXT_PLANE
           
 
Fields inherited from class com.ibm.hsr.screen.HsrScreenField
fieldAttributes
 
Constructor Summary
HostScreenField()
           
HostScreenField(HostScreen screen, int index)
           
 
Method Summary
 short backgroundColor()
          Deprecated. should use getBackgroundColor() instead
 short backgroundColor(int index)
          Deprecated. should use getBackgroundColor(int) instead
static int convertPosToCol(int pos, int sizecols)
          Finds the column from the position using the given column size.
static int convertPosToRow(int pos, int sizecols)
          Finds the row from the position using the given column size.
 boolean equals(HostScreenField hsf)
           
 short foregroundColor()
          Deprecated. should use getForegroundColor() instead
 short foregroundColor(int index)
          Deprecated. should use getForegroundColor(int) instead
 short getAttribute()
           
 short GetAttribute()
          Deprecated. should use getAttribute()
 short getBackgroundColor()
           
 short getBackgroundColor(int index)
           
 int getEnd()
           
 int GetEnd()
           
 int getEndCol()
          Returns the field ending column.
 int GetEndCol()
           
 int getEndPosition()
          Returns the field ending position.
 int getEndRow()
          Returns the field ending row.
 int GetEndRow()
           
 short getExtendedAttribute()
           
 HsrAttributes getFieldAttributes()
          Returns the HsrAttributes object associated with the HsrField.
 String getFieldName()
           
 int getFieldString(char[] buffer, int length)
          Get the textual data of a field, whose length is determined by parameter "length."
 int getFieldString(char[] buffer, int fieldRelativeStartPos, int length)
          Get the textual data of a field, whose length is determined by parameter "length" and whose starting position is determined by parameter "fieldRelativeStartPos."
 String getFieldString(int pos, int len)
          Get the textual data of a field, whose length is determined by parameter "len" and whose starting position is determined by parameter "pos."
 String getFieldString(int pos, int len, boolean flag)
          Deprecated.  
 String getFieldString(int pos, int len, String limitingAttribute)
          Get the textual data of a field, whose length is determined by parameter "len" and whose starting position is determined by parameter "pos" and whose type is limitide by parameter "limitingAttribute."
 String getFieldText()
          Returns the textual data of the field, but without the extra character processing that may occur in the getFieldString functions (such as DBCS/Bidi character processing).
 short getForegroundColor()
           
 short getForegroundColor(int index)
           
 HostScreen getHostScreen()
           
 int getIndex()
           
 int GetIndex()
           
 ECLInputFieldAttribute getInputFieldAttributes()
           
 int getLength()
          Returns the field length.
 int GetLength()
           
 int GetScreen(char[] buffer, int length, int aplane)
           
 int GetScreen(char[] buffer, int fieldRelativeStartPos, int length, int aplane)
           
 int GetScreen2(char[] buffer, int length, int aplane)
           
 int GetScreen2(char[] buffer, int fieldRelativeStartPos, int length, int aplane)
           
 com.ibm.hats.common.SelectorField getSelectorPenType()
           
 short[] getShortArray()
           
 short[] getShortArray(int plane)
           
 short[] getShortArray(int pos, int len)
           
 short[] getShortArray(int pos, int len, int plane)
           
 int getStart()
           
 int GetStart()
           
 int getStartCol()
          Get the column number to which the field starts.
 int GetStartCol()
           
 int getStartPosition()
          Returns the field start position.
 int getStartRow()
          Get the row number to which the field starts.
 int GetStartRow()
           
 String getString()
           
 String GetString()
           
 int GetString(char[] buffer, int length)
           
 int GetString(char[] buffer, int fieldRelativeStartPos, int length)
           
 String getString(int pos, int len)
           
 String GetString(int pos, int len)
           
 String GetString(int pos, int len, String limitingAttribute)
           
 String getString(String limitingAttribute)
           
 String GetString2()
          Returns the String represented in the field by the host screen.
 String GetString2(int pos, int len)
          Returns the String represented in the field by the area specified on the host screen.
 String getText()
           
 int GetText(char[] buffer, int length)
           
 boolean is3270()
           
 boolean is5250()
           
 boolean isDisplay()
           
 boolean IsDisplay()
           
 boolean isHighIntensity()
           
 boolean IsHighIntensity()
           
 boolean isModified()
           
 boolean IsModified()
           
 boolean isNumeric()
           
 boolean IsNumeric()
           
 boolean isPenDetectable()
           
 boolean IsPenDetectable()
           
 boolean isProtected()
           
 boolean IsProtected()
           
 boolean IsSignedNumeric()
           
 boolean IsUnicodeField()
          Use to determine if this field is a Unicode field.
 String logString()
           
 int SearchString(String text, int position, int direction)
          return total screen index
 void setEndCol(int fieldCol)
          Set the field end column.
 void setEndPosition(int fieldEndPosition)
          Set the field end position.
 void setEndRow(int fieldRow)
          Set the field end row.
 void setFieldAttributes(HsrAttributes fieldAttributes)
          Set the field attributes, which are represented as an HsrAttributes object.
 void setLength(int fieldLength)
          Set the field length.
 void setStartColumn(int fieldCol)
          Set the starting column of the field.
 void setStartPosition(int fieldStartPosition)
           
 void setStartRow(int fieldRow)
          Set the starting row of the field.
 void SetString(String text)
           
 void SetText(String text)
           
 String toString()
           
 
Methods inherited from class com.ibm.hsr.screen.HsrScreenField
getFieldString, getFieldString
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Field Detail

Copyright

public static final String Copyright
Embeds a copyright statement into the class file.

See Also:
Constant Field Values

TEXT_PLANE

public static int TEXT_PLANE

FIELD_PLANE

public static int FIELD_PLANE

EXFIELD_PLANE

public static int EXFIELD_PLANE

EXTFIELD_PLANE

public static int EXTFIELD_PLANE

COLOR_PLANE

public static int COLOR_PLANE

DBCS_PLANE

public static int DBCS_PLANE

GRID_PLANE

public static int GRID_PLANE

HOST_PLANE

public static int HOST_PLANE
Constructor Detail

HostScreenField

public HostScreenField()

HostScreenField

public HostScreenField(HostScreen screen,
                       int index)
Method Detail

convertPosToRow

public static int convertPosToRow(int pos,
                                  int sizecols)
Finds the row from the position using the given column size.

Parameters:
pos - - the position
sizecols - - the number of columns on a row
Returns:
the row for the given position and given screen width

convertPosToCol

public static int convertPosToCol(int pos,
                                  int sizecols)
Finds the column from the position using the given column size.

Parameters:
pos - - the position
sizecols - - the number of columns on a row
Returns:
the column for the given position and given screen width

backgroundColor

public final short backgroundColor()
Deprecated. should use getBackgroundColor() instead

Overrides:
backgroundColor in class HsrScreenField

backgroundColor

public final short backgroundColor(int index)
Deprecated. should use getBackgroundColor(int) instead

Specified by:
backgroundColor in class HsrScreenField

getBackgroundColor

public final short getBackgroundColor()

getBackgroundColor

public final short getBackgroundColor(int index)

equals

public boolean equals(HostScreenField hsf)

foregroundColor

public final short foregroundColor()
Deprecated. should use getForegroundColor() instead

Overrides:
foregroundColor in class HsrScreenField

foregroundColor

public final short foregroundColor(int index)
Deprecated. should use getForegroundColor(int) instead

Specified by:
foregroundColor in class HsrScreenField

getForegroundColor

public final short getForegroundColor()

getForegroundColor

public final short getForegroundColor(int index)

getEnd

public int getEnd()

GetEnd

public int GetEnd()
Overrides:
GetEnd in class HsrScreenField

getEndCol

public int getEndCol()
Description copied from class: HsrScreenField
Returns the field ending column.

Specified by:
getEndCol in class HsrScreenField
Returns:
- field end column

GetEndCol

public int GetEndCol()
Overrides:
GetEndCol in class HsrScreenField

getEndPosition

public int getEndPosition()
Description copied from class: HsrScreenField
Returns the field ending position.

Specified by:
getEndPosition in class HsrScreenField
Returns:
- field end position

getEndRow

public int getEndRow()
Description copied from class: HsrScreenField
Returns the field ending row.

Specified by:
getEndRow in class HsrScreenField
Returns:
- field end row

GetEndRow

public int GetEndRow()
Overrides:
GetEndRow in class HsrScreenField

getFieldAttributes

public HsrAttributes getFieldAttributes()
Description copied from class: HsrScreenField
Returns the HsrAttributes object associated with the HsrField.

Overrides:
getFieldAttributes in class HsrScreenField
Returns:
Returns the fieldAttributes.

getFieldName

public String getFieldName()

getFieldString

public int getFieldString(char[] buffer,
                          int length)
Description copied from class: HsrScreenField
Get the textual data of a field, whose length is determined by parameter "length."

Specified by:
getFieldString in class HsrScreenField
Parameters:
buffer - - an array of characters to store the return values
length - - the number of characters to copy to the buffer
Returns:
- number of the characters copied to the buffer

getFieldString

public int getFieldString(char[] buffer,
                          int fieldRelativeStartPos,
                          int length)
Description copied from class: HsrScreenField
Get the textual data of a field, whose length is determined by parameter "length" and whose starting position is determined by parameter "fieldRelativeStartPos."

Specified by:
getFieldString in class HsrScreenField
Parameters:
buffer - - an array of characters to store the return values
fieldRelativeStartPos - - the relative position inside the field to retrieve the text from (with "1" being the first field character)
length - - the number of characters to copy to the buffer
Returns:
- number of characters copied to the buffer

getFieldString

public String getFieldString(int pos,
                             int len)
Description copied from class: HsrScreenField
Get the textual data of a field, whose length is determined by parameter "len" and whose starting position is determined by parameter "pos."

Specified by:
getFieldString in class HsrScreenField
Parameters:
pos - - the relative position inside the field to retrieve the text from (with "1" being the first field character)
len - - the number of characters in the field to retrieve
Returns:
The text data of the field as a String

getFieldString

public String getFieldString(int pos,
                             int len,
                             String limitingAttribute)
Description copied from class: HsrScreenField
Get the textual data of a field, whose length is determined by parameter "len" and whose starting position is determined by parameter "pos" and whose type is limitide by parameter "limitingAttribute."

Specified by:
getFieldString in class HsrScreenField
Parameters:
pos - - the relative position inside the field to retrieve the text from (with "1" being the first field character)
len - - the number of characters in the field to retrieve
limitingAttribute - - limit the field text, for example, protected-text only, or visible-text only (see class HsrScreen for built-in examples)
Returns:
- text data of the field as a String which meets the requirement of the limiting attribute

getFieldString

public String getFieldString(int pos,
                             int len,
                             boolean flag)
Deprecated. 

Specified by:
getFieldString in class HsrScreenField

getHostScreen

public HostScreen getHostScreen()

getIndex

public final int getIndex()

GetIndex

public final int GetIndex()

getInputFieldAttributes

public ECLInputFieldAttribute getInputFieldAttributes()

getLength

public final int getLength()
Description copied from class: HsrScreenField
Returns the field length.

Specified by:
getLength in class HsrScreenField
Returns:
- field length

GetLength

public final int GetLength()
Overrides:
GetLength in class HsrScreenField

GetScreen

public int GetScreen(char[] buffer,
                     int length,
                     int aplane)

GetScreen

public int GetScreen(char[] buffer,
                     int fieldRelativeStartPos,
                     int length,
                     int aplane)

GetScreen2

public int GetScreen2(char[] buffer,
                      int length,
                      int aplane)

GetScreen2

public int GetScreen2(char[] buffer,
                      int fieldRelativeStartPos,
                      int length,
                      int aplane)

getSelectorPenType

public com.ibm.hats.common.SelectorField getSelectorPenType()

getShortArray

public short[] getShortArray()

getShortArray

public short[] getShortArray(int plane)

getShortArray

public short[] getShortArray(int pos,
                             int len)

getShortArray

public short[] getShortArray(int pos,
                             int len,
                             int plane)

getStart

public int getStart()

GetStart

public int GetStart()
Overrides:
GetStart in class HsrScreenField

getStartCol

public int getStartCol()
Description copied from class: HsrScreenField
Get the column number to which the field starts.

Specified by:
getStartCol in class HsrScreenField
Returns:
- column number to which the field starts

GetStartCol

public int GetStartCol()
Overrides:
GetStartCol in class HsrScreenField

getStartPosition

public int getStartPosition()
Description copied from class: HsrScreenField
Returns the field start position.

Specified by:
getStartPosition in class HsrScreenField
Returns:
- field start position

getStartRow

public int getStartRow()
Description copied from class: HsrScreenField
Get the row number to which the field starts.

Specified by:
getStartRow in class HsrScreenField
Returns:
- row number to which the field starts

GetStartRow

public int GetStartRow()
Overrides:
GetStartRow in class HsrScreenField

getString

public String getString()

getString

public String getString(String limitingAttribute)

getString

public String getString(int pos,
                        int len)

GetString

public String GetString()

GetString

public int GetString(char[] buffer,
                     int length)

GetString

public int GetString(char[] buffer,
                     int fieldRelativeStartPos,
                     int length)

GetString

public String GetString(int pos,
                        int len)

GetString

public String GetString(int pos,
                        int len,
                        String limitingAttribute)

GetString2

public String GetString2()
Returns the String represented in the field by the host screen.

Returns:
The string representing the entire field.

GetString2

public String GetString2(int pos,
                         int len)
Returns the String represented in the field by the area specified on the host screen.

Parameters:
pos - The starting position of the String
len - The length of the String to extract
Returns:
The host screen information in the area given

getFieldText

public String getFieldText()
Description copied from class: HsrScreenField
Returns the textual data of the field, but without the extra character processing that may occur in the getFieldString functions (such as DBCS/Bidi character processing).

Specified by:
getFieldText in class HsrScreenField
Returns:
- textual data of the field without the extra character processing that may occur in the getFieldString functions

getText

public String getText()
Overrides:
getText in class HsrScreenField

GetText

public int GetText(char[] buffer,
                   int length)
Overrides:
GetText in class HsrScreenField

logString

public String logString()

SearchString

public int SearchString(String text,
                        int position,
                        int direction)
return total screen index


setEndCol

public void setEndCol(int fieldCol)
Description copied from class: HsrScreenField
Set the field end column.

Specified by:
setEndCol in class HsrScreenField
Parameters:
fieldCol - - value of field end column

setEndPosition

public void setEndPosition(int fieldEndPosition)
Description copied from class: HsrScreenField
Set the field end position.

Specified by:
setEndPosition in class HsrScreenField
Parameters:
fieldEndPosition - - value of field end position

setEndRow

public void setEndRow(int fieldRow)
Description copied from class: HsrScreenField
Set the field end row.

Specified by:
setEndRow in class HsrScreenField
Parameters:
fieldRow - - value of field end row

setFieldAttributes

public void setFieldAttributes(HsrAttributes fieldAttributes)
Set the field attributes, which are represented as an HsrAttributes object.

Overrides:
setFieldAttributes in class HsrScreenField
Parameters:
fieldAttributes - - field attributes object

setLength

public void setLength(int fieldLength)
Description copied from class: HsrScreenField
Set the field length.

Specified by:
setLength in class HsrScreenField
Parameters:
fieldLength - - value of field length

setStartColumn

public void setStartColumn(int fieldCol)
Description copied from class: HsrScreenField
Set the starting column of the field.

Specified by:
setStartColumn in class HsrScreenField
Parameters:
fieldCol - - field starting column

setStartPosition

public void setStartPosition(int fieldStartPosition)
Specified by:
setStartPosition in class HsrScreenField
Parameters:
fieldStartPosition - The fieldStartPosition to set.

setStartRow

public void setStartRow(int fieldRow)
Description copied from class: HsrScreenField
Set the starting row of the field.

Specified by:
setStartRow in class HsrScreenField
Parameters:
fieldRow - - field start row

SetString

public void SetString(String text)

SetText

public void SetText(String text)

toString

public String toString()
Overrides:
toString in class Object

GetAttribute

public final short GetAttribute()
Deprecated. should use getAttribute()


getAttribute

public final short getAttribute()

getExtendedAttribute

public final short getExtendedAttribute()

isProtected

public final boolean isProtected()
Specified by:
isProtected in class HsrScreenField

IsProtected

public final boolean IsProtected()
Overrides:
IsProtected in class HsrScreenField

isDisplay

public final boolean isDisplay()
Specified by:
isDisplay in class HsrScreenField

IsDisplay

public final boolean IsDisplay()
Overrides:
IsDisplay in class HsrScreenField

isModified

public final boolean isModified()
Specified by:
isModified in class HsrScreenField

IsModified

public final boolean IsModified()
Overrides:
IsModified in class HsrScreenField

isNumeric

public final boolean isNumeric()
Specified by:
isNumeric in class HsrScreenField

IsNumeric

public final boolean IsNumeric()
Overrides:
IsNumeric in class HsrScreenField

IsSignedNumeric

public final boolean IsSignedNumeric()

isHighIntensity

public final boolean isHighIntensity()
Specified by:
isHighIntensity in class HsrScreenField

IsHighIntensity

public final boolean IsHighIntensity()
Overrides:
IsHighIntensity in class HsrScreenField

isPenDetectable

public final boolean isPenDetectable()
Specified by:
isPenDetectable in class HsrScreenField

IsPenDetectable

public final boolean IsPenDetectable()
Overrides:
IsPenDetectable in class HsrScreenField

is3270

public boolean is3270()
Specified by:
is3270 in class HsrScreenField

is5250

public boolean is5250()
Specified by:
is5250 in class HsrScreenField

IsUnicodeField

public boolean IsUnicodeField()
Use to determine if this field is a Unicode field.

Returns:
true if field is Unicode, false otherwise.

HATS 7.5.1 (201005110649)