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.
This class is the default locator strategy. This can also be used as a base class for other locator strategies. To register custom locator strategies, see ST#addLocatorStrategy or ST#setLocatorStrategies.
Property names are the component xtypes to ignore. Values are either the xtype
of the parent if the component should only be ignored when inside this type of
parent, or true to always ignore.
Defaults to:
{
gridview: 'grid',
tableview: 'grid',
treeview: 'tree'
}
The list of config properties used to identify components in order of priority.
Defaults to:
[
'id',
'stateId',
'reference',
'itemId',
'name',
'iconCls',
'text',
'fieldLabel'
]
Available since: 1.0.1
Generates a set of ComponentQuery candidates for the given Component. The generated CQ selectors are "shallow" in that they do not describe the containment hierarchy of the component.
Available since: 1.0.1
cmp : Ext.Component
el : HTMLElement
The actual element to target. If this parameter is not
null this method may include an additional DOM query on the generated selectors
separated by "=>" (a "Composite Query").
targets : Array[]
The array to which to append targets and their locator(s)
as an array of [ el, locator ].
ev : Object
Returns true if any targets were generated.
Generates a ComponentQuery selector for the given Component using the specified config property. The selector is "shallow" in that they do not describe the containment hierarchy of the component.
The supported properties are listed in the configList array.
Available since: 1.0.1
cmp : Ext.Component
prop : String
The property to use in the generated selector.
targets : Array[]
The array to which to append targets and their locator(s)
as an array of [ el, locator ].
Returns true if any targets were generated.
Returns the id of the given Component.
cmp : Ext.Component
Returns an array of RegExp patterns that describe CSS classes to be ignored.
Available since: 1.0.1
baseCSSPrefix : String
The CSS prefix for Ext JS (typically "x-").
Returns the xtype of the given Component. If the component has multiple xtypes,
the primary is returned.
Available since: 1.0.1
cmp : Ext.Component
Returns true if the given CSS class should be ignored.
cls : String
Initializes this instance. This method is called immediately prior to the first
call to locate. This is done in a deferred manner to ensure that any necessary
code has been loaded (such as Ext JS).
Available since: 1.0.1
This method should append target locators to the targets array based on the
provided el. Each identified target should be appended to the targets array
(e.g., using push()).
Because a locator can describe the passed el or a parent node, results added to
the targets array should be an array consisting of the element and its locator.
For example:
if (el.id) {
targets.push([ el, '@' + el.id ]);
}
el : HTMLElement
The element for which to generate target locator(s).
targets : Array[]
The array to which to append targets and their locator(s)
as an array of [ el, locator ].
ev : Object
Returns true if any targets were generated.
Returns the array of CSS classes given the className (space-separated classes).
The ignored classes have been removed from the array.
Available since: 1.0.1
cls : String
Sencha Test | Terms of Use