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.hsr.screen
Class HsrScreenField

java.lang.Object
  extended by com.ibm.hsr.screen.HsrScreenField
Direct Known Subclasses:
HostScreenField

public abstract class HsrScreenField
extends Object

An HsrScreenField is a fundamental element of a host screen, such as an input area, a text caption, or command line. An HsrScreenField also contains attributes, such as the field's foreground color or whether the field is protected or not.


Field Summary
protected  HsrAttributes fieldAttributes
          attributes for the field
 
Constructor Summary
HsrScreenField()
          Construct a new instance of an HsrScreenField object.
 
Method Summary
 short backgroundColor()
          Deprecated. - Use backgroundColor(0) instead.
abstract  short backgroundColor(int index)
           
 short foregroundColor()
          Deprecated. - use foregroundColor(0) instead.
abstract  short foregroundColor(int index)
           
 int GetEnd()
          Deprecated. - Use getEndPosition() instead.
abstract  int getEndCol()
          Returns the field ending column.
 int GetEndCol()
          Deprecated. - Use getEndCol() instead.
abstract  int getEndPosition()
          Returns the field ending position.
abstract  int getEndRow()
          Returns the field ending row.
 int GetEndRow()
          Deprecated. - Use getEndRow() instead.
 HsrAttributes getFieldAttributes()
          Returns the HsrAttributes object associated with the HsrField.
 String getFieldString()
          Get the textual data of a field.
abstract  int getFieldString(char[] buffer, int length)
          Get the textual data of a field, whose length is determined by parameter "length."
abstract  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."
abstract  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."
abstract  String getFieldString(int pos, int len, boolean flag)
           
abstract  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 getFieldString(String limitingAttribute)
          Get the textual data of a field, limited by the limitingAttribute.
abstract  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).
abstract  int getLength()
          Returns the field length.
 int GetLength()
          Deprecated. Use getLength() instead.
 int GetStart()
          Deprecated. - Use getStartPostion() instead.
abstract  int getStartCol()
          Get the column number to which the field starts.
 int GetStartCol()
          Deprecated. - Use getStartCol() instead.
abstract  int getStartPosition()
          Returns the field start position.
abstract  int getStartRow()
          Get the row number to which the field starts.
 int GetStartRow()
          Deprecated. - Use getStartRow() instead.
 String getText()
          Deprecated. - Use getFieldText() instead.
 int GetText(char[] buffer, int length)
          Deprecated. - Use getFieldString(char[] b, int len) instead.
abstract  boolean is3270()
           
abstract  boolean is5250()
           
abstract  boolean isDisplay()
           
 boolean IsDisplay()
          Deprecated. - Use isDisplay() instead.
abstract  boolean isHighIntensity()
           
 boolean IsHighIntensity()
          Deprecated. - Use isHighIntensity() instead.
abstract  boolean isModified()
           
 boolean IsModified()
          Deprecated. - Use isModified() instead.
abstract  boolean isNumeric()
           
 boolean IsNumeric()
          Deprecated. - Use isNumeric() instead.
abstract  boolean isPenDetectable()
           
 boolean IsPenDetectable()
          Deprecated. - Use isPenDetectable() instead.
abstract  boolean isProtected()
           
 boolean IsProtected()
          Deprecated. - Use isProtected() instead.
abstract  void setEndCol(int fieldCol)
          Set the field end column.
abstract  void setEndPosition(int fieldEndPosition)
          Set the field end position.
abstract  void setEndRow(int fieldRow)
          Set the field end row.
 void setFieldAttributes(HsrAttributes fieldAttributes)
          Set the field attributes, which are represented as an HsrAttributes object.
abstract  void setLength(int fieldLength)
          Set the field length.
abstract  void setStartColumn(int fieldCol)
          Set the starting column of the field.
abstract  void setStartPosition(int fieldStartPosition)
           
abstract  void setStartRow(int fieldRow)
          Set the starting row of the field.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

fieldAttributes

protected HsrAttributes fieldAttributes
attributes for the field

Constructor Detail

HsrScreenField

public HsrScreenField()
Construct a new instance of an HsrScreenField object.

Method Detail

getEndCol

public abstract int getEndCol()
Returns the field ending column.

Returns:
- field end column

getEndPosition

public abstract int getEndPosition()
Returns the field ending position.

Returns:
- field end position

getEndRow

public abstract int getEndRow()
Returns the field ending row.

