Field

TerminalEmulators. Field

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

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

Methods

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

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

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

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

isNumeric(isNumeric[opt]) → {boolean|Description}

Indicates whether the field is numeric.
Parameters:
NameTypeAttributesDescription
isNumericboolean <optional>
When provided, this method acts as a setter and sets the isNumeric value.
Returns:
If no parameter is provided, the method acts as a getter and returns the current stored isNumeric value; otherwise it returns 'this' for use with the builder pattern.
Type
boolean | Description

isProtected(isProtected[opt]) → {boolean|Description}

Indicates whether the field is protected.
Parameters:
NameTypeAttributesDescription
isProtectedboolean <optional>
When provided, this method acts as a setter and sets the isProtected value.
Returns:
If no parameter is provided, the method acts as a getter and returns the current stored isProtected value; otherwise it returns 'this' for use with the builder pattern.
Type
boolean | Description

isVisible(isVisible[opt]) → {boolean|Description}

Indicates whether the field is visible.
Parameters:
NameTypeAttributesDescription
isVisibleboolean <optional>
When provided, this method acts as a setter and sets the isVisible value.
Returns:
If no parameter is provided, the method acts as a getter and returns the current stored isVisible value; otherwise it returns 'this' for use with the builder pattern.
Type
boolean | Description

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

Returns a field length in characters.
Parameters:
NameTypeAttributesDescription
lengthnumber <optional>
When provided, this method acts as a setter and sets the length value.
Returns:
If no parameter is provided, the method acts as a getter and returns the current stored length value; otherwise it returns 'this' for use with the builder pattern.
Type
number | Description

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

Returns the 'start row' and 'start column' attributes for TeField.
Parameters:
NameTypeAttributesDescription
startPositionObject <optional>
When provided, this method acts as a setter and sets the startPosition 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 startPosition value; otherwise it returns 'this' for use with the builder pattern.
Type
Object | Description

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

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