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.
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.
Public classes and class members are available for use by any other class or application code and may be relied upon as a stable and persistent within major product versions. Public classes and members may safely be extended via a subclass.
Protected class members are stable public members intended to be used by the
owning class or its subclasses. Protected members may safely be extended via a subclass.
Private classes and class members are used internally by the framework and are not intended to be used by application developers. Private classes and members may change or be omitted from the framework at any time without notice and should not be relied upon in application logic.
static label next to the
method name. *See Static below.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).
Let's look at each part of the member row:
lookupComponent in this example)( item ) in this example)Ext.Component in this case). This may be omitted for methods that do not
return anything other than undefined or may display as multiple possible values
separated by a forward slash / signifying that what is returned may depend on the
results of the method call (i.e. a method may return a Component if a get method calls is
successful or false if unsuccessful which would be displayed as
Ext.Component/Boolean).PROTECTED in
this example - see the Flags section below)Ext.container.Container in this example). The source
class will be displayed as a blue link if the member originates from the current class
and gray if it is inherited from an ancestor or mixed-in class.view source in the example)item : Object in the example).undefined a "Returns" section
will note the type of class or object returned and a description (Ext.Component in the
example)Available since 3.4.0 - not pictured in
the example) just after the member descriptionDefaults to: false)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.
classInstance.method1().method2().etc();false is returned from
an event handler- 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
- 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
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.
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.
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.
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 and inheritance. This is done using the checkboxes at the top of
the page. Note that filtering out private members also filters the API class
navigation tree.
Clicking on an empty search field will show your last 10 searches for quick navigation.
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:
Ext.button.Button class has an alternate class name of Ext.Button). Alternate class
names are commonly maintained for backward compatibility.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.
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:
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.
A future Element is a class that can be used to interact with an element that will exist at some point. Typically that element does not exist when the future is created.
The methods of a future (including its constructor) defer actions in an event queue (based on ST.event.Player). A simple example would be:
ST.element('@some-div').
click(10, 10);
The API of futures is based on chained method calls, sometimes called a "fluent" API. In the above example, the ST#element method accepts the locator and returns a future. The click method of the future queues a click event at offset (10, 10).
Many methods of futures perform actions (such as click) on their target. These methods schedule their actions so that they follow previously invoked future methods to ensure that these actions flow in the same order as the test code that requested them.
Actions methods use verbs for names.
The other main group of methods on futures are state methods. These methods do not affect their target but rather schedule a delay in the test sequence that begins at the proper time (following all previously schedules operations) and finishing when the target arrives in the desired state.
For example:
ST.element('@some-div').
click(10, 10).
textLike(/hello/i);
The above test will locate our div, click on it and then wait for its textContent
to match the specified regular expression. The test will complete successfully if
the text matches within the default timeout (5 seconds) and will fail otherwise.
State methods use nouns or descriptions for names.
Because operations on futures all complete asynchronously, it is important not to mix these operations with immediate method calls. Instead, we schedule inspections using the future's and method.
ST.element('@some-div').
click(10, 10).
and(
// Invoked after the click has played. The ST.Element wrapper for
// the target div is given as a parameter.
function (divEl) {
expect(divEl.hasCls('foo')).toBe(false);
}
);
The functions passed to and() are called "inspections" but there are no particular
restrictions on what these methods actually do when they are called.
There are two basic ways to control the timing of the test sequence. The first is the
and() method's optional second argument:
ST.element('@some-div').
click(10, 10).
and(function (divEl, done) {
something().then(done);
});
When an inspection function is declared to have a second argument, it is called with
a completion function typically named "done". If declared as an argument, this function
must be called or the test will fail. The inspection function, however, can decide when
the function should be called. Once done is called, the test sequence can continue.
When there is no mechanism that can reasonably be used to determine when a condition is satisfied, there is the wait method.
ST.element('@some-div').
click(10, 10).
wait(function (divEl) {
return divEl.hasCls('foo');
});
In this case, the function passed to wait() is called periodically and when it
eventually returns true the test can proceed. Obviously, the and() method and its
done function are preferrable because they won't need to poll for completion. Which
approach is more readily implemented in a given situation will typically determine the
best choice, and not this slight performance consideration.
When interacting with Ext JS components, see ST#component or one of the more specific methods such as ST#panel, ST#grid, etc..
This class is not created directly by user code. Instead, it is created automatically by various helper methods, like ST#element and ST#wait.
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);
});
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);
}
);
fnOrTimeout : Number / Function...
One or more functions to invoke or timeout values. 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.
this
Waits for this element to become blurred.
ST.element('@someEl').
focused().
and(function (el) {
// el is now hidden
});
timeout : Number (optional)
The maximum time (in milliseconds) to wait.
this
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.
selector : String
The DOM Query selector to use to search for the child component
timeout : Number (optional)
The maximum time (in milliseconds) to wait.
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);
If first argument is an object, it should be a ST.event.Playable
config object for a type="click" event. In this case, all other arguments are
ignored.
y : Number
The number of pixels from the top edge of the element.
timeout : Number (optional)
The maximum time (in milliseconds) to wait.
this
Waits for this element's innerHTML to match the specified value.
ST.element('@some-div').
click(10, 10).
content('Hello <b>world</b>');
If first argument is an object, it should be a ST.event.Playable
config object (with an additional required html property). In this case, all
other arguments are ignored.
Available since: 1.0.1
timeout : Number (optional)
The maximum time (in milliseconds) to wait.
this
Waits for this element's innerHTML to be empty.
ST.element('@some-div').
click(10, 10).
contentEmpty();
If first argument is an object, it should be a ST.event.Playable config object. In this case, all other arguments are ignored.
this
Waits for this element's innerHTML to match the specified RegExp pattern.
ST.element('@some-div').
click(10, 10).
contentLike(/hello/i);
If first argument is an object, it should be a ST.event.Playable
config object (with an additional required pattern property). In this case, all
other arguments are ignored.
pattern : RegExp / String / Object
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.
this
Waits for this element's innerHTML to be non-empty.
ST.element('@some-div').
click(10, 10).
contentNotEmpty();
If first argument is an object, it should be a ST.event.Playable config object. In this case, all other arguments are ignored.
this
Waits for this element's innerHTML to not match the specified RegExp pattern.
ST.element('@some-div').
click(10, 10).
contentNotLike(/world/i);
If first argument is an object, it should be a ST.event.Playable
config object (with an additional required pattern property). In this case, all
other arguments are ignored.
pattern : RegExp / String / Object
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.
this
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.
locator : String
The DOM Query selector to use to search for the descendant
timeout : Number (optional)
The maximum time (in milliseconds) to wait.
Schedules the component to receive the focus.
ST.element('@some-div/input').
focus();
If first argument is an object, it should be a ST.event.Playable config object. In this case, all other arguments are ignored.
this
Waits for this element to become focused.
ST.element('@someEl').
focused().
and(function (el) {
// el is now hidden
});
timeout : Number (optional)
The maximum time (in milliseconds) to wait.
this
Waits for this element to have a specified CSS class.
ST.element('@someEl').
hasCls('foo').
and(function (el) {
// el is now does has a "foo" class
});
cls : String
The class name to test.
timeout : Number (optional)
The maximum time (in milliseconds) to wait.
this
Waits for this element to not have a specified CSS class.
ST.element('@someEl').
missingCls('foo').
and(function (el) {
// el is now does not have a "foo" class
});
cls : String
The class name to test.
timeout : Number (optional)
The maximum time (in milliseconds) to wait.
this
Waits for this element to be removed from the document.
ST.element('@someEl').
removed().
and(function (el) {
// el is now removed from the document
});
timeout : Number (optional)
The maximum time (in milliseconds) to wait.
this
Takes a snapshot of the viewport and compares it to the associated baseline image.
ST.element('@someEl').
click(10, 10).
screenshot();
name : String
timeout : Number (optional)
The maximum time (in milliseconds) to wait.
this
Waits for this element's textContent to match the specified string.
ST.element('@some-div').
click(10, 10).
text('Hello world');
If first argument is an object, it should be a ST.event.Playable config object (with an additional required text property). In this case, all other arguments are ignored.
Available since: 1.0.1
timeout : Number (optional)
The maximum time (in milliseconds) to wait.
this
Waits for this element's textContent to be empty.
ST.element('@some-div').
click(10, 10).
textEmpty();
If first argument is an object, it should be a ST.event.Playable config object. In this case, all other arguments are ignored.
this
Waits for this element's textContent to match the specified RegExp pattern.
ST.element('@some-div').
click(10, 10).
textLike(/hello/i);
If first argument is an object, it should be a ST.event.Playable
config object (with an additional required pattern property). In this case, all
other arguments are ignored.
pattern : RegExp / String / Object
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.
this
Waits for this element's textContent to be non-empty.
ST.element('@some-div').
click(10, 10).
textNotEmpty(200);
If first argument is an object, it should be a ST.event.Playable config object. In this case, all other arguments are ignored.
this
Waits for this element's textContent to not match the specified RegExp pattern.
ST.element('@some-div').
click(10, 10).
textNotLike(/hello/i, 200);
If first argument is an object, it should be a ST.event.Playable
config object (with an additional required pattern property). In this case, all
other arguments are ignored.
pattern : RegExp / String / Object
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.
this
Schedules a "type" action at the specified relative coordinates. This method assumes you have already achieved correct focus of the target.
ST.element('@some-div/input').
focus().
type('Hello world');
If first argument is an object, it should be a ST.event.Playable
config object for a type="type" event. In this case, all other arguments are
ignored.
timeout : Number (optional)
The maximum time (in milliseconds) to wait for the typing to finish.
this
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.
selector : String
The DOM Query selector to use to search for the ancestor
timeout : Number (optional)
The maximum time (in milliseconds) to wait.
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
});
timeout : Number (optional)
The maximum time (in milliseconds) to wait.
this
Schedules a wait a specified amount of time (in milliseconds) or until a provided function returns a truthy value.
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);
});
delayOrPollFn : Number / String / Function...
One or more millisecond delays, functions to poll for truthy return value or timeout messages for said functions.
this
Sencha Test 1.0.3 | Terms of Use