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.3.0


top

Summary

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.

No members found using the current filters

properties

Instance Properties

classIgnore : Object

Property names are the Ext JS classes to ignore.

Defaults to:

{}

cmpIgnore : Object

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'
}

configList : String[]

The list of config properties used to identify components in order of priority.

Defaults to:

[
    'id',
    'stateId',
    'reference',
    'itemId',
    'fieldLabel',
    //Moving fieldLabel to the top of generic identifier list to give preference. Fix for ORION-2300
    'boxLabel',
    'name',
    'iconCls',
    'text',
    'label'
]

Available since: 1.0.1

cssIgnore : Object

Property names are the CSS class names to ignore.

Defaults to:

{
    fa: 1,
    // FontAwesome
    // Some old framework bugs rendered null/undefined into class attribute
    'null': 1,
    'undefined': 1
}

methods

Instance Methods

getCQ ( cmp, el, targets, ev ) : Boolean

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

Parameters

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

:Boolean

Returns true if any targets were generated.

getCQForProperty ( cmp, prop, targets ) : Boolean

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

Parameters

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

:Boolean

Returns true if any targets were generated.

getCmpId ( cmp ) : String

Returns the id of the given Component.

Parameters

cmp :  Ext.Component

Returns

:String

getCssIgnorePatterns ( baseCSSPrefix ) : String[]
protected pro

Returns an array of RegExp patterns that describe CSS classes to be ignored.

Available since: 1.0.1

Parameters

baseCSSPrefix :  String

The CSS prefix for Ext JS (typically "x-").

Returns

:String[]

getXType ( cmp ) : String

Returns the xtype of the given Component. If the component has multiple xtypes, the primary is returned.

Available since: 1.0.1

Parameters

cmp :  Ext.Component

Returns

:String

ignoreCls ( cls ) : Boolean
protected pro

Returns true if the given CSS class should be ignored.

Parameters

cls :  String

Returns

:Boolean

init
protected pro

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

locate ( el, targets, ev, noComponentLocators ) : Boolean

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 ]);
 }

Parameters

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

noComponentLocators :  Boolean

if true then don't return locators which locate Ext Components

Returns

:Boolean

Returns true if any targets were generated.

splitCls ( cls ) : String[]
protected pro

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

Parameters

cls :  String

Returns

:String[]

Sencha Test 2.3.0