All Packages  Class Hierarchy  This Package  Previous  Next  Index

Class com.ibm.eNetwork.ECL.ECLPS

java.lang.Object
   |
   +----com.ibm.eNetwork.ECL.ECLPS

public class ECLPS
extends Object
implements ECLConstants, iOhioScreen
ECLPS encapsulates the host presentation space. The presentation space is a virtual screen which contains all the characters and attributes that would be seen on a traditional emulator screen. The presentation space is the primary object for text-based interactions with the host. This class provides methods that manipulate text, perform searches, send keystrokes to the host, and work with the cursor. An instance of ECLPS can be obtained using the GetPS() method on an instance of ECLSession.

The raw presentation space data is maintained in a series of planes which can be accessed by various methods within this class. The text plane contains the actual characters in the presentation space. Most of the methods in ECLPS work exclusively with the text plane.

The remaining planes contain the corresponding attributes for each character in the text plane. The color plane contains color characteristics. The field plane contains the field attributes. The extended field plane contains the extended field attributes. The DBCS plane contains double byte character set (DBCS) character and field attributes. The grid plane contains the DBCS grid information. The color, field, extended field, DBCS, and grid planes are not interpreted by any of the methods in this class.

It may be more convenient to access the presentation space through a field list (ECLFieldList). The GetFieldList() method may be used to get an instance of ECLFieldList which contains a snapshot of all the fields in the current presentation space. Fields provide convenient methods for interpreting the data in the non-text planes.

The only configurable feature of the presentation space is its size. The size is determined by the value of the SESSION_PS_SIZE keyword in the Properties parameter when ECLSession is constructed. Valid presentation space sizes include 24 x 80, 32 x 80, 43 x 80, 27 x 132, and 24 x 132 but might be limited by the type of emulation (3270, 5250, VT). The default size is 24 rows by 80 columns. The size of the presentation space can be determined using the GetSize(), GetSizeRows(), and GetSizeCols() methods.

Once an instance of ECLPS has been obtained, an application can register for PS events using the RegisterPSEvent() method. PS events are sent to registered objects whenever the presentation space is changed for any reason, be it host or operator initiated. These PS events are the primary mechanism used by an application to drive interactions with the presentation space.

See Also:
ECLSession, ECLFieldList, ECLField

Variable Index

 o ALL_EVENTS
 o fileAttr
 o HOST_EVENTS
 o USER_EVENTS

Method Index

 o clearHistoryWindow()
 o ConvertPosToCol(int)
The ConvertPosToCol method converts a linear presentation space position to its corresponding column.
 o ConvertPosToRow(int)
The ConvertPosToRow method converts a linear presentation space position to its corresponding row.
 o ConvertRowColToPos(int, int)
The ConvertRowColToPos method converts a row and column coordinate to its corresponding linear position.
 o GetCursorCol()
Returns the column coordinate of the current cursor position.
 o GetCursorPos()
Returns the linear cursor position.
 o GetCursorRow()
Returns the row coordinate of the current cursor position.
 o GetCursorVisible()
Returns whether the cursor is visible.
 o GetFieldList()
GetFieldList returns an instance of ECLFieldList based on the current PS.
 o GetFieldList(int)
GetFieldList returns an instance of ECLFieldList based on the current PS.
 o getHistoryPosFromLogicalPos(int)
getHistoryPosFromLogicalPos() This function returns the calculated history linear position based on the passed in logical screen position.
 o getHistoryRows()
getHistoryRows() This function returns the number of history rows captured.
 o getHistoryViewPos()
getHistoryViewPos() This function returns the local copy of the history view position.
 o GetParent()
Get the parent of this PS which is an instance of ECLSession.
 o GetScreen(char[], int, int)
GetScreen retrieves the various planes (text, color, attributes, extended attributes) associated with the presentation space.
 o GetScreen(char[], int, int, int, int)
GetScreen retrieves the various planes (text, color, attributes, extended attributes) associated with the presentation space.
 o GetScreen(char[], int, int, int, int, int)
GetScreen retrieves the various planes (text, color, attributes, extended attributes) associated with the presentation space.
 o GetScreenRect(char[], int, int, int, int)
GetScreenRect retrieves data from the various planes (text, color, attributes, extended attributes) associated with the presentation space.
 o GetScreenRect(char[], int, int, int, int, int, int)
GetScreenRect retrieves data from the various planes (text, color, attributes, extended attributes) associated with the presentation space.
 o GetSendKeyMnemonics()
Returns the valid list of SendKey mnemonic commands for the PS object.
 o GetSize()
Returns the linear size of the presentation space.
 o GetSizeCols()
Returns the total number of columns in the presentation space.
 o GetSizeRows()
Returns the total number of rows in the presentation space.
 o GetString(char[], int)
GetString retrieves text plane information from the presentation space similarly to GetScreen using the TEXT_PLANE parameter, but it handles DBCS characters differently.
 o GetString(char[], int, int, int)
GetString retrieves text plane information from the presentation space similarly to GetScreen using the TEXT_PLANE parameter, but it handles DBCS characters differently.
 o GetString(char[], int, int, int, int)
GetString retrieves text plane information from the presentation space similarly to GetScreen using the TEXT_PLANE parameter, but it handles DBCS characters differently.
 o initHistoryWindow()
 o isHistoryEnabled()
isHistoryEnabled() This function returns the boolean state of history mode.
 o isScreenReversed()
