CheckboxesField
Summary
Defines a form checkboxes field.
Use Field.get method to get an instance of CheckboxesField.
Constructor
CheckboxesField
Syntax
CheckboxesField
(
-
conf
Summary
Parameters:
-
confObjectA field configuration object
Example:
var Field = require('@openveo/test').e2e.fields.Field;
var CheckboxesField = Field.get({
type: 'checkboxes',
name: 'My field',
baseElement: element(by.css('form'))
});Item Index
Methods
Properties
Methods
clear
Syntax
Summary
Unchecks all checkboxes.
Returns:
Promise:
Promise resolving when the field is cleared
Example:
myField.clear().then(function() {
console.log('Field cleared');
});getDescription
Syntax
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
Summary
Gets field element wrapper. Look for a form element label and return its parent.Returns:
Promise:
Promise resolving with the element
getErrorMessage
Syntax
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
Summary
Gets field label.Returns:
Promise:
Promise resolving with the label
Example:
myField.getLabel().then(function(label) {
console.log('Field label is : ' + label);
});getOptions
Syntax
Summary
Gets all checkboxes labels.
Returns:
Promise:
Promise resolving with checkboxes options
Example:
myField.getOptions().then(function(options) {
console.log(options);
});getText
Syntax
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
Syntax
Summary
Gets selected checkboxe names.
Returns:
Promise:
Promise resolving with selected checkboxes
Example:
myField.getValue().then(function(values) {
console.log(values);
});isOnError
Syntax
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);
});