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, 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.
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.
Date: Mon Mar 8 2017
Version Number: 2.0.2.9
Event Recorder
The Event Recorder currently supports Chrome and Edge browsers with WebDriver-based scenarios. For best results, it is recommended to utilize the embedded Selenium Server instance (for Chrome), or Selenium Server 3.0.1 and the latest compatible browser drivers with a custom browser farm: Selenium Server Downloads
When recording WebDriver-based scenarios on Windows, ensure that the Internet Explorer or Microsoft Edge browser zoom is set to 100% and that screen resolution scaling is set to the same percentage on all attached monitors. Use the primary Windows display for recording test steps when possible.
Recording pages with items that open new tabs (windows) is not currently supported.
The Event Recorder is currently unavailable for WebDriver-based scenarios on Linux.
An "Electron Helper" icon will appear in the tray when recording on OSX. This is expected behavior and should not be closed manually. It will close when the recorder is closed via "Cancel" or "Insert Event Recording" in Studio.
A Selenium Grid Java icon may appear in OS X during recording. This is expected behavior and should not affect any functionality.
Recording and Playback in Studio may not function properly on sites that use a Content Security Policy (CSP). Workaround is to remove CSP in a development or QA environment for the purposes of Recording and Playback.
API (1)
EventPlayer (1)
TestRunner (4)
ORION-1571 - Runner halts before all agents are done
ORION-1568 - WebDriver-based scenario tests include many bad global variable warnings
ORION-1569 - "binding.node not found" and "ffi.node not found" errors on Windows
ORION-1594 - Runner should park browser after test
BrowserFarm (1)
EventRecorder (3)
ORION-1449 - Event Recorder is non-transparent on Linux
ORION-1222 - Event recorder is not able to handle opening of a new window.
ORION-63 - ST cannot play back a recorded Drag and Drop sequence
TestRunner (1)
Date: Tue Feb 28 2017
Version Number: 2.0.1.27
Event Recorder
The Event Recorder currently supports Chrome and Edge browsers with WebDriver-based scenarios. For best results, it is recommended to utilize the embedded Selenium Server instance (for Chrome), or Selenium Server 3.0.1 and the latest compatible browser drivers with a custom browser farm: Selenium Server Downloads
When recording WebDriver-based scenarios on Windows, ensure that the Internet Explorer or Microsoft Edge browser zoom is set to 100% and that screen resolution scaling is set to the same percentage on all attached monitors. Use the primary Windows display for recording test steps when possible.
Recording pages with items that open new tabs (windows) is not currently supported.
The Event Recorder is currently unavailable for WebDriver-based scenarios on Linux.
An "Electron Helper" icon will appear in the tray when recording on OSX. This is expected behavior and should not be closed manually. It will close when the recorder is closed via "Cancel" or "Insert Event Recording" in Studio.
A Selenium Grid Java icon may appear in OS X during recording. This is expected behavior and should not affect any functionality.
Recording and Playback in Studio may not function properly on sites that use a Content Security Policy (CSP). Workaround is to remove CSP in a development or QA environment for the purposes of Recording and Playback.
BrowserFarm (2)
* ORION-1513 - Initially selected browser version is ignored when adding a browser to a BrowserStack farm
* ORION-1516 - Cannot create IE instance on saucelabs because extra param is sent
Documentation (1)
* ORION-1563 - Corrupted encoding in release notes.
EventPlayer (2)
* ORION-1492 - Button click events not firing consistently in WebDriver scenarios
* ORION-997 - Backspace does not playback properly
EventRecorder (13)
* ORION-1546 - Capslock,PageUp and Page down keys does not works on Webdriver scenario
* ORION-1517 - PageUp and PageDown keys are incorrectly handled in Event Recorder for WebDriver scenarios
* ORION-1541 - Edge Browser is missing icon in Event Recorder browser list
* ORION-1519 - Checkbox interaction is inconsistent in WebDriver scenario when using Event Recorder
* ORION-1527 - Unable to record menu item hover action via Event Recorder
* ORION-1478 - Row click does not select row when using Event Recorder in Internet Explorer
* ORION-1494 - Error occurs when recording a scroll event in Internet Explorer
* ORION-1476 - Locator for menu item is not stable
* ORION-1490 - Event recorder incorrectly locates checkbox within grid in Internet Explorer
* ORION-1477 - A recorded <enter>key does not create line break in text areas when played back</enter>
* ORION-1518 - Navigation keys are incorrectly recorded for WebDriver scenario
* ORION-1479 - Locator for grid column header click is not stable
* ORION-1483 - Sencha Test loses connection to the browser page when using Event Recorder
Studio (2)
* ORION-1538 - Deleting scenario removes shared folder content
* ORION-1443 - Clicking on Studio application menu will save currently unsaved files
stc (1)
* ORION-1547 - ST.screenshot() doesn't work.
BrowserFarm (1)
* ORION-166 - Sauce Labs or BrowserStack tunnel cannot be started automatically
EventRecorder (3)
* ORION-1449 - Event Recorder is non-transparent on Linux
* ORION-1222 - Event recorder is not able to handle opening of a new window.
* ORION-63 - ST cannot play back a recorded Drag and Drop sequence
TestRunner (1)
* ORION-561 - Test Runner does not handle all forms of Pending specs in Jasmine
Date: January 30, 2017
Version Number: 2.0.0.359
Event Recorder
The Event Recorder currently supports Chrome and Edge browsers with WebDriver-based scenarios. For best results, it is recommended to utilize the embedded Selenium Server instance (for Chrome), or Selenium Server 3.0.1 and the latest compatible browser drivers with a custom browser farm: Selenium Server Downloads
When recording WebDriver-based scenarios on Windows, ensure that the Internet Explorer or Microsoft Edge browser zoom is set to 100% and that screen resolution scaling is set to the same percentage on all attached monitors. Use the primary Windows display for recording test steps when possible.
Recording pages with items that open new tabs (windows) is not currently supported.
The Event Recorder is currently unavailable for WebDriver-based scenarios on Linux.
An "Electron Helper" icon will appear in the tray when recording on OSX. This is expected behavior and should not be closed manually. It will close when the recorder is closed via “Cancel” or “Insert Event Recording” in Studio.
A Selenium Grid Java icon may appear in OS X during recording. This is expected behavior and should not affect any functionality.
Recording and Playback in Studio may not function properly on sites that use a Content Security Policy (CSP). Workaround is to remove CSP in a development or QA environment for the purposes of Recording and Playback.
ORION-1427 - Browser concurrency field is not saved
ORION-946 - Browser version should be reset when browser name is changed
Date: December 14, 2016
Version Number: 2.0.0.309
Issue regarding unexpected results when using the and()
function has been fixed.
Date: November 4, 2016
Version Number: 2.0.0.286
During this EA, Event Recorder for WebDriver-based tests requires Google Chrome browser to be installed on the machine where Sencha Test is installed. Support for other browsers will be available in subsequent releases. WebDriver-based tests can be run on multiple browsers.
Events other than ‘type’ and ‘tap/click’ are not played back for WebDriver-based tests.
Sencha Test does not currently support Event Recording or API calls that attempt to interact with elements within iframes. This functionality will be available in future releases.
A future which is created as a result of a hierarchical operation (e.g., down()
,
row()
, item()
, etc.) may not properly resolve after a page navigation. This will be
resolved in future releases, but as a workaround, simply recalling the desired future
after page navigation should properly relocate the element.
Use of the and()
function may produce unexpected results if additional events are
called within the function:
ST.element('div').and(function () {
ST.element('input').type('foo');
});