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.

Ext JS 6.7.0-CE - Modern Toolkit


top

Ext.env.Ready private singleton

Hierarchy

Ext.env.Ready
NOTE: This is a private utility class for internal use by the framework. Don't rely on its existence.

Summary

This class manages ready detection and handling. Direct use of this class is not recommended. Instead use Ext.onReady:

 Ext.onReady(function () {
     // DOM and Framework are ready...
 });

DOM Ready

The lowest-level of readiness is DOM readiness. This level implies only that the document body exists. Many things require the DOM to be ready for manipulation. If that is all that is required, the Ext.onDocumentReady method can be called to register a callback to be called as soon as the DOM is ready:

 Ext.onDocumentReady(function () {
     // the document body is ready
 });

Framework Ready

In production builds of applications it is common to have all of the code loaded before DOM ready, so the need to wait for "onReady" is often confused with only that concern. This is easy to understand, at least in part because historically Ext.onReady only waited for DOM ready.

With the introduction of Ext.Loader, however, it became common for DOM ready to occur in the middle of dynamically loading code. If application code were executed at that time, any use of the yet-to-be-loaded classes would throw errors. As a consequence of this, the Ext.onReady mechanism was extended to wait for both DOM ready and all of the required classes to be loaded.

When the framework enters or leaves a state where it is not ready (for example, the first dynamic load is requested or last load completes), Ext.env.Ready is informed. For example:

 Ext.env.Ready.block();

 //...

 Ext.env.Ready.unblock();

When there are no blocks and the DOM is ready, the Framework is ready and the "onReady" callbacks are called.

Priority can be used to control the ordering of onReady listeners, for example:

Ext.onReady(function() {

}, null, {
    priority: 100
});

Ready listeners with higher priorities will run sooner than those with lower priorities, the default priority being 0. Internally the framework reserves priorities of 1000 or greater, and -1000 or lesser for onReady handlers that must run before or after any application code. Applications should stick to using priorities in the -999 - 999 range. The following priorities are currently in use by the framework:

  • Element_scroll rtl override: 1001
  • Event system initialization: 2000
  • Ext.dom.Element: 1500
No members found using the current filters

properties

Instance Properties

blocks : Number
private pri

The number of Framework readiness blocks.

Defaults to:

(location.search || '').indexOf('ext-pauseReadyFire') > 0 ? 1 : 0

bound : Number
private pri

This property stores the state of event listeners bound to the document or window to detect ready state.

Defaults to:

0

delay : Number
private pri

This allows the DOM listener thread to complete (usually desirable with mobWebkit, Gecko) before firing the entire onReady chain (high stack load on Loader). For mobile devices when running from Home Screen, the splash screen will not disappear until all external resource requests finish. This delay clears the splash screen.

Defaults to:

1

events : Event[]
private pri

An array of events that have triggered ready state. This is for diagnostic purposes only and is only available in debug builds. An array

Defaults to:

[]

firing : Boolean
private pri

This property is true when we currently calling the listeners.

Defaults to:

false

generation : Number
private pri

A counter of the number of mutations of listeners.

Defaults to:

0

listeners : Object[]
private pri

The set of listeners waiting for ready.

Defaults to:

[]

nextId : Number
private pri

A counter so we can assign listeners an id to keep them in FIFO order.

Defaults to:

0

readyStatesRe
private pri

Defaults to:

/complete/i

scrollTimer
private pri

Timer for doScroll polling

Defaults to:

null

sortGeneration : Number
private pri

A captured value of generation that indicates when the listeners were last sorted.

Defaults to:

0

state : Number
private pri

Holds the current ready state as managed by this class. The values possible are:

  • 0 - Not ready.
  • 1 - Ready detected but listeners are not yet notified.
  • 2 - Ready detected and listeners are notified. See also firing.

Defaults to:

0

timer : Object
private pri

The handle from setTimeout for the delayed notification of ready.

Defaults to:

null

methods

Instance Methods

bind
private pri

Binds the appropriate browser event for checking if the DOM has loaded.

fireReady
private pri

This method starts the process of firing the ready event. This may be delayed based on the delay property.

handleReady
private pri

This method iterates over the listeners and invokes them. This advances the state from 1 to 2 and ensure the proper subset of listeners are invoked.

handleReadySoon ( [delay] )
private pri

This method is called to schedule a call to handleReady using a setTimeout. It ensures that only one timer is pending.

Parameters

delay :  Number (optional)

If passed, this overrides the delay property.

invoke ( listener )

This method invokes the given listener instance based on its options.

Parameters

listener :  Object

invokeAll

Invokes as many listeners as are appropriate given the current state. This should only be called when DOM ready is achieved. The remaining business of blocks is handled here.

makeListener ( fn, [scope], [options] ) : Object
private pri

This method wraps the given listener pieces in a proper object for the listeners array and invoke methods.

Parameters

fn :  Function

The method to call.

scope :  Object (optional)

The scope (this reference) in which the fn executes. Defaults to the browser window.

options :  Object (optional)

An object with extra options.

delay :  Number (optional)

A number of milliseconds to delay.

Defaults to:

0

priority :  Number (optional)

Relative priority of this callback. A larger number will result in the callback being sorted before the others. Priorities 1000 or greater and -1000 or lesser are reserved for internal framework use only.

Defaults to:

0

dom :  Boolean (optional)

Pass true to only wait for DOM ready, false means full Framework and DOM readiness.

Defaults to:

false

Returns

:Object

The listener instance.

on ( fn, [scope], [options] )
private pri

Adds a listener to be notified when the document is ready (before onload and before images are loaded).

Parameters

fn :  Function

The method to call.

scope :  Object (optional)

The scope (this reference) in which the fn executes. Defaults to the browser window.

options :  Object (optional)

An object with extra options.

delay :  Number (optional)

A number of milliseconds to delay.

Defaults to:

0

priority :  Number (optional)

Relative priority of this callback. A larger number will result in the callback being sorted before the others. Priorities 1000 or greater and -1000 or lesser are reserved for internal framework use only.

Defaults to:

0

dom :  Boolean (optional)

Pass true to only wait for DOM ready, false means full Framework and DOM readiness.

Defaults to:

false

onReadyEvent ( [ev] )
private pri

This is a generic event handler method attached to all of the various events that may indicate ready state. The first call to this method indicates ready state has been achieved.

Parameters

ev :  Event (optional)

The event instance.

onReadyStateChange
private pri

This event handler is called when the readyState changes.

pollScroll
private pri

This strategy has minimal benefits for Sencha solutions that build themselves (ie. minimal initial page markup). However, progressively-enhanced pages (with image content and/or embedded frames) will benefit the most from it. Browser timer resolution is too poor to ensure a doScroll check more than once on a page loaded with minimal assets (the readystatechange event 'complete' usually beats the doScroll timer on a 'lightly-loaded' initial document).

sortFn ( a, b )
private pri

Sorts the listeners array by phase and priority such that the first listener to fire can be determined using pop on the listeners array.

Parameters

a :  Object

b :  Object

unbind
private pri

This method is called to remove all event listeners that may have been set up to detect ready state.

Ext JS 6.7.0-CE - Modern Toolkit