Share this page
Methods
_getAsTestObject(rowIdentifier, columnIdentifier) → {Promise.<TestObject>}
Returns the test object representing a specified cell.
Parameters:
| Name | Type | Description |
|---|---|---|
rowIdentifier | number | 0-based index. |
columnIdentifier | number | 0-based index. |
Returns:
a promise that is fulfilled when the _getAsTestObject operation ends.
- Type
- Promise.<TestObject>
_isEditable(rowIdentifier, columnIdentifier) → {Promise.<boolean>}
Checks whether the field is editable.
Parameters:
| Name | Type | Description |
|---|---|---|
rowIdentifier | number | 0-based index. |
columnIdentifier | number | 0-based index. |
Returns:
a promise that is fulfilled with the column header name of this cell.
- Type
- Promise.<boolean>
_openDialog(rowIdentifier, columnIdentifier) → {Promise.<void>}
Opens a specified cell's associated dialog box.
Parameters:
| Name | Type | Description |
|---|---|---|
rowIdentifier | number | 0-based index. |
columnIdentifier | number | 0-based index. |
Returns:
a promise that is fulfilled when the openDialog operation ends.
- Type
- Promise.<void>
_setFocus(rowIdentifier, columnIdentifier) → {Promise.<void>}
Transfers focus to a specified cell.
Parameters:
| Name | Type | Description |
|---|---|---|
rowIdentifier | number | 0-based index. |
columnIdentifier | number | 0-based index. |
Returns:
a promise that is fulfilled when the setFocus operation ends.
- Type
- Promise.<void>
asTestObject() → {Promise.<TestObject>}
Returns the test object representing a specified cell.
Returns:
a promise that is fulfilled when the asTestObject operation ends.
- Type
- Promise.<TestObject>
isEditable() → {Promise.<boolean>}
Checks whether the field is editable.
Returns:
a promise that is fulfilled with the column header name of this cell.
- Type
- Promise.<boolean>
openDialog() → {Promise.<void>}
Opens a specified cell's associated dialog box.
Returns:
a promise that is fulfilled when the openDialog operation ends.
- Type
- Promise.<void>
setFocus() → {Promise.<void>}
Transfers focus to a specified cell.
Returns:
a promise that is fulfilled when the setFocus operation ends.
- Type
- Promise.<void>
setValue(value) → {Promise.<void>}
Enters a value in a specific cell.
Parameters:
| Name | Type | Description |
|---|---|---|
value | Object | The value to set. |
Returns:
a promise that is fulfilled when the setValue operation ends.
- Type
- Promise.<void>
setValueAndValidate(value) → {Promise.<void>}
Enters a value in a specific cell with validation.
Parameters:
| Name | Type | Description |
|---|---|---|
value | Object | The value to set. |
Returns:
a promise that is fulfilled when the setValueAndValidate operation ends.
- Type
- Promise.<void>
value() → {Promise.<Object>}
Retrieves the value of a specified cell.
Returns:
a promise that is fulfilled with the content of this cell.
- Type
- Promise.<Object>
