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.
These configs apply to JavaScript assets defined in the "js" array. The "js" array contains entries for each script that needs to be loaded as part of the application.
The starter app template (default template) includes two scripts on the "js" array:
"js": [{
"path": "${framework.dir}/build/ext-all-rtl-debug.js"
}, {
"path": "app.js",
"bundle": true
}]
The first entry is added to increase the speed of the development version, since it loads all Ext JS classes (even with right-to-left support) at once from a single js file instead of loading each from its own source file.
Any entries in the "js" array that point to files inside the framework directory will not be included in the final build output.
The second entry is the entry point of this application. The bundle config tells
Sencha Cmd that this script should become the container for the concatenated classes.
The app's "bundle" will be written to app.js in the build output folder.
All Ext JS applications make use of classes inside the Framework (for example Ext.Button
or Ext.data.Store) as well as classes inside its namespace (for example MyApp.view.Main
or MyApp.model.Item) or even classes that are part of a given package (for example
MyCompany.common.User or ThirdParty.plugin.Widget). During the build process, all
these classes are identified, listed and sorted according to how they need to be loaded
(in order to transitively satisfy all dependencies). These files are concatenated into
what Sencha Cmd calls the "application bundle".
You can think of the bundle as file that contains the following (the order is important):
{all framework classes required by the application}
{all theme-specific overrides}
{all overrides specified by your application}
{all classes inside your app's classpath (typically the "app" directory)}
{all scripts with "includeInBundle": true}
{the contents of the file with "bundle": true (typically app.js)}
Loading additional scripts is as easy as adding them to the "js" array. Take the following example:
"js": [{
"path": "foo.js"
}, {
"path": "${framework.dir}/build/ext-all-rtl-debug.js"
},{
"path": "app.js",
"bundle": true
}, {
"path": "bar.js"
}]
In this example, foo.js will load before the application bundle, where bar.js will
be loaded after it.
Sencha Cmd will copy these files to the build directory and will include them in the build manifest. When opening the application in the browser, three scripts will be requested in the following order:
http://example.com/MyApp/foo.js
http://example.com/MyApp/app.js
http://example.com/MyApp/bar.js
You can instruct Sencha Cmd to include any script in the application bundle by
specifying "includeInBundle": true on its entry:
"js": [{
"path": "${framework.dir}/build/ext-all-rtl-debug.js"
},{
"path": "foo.js",
"includeInBundle": true
},{
"path": "app.js",
"bundle": true
}]
In this case foo.js will be included in the bundle, right before the content of app.js.
You can specify any number of files to be included in the bundle and their order will be preserved:
"js": [{
"path": "${framework.dir}/build/ext-all-rtl-debug.js"
},{
"path": "foo.js",
"includeInBundle": true
},{
"path": "bar.js",
"includeInBundle": true
},{
"path": "app.js",
"bundle": true
}]
The contents of ${build.dir}/app.js will now look like this:
{all framework classes required by the application}
{all theme-specific overrides}
{all overrides specified by your application}
{all classes inside your app's classpath (typically the "app" directory)}
{the contents of foo.js}
{the contents of bar.js}
{the contents of the file with "bundle": true (typically app.js)}
While this may be a desired outcome for most cases, others may require the additional files to be included before the app bundle or even between the framework classes and the application classes. Let's see how we can achieve that.
As noted before, the application bundle is a Sencha Cmd concept that contains all the dependencies of the built application in the order they'll be needed. The top-most requirement are the core framework classes, which have no dependencies. This is why there's no out-of-the-box way to include scripts before other contents in the application bundle.
It is however possible to use the underlying ant task hooks to include a script before the bundle:
Let's assume you want to include the contents of a file named foo.js, located in the root directory of the application:
console.log("I'm foo.js");
Add the following task to the application's build.xml file:
Build the application
sencha app build
The contents of the built app.js will now look like this:
{the contents of foo.js} {all framework classes required by the application} {all theme-specific overrides} {all overrides specified by your application} {all classes inside your app's classpath (typically the "app" directory)} {the contents of the file with "bundle": true (typically app.js)}
We took this approach instead of just concatenating to the file at the end to make sure the additional script is also optimized and minified (as part of the normal optimization and minification process).
In some cases, you may have some scripts that require the framework to run but need to be loaded before any of the application classes. Let's check the bundle overview again (without additional scripts and this time with numbers so we can reference some items below):
{(1) all framework classes required by the application}
{(2) all theme-specific overrides}
{(3) all overrides specified by your application}
{(4) all classes inside your app's classpath (typically the "app" directory)}
{(5) the contents of app.js}
We want some script(s) to be included before (4), because the application classes may depend on them.
To achieve this, we can make use of Compiler Directives. Let's take a look at the following example:
Let's assume you want to include the contents of a file named foo.js, located in the root directory of the application:
console.log("I'm foo.js");
Let's add the following comment to app/Application.js:
// @require ../foo.js
Build the application
sencha app build
The contents of the built app.js will now look like this:
{all framework classes required by the application} {all theme-specific overrides} {all overrides specified by your application} {the contents of foo.js} {all classes inside your app's classpath (typically the "app" directory)} {the contents of the file with "bundle": true (typically app.js)}
While the typical approach of loading files individually when loading the application may be suitable for most cases, Sencha Cmd provides some alternatives to include scripts into the concatenated file, either before all other code or once the framework classes are available (and before the application code is executed).
Set to true to indicate that is a development mode only dependency. These files will
not be copied into the build directory or referenced in the generate app.json manifest
for the micro-loader.
Defaults to:
false
Set to true on one file to indicate that it should become the container for the concatenated classes.
Specify as true if this file is remote and should not be copied into the build folder. Defaults to false for a local file which will be copied.
Defaults to:
false
If not specified, this file will only be loaded once, and cached inside localStorage until this value is changed.
You can specify:
"delta" to enable over-the-air delta update for this file."full" means full update will be made when this file changes.
Cmd | Terms of Use