|
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.HsrScreen
public abstract class HsrScreen
The HsrScreen is the bridge between the HSR transformation functions and the other interfaces of the HSR Screen interface. The HsrScreen class is used to contain all of the objects that make up a legacy host screen. For example, an HsrScreen and legacy host screen both contain a collection of fields, as well as attributes of each field, and a cursor. Most of the objects in HsrScreen are interfaces, themselves, such as the fields and field attributes.
| Field Summary | |
|---|---|
protected int |
cursorCol
the cursor column |
protected int |
cursorPos
cursor position |
protected int |
cursorRow
cursor row |
protected HsrBidiServices |
hsrBidi
Bidi information about a host screen if it is Bidi screen |
static String |
PROTECTED_TEXT_ONLY
An indicator for limiting screen text to the protected text only (versus protected & unprotected) |
protected int |
screenSize
screen size |
protected int |
sizeCols
# of screen columns |
protected int |
sizeRows
# of screen rows |
static String |
VISIBLE_SHIFTLESS_TEXT
An indicator for limiting screen text to visible text, with no shift-in or shift-out characters if the screen text is from a double-byte character set |
static String |
VISIBLE_TEXT_ONLY
An indicator for limiting screen text to the visible text only (versus both visible and hidden) |
| Constructor Summary | |
|---|---|
HsrScreen()
|
|
| Method Summary | |
|---|---|
char |
charAt(int cursorPos)
Returns a screen character from the host screen at the specified cursor position |
char |
charAt(int cursorPos,
String limitingAttrib)
Returns a screen character from the host screen at the specified cursor position. |
int |
ConvertPosToCol(int pos)
Deprecated. - Use CommonScreenFunctions.convertPosToCol(pos, this.getSizeCols()) instead. |
int |
ConvertPosToRow(int pos)
Deprecated. - Use CommonScreenFunctions.convertPosToRow(pos, this.getSizeCols()) instead. |
int |
ConvertRowColToPos(int row,
int col)
Deprecated. - Use CommonScreenFunctions.convertRowColToPos(row, col, this.getSizeCols()) instead. |
int |
getBackgroundColor(int screenPosition)
Returns the background color for a character at a specific position on the screen, where the color value ranges from 0-7, as in the IBM Host Access Client Library. |
int |
getCursorCol()
Returns the cursor column value. |
int |
GetCursorCol()
Deprecated. - Use getCursorCol() instead. |
int |
getCursorPos()
Returns the cursor position value. |
int |
GetCursorPos()
Deprecated. - Use getCursorPos() instead. |
int |
getCursorRow()
Returns the cursor row value. |
int |
GetCursorRow()
Deprecated. - Use getCursorRow() instead. |
HsrScreenField |
getFieldAssociatedWithPos(int pos)
Retrieves the HsrScreenField at the given location, as in getFieldAtPosition. |
HsrScreenField |
getFieldAtPos(int pos)
Retrieves the HsrScreenField at the given location. |
HsrScreenField |
getFieldAtPos(int row,
int col)
Retrieves the HsrScreenField at the given location |
HsrAttributes |
getFieldAttributes(int screenPosition)
Returns the field attributes for a character at a specific position on the screen. |
int |
getFieldCount()
Deprecated. - Use getFieldList().getFieldCount() instead. |
abstract IScreenFieldList |
getFieldList()
Returns the list of fields contained on the current HsrScreen. |
int |
getForegroundColor(int screenPosition)
Returns the foreground color for a character at a specific position on the screen, where the color value ranges from 0-15, as in the IBM Host Access Client Library. |
HsrBidiServices |
getHsrBidiServices()
Returns the hsrBidiServices object, if a host screen is Bidirectional. |
abstract byte[] |
getScreenFingerprint(int position)
Returns a 12-byte "fingerprint" for the host screen if the screen contains a fingerprint, which is optionally found in IBM 5250 Subfile screens. |
int |
getScreenRect(char[] buffer,
int bufferLength,
int startRow,
int startCol,
int endRow,
int endCol,
String limitingAttribute)
Gets a textual area defined by the start/end rows and columns from the host screen. |
int |
getScreenSize()
Returns the screen size as an integer representing the total character buffer size of the screen. |
int |
getScreenText(char[] buffer,
int bufferLength)
Gets a textual area from the host screen. |
abstract int |
getScreenText(char[] buffer,
int bufferLength,
int position,
int length)
Gets a textual area from the host screen, starting at a given position. |
int |
getScreenText(char[] buffer,
int bufferLength,
int row,
int col,
int length)
Gets a textual area from the host screen, starting at a given position. |
int |
getScreenText(char[] buffer,
int bufferLength,
int row,
int col,
int length,
String limitingAttribute)
Gets a textual area from the host screen, starting at a given position. |
abstract int |
getScreenText(char[] buffer,
int bufferLength,
int position,
int length,
String limitingAttribute)
Gets a textual area from the host screen, starting at a given position. |
int |
getSize()
Deprecated. - Use getScreenSize() instead. |
int |
GetSize()
Deprecated. - Use getScreenSize() instead. |
int |
getSizeCols()
Returns the number of columns for the host screen. |
int |
GetSizeCols()
Deprecated. - Use getSizeCols() instead. |
int |
getSizeRows()
Returns the number of rows for the host screen. |
int |
GetSizeRows()
Deprecated. - Use getSizeRows() instead. |
int |
getTotalFieldCount()
Deprecated. - Use getFieldList().getFieldCount() instead. |
boolean |
is3270()
Deprecated. - Use is3270Screen() instead. |
abstract boolean |
is3270Screen()
Returns if the screen is a 3270 representation. |
boolean |
is5250()
Deprecated. - Use is5250Screen() instead. |
abstract boolean |
is5250Screen()
Returns if the screen is a 5250 representation. |
abstract boolean |
isArabic()
Returns whether the screen is Arabic or not (Arabic codepage). |
boolean |
isArabicSession()
Deprecated. - Use isArabic() instead. |
abstract boolean |
isBidi()
Returns whether the screen is of a Bidi codepage or not. |
boolean |
isBIDISession()
Deprecated. - Use isBidi() instead. |
abstract boolean |
isDbcsScreen()
Returns if the screen is a Double-byte character set screen. |
boolean |
isDBCSSession()
Deprecated. - Use isDbcsScreen() instead. |
void |
setCursorCol(int cursorCol)
Sets cursor column on the host screen. |
void |
setCursorPos(int cursorPos)
Sets cursor position on the host screen. |
void |
setCursorRow(int cursorRow)
Sets cursor row on the host screen. |
void |
setHsrBidiServices(HsrBidiServices hsrBidi)
Sets the HsrBidiServices object that the HsrScreen is to use for Bidirectional processing. |
void |
setScreenSize(int screenSize)
Set the screen size of the HsrScreen. |
void |
setSizeCols(int sizeCols)
Set the number of columns of the HsrScreen. |
void |
setSizeRows(int sizeRows)
Set the number of rows of the HsrScreen. |
| Methods inherited from class java.lang.Object |
|---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
| Field Detail |
|---|
public static String PROTECTED_TEXT_ONLY
public static String VISIBLE_SHIFTLESS_TEXT
public static String VISIBLE_TEXT_ONLY
protected int cursorCol
protected int cursorPos
protected int cursorRow
protected HsrBidiServices hsrBidi
protected int screenSize
protected int sizeCols
protected int sizeRows
| Constructor Detail |
|---|
public HsrScreen()
| Method Detail |
|---|
public char charAt(int cursorPos)
cursorPos - - position for retrieving the screen character
public char charAt(int cursorPos,
String limitingAttrib)
cursorPos - Position for retrieving the screen character.limitingAttrib - Limit the screen text, for example, return protected-text only, or visible-text only
(such as HsrScreen variable VISIBLE_TEXT_DATA).
public int getBackgroundColor(int screenPosition)
screenPosition - - absolute position on the screen of the character for which
to retrieve color information
public int GetCursorCol()
public int getCursorCol()
public int GetCursorPos()
public int getCursorPos()
public int GetCursorRow()
public int getCursorRow()
public HsrScreenField getFieldAssociatedWithPos(int pos)
pos - - the position of the screen to attempt field retrieval
public HsrScreenField getFieldAtPos(int pos)
pos - - the position of the screen
public HsrScreenField getFieldAtPos(int row,
int col)
row - - the row of the positioncol - - the column of the position
public HsrAttributes getFieldAttributes(int screenPosition)
screenPosition - - absolute position on the screen of the character for which
to retrieve attribute information
public int getTotalFieldCount()
public int getFieldCount()
public abstract IScreenFieldList getFieldList()
public int getForegroundColor(int screenPosition)
screenPosition - - absolute position on the screen of the character for which
to retrieve color information
public HsrBidiServices getHsrBidiServices()
public abstract byte[] getScreenFingerprint(int position)
position - - position on the host screen to start retrieving the 12-byte fingerprint
public int getScreenRect(char[] buffer,
int bufferLength,
int startRow,
int startCol,
int endRow,
int endCol,
String limitingAttribute)
buffer - - the buffer to place text intobufferLength - - the length of the bufferstartRow - - the row to start fromstartCol - - the column to start fromendRow - - the row to end atendCol - - the column to end atlimitingAttribute - - limit the screen text, for example, return protected-text only, or visible-text only (such as HsrScreen variable VISIBLE_TEXT_DATA)
public int GetSize()
public int getSize()
public int getScreenSize()
public int getScreenText(char[] buffer,
int bufferLength)
buffer - - the buffer to place text intobufferLength - - the length of the buffer
public abstract int getScreenText(char[] buffer,
int bufferLength,
int position,
int length)
buffer - - the buffer to place text intobufferLength - - the length of the bufferposition - - the position to start fromlength - - the length of data to retrieve
public int getScreenText(char[] buffer,
int bufferLength,
int row,
int col,
int length)
buffer - - the buffer to place text intobufferLength - - the length of the bufferrow - - the row to start fromcol - - the column to start fromlength - - the length of data to retrieve
public int getScreenText(char[] buffer,
int bufferLength,
int row,
int col,
int length,
String limitingAttribute)
buffer - - the buffer to place text intobufferLength - - the length of the bufferrow - - the row to start fromcol - - the column to start fromlength - - the length of data to retrievelimitingAttribute - - limit the screen text, for example, return protected-text only, or visible-text only (such as HsrScreen variable VISIBLE_TEXT_DATA)
public abstract int getScreenText(char[] buffer,
int bufferLength,
int position,
int length,
String limitingAttribute)
buffer - - the buffer to place text intobufferLength - - the length of the bufferposition - - the position to start fromlength - - the length of data to retrievelimitingAttribute - - limit the screen text, for example, return protected-text only, or visible-text only (such as HsrScreen variable VISIBLE_TEXT_DATA)
public int GetSizeCols()
public int getSizeCols()
public int GetSizeRows()
public int getSizeRows()
public boolean is3270()
public boolean is5250()
public abstract boolean is3270Screen()
public abstract boolean is5250Screen()
public boolean isArabicSession()
public abstract boolean isArabic()
public boolean isBIDISession()
public abstract boolean isBidi()
public boolean isDBCSSession()
public abstract boolean isDbcsScreen()
public void setCursorCol(int cursorCol)
cursorCol - - the cursor column valuepublic void setCursorPos(int cursorPos)
cursorPos - - the cursor position valuepublic void setCursorRow(int cursorRow)
cursorRow - - the cursorRow to setpublic void setHsrBidiServices(HsrBidiServices hsrBidi)
hsrBidi - - The HsrBidiServices object, if a host screen is Bidi.public void setScreenSize(int screenSize)
screenSize - - the screen sizepublic void setSizeCols(int sizeCols)
sizeCols - - number of total columnspublic void setSizeRows(int sizeRows)
sizeRows - - number of total rows
public int ConvertRowColToPos(int row,
int col)
row - The row of the positioncol - The column of the position
public int ConvertPosToCol(int pos)
pos - The position to query
public int ConvertPosToRow(int pos)
pos - The position to query
|
HATS 7.5.1 (201005110649) | ||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | ||||||||