|
HATS 7.5.1 Web API ReferencePublicly accessible methods not documented here are for IBM internal use only and may change in a future release of the product. |
||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | ||||||||
java.lang.Objectcom.ibm.hsr.screen.HsrScreenField
public abstract class HsrScreenField
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 |
|---|
protected HsrAttributes fieldAttributes
| Constructor Detail |
|---|
public HsrScreenField()
| Method Detail |
|---|
public abstract int getEndCol()
public abstract int getEndPosition()
public abstract int getEndRow()
public HsrAttributes getFieldAttributes()
HsrAttributes object associated with the
HsrField.
public String getFieldString()
public abstract int getFieldString(char[] buffer,
int length)
buffer - -
an array of characters to store the return valueslength - -
the number of characters to copy to the buffer
public abstract int getFieldString(char[] buffer,
int fieldRelativeStartPos,
int length)
buffer - -
an array of characters to store the return valuesfieldRelativeStartPos - -
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
public abstract String getFieldString(int pos,
int len)
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
public abstract String getFieldString(int pos,
int len,
String limitingAttribute)
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 retrievelimitingAttribute - -
limit the field text, for example, protected-text only, or
visible-text only (see class HsrScreen for
built-in examples)
public abstract String getFieldString(int pos,
int len,
boolean flag)
public String getFieldString(String limitingAttribute)
limitingAttribute - -
limit the field text, for example, protected-text only, or
visible-text only (see class HsrScreen for
built-in examples)
public abstract String getFieldText()
getFieldString functions
(such as DBCS/Bidi character processing).
getFieldString
functionspublic abstract int getLength()
public abstract int getStartCol()
public abstract int getStartPosition()
public abstract int getStartRow()
public abstract void setEndCol(int fieldCol)
fieldCol - -
value of field end columnpublic abstract void setEndPosition(int fieldEndPosition)
fieldEndPosition - -
value of field end positionpublic abstract void setEndRow(int fieldRow)
fieldRow - -
value of field end rowpublic void setFieldAttributes(HsrAttributes fieldAttributes)
HsrAttributes object.
fieldAttributes - -
field attributes objectpublic abstract void setLength(int fieldLength)
fieldLength - -
value of field lengthpublic abstract void setStartColumn(int fieldCol)
fieldCol - -
field starting columnpublic abstract void setStartPosition(int fieldStartPosition)
fieldStartPosition - The fieldStartPosition to set.public abstract void setStartRow(int fieldRow)
fieldRow - -
field start rowpublic abstract boolean isProtected()
public abstract boolean isDisplay()
public abstract boolean isModified()
public abstract boolean isNumeric()
public abstract boolean isHighIntensity()
public abstract boolean isPenDetectable()
public abstract short backgroundColor(int index)
public abstract short foregroundColor(int index)
public abstract boolean is3270()
public abstract boolean is5250()
public short backgroundColor()
public short foregroundColor()
public int GetEnd()
public int GetEndCol()
public int GetEndRow()
public int GetLength()
public int GetStart()
public int GetStartCol()
public int GetStartRow()
public String getText()
public int GetText(char[] buffer,
int length)
public boolean IsDisplay()
public boolean IsHighIntensity()
public boolean IsModified()
public boolean IsNumeric()
public boolean IsPenDetectable()
public boolean IsProtected()
|
HATS 7.5.1 (201005110649) | ||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | ||||||||