To learn more about using JavaScript in LeanFT, see Setting up and working with the JavaScript SDK.
For JavaScript code samples, see Code Samples - JavaScript.

ScreenTO

TerminalEmulators. ScreenTO

ScreenTO

Constructor

new ScreenTO()

A terminal emulator screen that fully supports HLLAPI.

Methods

cursorPosition() → {Promise.<Object>}

The terminal emulator screen's current row and current column.
Returns:
a promise that is fulfilled with the object's cursorPosition.
Type
Promise.<Object>

getText(areaopt) → {Promise.<String>}

Returns the text from the specified screen rectangle.
Parameters:
Name Type Attributes Description
area Object <optional>
If an Area object is passed, it will return the string from that location.
Properties
Name Type Attributes Description
top Number <optional>
Top position of the rectangle.
left Number <optional>
Left position of the rectangle.
bottom Number <optional>
Bottom position of the rectangle.
right Number <optional>
Right position of the rectangle.
Returns:
a promise that is fulfilled with the contents of the specified text.
Type
Promise.<String>

id() → {Promise.<int>}

The terminal emulator screen ID.
Returns:
the object's terminal emulator screen ID.
Type
Promise.<int>

inputFieldCount() → {Promise.<int>}

The terminal emulator screen input field count.
Returns:
the object's terminal emulator screen inputFieldCount.
Type
Promise.<int>

label() → {Promise.<string>}

The label of the terminal emulator screen.
Returns:
a promise this is fulfilled with the label of the terminal emulator screen.
Type
Promise.<string>

protectedFieldCount() → {Promise.<int>}

The protected field count of the terminal emulator screen.
Returns:
the object's Terminal Emulator screen protectedFieldCount.
Type
Promise.<int>

sendTEKeys(keys) → {Promise.<void>}

Sends a keystroke or string of keystrokes to the current cursor position on the emulator screen.
Parameters:
Name Type Description
keys String | Keys The string or terminal emulator keys to type in the object.
Returns:
a promise that is fulfilled when the sendTEKeys operation ends.
Type
Promise.<void>

setCursorPosition(positionOrRow, columnopt) → {Promise.<void>}

Changes the position of the cursor within the emulator screen.
Parameters:
Name Type Attributes Description
positionOrRow Object | Number If an object is passed, it will change the position of the cursor within the emulator screen.
If a number is passed, it will be interpreted as a row.
Properties
Name Type Attributes Description
row Number <optional>
The row position of the cursor in the emulator screen.
column Number <optional>
The column position of the cursor in the emulator screen.
column Number <optional>
If a number is passed, it changes the position of the cursor within the emulator screen.
Returns:
a promise that is fulfilled when the setCursorPosition operation ends.
Type
Promise.<void>

setText(Text, positionOrRowopt, columnopt) → {Promise.<void>}

Copies a string to a specific location in the emulator screen.
Parameters:
Name Type Attributes Description
Text String that will be written in the specified position within the emulator screen.
positionOrRow Object | Number <optional>
If an object is passed, it will copy the string to that location.
If a number is passed, it will be interpreted as a row.
Properties
Name Type Attributes Description
row Number <optional>
The row position of the cursor in the emulator screen.
column Number <optional>
The column position of the cursor in the emulator screen.
column Number <optional>
If a number is passed, it will copy the string to this location.
Returns:
a promise that is fulfilled when the setText operation ends.
Type
Promise.<void>

size() → {Promise.<Object>}

The terminal emulator screen column count and row count.
Returns:
a promise that is fulfilled with the object's size.
Type
Promise.<Object>

sync(millisecondsopt) → {Promise.<void>}

Waits until a response is received from the host and the emulator status is set to Ready, or until the timeout is reached, before continuing with the run session.
Parameters:
Name Type Attributes Description
milliseconds Number <optional>
If a number is passed, it will wait this number of milliseconds for a response.
Returns:
a promise that is fulfilled when the sync operation ends.
Type
Promise.<void>

waitForText(text, millisecondsopt) → {Promise.<Bool>}

Waits for specific text to appear on the emulator screen before continuing the run session.

Example 1:
Use the waitForText method to wait 10 seconds for the string "CH70001 LAST ACCESS AT 14:27:07 ON THURSDAY", where this string is defined as a regular expression:
waitForText(new RegExp(".*LAST ACCESS AT \d\d:\d\d:\d\d ON .*DAY.*"), 10000)

Example 2:
Use the waitForText method to wait 5 seconds for the string "User":
waitForText("User", 5000)
Parameters:
Name Type Attributes Description
text String | RegExp The specified string or regular expression for which the emulator screen is waiting.
milliseconds Number <optional>
If a number is passed, it will wait this number of milliseconds for a response.
Returns:
a promise that is fulfilled with the state of the specified inputs.
Type
Promise.<Bool>

waitForTextInArea(text, area, millisecondsopt) → {Promise.<Bool>}

Waits for specific text to appear on the emulator screen before continuing the run session.

Example 1:
Use the waitForText method to wait 10 seconds for the string, "CH70001 LAST ACCESS AT 14:27:07 ON THURSDAY", where this string is defined as a regular expression:
waitForText(new RegExp(".*LAST ACCESS AT \d\d:\d\d:\d\d ON .*DAY.*"), {top: 6, left: 53, bottom: 6, right: 60}, 10000)

Example 2:
Use the waitForText method to wait 5 seconds for the string User":
waitForText("User", {top: 6, left: 53, bottom: 6, right: 60}, 5000)
Parameters:
Name Type Attributes Description
text String | RegExp The specified string or regular expression for which the emulator screen is waiting.
area Object If an Area object is passed, it will wait for text from that location.
If a number is passed, it will wait this number of milliseconds for a response..
Properties
Name Type Description
top Number Top position of the rectangle.
left Number Left position of the rectangle.
bottom Number Bottom position of the rectangle.
right Number Right position of the rectangle.
milliseconds Number <optional>
If a number is passed, it will wait this number of milliseconds for a response.
Returns:
a promise that is fulfilled with the state of the specified inputs.
Type
Promise.<Bool>