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: Jun 27 2017
Version Number: 2.1.1
ORION-1918 - Error occurs when user clicks on empty Jira issue column
ORION-1916 - Review screen does not always show "to do" and "done" status icons
ORION-1917 - Cannot scroll test run review results
ORION-2006 - Cannot test packages created with Cmd 6.5
ORION-1926 - STC fails to execute tests with custom Cmd paths
ORION-1978 - Spacebar key is not playable in IE11
ORION-1762 - Event Recorder setup error on Edge browser can occur for In-Browser scenarios if page with parking lot isn't opened
ORION-1992 - User can save page object without adding any locators
ORION-1990 - Auto-name generator for locators should remove illegal characters
ORION-1981 - User properties disappear when filtered in wizard
ORION-1911 - Errors occur when using Inspector with Ext JS 4 applications
ORION-1885 - Page Objects can be saved with only numeric characters
ORION-1891 - TreeListItem components are not highlighted on inspected page
ORION-1883 - Locators that cannot be initially "found" are removed from the selected grid
ORION-1867 - Exit button prompts user to save even after page objects are successfully saved
ORION-1862 - Error occurs when changes to Page Objects are canceled
ORION-1860 - Sencha Test sometimes freezes when loading Inspector
ORION-1841 - Selecting components via Inspector can have delay in WebDriver scenarios
ORION-2014 - isEmptyStore error can occur if you push issue to jira without loaded project
ORION-1980 - enableInRecorder cannot be unchecked for BrowserStack and SauceLabs farms
ORION-1958 - Failure state of browsers is incorrect in Jira ticket
ORION-1948 - Error occurs when closing test run review window
ORION-1937 - Newly added scenario directories are sorted above convention folders
ORION-1970 - User needs to click multiple times on folder/file icon when adding additional libraries
ORION-1938 - New test suite dialog should contain the correct title
ORION-1945 - Show error message for bad storage key entry in prompt
ORION-1929 - Endless refreshing of statuses when bug is moved to "ignored" section
ORION-1932 - Scenario timeout field can have negative value
ORION-1904 - New scenario is saved when user opens file picker for additional library file location
ORION-1882 - Renaming page object file adds redendant .js extension
ORION-1708 - "isSelectionBlocked" error occurs sometimes when opening and expanding scenario node quickly
ORION-1875 - Event Recorder and Inspector windows remain opened when entire project is closed
ORION-1222 - Event recorder is not able to handle opening of a new window.
ORION-1449 - Event Recorder is non-transparent on Linux
ORION-63 - ST cannot play back a recorded Drag and Drop sequence
Date: Wed May 18, 2017
Version Number: 2.1.0.81
If the provided credentials are correct but login is unsuccessful, the user will have to first login via the browser and then attempt authentication again within Sencha Test.
ORION-1656 - Provide ability to manage multiple remote archive servers in Studio
ORION-1624 - Support local archive server
ORION-1894 - Support local screenshot comparison in Studio
ORION-1662 - Cannot click on elements in Chrome 56 with Ext JS 6.2.2+
ORION-1642 - Tap event (and click() API) doesn't work on combobox item in IE/Edge
ORION-1531 - Cannot click on buttons on touch devices (Ext JS 6.5.0)
ORION-1506 - Cannot "check" on checkbox/radio via click/tap API on touch devices (Ext JS 6.5.0)
ORION-1701 - Selecting browser for runner throws an error
ORION-1622 - WebDriver scenario fails while looking for Sencha Cmd (stc)
ORION-1797 - Embedded text is not visible at Webdriver event recorder on second run
ORION-1819 - Enter key in textfield isn't correctly recorded for In-Browser scenario
ORION-1814 - Negative value can be set for process memory
ORION-1715 - Proxy settings password can't be deleted once it's inserted
ORION-1743 - Can't open screenshot result from runner GUI
ORION-1596 - JavaScript error occurs when WebDriver tests are stopped instantly after run
ORION-1578 - Browser isn't closed when test run on WebDriver scenario is stopped
ORION-1449 - Event Recorder is non-transparent on Linux
ORION-63 - ST cannot play back a recorded Drag and Drop sequence
ORION-1222 - Event recorder is not able to handle opening of a new window.