Screen

TerminalEmulators. Screen

new Screen(props[opt]) → {Screen}

The description of a terminal emulator screen that fully supports HLLAPI.
Parameters:
NameTypeAttributesDescription
propsObject <optional>
Initializes a screen test object using the supplied property bag.
Returns:
the description object that was initialized.
Type
Screen

Methods

cursorPosition(cursorPosition[opt]) → {Object|Description}

Returns the position of the cursor in the emulator screen.
Parameters:
NameTypeAttributesDescription
cursorPositionObject <optional>
When provided, this method acts as a setter and sets the cursorPosition value.
Properties
NameTypeAttributesDescription
rownumber <optional>
The row position of the cursor in the emulator screen.
columnnumber <optional>
The column position of the cursor in the emulator screen.
Returns:
If no parameter is provided, the method acts as a getter and returns the current stored cursorPosition value; otherwise it returns 'this' for use with the builder pattern.
Type
Object | Description

id(id[opt]) → {number|Description}

Returns the ID value of the screen.
Parameters:
NameTypeAttributesDescription
idnumber <optional>
When provided, this method acts as a setter and sets the screen's id value.
Returns:
If no parameter is provided, the method acts as a getter and returns the current stored screen's id value; otherwise it returns 'this' for use with the builder pattern.
Type
number | Description

inputFieldCount(inputFieldCount[opt]) → {number|Description}

Returns the number of input fields on the emulator screen.
Parameters:
NameTypeAttributesDescription
inputFieldCountnumber <optional>
When provided, this method acts as a setter and sets the inputFieldCount value.
Returns:
If no parameter is provided, the method acts as a getter and returns the current stored inputFieldCount value; otherwise it returns 'this' for use with the builder pattern.
Type
number | Description

label(label[opt]) → {string|Description}

Returns the label attribute of the emulator screen.
Parameters:
NameTypeAttributesDescription
labelstring <optional>
When provided, this method acts as a setter and sets the label value.
Returns:
If no parameter is provided, the method acts as a getter and returns the current stored label value; otherwise it returns 'this' for use with the builder pattern.
Type
string | Description

protectedFieldCount(protectedFieldCount[opt]) → {number|Description}

Returns the number of protected fields on the emulator screen.
Parameters:
NameTypeAttributesDescription
protectedFieldCountnumber <optional>
When provided, this method acts as a setter and sets the protectedFieldCount value.
Returns:
If no parameter is provided, the method acts as a getter and returns the current stored protectedFieldCount value; otherwise it returns 'this' for use with the builder pattern.
Type
number | Description

size(size[opt]) → {Size|Description}

Returns the total number of rows and columns in the emulator screen.
Parameters:
NameTypeAttributesDescription
sizeObject <optional>
When provided, this method acts as a setter and sets the size value.
Properties
NameTypeAttributesDescription
rowCountnumber <optional>
The row position in the emulator screen.
columnCountnumber <optional>
The column position in the emulator screen.
Returns:
If no parameter is provided, the method acts as a getter and returns the current stored size value; otherwise it returns 'this' for use with the builder pattern.
Type
Size | Description