/** This method is used for VT sessions.
 o IsSuppressClearEvent()
Returns whether the system should ignore screen events when a host application sends a clear screen command immediately followed by an end of record indicator in the data stream.
 o RegisterPSEvent(ECLPSListener)
Registers a PS Listener for all PS events.
 o RegisterPSEvent(ECLPSListener, int)
Registers a PS Listener for either host- or user-generated events.
 o RegisterPSEvent(ECLPSNotify)
Registers a notification object for events dispatched by a single instance of ECLPS. Deprecated.
 o SearchString(String, int)
The SearchString method searches for a given text string within the presentation space similarly to SearchText, but it handles DBCS characters differently.
 o SearchString(String, int, int)
The SearchString method searches for a given text string within the presentation space similarly to SearchText, but it handles DBCS characters differently.
 o SearchString(String, int, int, int)
The SearchString method searches for a given text string within the presentation space similarly to SearchText, but it handles DBCS characters differently.
 o SearchText(String, int)
The SearchText method searches for a given text string within the presentation space.
 o SearchText(String, int, int)
The SearchText method searches for a given text string within the presentation space.
 o SearchText(String, int, int, int)
The SearchText method searches for a given text string within the presentation space.
 o SendKeys(String)
The SendKeys method sends a string of keys to the presentation space.
 o SendKeys(String, int)
This signature of SendKeys sends the given text string at the specified cursor location.
 o SendKeys(String, int, int)
This signature of SendKeys sends the given text string at the specified cursor position.
 o SetCursorPos(int)
Sets the cursor position to the specified linear position.
 o SetCursorPos(int, int)
Sets the cursor position to the specified row and column.
 o SetCursorVisible(boolean)
Sets the cursor to be visible or invisible depending on the given parameter
 o setHistoryViewPos(int)
setHistoryViewPos() This function sets the local copy of the history view position.
 o setSize(int, int)
This method is used to set the size of the presentation space and allocate any memory need to store the characters.
 o SetString(String)
The SetString method sends a string to the presentation space at the current cursor location similarly to SetText, but it handles DBCS characters differently.
 o SetString(String, int)
The SetString method sends a string to the presentation space at the specified location similarly to SetText, but it handles DBCS characters differently.
 o SetString(String, int, int)
The SetString method sends a string to the presentation space at the specified location similarly to SetText, but it handles DBCS characters differently.
 o SetSuppressClearEvent(boolean)
Sets whether the system should ignore screen events when a host application sends a clear screen command immediately followed by an end of record indicator in the data stream.
 o SetText(String)
The SetText method sends a string to the presentation space at the current cursor location.
 o SetText(String, int)
The SetText method sends a string to the presentation space at the specified location.
 o SetText(String, int, int)
The SetText method sends a string to the presentation space at the specified location.
 o UnregisterPSEvent(ECLPSListener)
Unregisters a PS Listener that was previously registered with the RegisterPSEvent() method.
 o UnregisterPSEvent(ECLPSListener, int)
Unregisters a PS Listener that was previously registered with the RegisterPSEvent() method.
 o UnregisterPSEvent(ECLPSNotify)
Unregisters a notification object previously registered with the RegisterPSEvent() method. Deprecated.
 o WaitForAttrib(int, int, char, int)
Synchronously waits until the attribute appears at the given row and column position.
 o WaitForAttrib(int, int, char, int, long, boolean)
Synchronously waits until the attribute appears at the given row and column position or until the method times out.
 o WaitForCursor(int, int)
Synchronously waits until the cursor appears at the given row and column position.
 o WaitForCursor(int, int, long, boolean)
Synchronously waits until the cursor appears at the given row and column position or until the method times out.
 o WaitForScreen(ECLScreenDesc)
Synchronously waits until the screen, as described by ECLScreenDesc, appears in the Presentation Space.
 o WaitForScreen(ECLScreenDesc, long)
Synchronously waits for the screen, as described by ECLScreenDesc, to appear in the Presentation Space.
 o WaitForString(String)
Synchronously waits until the string appears in the presentation space.
 o WaitForString(String, int, int)
Synchronously waits until the string appears at the given position.
 o WaitForString(String, int, int, long, boolean, boolean)
Synchronously waits until the string appears at the given position.
 o WaitForStringInRect(String, int, int, int, int)
Synchronously waits until the string appears at the given rectangle.
 o WaitForStringInRect(String, int, int, int, int, long, boolean, boolean)
Synchronously waits until the string appears at the given rectangle.
 o WaitWhileAttrib(int, int, char, int)
Synchronously waits until the attribute is no longer at the given row and column position.
 o WaitWhileAttrib(int, int, char, int, long, boolean)
Synchronously waits until the attribute is no longer at the given row and column position.
 o WaitWhileCursor(int, int)
Synchronously waits until the cursor is no longer at the given row and column position.
 o WaitWhileCursor(int, int, long, boolean)
Synchronously waits until the cursor is no longer at the given row and column position or until the method times out.
 o WaitWhileScreen(ECLScreenDesc)
Synchronously waits until the screen, as described by ECLScreenDesc, is no longer in the Presentation Space.
 o WaitWhileScreen(ECLScreenDesc, long)
Synchronously waits until the screen, as described by ECLScreenDesc, is no longer in the Presentation Space.
 o WaitWhileString(String)
Synchronously waits until the string is no longer in the presentation space.
 o WaitWhileString(String, int, int)
Synchronously waits until the string is no longer in the given position.
 o WaitWhileString(String, int, int, long, boolean, boolean)
Synchronously waits until the string is no longer in the given position.
 o WaitWhileStringInRect(String, int, int, int, int)
Synchronously waits until the string is no longer in the given rectangle.
 o WaitWhileStringInRect(String, int, int, int, int, long, boolean, boolean)
Synchronously waits until the string is no longer in the given rectangle.

Variables

 o USER_EVENTS
 public static final int USER_EVENTS
 o HOST_EVENTS
 public static final int HOST_EVENTS
 o ALL_EVENTS
 public static final int ALL_EVENTS
 o fileAttr
 public boolean fileAttr

Methods

 o GetParent
 public ECLSession GetParent()
Get the parent of this PS which is an instance of ECLSession.

Returns:
The parent ECLSession.
 o GetSize
 public synchronized int GetSize()
Returns the linear size of the presentation space. The linear size of a presentation space is determined by multiplying the number of rows and columns. For example a 24 x 80 presentation space would have a size of 1920.

Returns:
The linear size of the presentation space.
 o GetSizeRows
 public synchronized int GetSizeRows()
Returns the total number of rows in the presentation space.

Returns:
The number of rows in the presentation space.
See Also:
GetSizeCols
 o GetSizeCols
 public synchronized int GetSizeCols()
Returns the total number of columns in the presentation space.

Returns:
The number of columns in the presentation space.
See Also:
GetSizeRows
 o GetCursorPos
 public synchronized int GetCursorPos()
Returns the linear cursor position. The linear cursor position is determined by assuming the presentation space is mapped to a one-dimensional array. Two-dimensional array coordinates can be mapped to a one-dimensional array using the following formula: (y - 1) * numCol + x. Therefore, the linear position of a cursor at 10, 15 on a 24 x 80 presentation space would be 9*80+15=735.

Note: The cursor positioning system is 1-based rather than 0-based. The valid cursor positions for a 24 x 80 presentation space are between 1 and 1920 inclusive.

Returns:
The linear cursor position.
 o GetCursorRow
 public synchronized int GetCursorRow()
Returns the row coordinate of the current cursor position.

Note: The cursor positioning system is 1-based rather than 0-based. The valid cursor row positions for a 24 x 80 presentation space are between 1 and 24 inclusive.

Returns:
The row coordinate of the current cursor position.
See Also:
GetCursorCol
 o GetCursorCol
 public synchronized int GetCursorCol()
Returns the column coordinate of the current cursor position.

Note: The cursor positioning system is 1-based rather than 0-based. The valid cursor column positions for a 24 x 80 presentation space are between 1 and 80 inclusive.

Returns:
The column coordinate of the current cursor position.
See Also:
GetCursorRow
 o SetCursorPos
 public synchronized void SetCursorPos(int pos) throws ECLErr
Sets the cursor position to the specified linear position.

Parameters:
pos - The new linear cursor position. This number must be between 1 and the size of the presentation space inclusive.
Throws: ECLErr
Thrown when the given position is out of range.
See Also:
SetCursorPos
 o SetCursorPos
 public synchronized void SetCursorPos(int row,
                                       int col) throws ECLErr
Sets the cursor position to the specified row and column.

Parameters:
row - The new row coordinate of the cursor position. This number must be between 1 and the number of rows in the presentation space inclusive.
column - The new column coordinate of the cursor position. This number must be between 1 and the number of columns in the presentation space inclusive.
Throws: ECLErr
Thrown when the coordinates given are out of range.
See Also:
SetCursorPos
 o GetSendKeyMnemonics
 public String[] GetSendKeyMnemonics()
Returns the valid list of SendKey mnemonic commands for the PS object. This list is based on what session type the PS is from (3270, 5250, VT, and CICS) and what national language environment the PS is running in (Bidi, DBCS, and Thai).

These special keys are represented by keywords which are delimited by square brackets and called mnemonics. For example, the mnemonic keyword for the Enter key is [enter].

Returns:
java.lang.String [] String array that contains the valid key mnemonics
 o SendKeys
 public synchronized void SendKeys(String text) throws ECLErr
The SendKeys method sends a string of keys to the presentation space. The string can be thought of as keystrokes from the keyboard which can contain both text characters and special keystrokes, like the Enter key, the Tab key, or the Page Up key. These special keys are represented by keywords which are delimited by square brackets and called mnemonics. For example, the mnemonic keyword for the Enter key is [enter].

The text string can contain any number or combination of characters and mnemonics. For example, the following string, "userID[tab]password[enter]", can be used to send a user's ID, tab to the next field, send the user's password, and then send the Enter key to logon to a host.

To send a left or right square bracket, the character must be doubled. To send a left square bracket use "[[". To send a right square bracket use "]]".

This signature of SendKeys sends the given text string at the current cursor location.

Parameters:
text - The string of characters and aid key mnemonics to be sent.
See Also:
SendKeys, SendKeys
 o SendKeys
 public synchronized void SendKeys(String text,
                                   int pos) throws ECLErr
This signature of SendKeys sends the given text string at the specified cursor location. The cursor is moved to the given location before the text string is sent.

Parameters:
text - The string of characters and mnemonic keywords to be sent.
pos - The linear position where keys should be sent.
Throws: ECLErr
Thrown if the position specified is out of range.
See Also:
SendKeys, SendKeys
 o SendKeys
 public synchronized void SendKeys(String text,
                                   int row,
                                   int col) throws ECLErr
This signature of SendKeys sends the given text string at the specified cursor position. The cursor is moved to the given coordinates before the text string is sent.

Parameters:
text - The string of characters and mnemonic keywords to be sent.
row - The starting row where keys should be sent.
column - The starting column where keys should be sent.
Throws: ECLErr
Thrown if the position specified is out of range.
See Also:
SendKeys, SendKeys
 o SearchText
 public synchronized int SearchText(String text,
                                    int direction)
The SearchText method searches for a given text string within the presentation space. The method allows both forward and backward searches. If a forward search is specified, the search starts at the beginning of the presentation space. If a backward search is specified, the search starts at the end of the presentation space.

The method returns the linear position of the found string or zero if the string is not found. The linear position can be converted to row and column coordinates using the ConvertPosToRow() and ConvertPosToCol() methods.

Parameters:
text - The string to search for.
direction - Specifies whether to search forward or backward from the starting location of the search. To search forward use the SEARCH_FORWARD constant. To search backward use the SEARCH_BACKWARD constant.
Returns:
The linear position of the given string, or zero if not found.
See Also:
SearchText, SearchText, ConvertPosToRow, ConvertPosToCol
 o SearchString
 public synchronized int SearchString(String text,
                                      int direction)
The SearchString method searches for a given text string within the presentation space similarly to SearchText, but it handles DBCS characters differently. While SearchText searches for the exact string specified, SearchString automatically duplicates DBCS characters in the search string before attempting the search.

The method allows both forward and backward searches. If a forward search is specified, the search starts at the beginning of the presentation space. If a backward search is specified, the search starts at the end of the presentation space.

The method returns the linear position of the found string or zero if the string is not found. The linear position can be converted to row and column coordinates using the ConvertPosToRow() and ConvertPosToCol() methods.

Note: SearchString functions identically to SearchText when the given search string contains no DBCS characters.

See Text Plane in Appendix B. Host Access Class Library Planes -- Format and Content for more information on the representation of DBCS characters in the text plane.

Parameters:
text - The string to search for.
direction - Specifies whether to search forward or backward from the starting location of the search. To search forward use the SEARCH_FORWARD constant. To search backward use the SEARCH_BACKWARD constant.
Returns:
The linear position of the given string, or zero if not found.
See Also:
SearchString, SearchString, ConvertPosToRow, ConvertPosToCol
 o SearchText
 public synchronized int SearchText(String text,
                                    int row,
                                    int column,
                                    int direction) throws ECLErr
The SearchText method searches for a given text string within the presentation space. The method allows both forward and backward searches. If a forward search is specified, the search begins at the given coordinates (inclusive) and ends at the end of the presentation space. If a backward search is specified, the search begins at the given coordinates (inclusive) and ends at the beginning of the presentation space.

The method returns the linear position of the found string or zero if the string is not found. The linear position can be converted to row and column coordinates using the ConvertPosToRow() and ConvertPosToCol() methods.

Parameters:
text - The string to search for.
row - Starting row.
column - Starting column.
direction - Specifies whether to search forward or backward from the starting location of the search. To search forward use the SEARCH_FORWARD constant. To search backward use the SEARCH_BACKWARD constant.
Returns:
The linear position of the given string, or zero if not found.
Throws: ECLErr
Thrown if the position specified is out of range.
See Also:
SearchText, SearchText, ConvertPosToRow, ConvertPosToCol
 o SearchString
 public synchronized int SearchString(String text,
                                      int row,
                                      int column,
                                      int direction) throws ECLErr
The SearchString method searches for a given text string within the presentation space similarly to SearchText, but it handles DBCS characters differently. While SearchText searches for the exact string specified, SearchString automatically duplicates DBCS characters in the search string before attempting the search.

The method allows both forward and backward searches. If a forward search is specified, the search begins at the given coordinates (inclusive) and ends at the end of the presentation space. If a backward search is specified, the search begins at the given coordinates (inclusive) and ends at the beginning of the presentation space.

The method returns the linear position of the found string or zero if the string is not found. The linear position can be converted to row and column coordinates using the ConvertPosToRow() and ConvertPosToCol() methods.

Note: SearchString functions identically to SearchText when the given search string contains no DBCS characters.

See Text Plane in Appendix B. Host Access Class Library Planes -- Format and Content for more information on the representation of DBCS characters in the text plane.

Parameters:
text - The string to search for.
row - Starting row.
column - Starting column.
direction - Specifies whether to search forward or backward from the starting location of the search. To search forward use the SEARCH_FORWARD constant. To search backward use the SEARCH_BACKWARD constant.
Returns:
The linear position of the given string, or zero if not found.
Throws: ECLErr
Thrown if the position specified is out of range.
See Also:
SearchString, SearchString, ConvertPosToRow, ConvertPosToCol
 o SearchText
 public synchronized int SearchText(String text,
                                    int position,
                                    int direction)
The SearchText method searches for a given text string within the presentation space. The method allows both forward and backward searches. If a forward search is specified, the search begins at the given linear position (inclusive) and ends at the end of the presentation space. If a backward search is specified, the search begins at the given linear position (inclusive) and ends at the beginning of the presentation space.

The method returns the linear position of the found string or zero if the string is not found. The linear position can be converted to row and column coordinates using the ConvertPosToRow() and ConvertPosToCol() methods.

Parameters:
text - The string to search for.
position - Starting linear position.
direction - Specifies whether to search forward or backward from the starting location of the search. To search forward use the SEARCH_FORWARD constant. To search backward use the SEARCH_BACKWARD constant.
Returns:
The linear position of the given string, or zero if not found.
See Also:
SearchText, SearchText, ConvertPosToRow, ConvertPosToCol
 o SearchString
 public synchronized int SearchString(String text,
                                      int position,
                                      int direction)
The SearchString method searches for a given text string within the presentation space similarly to SearchText, but it handles DBCS characters differently. While SearchText searches for the exact string specified, SearchString automatically duplicates DBCS characters in the search string before attempting the search.

The method allows both forward and backward searches. If a forward search is specified, the search begins at the given linear position (inclusive) and ends at the end of the presentation space. If a backward search is specified, the search begins at the given linear position (inclusive) and ends at the beginning of the presentation space.

The method returns the linear position of the found string or zero if the string is not found. The linear position can be converted to row and column coordinates using the ConvertPosToRow() and ConvertPosToCol() methods.

Note: SearchString functions identically to SearchText when the given search string contains no DBCS characters.

See Text Plane in Appendix B. Host Access Class Library Planes -- Format and Content for more information on the representation of DBCS characters in the text plane.

Parameters:
text - The string to search for.
position - Starting linear position.
direction - Specifies whether to search forward or backward from the starting location of the search. To search forward use the SEARCH_FORWARD constant. To search backward use the SEARCH_BACKWARD constant.
Returns:
The linear position of the given string, or zero if not found.
See Also:
SearchString, SearchString, ConvertPosToRow, ConvertPosToCol
 o GetScreen
 public synchronized int GetScreen(char buffer[],
                                   int bufferLength,
                                   int plane) throws ECLErr
GetScreen retrieves the various planes (text, color, attributes, extended attributes) associated with the presentation space. The data is returned as a linear array of character values in the array provided. The array is not terminated by a null character except when data is retrieved from the text plane, in which case a single null character is appended.

The application must supply a buffer for the returned data and the length of the buffer. Data is returned starting from the beginning of the presentation space and continuing until the buffer is full or the entire plane has been copied. For text plane data, the buffer must include one extra position for the terminating null character.

Parameters:
buffer - An array of characters that contains the returned data.
bufferLength - The length of the buffer.
plane - The plane to return. The valid values follow:
TEXT_PLANE - The character contents of the field. The text plane contains no null or non-displayable characters.
FIELD_PLANE - The field attributes for each field in the plane.
COLOR_PLANE - The color attributes for each character in the plane.
EXFIELD_PLANE - The extended field attributes for each character in the plane.
DBCS_PLANE - The double byte character set (DBCS) character and field attribute data.
GRID_PLANE - The DBCS grid information.
Returns:
The number of characters copied to the buffer, not including the terminating null for text plane data.
Throws: ECLErr
Thrown if the buffer parameter is null, or if the plane parameter is incorrect.
See Also:
GetScreen, GetScreen
 o GetString
 public synchronized int GetString(char buffer[],
                                   int bufferLength) throws ECLErr
GetString retrieves text plane information from the presentation space similarly to GetScreen using the TEXT_PLANE parameter, but it handles DBCS characters differently. While GetScreen returns the raw text plane data, GetString removes duplicate DBCS characters before the text plane data is returned.

The application must supply a buffer for the returned data and the length of the buffer. Data is returned starting from the beginning of the presentation space and continuing until the buffer is full or the entire text plane has been copied. The buffer must include one extra position for the addition of a terminating null character.

Note: GetString functions identically to GetScreen(char[], int, TEXT_PLANE) when the text plane contains no DBCS characters.

See Text Plane in Appendix B. Host Access Class Library Planes -- Format and Content for more information on the representation of DBCS characters in the text plane.

Parameters:
buffer - An array of characters that contains the returned data.
bufferLength - The length of the buffer.
Returns:
The number of characters copied to the buffer, not including the terminating null.
Throws: ECLErr
Thrown if the buffer parameter is null.
See Also:
GetString, GetString
 o GetScreen
 public synchronized int GetScreen(char buffer[],
                                   int bufferLength,
                                   int row,
                                   int col,
                                   int length,
                                   int plane) throws ECLErr
GetScreen retrieves the various planes (text, color, attributes, extended attributes) associated with the presentation space. The data is returned as a linear array of character values in the array provided. The array is not terminated by a null character except when data is retrieved from the text plane, in which case a single null character is appended.

The application must supply a buffer for the returned data and the length of the buffer. Data is returned starting from the given coordinates and continuing until the specified number of characters have been copied, the buffer is full, or the entire plane has been copied. For text plane data, the buffer must include one extra position for the terminating null character.

Parameters:
buffer - An array of characters that contains the returned data.
bufferLength - The length of the buffer.
row - The starting row.
column - The starting column.
length - The number of characters to copy.
plane - The plane to return. The valid values follow:
TEXT_PLANE - The character contents of the field. The text plane contains no null or non-displayable characters.
FIELD_PLANE - The field attributes for each field in the plane.
COLOR_PLANE - The color attributes for each character in the plane.
EXFIELD_PLANE - The extended field attributes for each character in the plane.
DBCS_PLANE - The double byte character set (DBCS) character and field attribute data.
GRID_PLANE - The DBCS grid information.
Returns:
The number of characters copied to the buffer, not including the terminating null for text plane data.
Throws: ECLErr
Thrown if the buffer parameter is null, if the plane parameter is incorrect, or if the position given is out of range.
See Also:
GetScreen, GetScreen
 o GetString
 public synchronized int GetString(char buffer[],
                                   int bufferLength,
                                   int row,
                                   int col,
                                   int length) throws ECLErr
GetString retrieves text plane information from the presentation space similarly to GetScreen using the TEXT_PLANE parameter, but it handles DBCS characters differently. While GetScreen returns the raw text plane data, GetString removes duplicate DBCS characters before the text plane data is returned.

The application must supply a buffer for the returned data and the length of the buffer. Data is returned starting from the given coordinates and continuing until the specified number of plane positions have been copied, the buffer is full, or the entire text plane has been copied. The buffer must include one extra position for the addition of a terminating null character. Note that a DBCS character occupies two plane positions.

Note: GetString functions identically to GetScreen(char[], int, int, int, int, TEXT_PLANE) when the text plane contains no DBCS characters.

See Text Plane in Appendix B. Host Access Class Library Planes -- Format and Content for more information on the representation of DBCS characters in the text plane.

Parameters:
buffer - An array of characters that contains the returned data.
bufferLength - The length of the buffer.
row - The starting row.
column - The starting column.
length - The number of plane positions to copy.
Returns:
The number of characters copied to the buffer, not including the terminating null.
Throws: ECLErr
Thrown if the buffer parameter is null or if the position given is out of range.
See Also:
GetString, GetString
 o GetScreen
 public synchronized int GetScreen(char buffer[],
                                   int bufferLength,
                                   int position,
                                   int length,
                                   int plane) throws ECLErr
GetScreen retrieves the various planes (text, color, attributes, extended attributes) associated with the presentation space. The data is returned as a linear array of character values in the array provided. The array is not terminated by a null character except when data is retrieved from the text plane, in which case a single null character is appended.

The application must supply a buffer for the returned data and the length of the buffer. Data is returned starting from the given position and continuing until the specified number of characters have been copied, the buffer is full or the entire plane has been copied. For text plane data, the buffer must include one extra position for the terminating null character.

Parameters:
buffer - An array of characters which contains the returned data.
bufferLength - The length of the buffer.
position - The starting position.
length - The number of characters to copy.
plane - The plane to return. The valid values follow:
TEXT_PLANE - The character contents of the field. The text plane contains no null or non-displayable characters.
FIELD_PLANE - The field attributes for each field in the plane.
COLOR_PLANE - The color attributes for each character in the plane.
EXFIELD_PLANE - The extended field attributes for each character in the plane.
DBCS_PLANE - The double byte character set (DBCS) character and field attribute data.
GRID_PLANE - The DBCS grid information.
Returns:
The number of characters copied to the buffer, not including the terminating null for text plane data.
Throws: ECLErr
Thrown if the buffer parameter is null, if the plane parameter is incorrect.
Throws: IllegalArgumentException
Runtime exception thrown if position given is out of range, bufferLength is not greater than 0 and length is not greater than 0.
See Also:
GetScreen, GetScreen
 o GetString
 public synchronized int GetString(char buffer[],
                                   int bufferLength,
                                   int position,
                                   int length) throws ECLErr
GetString retrieves text plane information from the presentation space similarly to GetScreen using the TEXT_PLANE parameter, but it handles DBCS characters differently. While GetScreen returns the raw text plane data, GetString removes duplicate DBCS characters before the text plane data is returned.

The application must supply a buffer for the returned data and the length of the buffer. Data is returned starting from the given coordinates and continuing until the specified number of plane positions have been copied, the buffer is full, or the entire text plane has been copied. The buffer must include one extra position for the addition of a terminating null character. Note that a DBCS character occupies two plane positions.

Note: GetString functions identically to GetScreen(char[], int, int, int, TEXT_PLANE) when the text plane contains no DBCS characters.

See Text Plane in Appendix B. Host Access Class Library Planes -- Format and Content for more information on the representation of DBCS characters in the text plane.

Parameters:
buffer - An array of characters that contains the returned data.
bufferLength - The length of the buffer.
position - The starting position.
length - The number of plane positions to copy.
Returns:
The number of characters copied to the buffer, not including the terminating null.
Throws: ECLErr
Thrown if the buffer parameter is null or if the position given is out of range.
See Also:
GetString, GetString
 o GetScreenRect
 public synchronized int GetScreenRect(char buffer[],
                                       int bufferLength,
                                       int startPos,
                                       int endPos,
                                       int plane) throws ECLErr
GetScreenRect retrieves data from the various planes (text, color, attributes, extended attributes) associated with the presentation space. The data is returned as a linear array of character values in the buffer provided.

The application supplies two positions that represent opposing corners of a rectangle within the presentation space. The starting and ending positions can have any spatial relationship to each other. The data returned starts from the row containing the upper-most point to the row containing the lower-most point, and from the left-most column to the right-most column.

The specified buffer must be at least large enough to contain the number of characters in the rectangle. If the buffer is too small, no data is copied and zero is returned by the method. Otherwise, the method returns the number of characters copied.

Parameters:
buffer - An array of characters that contains the returned data.
bufferLength - The length of the buffer.
startPos - One corner of the rectangle.
endPos - The opposite corner of the rectangle.
plane - The plane to return. The valid values follow:
TEXT_PLANE - The character contents of the field. The text plane contains no null or non-displayable characters.
FIELD_PLANE - The field attributes for each field in the plane.
COLOR_PLANE - The color attributes for each character in the plane.
EXFIELD_PLANE - The extended field attributes for each character in the plane.
DBCS_PLANE - The double byte character set (DBCS) character and field attribute data.
GRID_PLANE - The DBCS grid information.
Returns:
The number of characters copied to the buffer.
Throws: ECLErr
Thrown if the buffer parameter is null, if the plane parameter is incorrect or if either of the positions specified is not within the plane.
See Also:
GetScreenRect
 o GetScreenRect
 public synchronized int GetScreenRect(char buffer[],
                                       int bufferLength,
                                       int startRow,
                                       int startCol,
                                       int endRow,
                                       int endCol,
                                       int plane) throws ECLErr
GetScreenRect retrieves data from the various planes (text, color, attributes, extended attributes) associated with the presentation space. The data is returned as a linear array of character values in the buffer provided. The buffer is not terminated by a null character.

The application supplies two coordinates that represent opposing corners of a rectangle within the presentation space. The starting and ending coordinates can have any spatial relationship to each other. The data returned starts from the row containing the upper-most point to the row containing the lower-most point, and from the left-most column to the right-most column.

The specified buffer must be at least large enough to contain the number of characters in the rectangle. If the buffer is too small, no data is copied and zero is returned by the method. Otherwise, the method returns the number of characters copied.

Parameters:
buffer - An array of characters that contains the returned data.
bufferLength - The length of the buffer.
startRow - Starting row of the rectangle.
startCol - Starting column of the rectangle.
endRow - Ending row of the rectangle.
endCol - Ending column of the rectangle.
plane - The plane to return. The valid values follow:
TEXT_PLANE - The character contents of the field. The text plane contains no null or non-displayable characters.
FIELD_PLANE - The field attributes for each field in the plane.
COLOR_PLANE - The color attributes for each character in the plane.
EXFIELD_PLANE - The extended field attributes for each character in the plane.
DBCS_PLANE - The double byte character set (DBCS) character and field attribute data.
GRID_PLANE - The DBCS grid information.
Returns:
The number of characters copied to the buffer.
Throws: ECLErr
Thrown if the buffer parameter is null, if the plane parameter is incorrect or if either of the positions specified is not within the plane.
See Also:
GetScreenRect
 o SetText
 public synchronized void SetText(String text) throws ECLErr
The SetText method sends a string to the presentation space at the current cursor location. The string will overlay only unprotected fields, and any parts of the string which fall over protected fields will be discarded.

Parameters:
text - String to place in the presentation space.
Throws: ECLErr
Thrown if the position is not valid.
See Also:
SetText, SetText
 o SetString
 public synchronized void SetString(String text) throws ECLErr
The SetString method sends a string to the presentation space at the current cursor location similarly to SetText, but it handles DBCS characters differently. While SetText copies the given string directly to the presentation space, SetString automatically duplicates DBCS characters before copying the string to the presentation space.

The modified string will overlay only unprotected fields, and any parts of the string which fall over protected fields will be discarded.

Note: SetString functions identically to SetText when the text plane contains no DBCS characters.

See Text Plane in Appendix B. Host Access Class Library Planes -- Format and Content for more information on the representation of DBCS characters in the text plane.

Parameters:
text - String to place in the presentation space.
Throws: ECLErr
Thrown if the position is not valid.
See Also:
SetString, SetString
 o SetText
 public synchronized void SetText(String text,
                                  int pos) throws ECLErr
The SetText method sends a string to the presentation space at the specified location. The string will overlay only unprotected fields, and any parts of the string which fall over protected fields will be discarded.

Parameters:
text - String to place in the presentation space.
pos - Linear position where the string should be written.
Throws: ECLErr
Thrown if the position is not valid.
See Also:
SetText, SetText
 o SetString
 public synchronized void SetString(String text,
                                    int pos) throws ECLErr
The SetString method sends a string to the presentation space at the specified location similarly to SetText, but it handles DBCS characters differently. While SetText copies the given string directly to the presentation space, SetString automatically duplicates DBCS characters before copying the string to the presentation space.

The modified string will overlay only unprotected fields, and any parts of the string which fall over protected fields will be discarded.

Note: SetString functions identically to SetText when the text plane contains no DBCS characters.

See Text Plane in Appendix B. Host Access Class Library Planes -- Format and Content for more information on the representation of DBCS characters in the text plane.

Parameters:
text - String to place in the presentation space.
pos - Linear position where the string should be written.
Throws: ECLErr
Thrown if the position is not valid.
See Also:
SetString, SetString
 o SetText
 public synchronized void SetText(String text,
                                  int row,
                                  int column) throws ECLErr
The SetText method sends a string to the presentation space at the specified location. The string will overlay only unprotected fields, and any parts of the string which fall over protected fields will be discarded.

Parameters:
text - String to place in the presentation space.
row - Starting row where the string should be written.
column - Starting column where the string should be written.
Throws: ECLErr
Thrown if the position is not valid.
See Also:
SetText, SetText
 o SetString
 public synchronized void SetString(String text,
                                    int row,
                                    int column) throws ECLErr
The SetString method sends a string to the presentation space at the specified location similarly to SetText, but it handles DBCS characters differently. While SetText copies the given string directly to the presentation space, SetString automatically duplicates DBCS characters before copying the string to the presentation space.

The modified string will overlay only unprotected fields, and any parts of the string which fall over protected fields will be discarded.

Note: SetString functions identically to SetText when the text plane contains no DBCS characters.

See Text Plane in Appendix B. Host Access Class Library Planes -- Format and Content for more information on the representation of DBCS characters in the text plane.

Parameters:
text - String to place in the presentation space.
row - Starting row where the string should be written.
column - Starting column where the string should be written.
Throws: ECLErr
Thrown if the position is not valid.
See Also:
SetString, SetString
 o ConvertPosToRow
 public synchronized int ConvertPosToRow(int pos) throws ECLErr
The ConvertPosToRow method converts a linear presentation space position to its corresponding row.

Parameters:
pos - The position to be converted.
Returns:
The row which corresponds to the position given.
Throws: ECLErr
Thrown if the position is not greater than 0 and less than the presentation space size.
See Also:
ConvertPosToCol, ConvertRowColToPos
 o ConvertPosToCol
 public synchronized int ConvertPosToCol(int pos) throws ECLErr
The ConvertPosToCol method converts a linear presentation space position to its corresponding column.

Parameters:
pos - The position to be converted.
Returns:
The column which corresponds to the position given.
Throws: ECLErr
Thrown if the position is not greater than 0 and less than the presentation space size.
See Also:
ConvertPosToRow, ConvertRowColToPos
 o ConvertRowColToPos
 public synchronized int ConvertRowColToPos(int row,
                                            int col) throws ECLErr
The ConvertRowColToPos method converts a row and column coordinate to its corresponding linear position.

Parameters:
row - The row of the coordinate.
column - The column of the coordinate.
Returns:
The linear position which corresponds to the coordinate given.
Throws: ECLErr
Thrown if the coordinates are not within the presentation space boundaries.
See Also:
ConvertPosToRow, ConvertPosToCol
 o RegisterPSEvent
 public void RegisterPSEvent(ECLPSNotify notify) throws ECLErr
Note: RegisterPSEvent() is deprecated.

Registers a notification object for events dispatched by a single instance of ECLPS. The notification object must implement the ECLPSNotify interface which defines three callback methods which will be called by the ECLPS class under different conditions.

ECLPSNotify objects can be unregistered using the UnregisterPSEvent() method.

Parameters:
notify - ECLPSNotify object which is notified when events occur.
Throws: ECLErr
Thrown if the notify parameter is null.
See Also:
UnregisterPSEvent, ECLPSNotify
 o RegisterPSEvent
 public void RegisterPSEvent(ECLPSListener listener)
Registers a PS Listener for all PS events.

Parameters:
listener - ECLPSListener object which is notified when events occur.
Throws: IllegalArgumentException
Runtime exception thrown if listener is null.
See Also:
UnregisterPSEvent, ECLPSListener
 o RegisterPSEvent
 public void RegisterPSEvent(ECLPSListener listener,
                             int type)
Registers a PS Listener for either host- or user-generated events.

Parameters:
listener - ECLPSListener object which is notified when events occur.
type - The type notification events. Valid values are HOST_EVENTS for notification of host- generated events, USER_EVENTS for notification of user- (or API) generated events, and ALL_EVENTS for notification of both USER_EVENTS and HOST_EVENTS.
Throws: IllegalArgumentException
Runtime exception thrown if listener is null.
See Also:
UnregisterPSEvent, ECLPSListener
 o UnregisterPSEvent
 public void UnregisterPSEvent(ECLPSNotify notify)
Note: UnregisterPSEvent() is deprecated.

Unregisters a notification object previously registered with the RegisterPSEvent() method. If the notification object is not currently registered, this method does nothing.

Parameters:
notify - ECLPSNotify object which should be unregistered.
See Also:
RegisterPSEvent, ECLPSNotify
 o UnregisterPSEvent
 public void UnregisterPSEvent(ECLPSListener listener)
Unregisters a PS Listener that was previously registered with the RegisterPSEvent() method. If the listener is not currently registered, this method does nothing.

Parameters:
listener - ECLPSListener object which should be unregistered.
See Also:
RegisterPSEvent, ECLPSListener
 o UnregisterPSEvent
 public void UnregisterPSEvent(ECLPSListener listener,
                               int type)
Unregisters a PS Listener that was previously registered with the RegisterPSEvent() method. If the listener is not currently registered, this method does nothing.

Parameters:
listener - ECLPSListener object which should be unregistered.
type - The type notification events. Valid values are HOST_EVENTS for notification of host- generated events, USER_EVENTS for notification of user- (or API) generated events, and ALL_EVENTS for notification of both USER_EVENTS and HOST_EVENTS.
See Also:
UnregisterPSEvent, ECLPSListener
 o WaitForAttrib
 public boolean WaitForAttrib(int row,
                              int col,
                              char attrib,
                              int plane) throws ECLErr, InterruptedException
Synchronously waits until the attribute appears at the given row and column position. Will also wait until the OIA input is not inhibited.

Note: The row and col address of a field attribute is one character position before the start of the field. For example, if a field starts at row 16, col 8, the field attribute for that field is located at row 16, col 7. Another method of locating field attributes is to use the Field Plane, available by specifying the FIELD_PLANE parameter on the GetScreen method. For more information on the content of the FIELD PLANE, see Appendix B: Field Plane.

Parameters:
row - Cursor row position
col - Cursor column position
attrib - Attribute value
plane - Plane for attribute. The valid constant values follow:
FIELD_PLANE - attribute is a field attribute
EXFIELD_PLANE - attribute is an extended field attribute
COLOR_PLANE - attribute is a color attribute
See Also:
WaitForAttrib
 o WaitForAttrib
 public boolean WaitForAttrib(int row,
                              int col,
                              char attrib,
                              int plane,
                              long timeOut,
                              boolean waitForInput) throws ECLErr, InterruptedException
Synchronously waits until the attribute appears at the given row and column position or until the method times out.

Note: The row and col address of a field attribute is one character position before the start of the field. For example, if a field starts at row 16, col 8, the field attribute for that field is located at row 16, col 7. Another method of locating field attributes is to use the Field Plane, available by specifying the FIELD_PLANE parameter on the GetScreen method. For more information on the content of the FIELD PLANE, see Appendix B: Field Plane.

Parameters:
row - Cursor row position
col - Cursor column position
attrib - Attribute value
plane - Plane for attribute. The valid constant values follow:
FIELD_PLANE - attribute is a field attribute
EXFIELD_PLANE - attribute is an extended field attribute
COLOR_PLANE - attribute is a color attribute
timeOut - Indicates wait time (milliseconds)
waitForInput - If true, will wait until OIA indicates PS is ready for input.
See Also:
WaitForAttrib
 o WaitForCursor
 public boolean WaitForCursor(int row,
                              int col) throws InterruptedException
Synchronously waits until the cursor appears at the given row and column position. Will also wait until the OIA input is not inhibited.

Parameters:
row - Cursor row position
col - Cursor column position
See Also:
WaitForCursor
 o WaitForCursor
 public boolean WaitForCursor(int row,
                              int col,
                              long timeOut,
                              boolean waitForInput) throws InterruptedException
Synchronously waits until the cursor appears at the given row and column position or until the method times out.

Parameters:
row - Cursor row position
col - Cursor column position
timeOut - Indicates wait time (milliseconds)
waitForInput - If true, will wait until OIA indicates PS is ready for input.
See Also:
WaitForCursor
 o WaitForScreen
 public boolean WaitForScreen(ECLScreenDesc screenDesc) throws ECLErr, InterruptedException
Synchronously waits until the screen, as described by ECLScreenDesc, appears in the Presentation Space. NOTE: the wait for OIA flag is set on the ECLScreenDesc object, it is not passed as a parameter to the wait method.

Parameters:
ECLScreenDesc - Object that describes the screen
See Also:
WaitForScreen, ECLScreenDesc
 o WaitForScreen
 public boolean WaitForScreen(ECLScreenDesc screenDesc,
                              long timeOut) throws ECLErr, InterruptedException
Synchronously waits for the screen, as described by ECLScreenDesc, to appear in the Presentation Space. NOTE: the wait for OIA flag is set on the ECLScreenDesc object, it is not passed as a parameter to the wait method.

Parameters:
ECLScreenDesc - Object that describes the screen
timeOut - Indicates wait time (milliseconds)
See Also:
WaitForScreen, ECLScreenDesc
 o WaitForString
 public boolean WaitForString(String str) throws InterruptedException
Synchronously waits until the string appears in the presentation space. Will also wait until the OIA input is not inhibited. String wait will be case sensitive.

Parameters:
str - String to wait for
See Also:
WaitForString, WaitForString
 o WaitForString
 public boolean WaitForString(String str,
                              int row,
                              int col) throws InterruptedException
Synchronously waits until the string appears at the given position. Will also wait until the OIA input is not inhibited. String wait will be case sensitive.

Parameters:
str - String to wait for
row - Starting row position
col - Starting column position
See Also:
WaitForString, WaitForString
 o WaitForString
 public boolean WaitForString(String str,
                              int row,
                              int col,
                              long timeOut,
                              boolean waitForInput,
                              boolean caseSensitive) throws InterruptedException
Synchronously waits until the string appears at the given position.

Parameters:
str - String to wait for
row - Starting row position
col - Starting column position
timeOut - Indicates wait time (milliseconds)
waitForInput - If true, will wait until OIA indicates PS is ready for input.
caseSensitive - If true, String wait will be case sensitive
See Also:
WaitForString, WaitForString
 o WaitForStringInRect
 public boolean WaitForStringInRect(String str,
                                    int sRow,
                                    int sCol,
                                    int eRow,
                                    int eCol) throws InterruptedException
Synchronously waits until the string appears at the given rectangle. Will also wait until the OIA input is not inhibited. String wait will be case sensitive.

Parameters:
str - String to wait for
sRow - Upper left rectangle corner row position
sCol - Upper left rectangle corner column position
eRow - Lower right rectangle corner row position
eCol - Lower right rectangle corner column position
See Also:
WaitForStringInRect
 o WaitForStringInRect
 public boolean WaitForStringInRect(String str,
                                    int sRow,
                                    int sCol,
                                    int eRow,
                                    int eCol,
                                    long timeOut,
                                    boolean waitForInput,
                                    boolean caseSensitive) throws InterruptedException
Synchronously waits until the string appears at the given rectangle.

Parameters:
str - String to wait for
sRow - Upper left rectangle corner row position
sCol - Upper left rectangle corner column position
eRow - Lower right rectangle corner row position
eCol - Lower right rectangle corner column position
timeOut - Indicates wait time (milliseconds)
waitForInput - If true, will wait until OIA indicates PS is ready for input.
caseSensitive - If true, String wait will be case sensitive
See Also:
WaitForStringInRect
 o WaitWhileAttrib
 public boolean WaitWhileAttrib(int row,
                                int col,
                                char attrib,
                                int plane) throws ECLErr, InterruptedException
Synchronously waits until the attribute is no longer at the given row and column position. Will also wait until the OIA input is not inhibited.

Note: The row and col address of a field attribute is one character position before the start of the field. For example, if a field starts at row 16, col 8, the field attribute for that field is located at row 16, col 7. Another method of locating field attributes is to use the Field Plane, available by specifying the FIELD_PLANE parameter on the GetScreen method. For more information on the content of the FIELD PLANE, see Appendix B: Field Plane.

Parameters:
row - Cursor row position
col - Cursor column position
attrib - Attribute value
plane - Plane for attribute
See Also:
WaitWhileAttrib
 o WaitWhileAttrib
 public boolean WaitWhileAttrib(int row,
                                int col,
                                char attrib,
                                int plane,
                                long timeOut,
                                boolean waitForInput) throws ECLErr, InterruptedException
Synchronously waits until the attribute is no longer at the given row and column position.

Note: The row and col address of a field attribute is one character position before the start of the field. For example, if a field starts at row 16, col 8, the field attribute for that field is located at row 16, col 7. Another method of locating field attributes is to use the Field Plane, available by specifying the FIELD_PLANE parameter on the GetScreen method. For more information on the content of the FIELD PLANE, see Appendix B: Field Plane.

Parameters:
row - Cursor row position
col - Cursor column position
attrib - Attribute value
plane - Plane for attribute. The valid constant values follow:
FIELD_PLANE - attribute is a field attribute
EXFIELD_PLANE - attribute is an extended field attribute
COLOR_PLANE - attribute is a color attribute
timeOut - Indicates wait time (milliseconds)
waitForInput - If true, will wait until OIA indicates PS is ready for input.
See Also:
WaitWhileAttrib
 o WaitWhileCursor
 public boolean WaitWhileCursor(int row,
                                int col) throws InterruptedException
Synchronously waits until the cursor is no longer at the given row and column position. Will also wait until the OIA input is not inhibited.

Parameters:
row - Cursor row position
col - Cursor column position
See Also:
WaitWhileCursor
 o WaitWhileCursor
 public boolean WaitWhileCursor(int row,
                                int col,
                                long timeOut,
                                boolean waitForInput) throws InterruptedException
Synchronously waits until the cursor is no longer at the given row and column position or until the method times out.

Parameters:
row - Cursor row position
col - Cursor column position
timeOut - Indicates wait time (milliseconds)
waitForInput - If true, will wait until OIA indicates PS is ready for input.
See Also:
WaitWhileCursor
 o WaitWhileScreen
 public boolean WaitWhileScreen(ECLScreenDesc screenDesc) throws ECLErr, InterruptedException
Synchronously waits until the screen, as described by ECLScreenDesc, is no longer in the Presentation Space. NOTE: the wait for OIA flag is set on the ECLScreenDesc object, it is not passed as a parameter to the wait method.

Parameters:
ECLScreenDesc - Object that describes the screen
See Also:
WaitWhileScreen, ECLScreenDesc
 o WaitWhileScreen
 public boolean WaitWhileScreen(ECLScreenDesc screenDesc,
                                long timeOut) throws ECLErr, InterruptedException
Synchronously waits until the screen, as described by ECLScreenDesc, is no longer in the Presentation Space. NOTE: the wait for OIA flag is set on the ECLScreenDesc, object, it is not passed as a parameter to the wait method.

Parameters:
ECLScreenDesc - Object that describes the screen
timeOut - Indicates wait time (milliseconds)
See Also:
WaitWhileScreen, ECLScreenDesc
 o WaitWhileString
 public boolean WaitWhileString(String str) throws InterruptedException
Synchronously waits until the string is no longer in the presentation space. Will also wait until the OIA input is not inhibited.

Parameters:
str - String to wait on
See Also:
WaitWhileString, WaitWhileString
 o WaitWhileString
 public boolean WaitWhileString(String str,
                                int row,
                                int col) throws InterruptedException
Synchronously waits until the string is no longer in the given position. Will also wait until the OIA input is not inhibited. String wait will be case sensitive.

Parameters:
str - String to wait for
row - Starting row position
col - Starting column position
See Also:
WaitWhileString, WaitWhileString
 o WaitWhileString
 public boolean WaitWhileString(String str,
                                int row,
                                int col,
                                long timeOut,
                                boolean waitForInput,
                                boolean caseSensitive) throws InterruptedException
Synchronously waits until the string is no longer in the given position.

Parameters:
str - String to wait for
row - Starting row position
col - Starting column position
timeOut - Indicates wait time (milliseconds)
waitForInput - If true, will wait until OIA indicates PS is ready for input.
caseSensitive - If true, String wait will be case sensitive
See Also:
WaitWhileString, WaitWhileString
 o WaitWhileStringInRect
 public boolean WaitWhileStringInRect(String str,
                                      int sRow,
                                      int sCol,
                                      int eRow,
                                      int eCol) throws InterruptedException
Synchronously waits until the string is no longer in the given rectangle. Will also wait until the OIA input is not inhibited.

Parameters:
str - String to wait on
sRow - Upper left rectangle corner row position
sCol - Upper left rectangle corner column position
eRow - Lower right rectangle corner row position
eCol - Lower right rectangle corner column position
See Also:
WaitWhileStringInRect
 o WaitWhileStringInRect
 public boolean WaitWhileStringInRect(String str,
                                      int sRow,
                                      int sCol,
                                      int eRow,
                                      int eCol,
                                      long timeOut,
                                      boolean waitForInput,
                                      boolean caseSensitive) throws InterruptedException
Synchronously waits until the string is no longer in the given rectangle.

Parameters:
str - String to wait on
sRow - Upper left rectangle corner row position
sCol - Upper left rectangle corner column position
eRow - Lower right rectangle corner row position
eCol - Lower right rectangle corner column position
timeOut - Indicates wait time (milliseconds)
waitForInput - If true, will wait until OIA indicates PS is ready for input.
caseSensitive - If true, String wait will be case sensitive
See Also:
WaitWhileStringInRect
 o GetFieldList
 public ECLFieldList GetFieldList() throws ECLErr
GetFieldList returns an instance of ECLFieldList based on the current PS. A field list contains a collection of the fields in the presentation space. It provides methods which iterate through the fields, find fields based on location, and find fields containing a given string. Each element of the list is an instance of ECLField.

This signature builds a field list with only TEXT plane information for each field object.

Throws: ECLErr
Thrown if the planes parameter is not valid or an error building the field list.
See Also:
GetFieldList, ECLFieldList
 o GetFieldList
 public ECLFieldList GetFieldList(int planes) throws ECLErr
GetFieldList returns an instance of ECLFieldList based on the current PS. A field list contains a collection of the fields in the presentation space. It provides methods which iterate through the fields, find fields based on location, and find fields containing a given string. Each element of the list is an instance of ECLField.

This signature builds a field list with the information from the specified planes for each field object.

Parameters:
planes - The planes to update. The valid values follow and can be ORed together:
TEXT_PLANE - The character contents of the field. The text plane contains no null or non-displayable characters.
FIELD_PLANE - The field attributes for each field in the plane.
COLOR_PLANE - The color attributes for each character in the plane.
EXFIELD_PLANE - The extended field attributes for each character in the plane.
DBCS_PLANE - The double byte character set (DBCS) character and field attribute data.
GRID_PLANE - The DBCS grid information.
ALL_PLANES - Refreshes all planes.
Throws: ECLErr
Thrown if the planes parameter is not valid.
See Also:
GetFieldList, ECLFieldList
 o setSize
 public void setSize(int nRows,
                     int nColumns)
This method is used to set the size of the presentation space and allocate any memory need to store the characters. THIS METHOD ADDED UNDER SM2

 o isScreenReversed
 public boolean isScreenReversed()
/** This method is used for VT sessions. This is to be overridden by PSVT. It is used for determining. if the entire VT screen is reversed rather than char. by char. reverse

 o SetCursorVisible
 public void SetCursorVisible(boolean bVisible)
Sets the cursor to be visible or invisible depending on the given parameter

Parameters:
bVisible - Used to set cursor to be visible or invisible
 o GetCursorVisible
 public boolean GetCursorVisible()
Returns whether the cursor is visible.

 o IsSuppressClearEvent
 public boolean IsSuppressClearEvent()
Returns whether the system should ignore screen events when a host application sends a clear screen command immediately followed by an end of record indicator in the data stream.

This is an advanced feature and the default is false. It is possible that an ill-behaved host application can send a clear command then an end of record indicator in the data stream. If this property is set to false, a PS event is generated when really no screen has arrived from the host.

Returns:
true if system ignores clear screen commands followed by end of record indicators
 o SetSuppressClearEvent
 public void SetSuppressClearEvent(boolean argVal)
Sets whether the system should ignore screen events when a host application sends a clear screen command immediately followed by an end of record indicator in the data stream.

This is an advanced feature and the default is false. It is possible that an ill-behaved host application can send a clear command then an end of record indicator in the data stream. If this property is set to false, a PS event is generated when really no screen has arrived from the host.

Parameters:
argVal - if true, system ignores clear screen commands followed by end of record indicators
 o isHistoryEnabled
 public boolean isHistoryEnabled()
isHistoryEnabled() This function returns the boolean state of history mode. If the history buffer size is set, then history mode is enabled.

 o getHistoryRows
 public int getHistoryRows()
getHistoryRows() This function returns the number of history rows captured. This value grows as data is added to the circular buffer. If the buffer wraps, then the buffer is full, and the number of rows is fixed at the buffer size.

 o setHistoryViewPos
 public void setHistoryViewPos(int pos)
setHistoryViewPos() This function sets the local copy of the history view position. This value is a reflection of the history scroll bar thumb position. The scroll bar is managed by the Screen object.

 o getHistoryViewPos
 public int getHistoryViewPos()
getHistoryViewPos() This function returns the local copy of the history view position. This value is a reflection of the history scroll bar thumb position. The scroll bar is managed by the Screen object.

 o getHistoryPosFromLogicalPos
 public int getHistoryPosFromLogicalPos(int pos)
getHistoryPosFromLogicalPos() This function returns the calculated history linear position based on the passed in logical screen position. If the linear position is not in the history buffer, but rather, in the standard ps buffer, the proper value is calculated and returned as negative number.

 o clearHistoryWindow
 public void clearHistoryWindow()
 o initHistoryWindow
 public void initHistoryWindow()

All Packages  Class Hierarchy  This Package  Previous  Next  Index