Docs Help

Terms, Icons, and Labels

Many classes have shortcut names used when creating (instantiating) a class with a configuration object. The shortcut name is referred to as an alias (or xtype if the class extends Ext.Component). The alias/xtype is listed next to the class name of applicable classes for quick reference.

Access Levels

Framework classes or their members may be specified as private or protected. Else, the class / member is public. Public, protected, and private are access descriptors used to convey how and when the class or class member should be used.

Member Types

Member Syntax

Below is an example class member that we can disect to show the syntax of a class member (the lookupComponent method as viewed from the Ext.button.Button class in this case).

lookupComponent ( item ) : Ext.Component
protected

Called when a raw config object is added to this container either during initialization of the items config, or when new items are added), or {@link #insert inserted.

This method converts the passed object into an instanced child component.

This may be overridden in subclasses when special processing needs to be applied to child creation.

Parameters

item :  Object

The config object being added.

Returns
Ext.Component

The component to be added.

Let's look at each part of the member row:

Member Flags

The API documentation uses a number of flags to further commnicate the class member's function and intent. The label may be represented by a text label, an abbreviation, or an icon.

Class Icons

- Indicates a framework class

- A singleton framework class. *See the singleton flag for more information

- A component-type framework class (any class within the Ext JS framework that extends Ext.Component)

- Indicates that the class, member, or guide is new in the currently viewed version

Member Icons

- Indicates a class member of type config

- Indicates a class member of type property

- Indicates a class member of type method

- Indicates a class member of type event

- Indicates a class member of type theme variable

- Indicates a class member of type theme mixin

- Indicates that the class, member, or guide is new in the currently viewed version

Class Member Quick-Nav Menu

Just below the class name on an API doc page is a row of buttons corresponding to the types of members owned by the current class. Each button shows a count of members by type (this count is updated as filters are applied). Clicking the button will navigate you to that member section. Hovering over the member-type button will reveal a popup menu of all members of that type for quick navigation.

Getter and Setter Methods

Getting and setter methods that correlate to a class config option will show up in the methods section as well as in the configs section of both the API doc and the member-type menus just beneath the config they work with. The getter and setter method documentation will be found in the config row for easy reference.

History Bar

Your page history is kept in localstorage and displayed (using the available real estate) just below the top title bar. By default, the only search results shown are the pages matching the product / version you're currently viewing. You can expand what is displayed by clicking on the button on the right-hand side of the history bar and choosing the "All" radio option. This will show all recent pages in the history bar for all products / versions.

Within the history config menu you will also see a listing of your recent page visits. The results are filtered by the "Current Product / Version" and "All" radio options. Clicking on the button will clear the history bar as well as the history kept in local storage.

If "All" is selected in the history config menu the checkbox option for "Show product details in the history bar" will be enabled. When checked, the product/version for each historic page will show alongside the page name in the history bar. Hovering the cursor over the page names in the history bar will also show the product/version as a tooltip.

Search and Filters

Both API docs and guides can be searched for using the search field at the top of the page.

On API doc pages there is also a filter input field that filters the member rows using the filter string. In addition to filtering by string you can filter the class members by access level, inheritance, and read only. This is done using the checkboxes at the top of the page.

The checkbox at the bottom of the API class navigation tree filters the class list to include or exclude private classes.

Clicking on an empty search field will show your last 10 searches for quick navigation.

API Doc Class Metadata

Each API doc page (with the exception of Javascript primitives pages) has a menu view of metadata relating to that class. This metadata view will have one or more of the following:

Expanding and Collapsing Examples and Class Members

Runnable examples (Fiddles) are expanded on a page by default. You can collapse and expand example code blocks individually using the arrow on the top-left of the code block. You can also toggle the collapse state of all examples using the toggle button on the top-right of the page. The toggle-all state will be remembered between page loads.

Class members are collapsed on a page by default. You can expand and collapse members using the arrow icon on the left of the member row or globally using the expand / collapse all toggle button top-right.

Desktop -vs- Mobile View

Viewing the docs on narrower screens or browsers will result in a view optimized for a smaller form factor. The primary differences between the desktop and "mobile" view are:

Viewing the Class Source

The class source can be viewed by clicking on the class name at the top of an API doc page. The source for class members can be viewed by clicking on the "view source" link on the right-hand side of the member row.

Sencha Test 2.4.0


top

Hierarchy

ST.future.Item

Summary

This class provides methods to interact with a DataView item when it becomes available. Instances of this class are returned by the following methods:

No members found using the current filters

configs

Optional Configs

at : Number

The item index in the component's store. This property is set when calling the ST.future.DataView#itemAt method.

If specified the itemId, propertyName and propertyValue configs are ignored.

itemId

The value of the idProperty of the item's record. This property is set when calling the ST.future.DataView#item method.

If specified the propertyName and propertyValue configs are ignored.

propertyName : String

The name of the property for which to search. The first record that matches the desired propertyValue is used as returned by the store's find() method.

This property is set when calling the ST.future.DataView#itemWith method.

If specified the propertyValue must also be specified.

propertyValue : Object / RegExp

The value that must exactly match that of the propertyName unless this is a RegExp. This and the propertyName are passed to the store's find() method to find the matching record.

This property is set when calling the ST.future.DataView#itemWith method.

properties

Instance Properties

findInHierarchy
private pri

Schedules an event to locate a hierarchical component/element

Defaults to:

{
    addEvent: function(config, timeout) {
        var me = this,
            rec = me._buildRec('element', {
                timeout: timeout,
                target: config.locator
            });
        config.locatorChain.push({
            direction: config.direction,
            locator: config.target,
            futureClsName: me.$className,
            type: (!me.$futureType || me.$futureType === 'element') ? 'element' : 'component'
        });
        me.root = config.locatorChain;
        me.locatorChain = config.locatorChain;
        me.locator = me.play(ST.apply(rec, config));
        return me;
    }
}

methods

Instance Methods

_asFutureComponent ( type, [timeout] ) : ST.future.Component

Common endpoint for creating component futures from an item.

Parameters

type :  Object

The type of future to create.

timeout :  Number (optional)

The maximum time (in milliseconds) to wait.

Returns

:ST.future.Component

_createRelatedFuture ( maker, direction, locator, timeout )
private pri

Parameters

maker :  Object

direction :  Object

locator :  Object

timeout :  Object

_value
private pri

Called internally by and() Will return the valueProperty of the currently "active" future For in-browser tests, this could be an Ext JS Component, an ST.Element, or a full future For WebDriver-based tests, this will always be the future

addPlayable ( name, config )
private pri

if config is a function, the playable will extend ST.playable.State and the provided function will be the "is" function.

Parameters

name :  Object

config :  Object

and ( fnOrTimeout ) : ST.future.Element
chainable ch

Schedules arbitrary actions for later execution. Often these actions are added to the queue following click or other interactions in order to test an expectation.

For example:

 ST.element('@some-div').
     click(10, 10).
     and(function (el) {
         // Runs after the click event. We receive the ST.Element
         // wrapper for the "some-div" element.
         expect(el.hasCls('foo')).toBe(true);
     });

The future's value is passed as the first argument. For an Element future the arg will be an ST.Element, for components it will be various things, typically the component instance itself. If the scenario is a WebDriver scenario the arg will be the current future such as ST.future.Element above.

The function's scope is set to the playable which includes a reference to the future so the code above could be re-written as:

 ST.element('@some-div').
     click(10, 10).
     and(function () {
         expect(this.future.el.hasCls('foo')).toBe(true);
     });

Functions that need to perform asynchronous actions can declare a 2nd argument (typically called "done").

 ST.element('@some-div').
     click(10, 10).
     and(
         function (el, done) {
             expect(el.hasCls('foo')).toBe(true);

             Ext.Ajax.request({
                 ...
                 callback: function () {
                     done();
                 }
             });
         }
     );

Multiple actions can be listed in a single call. Asynchronous actions can override the timeout by specifying a number as the previous argument.

For example:

 ST.element('@some-div').
     click(10, 10).
     and(
         1000,   // timeout for following async steps in this and()

         function (el, done) {
             expect(el.hasCls('foo')).toBe(true);

             Ext.Ajax.request({
                 ...
                 callback: function () {
                     done();
                 }
             });
         },
         function (el) {
             expect(el.hasCls('foo')).toBe(false);
         }
     );

Parameters

fnOrTimeout :  Number/Function...

One or more functions to invoke or timeout values. For functions, the 1st argument will be the future value such as ST.Element or an Ext.Component or the future itself in the case of WebDriver scenarios. The scope of functions will be the playable event itself. To access the future use this.future. Functions that declare a 2nd argument must call the provided function to indicate that they are complete. Timeout values affect subsequent asynchronous functions and override the timeout. These timeouts only apply to functions passed in the current call.

Returns

:ST.future.Element

this

asButton ( timeout ) : ST.future.Button
chainable ch

Returns an ST.future.Button future This method is only applicable in conjuction with Ext JS Modern Toolkit (or Sencha Touch) when using an Ext.dataview.DataView that is configured with useComponents:true.

Parameters

timeout :  Object

Returns

:ST.future.Button

asCheckBox ( timeout ) : ST.future.CheckBox
chainable ch

Returns an ST.future.CheckBox future This method is only applicable in conjuction with Ext JS Modern Toolkit (or Sencha Touch) when using an Ext.dataview.DataView that is configured with useComponents:true.

Parameters

timeout :  Object

Returns

:ST.future.CheckBox

asComponent ( timeout ) : ST.future.Component
chainable ch

Returns an ST.future.Component future This method is only applicable in conjuction with Ext JS Modern Toolkit (or Sencha Touch) when using an Ext.dataview.DataView that is configured with useComponents:true.

Parameters

timeout :  Object

Returns

:ST.future.Component

asDataView ( timeout ) : ST.future.DataView
chainable ch

Returns an ST.future.DataView future This method is only applicable in conjuction with Ext JS Modern Toolkit (or Sencha Touch) when using an Ext.dataview.DataView that is configured with useComponents:true.

Parameters

timeout :  Object

Returns

:ST.future.DataView

asField ( timeout ) : ST.future.Field
chainable ch

Returns an ST.future.Field future This method is only applicable in conjuction with Ext JS Modern Toolkit (or Sencha Touch) when using an Ext.dataview.DataView that is configured with useComponents:true.

Parameters

timeout :  Object

Returns

:ST.future.Field

asGrid ( timeout ) : ST.future.Grid
chainable ch

Returns an ST.future.Grid future This method is only applicable in conjuction with Ext JS Modern Toolkit (or Sencha Touch) when using an Ext.dataview.DataView that is configured with useComponents:true.

Parameters

timeout :  Object

Returns

:ST.future.Grid

asPanel ( timeout ) : ST.future.Panel
chainable ch

Returns an ST.future.Panel future This method is only applicable in conjuction with Ext JS Modern Toolkit (or Sencha Touch) when using an Ext.dataview.DataView that is configured with useComponents:true.

Parameters

timeout :  Object

Returns

:ST.future.Panel

asSelect ( timeout ) : ST.future.Select
chainable ch

Returns an ST.future.Select future This method is only applicable in conjuction with Ext JS Modern Toolkit (or Sencha Touch) when using an Ext.dataview.DataView that is configured with useComponents:true.

Parameters

timeout :  Object

Returns

:ST.future.Select

asTextField ( timeout ) : ST.future.TextField
chainable ch

Returns an ST.future.TextField future This method is only applicable in conjuction with Ext JS Modern Toolkit (or Sencha Touch) when using an Ext.dataview.DataView that is configured with useComponents:true.

Parameters

timeout :  Object

Returns

:ST.future.TextField

blurred ( [timeout] ) : ST.future.Element
chainable ch

Waits for this element to become blurred.

 ST.element('@someEl').
     blurred().
     and(function (el) {
         // el is now blurred
     });

Parameters

timeout :  Number (optional)

The maximum time (in milliseconds) to wait.

Returns

:ST.future.Element

this

child ( selector, [timeout] ) : ST.future.Element
chainable ch

Returns a direct child ST.future.Element that corresponds to the specified selector.

 ST.element('@someElement').
     child('p').
     and(function (element) {
         // p is now available
     });

If the specified selector for the child element cannot be resolved, the request will timeout.

Parameters

selector :  String

The DOM Query selector to use to search for the child component

timeout :  Number (optional)

The maximum time (in milliseconds) to wait.

Returns

:ST.future.Element

click ( x, y, [button], [timeout] ) : ST.future.Element
chainable ch

Schedules a click action at the specified relative coordinates.

 ST.element('@some-div').
     click(10, 10);

Or for a Component:

 ST.component('#some-cmp').
     click(10, 10);

To perform a right-click action, provide a button code of 2:

 ST.component('#some-cmp').
     click(10, 10, 2);

This future will wait for the element to be visible before performing the click action.

Note that x, y and button args are not honored for WebDriver scenarios.

Parameters

x :  Number

The number of pixels from the left edge of the element.

y :  Number

The number of pixels from the top edge of the element.

button :  Number (optional)

The mouse button code for the click.

Defaults to: 0

timeout :  Number (optional)

The maximum time (in milliseconds) to wait.

Returns

:ST.future.Element

this

content ( html, [timeout] ) : ST.future.Element
chainable ch

Waits for this element's innerHTML to match the specified value.

 ST.element('@some-div').
     click(10, 10).
     content('Hello <b>world</b>');

Available since: 1.0.1

Parameters

html :  String

The html to match.

timeout :  Number (optional)

The maximum time (in milliseconds) to wait.

Returns

:ST.future.Element

this

contentEmpty ( [timeout] ) : ST.future.Element
chainable ch

Waits for this element's innerHTML to be empty.

 ST.element('@some-div').
     click(10, 10).
     contentEmpty();

Parameters

timeout :  Number (optional)

The maximum time (in milliseconds) to wait.

Returns

:ST.future.Element

this

contentLike ( pattern, [timeout] ) : ST.future.Element
chainable ch

Waits for this element's innerHTML to match the specified RegExp pattern.

 ST.element('@some-div').
     click(10, 10).
     contentLike(/hello/i);

Parameters

pattern :  RegExp/String

The pattern to match. If this is a String, it is first promoted to a RegExp by called new RegExp(pattern).

timeout :  Number (optional)

The maximum time (in milliseconds) to wait.

Returns

:ST.future.Element

this

contentNotEmpty ( [timeout] ) : ST.future.Element
chainable ch

Waits for this element's innerHTML to be non-empty.

 ST.element('@some-div').
     click(10, 10).
     contentNotEmpty();

Parameters

timeout :  Number (optional)

The maximum time (in milliseconds) to wait.

Returns

:ST.future.Element

this

contentNotLike ( pattern, [timeout] ) : ST.future.Element
chainable ch

Waits for this element's innerHTML to not match the specified RegExp pattern.

 ST.element('@some-div').
     click(10, 10).
     contentNotLike(/world/i);

Parameters

pattern :  RegExp/String

The pattern to match. If this is a String, it is first promoted to a RegExp by called new RegExp(pattern).

timeout :  Number (optional)

The maximum time (in milliseconds) to wait.

Returns

:ST.future.Element

this

dataView ST.future.DataView

Returns the owning ST.future.DataView. This method can be called at any time to "return" to the owning future. For example:

 ST.dataView('@someView').
     item(42).           // get a future item (ST.future.Item)
         reveal().       //    operates on the ST.future.Item
     dataView().         // now back to the dataView
     click(10, 10);      // click on the dataView

Returns

:ST.future.DataView

deselect ( [timeout] ) : ST.future.Item

Deselects the item's corresonding record

Parameters

timeout :  Number (optional)

The maximum time (in milliseconds) to wait.

Returns

:ST.future.Item

deselected ( [timeout] ) : ST.future.Item
chainable ch

Waits for the item's record to be deselected

 ST.dataView('@someDataView').
     itemAt(150).
     selected().
     reveal().
     deselected().
     and(function (item) {
         // item is now deselected
     });

Parameters

timeout :  Number (optional)

The maximum time (in milliseconds) to wait.

Returns

:ST.future.Item

this

documentReady ( [state] ) : ST.future.Element
chainable ch

Waits for the document.readyState to be the specified state.

Available since: 2.0.0

Parameters

state :  String (optional)

Defaults to: "complete"

Returns

:ST.future.Element

this

doubleClick ( x, y, [timeout] ) : ST.future.Element
chainable ch

Schedules a double-click action at the specified relative coordinates.

 ST.element('@some-div').
     doubleClick(10, 10);

Or for a Component:

 ST.component('#some-cmp').
     doubleClick(10, 10);

This future will wait for the element to be visible before performing the double-click action.

Available since: 2.2.1

Parameters

x :  Number

The number of pixels from the left edge of the element.

y :  Number

The number of pixels from the top edge of the element.

timeout :  Number (optional)

The maximum time (in milliseconds) to wait.

Returns

:ST.future.Element

this

down ( selector, [timeout] ) : ST.future.Element
chainable ch

Returns a descendant ST.future.Element that corresponds to the specified selector.

 ST.element('@someElement').
     down('span').
     and(function (element) {
         // span is now available
     });

If the specified selector for the descendant element cannot be resolved, the request will timeout.

Parameters

selector :  String

The DOM Query selector to use to search for the descendant

timeout :  Number (optional)

The maximum time (in milliseconds) to wait.

Returns

:ST.future.Element

element ( locator, [timeout] ) : ST.future.Element
chainable ch

Returns a ST.future.Element used to queue operations for when that element becomes available (rendered to the page). The element does not need to be visible for this future to complete.

Once a future is returned from this method, it is typically used to describe some sequence of actions, wait for state transitions and perform inspections.

 ST.element('@someEl').
     click(10, 10).
     textLike(/hello/i).
     and(function (el) { ... });

Parameters

locator :  String

See ST.Locator for supported syntax.

timeout :  Number (optional)

The maximum time (in milliseconds) to wait for the element.

Returns

:ST.future.Element

execute ( fn ) : ST.future.Element
chainable ch

Executes the provided function in the browser under test. Be aware that with WebDriver scenarios the scope of the function is not related to the scope of the test code. The following will not work:

 var foo = '1';
 ST.execute(function () {
     expect(foo).toBe(1);
 });

Because the bar foo is in the test scope but the function is executed in the browser under test.

For in-browser scenarios the code above will work.

If the provided function returns a value it will be set on the current future's data as the property 'executeResult'.

 ST.element('@some-div')
     .execute(function () {
         return 'foo';
     })
     .and(function (future) {
         expect(future.data.executeResult).toBe('foo')
     });

Similarly if any errors are thrown in the provided function the error will be set on the future's data as the property 'executeError'.

 ST.element('@some-div')
     .execute(function () {
         throw 'foo';
     })
     .and(function (future) {
         expect(future.data.executeError).toBe('foo')
     });

For the function, the 1st argument will be the future value such as ST.Element or an Ext.Component or the future itself in the case of WebDriver scenarios. The scope of functions will be the playable event itself. To access the future use this.future.

Available since: 2.0.0

Parameters

fn :  Function

the function to execute in the browser under test

Returns

:ST.future.Element

this

expect ( property ) :
chainable ch

Schedules an expectation on a getter or property of the given component or element future. The expect() call returns a set of matchers. The matcher funtions return the current future for further chaining.

 ST.textField('@username')
     .type('test-username')
     .expect('value').toBe('test-username')
     .textField('@password')
     .type('test-password')
     .expect('value').toBe('test-password');

The string property name is used to get properties from the future and it's underlying Ext.Component or dom.

new Ext.Container({ id: 'my-container', renderTo: Ext.getBody(), height: 100 })

ST.component('@my-container') // component getter .expect('XTypes').toBe('component/box/container')

     // component property
     .expect('height').toBe(100)

     // dom property
     .expect('innerHTML').toContain('my-container')

     // computed style
     .expect('visibility').toBe('visible');

Custom jasmine matchers are included. "not" is supported. Other matchers such as jasmine.any(), jasmine.objectContaining and jasmine.anything() are supported as well.

 ST.textField('@futureCmp')
     .expect('aString').toBe('bar')
     .expect('aString').not.toBe('baz')
     .expect('aString').toEqual(jasmine.any(String))
     .expect('aString').not.toEqual(jasmine.any(Number))
     .expect('aNumber').toBe(42)
     .expect('aNumber').not.toBe(23)
     .expect('aNumber').toEqual(jasmine.any(Number))
     .expect('aNumber').not.toEqual(jasmine.any(String))
     .expect('anObject').toEqual(jasmine.anything())
     .expect('anObject').toEqual(jasmine.objectContaining({a:1,b:2}))
     .expect('anObject').not.toEqual(jasmine.objectContaining({c:3}))
     .expect('notThere').not.toEqual(jasmine.anything())

Available since: 2.0.0

Parameters

property :  String

name to compare against

Returns

:

Object resembling jasmine Expectation class as documented here href="https://jasmine.github.io/2.5/introduction#section-Included_Matchers" class="external-link" target="_blank">https://jasmine.github.io/2.5/introduction#section-Included_Matchers}

findRecord ( dataView, config )
private pri

Parameters

dataView :  Object

config :  Object

focus ( [timeout] ) : ST.future.Element
chainable ch

Schedules the component to receive the focus.

 ST.element('@some-div/input').
     focus();

Parameters

timeout :  Number (optional)

The maximum time (in milliseconds) to wait.

Returns

:ST.future.Element

this

focused ( [timeout] ) : ST.future.Element
chainable ch

Waits for this element to become focused.

 ST.element('@someEl').
     focused().
     and(function (el) {
         // el is now focused
     });

Parameters

timeout :  Number (optional)

The maximum time (in milliseconds) to wait.

Returns

:ST.future.Element

this

get ( properties ) : ST.future.Element
chainable ch

Retrieves the values of the specified list of properties from the future's underlying dom or computed style. These values will then be available on the future's data property for use in expectations within an and() method.

This method is particularly useful for WebDriver-based tests where direct access to DOM elements is not possible within the context of the executed spec.

 ST.element('#mydiv')
     .get('className')
     .and(function () {
         expect(this.future.data.className).toContain('foo');
     })

Each string property is tried first as a dom property and then a property of the computed style of the dom.

 get('id') returns dom.id
 get('height') returns the dom's computed style height

See ST.future.Component#get for details on how this method works on Component futures.

Available since: 2.0.0

Parameters

properties :  String

A comma-delimited list of property values to retrieive

Returns

:ST.future.Element

this

getData ( [name] ) : Object
private pri

Convenience method for retrieving data from the future. The data object is used by get and expect to store retrieved properties on the future.

Parameters

name :  String (optional)

Provide the name of a key to scope the results, otherwise the full data object will be returned

Returns

:Object

getItemAt ( view, index )
private pri

Parameters

view :  Object

index :  Object

getRecord ST.future.Item
chainable ch

Retrieves the Item's record data and associated data and places a shallow copy on the future instance's data.record. Modifications of the record data may be reflected in the copy on the future instance.

Available since: 2.2.1

Returns

:ST.future.Item

Example usage:

 ST.dataView('mydataview').itemAt(1).getRecord().and(function (item) {
     expect(item.data.record.species).toBe("Cat");

     expect(this.future.data.record.species).toBe("Cat");
 });

getRelated ( [name] ) : Object
private pri

Convenience method for retrieving related futures from the future.

Parameters

name :  String (optional)

Provide the name of a future to scope the results, otherwise the full "related" map will be returned

Returns

:Object

getTitle ( callback ) : ST.future.Element
chainable ch

Returns the title of the current document as the first arg of the provided callback function.

 ST.navigate('https://duckduckgo.com')
     .getTitle(function (title) {
         expect(title).toContain('Duck');
     });

Available since: 2.0.0

Parameters

callback :  Function

function to receive the title of the current document

Returns

:ST.future.Element

this

getUrl ( callback ) : ST.future.Element
chainable ch

Returns the current url of the target browser as the first arg of the provided callback function.

ST.navigate('https://duckduckgo.com') .getUrl(function (url) { expect(url).toContain('duckduckgo'); });

Available since: 2.0.0

Parameters

callback :  Function

The callback function to execute when the url has been determined

Returns

:ST.future.Element

this

hasCls ( cls, [timeout] ) : ST.future.Element
chainable ch

Waits for this element to have a specified CSS class.

 ST.element('@someEl').
     hasCls('foo').
     and(function (el) {
         // el now has a "foo" class
     });

Parameters

cls :  String

The class name to test.

timeout :  Number (optional)

The maximum time (in milliseconds) to wait.

Returns

:ST.future.Element

this

hidden ( [timeout] ) : ST.future.Element
chainable ch

Waits for this element to become hidden.

 ST.element('@someEl').
     hidden().
     and(function (el) {
         // el is now hidden
     });

Note that the element must still be present in order to check if it is hidden.

 ST.component('@someCmp').
     click().
     and(function (cmp) {
         cmp.destroy();
     }).
     hidden(); // will timeout and produce an error

Parameters

timeout :  Number (optional)

The maximum time (in milliseconds) to wait.

Returns

:ST.future.Element

this

isInView ( view, node )
private pri

Parameters

view :  Object

node :  Object

missingCls ( cls, [timeout] ) : ST.future.Element
chainable ch

Waits for this element to not have a specified CSS class.

 ST.element('@someEl').
     missingCls('foo').
     and(function (el) {
         // el now does not have a "foo" class
     });

Parameters

cls :  String

The class name to test.

timeout :  Number (optional)

The maximum time (in milliseconds) to wait.

Returns

:ST.future.Element

this

navigate ( url ) : ST.future.Element
chainable ch

Causes the browser to load the specified URL.

 ST.navigate('https://www.google.com')
     .input('input[title="Search"]').
     .navigate('https://www.sencha.com')
     .input('input');

NOTE: Using this method to navigate away from the page in a non-WebDriver test will halt the test execution. It is possible to use this to navigate to different anchors on the same page:

 ST.getUrl(function (url) {
     ST.navigate(url+'#first-anchor').
         element('@some-div');

});

If URL begins with '#' then the page will be redirected to that anchor.

Available since: 2.0.0

Parameters

url :  String

The URL to navigate to.

Returns

:ST.future.Element

this

removed ( [timeout] ) : ST.future.Element
chainable ch

Waits for this element to be removed from the document.

 ST.element('@someEl').
     removed().
     and(function (el) {
         // el is now removed from the document
     });

Parameters

timeout :  Number (optional)

The maximum time (in milliseconds) to wait.

Returns

:ST.future.Element

this

reveal ( [timeout] ) : ST.future.Item
chainable ch

Scrolls this item into view.

Parameters

timeout :  Number (optional)

The maximum time (in milliseconds) to wait.

Returns

:ST.future.Item

rightClick ( x, y, [timeout] ) : ST.future.Element
chainable ch

Schedules a right-click action at the specified relative coordinates.

 ST.element('@some-div').
     rightClick(10, 10);

Or for a Component:

 ST.component('#some-cmp').
     rightClick(10, 10);

This future will wait for the element to be visible before performing the right-click action.

Available since: 2.2.1

Parameters

x :  Number

The number of pixels from the left edge of the element.

y :  Number

The number of pixels from the top edge of the element.

timeout :  Number (optional)

The maximum time (in milliseconds) to wait.

Returns

:ST.future.Element

this

screenshot ( [name], [callback], [tolerance], [timeout] ) : ST.future.Element
chainable ch

Takes a snapshot of the viewport and compares it to the associated baseline image.

 ST.element('@someEl').
     click(10, 10).
     screenshot();

Can also be used directly from the ST namespace and chained with other futures API methods:

 ST.screenshot('first', 10, 10000).    // tolerance=10 (10 pixels), timeout=10000 (10 seconds)
     navigate('#somewhere').
     screenshot('second', 20);        // tolerance=20 (20 pixels), timeout=30000 (default)

It is possible to set the maximum number of different pixels the current snapshot can have compared to the baseline image before the method will cause the test to fail, by defining a tolerance:

 ST.screenshot('first', 200);    // Tolerance of 200 pixels (defaults to 0 if not explicitly set)

To support the 1.0.x API as well as for flexibility the second parameter can be a callback function, though the preferred usage is chaining as above.

 ST.screenshot('third', function () {
     // the screenshot has been taken!
 });

Parameters

name :  String (optional)

for the snapshot filename. Default is an incremental number for the current test run.

callback :  Function (optional)

Optional callback for when the screenshot is complete.

tolerance :  Number (optional)

Optional the maximum number of different pixels the current snapshot can have compared to the baseline image before the method will cause the test to fail.

Defaults to: 0

timeout :  Number (optional)

Optional The maximum time (in milliseconds) to wait.

Defaults to: 30000

Returns

:ST.future.Element

this

scroll ( x, y, [timeout] ) : ST.future.Element
chainable ch

Schedules a scroll action by the amounts specified for each axis.

 ST.element('@some-div').
     scroll(10, 10); // scroll the element 10px on the x-axis and 10px on the y-axis

Or for a Component:

 ST.component('#some-cmp').
     scroll(10, 10); // scroll the component 10px on the x-axis and 10px on the y-axis

This future will wait for the element to be visible before performing the scroll action.

Parameters

x :  Number

The number of pixels to scroll from the left edge of the element.

y :  Number

The number of pixels to scroll from the top edge of the element.

timeout :  Number (optional)

The maximum time (in milliseconds) to wait.

Returns

:ST.future.Element

this

select ( [keepExisting], [timeout] ) : ST.future.Item

Selects the item's corresonding record

Parameters

keepExisting :  Boolean (optional)

true to preserve existing selections (default: false)

timeout :  Number (optional)

The maximum time (in milliseconds) to wait.

Returns

:ST.future.Item

selected ( [timeout] ) : ST.future.Item
chainable ch

Waits for the item's record to be selected

 ST.dataView('@someDataView').
     itemAt(1).
     selected().
     and(function (item) {
         // item is now selected
     });

Parameters

timeout :  Number (optional)

The maximum time (in milliseconds) to wait.

Returns

:ST.future.Item

this

setData ( name, value )
private pri

Convenience method for setting key/value pairs on the future's data object. The data object is used by get and expect to store retrieved properties on the future.

Parameters

name :  String/Object

The name of the key to set, or an object of key-value pairs to set

value :  Object

The value to set on the data object

setRelated ( [name], future )
private pri

Convenience method for creating a lasting relationship between two futures

Parameters

name :  String (optional)

The name of the key for the value, or an object of related futures

future :  ST.future.Component/ST.future.Element

The future to which the relationship should be made

setViewportSize ( width, height ) : ST.future.Element
chainable ch

Sets the size of the browser viewport. This method has no effect on in-browser tests when the browser wasn't launched via WebDriver, and it is particulary useful to ensure that compared screenshots have the same dimensions.

ST.setViewportSize(1024, 768)
  .screenshot();

Parameters

width :  Number

height :  Number

Returns

:ST.future.Element

this

text ( text, [timeout] ) : ST.future.Element
chainable ch

Waits for this element's textContent to match the specified string.

 ST.element('@some-div').
     click(10, 10).
     text('Hello world');

Available since: 1.0.1

Parameters

text :  String

The text to match.

timeout :  Number (optional)

The maximum time (in milliseconds) to wait.

Returns

:ST.future.Element

this

textEmpty ( [timeout] ) : ST.future.Element
chainable ch

Waits for this element's textContent to be empty.

 ST.element('@some-div').
     click(10, 10).
     textEmpty();

Parameters

timeout :  Number (optional)

The maximum time (in milliseconds) to wait.

Returns

:ST.future.Element

this

textLike ( pattern, [timeout] ) : ST.future.Element
chainable ch

Waits for this element's textContent to match the specified RegExp pattern.

 ST.element('@some-div').
     click(10, 10).
     textLike(/hello/i);

Parameters

pattern :  RegExp/String

The pattern to match. If this is a String, it is first promoted to a RegExp by called new RegExp(pattern).

timeout :  Number (optional)

The maximum time (in milliseconds) to wait.

Returns

:ST.future.Element

this

textNotEmpty ( [timeout] ) : ST.future.Element
chainable ch

Waits for this element's textContent to be non-empty.

 ST.element('@some-div').
     click(10, 10).
     textNotEmpty(200);

Parameters

timeout :  Number (optional)

The maximum time (in milliseconds) to wait.

Returns

:ST.future.Element

this

textNotLike ( pattern, [timeout] ) : ST.future.Element
chainable ch

Waits for this element's textContent to not match the specified RegExp pattern.

 ST.element('@some-div').
     click(10, 10).
     textNotLike(/hello/i, 200);

Parameters

pattern :  RegExp/String

The pattern to match. If this is a String, it is first promoted to a RegExp by called new RegExp(pattern).

timeout :  Number (optional)

The maximum time (in milliseconds) to wait.

Returns

:ST.future.Element

this

timedout ST.future.Element
chainable ch

Expects the last method to timeout and adds a test result explaining the desired state. Such as:

 ST.element('not-there').timedout();

 expected timeout waiting for '[input]' to be ready for element

Available since: 2.0.0

Returns

:ST.future.Element

this

type ( text, [timeout] ) : ST.future.Element
chainable ch

Schedules a "type" action at the specified relative coordinates. This method assumes you have already achieved correct focus of the target and that the target is visible. If the target is not visible this future will timeout.

 ST.element('@some-div/input').
     focus().
     type('Hello world');

If first argument is an object, it should be a ST.playable.Playable config object for a type="type" event. In this case, all other arguments are ignored.

To specify a location in the input to insert text, the type object accepts a caret property:

 ST.element('@some-div/input').
     focus().
     type('Hllo world').
     type({
         text: 'e',
         caret: 1
     });

which would insert the 'e' after the first character. Likewise, specifying a range:

 ST.element('@some-div/input').
     focus().
     type('H1234 world').
     type({
         text: 'ello',
         caret: [1,4]
     });

would overwrite any text in the given range.

Parameters

text :  String

The text to type.

timeout :  Number (optional)

The maximum time (in milliseconds) to wait for the typing to finish.

Returns

:ST.future.Element

this

up ( selector, [timeout] ) : ST.future.Element
chainable ch

Returns an ancestor ST.future.Element that corresponds to the specified selector.

 ST.element('@someElement').
     up('div').
     and(function (element) {
         // div is now available
     });

If the specified selector for the ancestor element cannot be resolved, the request will timeout.

Parameters

selector :  String

The DOM Query selector to use to search for the ancestor

timeout :  Number (optional)

The maximum time (in milliseconds) to wait.

Returns

:ST.future.Element

visible ( [timeout] ) : ST.future.Element
chainable ch

Waits for this element to become visible.

Event injection methods automatically wait for target visibility, however, if using and sequences explicitly waiting for visibility may be necessary.

 ST.element('@someEl').
     visible().
     and(function (el) {
         // el is now visible
     });

Parameters

timeout :  Number (optional)

The maximum time (in milliseconds) to wait.

Returns

:ST.future.Element

this

wait ( delayOrPollFn ) : ST.future.Element
chainable ch

Schedules a wait a specified amount of time (in milliseconds) or until a provided function returns a truthy value. Note that there is no practical use for using a function in a WebDriver scenario test because these functions are executed in the test context and not in the target browser where the application under test is.

For example:

 ST.element('@some-div').
     click(10, 10).

     wait(100).  // wait 100ms

     and(function (el) {
         // Runs after the click event. We receive the ST.Element
         // wrapper for the "some-div" element.

         expect(el.hasCls('foo')).toBe(true);
     });

Sometimes the condition on which a wait is based cannot be handles via callbacks or events and must be polled. That is, one must check and re-check at some short interval to determine if the condition is satisfied.

For example:

 var t = 0;

 setTimeout(function () {
     t = 1;
 }, 1000);

 ST.element('@some-div').
     click(10, 10).

     wait(function (el) {
         // this test method ignores the el (ST.Element) argument
         // for demonstration purposes.
         return t;
     }).

     and(function (el) {
         // Runs after the click event and when t is truthy. We receive the
         // ST.Element wrapper for the "some-div" element.

         expect(el.hasCls('foo')).toBe(true);
     });

These can be combined as needed.

 ST.element('@some-div').
     click(10, 10).

     wait(200, // wait 200ms

         function (el) {
             return t;  // poll this one until it is truthy
         },

         300,  // wait 300ms

         'Something interest', // message for the next fn's timeout reason

         function (el) {
             return el.somethingInteresting();
         }
     ).

     and(function (el) {
         expect(el.hasCls('foo')).toBe(true);
     });

Parameters

delayOrPollFn :  Number/String/Function...

One or more millisecond delays, functions to poll for truthy return value or timeout messages for said functions.

Returns

:ST.future.Element

this

Sencha Test 2.4.0