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


top

Hierarchy

ST.Element

Summary

This class wraps a DOM element and provides helpful methods that simplify and normalize browser differences.

No members found using the current filters

properties

methods

Instance Methods

child ( selector, [asDom], [single] ) : HTMLElement/ST.Element

Selects one or more direct descendent children based on the passed CSS selector (the selector should not contain an id).

Parameters

selector :  String

The CSS selector.

asDom :  Boolean (optional)

true to return the DOM node instead of ST.Element.

Defaults to: false

single :  Boolean (optional)

true to return only a single direct descendent.

Defaults to: true

Returns

:HTMLElement/ST.Element

The child ST.Element (or DOM node if asDom is true)

down ( selector, [asDom], [single] ) : HTMLElement/ST.Element

Selects a single child at any depth below this element based on the passed CSS selector (the selector should not contain an id).

Parameters

selector :  String

The CSS selector

asDom :  Boolean (optional)

true to return the DOM node instead of ST.Element

Defaults to: false

single :  Boolean (optional)

true to return only the first result (private) TODO OK?

Defaults to: true

Returns

:HTMLElement/ST.Element

The child ST.Element (or DOM node if asDom is true)

findParent ( selector, asDom, limit )
private pri

Parameters

selector :  Object

asDom :  Object

limit :  Object

findParentNode ( selector, asDom, limit )
private pri

Parameters

selector :  Object

asDom :  Object

limit :  Object

focus ST.Element
chainable ch

Try to focus the element.

Returns

:ST.Element

this

getCaret ( packed ) : Number/Number[]
private pri

Gets the cursor position in a text field

Parameters

packed :  Boolean

Return a single location or a range

Returns

:Number/Number[]

getComponent Ext.Component

Returns the Ext.Component associated with this element.

Returns

:Ext.Component

getText

Returns the elements textContent.

getXPath

Return the full XPath for this element.

hasAnyCls ( cls ) : Boolean

Returns true if this element has any of the classes in the given cls string (of space-separated classes) or array of class names. Array elements are not checked for space-separators.

Parameters

cls :  String/String[]

The classes to test

Returns

:Boolean

hasCls ( cls, [any] ) : Boolean

Returns true if this element has the classes in the given cls string (of space-separated classes) or array of class names. Array elements are not checked for space-separators.

Parameters

cls :  String/String[]

The classes to test

any :  Boolean (optional)

Pass true to only require that one of the classes must be present, false (the default) will require that all classes be present.

Returns

:Boolean

is ( selector ) : Boolean

Returns true if this element matches the passed simple selector (e.g. 'div.some-class' or 'span:first-child').

Parameters

selector :  String/Function

The simple selector to test or a function which is passed candidate nodes, and should return true for nodes which match.

Returns

:Boolean

true if this element matches the selector, else false.

query ( selector, [asDom] ) : HTMLElement[]/ST.Element[]

Selects child nodes based on the passed CSS selector. Delegates to document.querySelectorAll. More information can be found at http://www.w3.org/TR/css3-selectors/

All selectors, attribute filters and pseudos below can be combined infinitely in any order. For example div.foo:nth-child(odd)[@foo=bar].bar:first would be a perfectly valid selector.

Element Selectors:

  • * any element
  • E an element with the tag E
  • E F All descendant elements of E that have the tag F
  • E > F or E/F all direct children elements of E that have the tag F
  • E + F all elements with the tag F that are immediately preceded by an element with the tag E
  • E ~ F all elements with the tag F that are preceded by a sibling element with the tag E

Attribute Selectors:

The use of @ and quotes are optional. For example, div[@foo='bar'] is also a valid attribute selector.

  • E[foo] has an attribute "foo"
  • E[foo=bar] has an attribute "foo" that equals "bar"
  • E[foo^=bar] has an attribute "foo" that starts with "bar"
  • E[foo$=bar] has an attribute "foo" that ends with "bar"
  • E[foo*=bar] has an attribute "foo" that contains the substring "bar"
  • E[foo%=2] has an attribute "foo" that is evenly divisible by 2
  • E[foo!=bar] has an attribute "foo" that does not equal "bar"

Pseudo Classes:

  • E:first-child E is the first child of its parent
  • E:last-child E is the last child of its parent
  • E:nth-child(n) E is the nth child of its parent (1 based as per the spec)
  • E:nth-child(odd) E is an odd child of its parent
  • E:nth-child(even) E is an even child of its parent
  • E:only-child E is the only child of its parent
  • E:checked E is an element that is has a checked attribute that is true (e.g. a radio or checkbox)
  • E:first the first E in the resultset
  • E:last the last E in the resultset
  • E:nth(n) the nth E in the resultset (1 based)
  • E:odd shortcut for :nth-child(odd)
  • E:even shortcut for :nth-child(even)
  • E:not(S) an E element that does not match simple selector S
  • E:has(S) an E element that has a descendant that matches simple selector S
  • E:next(S) an E element whose next sibling matches simple selector S
  • E:prev(S) an E element whose previous sibling matches simple selector S
  • E:any(S1|S2|S2) an E element which matches any of the simple selectors S1, S2 or S3//\

CSS Value Selectors:

  • E{display=none} CSS value "display" that equals "none"
  • E{display^=none} CSS value "display" that starts with "none"
  • E{display$=none} CSS value "display" that ends with "none"
  • E{display*=none} CSS value "display" that contains the substring "none"
  • E{display%=2} CSS value "display" that is evenly divisible by 2
  • E{display!=none} CSS value "display" that does not equal "none"

Parameters

selector :  String

The CSS selector.

asDom :  Boolean (optional)

false to return an array of ST.Element

Defaults to: false

Returns

:HTMLElement[]/ST.Element[]

An Array of elements ( HTMLElement or ST.Element if asDom is false) that match the selector. If there are no matches, an empty Array is returned.

setCaret ( caret ) : Boolean
private pri

Sets the cursor position in a text field

Parameters

caret :  Number/Number[]

The position to place the cursor in the string

Returns

:Boolean

up ( selector, [asDom], [limit] ) : ST.Element/HTMLElement

Walks up the dom looking for a parent node that matches the passed simple selector (e.g. 'div.some-class' or 'span:first-child'). This is a shortcut for findParentNode() that always returns an ST.Element.

Parameters

selector :  String

The simple selector to test.

asDom :  Boolean (optional)

True to return the DOM node instead of ST.Element

Defaults to: false

limit :  Number/String/HTMLElement/ST.Element (optional)

The max depth to search as a number or an element that causes the upward traversal to stop and is not considered for inclusion as the result. (defaults to 50 || document.documentElement)

Returns

:ST.Element/HTMLElement

The matching DOM node (or DOM node if asDom is true)

Static Methods

normalize ( prop ) : String
static sta private pri

Normalizes CSS property keys from dash delimited to camel case JavaScript Syntax. For example:

  • border-width -> borderWidth
  • padding-top -> paddingTop

Parameters

prop :  String

The property to normalize

Returns

:String

The normalized string

Sencha Test 2.2.0