Returns:
- field end row

getFieldAttributes

public HsrAttributes getFieldAttributes()
Returns the HsrAttributes object associated with the HsrField.

Returns:
- HsrAttributes associated with the field

getFieldString

public String getFieldString()
Get the textual data of a field.

Returns:
- text data of the whole field as a String

getFieldString

public abstract int getFieldString(char[] buffer,
                                   int length)
Get the textual data of a field, whose length is determined by parameter "length."

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 abstract 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."

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 abstract 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."

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 abstract 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."

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 abstract String getFieldString(int pos,
                                      int len,
                                      boolean flag)

getFieldString

public String getFieldString(String limitingAttribute)
Get the textual data of a field, limited by the limitingAttribute.

Parameters:
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

getFieldText

public abstract 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).

Returns:
- textual data of the field without the extra character processing that may occur in the getFieldString functions

getLength

public abstract int getLength()
Returns the field length.

Returns:
- field length

getStartCol

public abstract int getStartCol()
Get the column number to which the field starts.

Returns:
- column number to which the field starts

getStartPosition

public abstract int getStartPosition()
Returns the field start position.

Returns:
- field start position

getStartRow

public abstract int getStartRow()
Get the row number to which the field starts.

Returns:
- row number to which the field starts

setEndCol

public abstract void setEndCol(int fieldCol)
Set the field end column.

Parameters:
fieldCol - - value of field end column

setEndPosition

public abstract void setEndPosition(int fieldEndPosition)
Set the field end position.

Parameters:
fieldEndPosition - - value of field end position

setEndRow

public abstract void setEndRow(int fieldRow)
Set the field end row.

Parameters:
fieldRow - - value of field end row

setFieldAttributes

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

Parameters:
fieldAttributes - - field attributes object

setLength

public abstract void setLength(int fieldLength)
Set the field length.

Parameters:
fieldLength - - value of field length

setStartColumn

public abstract void setStartColumn(int fieldCol)
Set the starting column of the field.

Parameters:
fieldCol - - field starting column

setStartPosition

public abstract void setStartPosition(int fieldStartPosition)
Parameters:
fieldStartPosition - The fieldStartPosition to set.

setStartRow

public abstract void setStartRow(int fieldRow)
Set the starting row of the field.

Parameters:
fieldRow - - field start row

isProtected

public abstract boolean isProtected()

isDisplay

public abstract boolean isDisplay()

isModified

public abstract boolean isModified()

isNumeric

public abstract boolean isNumeric()

isHighIntensity

public abstract boolean isHighIntensity()

isPenDetectable

public abstract boolean isPenDetectable()

backgroundColor

public abstract short backgroundColor(int index)

foregroundColor

public abstract short foregroundColor(int index)

is3270

public abstract boolean is3270()

is5250

public abstract boolean is5250()

backgroundColor

public short backgroundColor()
Deprecated. - Use backgroundColor(0) instead.


foregroundColor

public short foregroundColor()
Deprecated. - use foregroundColor(0) instead.


GetEnd

public int GetEnd()
Deprecated. - Use getEndPosition() instead.


GetEndCol

public int GetEndCol()
Deprecated. - Use getEndCol() instead.


GetEndRow

public int GetEndRow()
Deprecated. - Use getEndRow() instead.


GetLength

public int GetLength()
Deprecated. Use getLength() instead.


GetStart

public int GetStart()
Deprecated. - Use getStartPostion() instead.


GetStartCol

public int GetStartCol()
Deprecated. - Use getStartCol() instead.


GetStartRow

public int GetStartRow()
Deprecated. - Use getStartRow() instead.


getText

public String getText()
Deprecated. - Use getFieldText() instead.


GetText

public int GetText(char[] buffer,
                   int length)
Deprecated. - Use getFieldString(char[] b, int len) instead.


IsDisplay

public boolean IsDisplay()
Deprecated. - Use isDisplay() instead.


IsHighIntensity

public boolean IsHighIntensity()
Deprecated. - Use isHighIntensity() instead.


IsModified

public boolean IsModified()
Deprecated. - Use isModified() instead.


IsNumeric

public boolean IsNumeric()
Deprecated. - Use isNumeric() instead.


IsPenDetectable

public boolean IsPenDetectable()
Deprecated. - Use isPenDetectable() instead.


IsProtected

public boolean IsProtected()
Deprecated. - Use isProtected() instead.


HATS 7.5.1 (201005110649)