OpenVeo test API

API Docs for: 8.0.0
Show:

SelectField

Extends Field
Module: e2e

Summary

Defines a form select field.

Use Field.get method to get an instance of SelectField.

Constructor

SelectField

Syntax

SelectField

()

Summary

Example:

var Field = require('@openveo/test').e2e.fields.Field;

var mySelectField = Field.get({
  type: 'select',
  name: 'My field',
  baseElement: element(by.css('form'))
});

Methods

clear

Inherited from Field but overwritten in lib/e2e/fields/SelectField.js:87

Syntax

clear

() Promise

Summary

Clears field value.

This will select the first option of the select element.

Returns:

Promise:

Promise resolving when the field is cleared

Example:

myField.clear().then(function() {
  console.log('Field cleared');
});

getDescription

Syntax

getDescription

() Promise

Summary

Gets field description.

Returns:

Promise:

Promise resolving with the description

Example:

myField.getDescription().then(function(description) {
  console.log('Field description is : ' + description);
});

getElement

Syntax

getElement

() Promise

Summary

Gets field element wrapper.

Look for a form element label and return its parent.

Returns:

Promise:

Promise resolving with the element

getErrorMessage

Syntax

getErrorMessage

() Promise

Summary

Gets field error message.

Returns:

Promise:

Promise resolving with the error message

Example:

myField.getErrorMessage().then(function(errorMessage) {
  console.log('Error message : ' + errorMessage);
});

getLabel

Syntax

getLabel

() Promise

Summary

Gets field label.

Returns:

Promise:

Promise resolving with the label

Example:

myField.getLabel().then(function(label) {
  console.log('Field label is : ' + label);
});

getText

Syntax

getText

() Promise

Summary

Gets field text representation in case of an inline editable field.

Returns:

Promise:

Promise resolving with field text representation

Example:

myField.getText().then(function(text) {
  console.log(text);
});

getValue

Inherited from Field but overwritten in lib/e2e/fields/SelectField.js:37

Syntax

getValue

() Promise

Summary

Gets field value.

Returns:

Promise:

Promise resolving with the name of the selected option (not the value)

Example:

myField.getValue().then(function(value) {
  console.log('Got value : ' + value);
});

isOnError

Syntax

isOnError

() Promise

Summary

Tests if a field is considered as on error.

Returns:

Promise:

Promise resolving with a boolean indicating if the field is on error

Example:

myField.isOnError().then(function(isOnError) {
  console.log('Is field on error ? ' + isOnError);
});

setValue

Inherited from Field but overwritten in lib/e2e/fields/SelectField.js:64

Syntax

setValue

(
  • [value='']
)
Promise

Summary

Sets field value.

Parameters:

  • [value=''] String optional

    The name of the option to select (not the value)

Returns:

Promise:

Promise resolving when the field is filled

Example:

myField.setValue('new value').then(function() {
  console.log('Value set');
});

Properties

baseElement

Syntax

baseElement

ElementFinder final

Summary

Element from where to look for the field (typically the form element).

name

Syntax

name

String final

Summary

Field label.