|
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
com.ibm.hats.common.HostScreenField
public class HostScreenField
This is the HATS implementation of an ECLField. Please refer to the ECLField javadoc for information on usage.
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 |
|---|
public static final String Copyright
public static int TEXT_PLANE
public static int FIELD_PLANE
public static int EXFIELD_PLANE
public static int EXTFIELD_PLANE
public static int COLOR_PLANE
public static int DBCS_PLANE
public static int GRID_PLANE
public static int HOST_PLANE
| Constructor Detail |
|---|
public HostScreenField()
public HostScreenField(HostScreen screen,
int index)
| Method Detail |
|---|
public static int convertPosToRow(int pos,
int sizecols)
pos - - the positionsizecols - - the number of columns on a row
public static int convertPosToCol(int pos,
int sizecols)
pos - - the positionsizecols - - the number of columns on a row
public final short backgroundColor()
backgroundColor in class HsrScreenFieldpublic final short backgroundColor(int index)
backgroundColor in class HsrScreenFieldpublic final short getBackgroundColor()
public final short getBackgroundColor(int index)
public boolean equals(HostScreenField hsf)
public final short foregroundColor()
foregroundColor in class HsrScreenFieldpublic final short foregroundColor(int index)
foregroundColor in class HsrScreenFieldpublic final short getForegroundColor()
public final short getForegroundColor(int index)
public int getEnd()
public int GetEnd()
GetEnd in class HsrScreenFieldpublic int getEndCol()
HsrScreenField
getEndCol in class HsrScreenFieldpublic int GetEndCol()
GetEndCol in class HsrScreenFieldpublic int getEndPosition()
HsrScreenField
getEndPosition in class HsrScreenFieldpublic int getEndRow()
HsrScreenField
getEndRow in class HsrScreenFieldpublic int GetEndRow()
GetEndRow in class HsrScreenFieldpublic HsrAttributes getFieldAttributes()
HsrScreenFieldHsrAttributes object associated with the
HsrField.
getFieldAttributes in class HsrScreenFieldpublic String getFieldName()
public int getFieldString(char[] buffer,
int length)
HsrScreenField
getFieldString in class HsrScreenFieldbuffer - -
an array of characters to store the return valueslength - -
the number of characters to copy to the buffer
public int getFieldString(char[] buffer,
int fieldRelativeStartPos,
int length)
HsrScreenField
getFieldString in class HsrScreenFieldbuffer - -
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 String getFieldString(int pos,
int len)
HsrScreenField
getFieldString in class HsrScreenFieldpos - -
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 String getFieldString(int pos,
int len,
String limitingAttribute)
HsrScreenField
getFieldString in class HsrScreenFieldpos - -
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 String getFieldString(int pos,
int len,
boolean flag)
getFieldString in class HsrScreenFieldpublic HostScreen getHostScreen()
public final int getIndex()
public final int GetIndex()
public ECLInputFieldAttribute getInputFieldAttributes()
public final int getLength()
HsrScreenField
getLength in class HsrScreenFieldpublic final int GetLength()
GetLength in class HsrScreenField
public int GetScreen(char[] buffer,
int length,
int aplane)
public int GetScreen(char[] buffer,
int fieldRelativeStartPos,
int length,
int aplane)
public int GetScreen2(char[] buffer,
int length,
int aplane)
public int GetScreen2(char[] buffer,
int fieldRelativeStartPos,
int length,
int aplane)
public com.ibm.hats.common.SelectorField getSelectorPenType()
public short[] getShortArray()
public short[] getShortArray(int plane)
public short[] getShortArray(int pos,
int len)
public short[] getShortArray(int pos,
int len,
int plane)
public int getStart()
public int GetStart()
GetStart in class HsrScreenFieldpublic int getStartCol()
HsrScreenField
getStartCol in class HsrScreenFieldpublic int GetStartCol()
GetStartCol in class HsrScreenFieldpublic int getStartPosition()
HsrScreenField
getStartPosition in class HsrScreenFieldpublic int getStartRow()
HsrScreenField
getStartRow in class HsrScreenFieldpublic int GetStartRow()
GetStartRow in class HsrScreenFieldpublic String getString()
public String getString(String limitingAttribute)
public String getString(int pos,
int len)
public String GetString()
public int GetString(char[] buffer,
int length)
public int GetString(char[] buffer,
int fieldRelativeStartPos,
int length)
public String GetString(int pos,
int len)
public String GetString(int pos,
int len,
String limitingAttribute)
public String GetString2()
public String GetString2(int pos,
int len)
pos - The starting position of the Stringlen - The length of the String to extract
public String getFieldText()
HsrScreenFieldgetFieldString functions
(such as DBCS/Bidi character processing).
getFieldText in class HsrScreenFieldgetFieldString
functionspublic String getText()
getText in class HsrScreenField
public int GetText(char[] buffer,
int length)
GetText in class HsrScreenFieldpublic String logString()
public int SearchString(String text,
int position,
int direction)
public void setEndCol(int fieldCol)
HsrScreenField
setEndCol in class HsrScreenFieldfieldCol - -
value of field end columnpublic void setEndPosition(int fieldEndPosition)
HsrScreenField
setEndPosition in class HsrScreenFieldfieldEndPosition - -
value of field end positionpublic void setEndRow(int fieldRow)
HsrScreenField
setEndRow in class HsrScreenFieldfieldRow - -
value of field end rowpublic void setFieldAttributes(HsrAttributes fieldAttributes)
HsrAttributes object.
setFieldAttributes in class HsrScreenFieldfieldAttributes - - field attributes objectpublic void setLength(int fieldLength)
HsrScreenField
setLength in class HsrScreenFieldfieldLength - -
value of field lengthpublic void setStartColumn(int fieldCol)
HsrScreenField
setStartColumn in class HsrScreenFieldfieldCol - -
field starting columnpublic void setStartPosition(int fieldStartPosition)
setStartPosition in class HsrScreenFieldfieldStartPosition - The fieldStartPosition to set.public void setStartRow(int fieldRow)
HsrScreenField
setStartRow in class HsrScreenFieldfieldRow - -
field start rowpublic void SetString(String text)
public void SetText(String text)
public String toString()
toString in class Objectpublic final short GetAttribute()
public final short getAttribute()
public final short getExtendedAttribute()
public final boolean isProtected()
isProtected in class HsrScreenFieldpublic final boolean IsProtected()
IsProtected in class HsrScreenFieldpublic final boolean isDisplay()
isDisplay in class HsrScreenFieldpublic final boolean IsDisplay()
IsDisplay in class HsrScreenFieldpublic final boolean isModified()
isModified in class HsrScreenFieldpublic final boolean IsModified()
IsModified in class HsrScreenFieldpublic final boolean isNumeric()
isNumeric in class HsrScreenFieldpublic final boolean IsNumeric()
IsNumeric in class HsrScreenFieldpublic final boolean IsSignedNumeric()
public final boolean isHighIntensity()
isHighIntensity in class HsrScreenFieldpublic final boolean IsHighIntensity()
IsHighIntensity in class HsrScreenFieldpublic final boolean isPenDetectable()
isPenDetectable in class HsrScreenFieldpublic final boolean IsPenDetectable()
IsPenDetectable in class HsrScreenFieldpublic boolean is3270()
is3270 in class HsrScreenFieldpublic boolean is5250()
is5250 in class HsrScreenFieldpublic boolean IsUnicodeField()
true if field is Unicode, false otherwise.
|
HATS 7.5.1 (201005110649) | ||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | ||||||||