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.
The Cmd Auto Dependency system is an api that allows Cmd to automatically detect class dependencies based purely on usages in code without needing to reference a needed class in either the requires or uses arrays.
It works by combining the values of class configs with metadata from associated auto dependency directives to allow Cmd to interpret the value of a config as a constructor parameter to another class.
As an example, consider the following auto dependency directive for the items config
of the Container class from the classic toolkit:
Ext.define('Ext.container.Container', {
...
// @cmd-auto-dependency {aliasPrefix: "widget.", typeProperty: "xtype", defaultTypeProperty: "defaultType", defaultsProperty: "defaults"}
items: undefined,
...
});
Cmd requires the directive to be contained in a single line, but for the purposes of discussing the structure of the directive, here is the same directive formatted for readability:
Ext.define('Ext.container.Container', {
...
// @cmd-auto-dependency {
// aliasPrefix: "widget.",
// typeProperty: "xtype",
// defaultTypeProperty: "defaultType",
// defaultsProperty: "defaults"
// }
items: undefined,
...
});
In this example, the presence of the cmd-auto-dependency directive above the items config is enough to indicate to Cmd that the value of an items config, when supplied, should be processed as a constructor parameter to one or more class instances.
To do this, Cmd must first determine the class being constructed. It does this by first looking at the value of the config. If the value of the config is a string, like:
new Ext.container.Container({
items: "button"
});
the value of the string is first checked to see if it is already a resolvable reference
to a class definition. If not, the data from the directive is used to produce other
match candidates. In this case, the directive indicates that the aliasPrefix to use
when resolving class names here is "widget.", so the name, "button", is combined with
the aliasPrefix to produce the candidate name "widget.button", which will resolve to
Ext.button.Button.
If, however, the value of the config is an object literal, the the object literal will need to be inspected to determine the string literal to use.
new Ext.container.Container({
items: {
xtype: "button"
}
});
To determine the class name for configs of this type, Cmd must inspect the object
literal to detect a specified class name. In this case, the directive specifies a
typeProperty of "xtype". This tells Cmd that if the object literal contains a property
by that name, then the value of that property should be used as the input string to
perform the above lookup.
For container items, an array may also be supplied as the value of the config. In this case, Cmd will iterate all of the items of the array, applying the same class name lookup process:
new Ext.container.Container({
items: [{
xtype: "button"
},{
xtype: "panel"
}]
});
In some cases, the data needed to create the target class name may be provided via
another property on the class definition, and defaultTypeProperty allows this property
name to be specified. For the items config, the defaultTypeProperty value of
"defaultType" indicates that the "defaultType" property should be used if supplied:
new Ext.container.Container({
defaultType: "button",
items: [{
text: "abc"
},{
xtype: "panel"
}]
});
The auto dependency system can also handle the case where a class definition supplies
an entire default config to use when creating certain class instances. For container
items, this is configured with the defaultsProperty of "defaults":
new Ext.container.Container({
defaults: {
xtype: "button",
text: "abc"
},
items: [{
label: "xyz"
},{
xtype: "panel"
}]
});
For other configs less dynamic than container items, or for cases where the default type
to looks up does not need to be dynamically modified, the defaultType dependency
property may be used to set the default type to use when no other type info is found
on the config value.
In other cases, while the config value itself may need to be processed to determine
further dependencies, there may be other helper classes required by the config that
can not be found by inspecting the config value itself. In these cases, the requires
dependency config may be used to list other classes that should be required when a
config value is supplied
One subtlety of the auto dependency system is that the detection of requirements is driven by the instantiation points, not the class definitions. Consider the following example:
Ext.define("A.container.Class", {
// @cmd-auto-dependency { aliasPrefix: "layout." }
// an optional layout config, "layout.hbox" will be the default
layout: "hbox"
});
Ext.create("A.container.Class", {
layout: "vbox"
});
In this example, the 'layout.hbox' class will never be required, even though it is the default layout for the class, since there are no instances of the container class that use the hbox layout, only vbox.
This property specifies an alias prefix to prepend to the detected name value when generating name matching candidates for the type lookup.
Ext.define("A.container.Class", {
// @cmd-auto-dependency { aliasPrefix: "layout." }
// an optional layout config, "layout.hbox" will be the default
layout: "hbox"
});
Ext.create("A.container.Class", {
layout: "vbox"
});
Controls whether the instantiation point, the class definition, or both gain the dependency when a value is supplied for this class config. Useful for controlling file sort ordering.
Supported values are class, instance, or all. The default value is instance
Considering the following example:
// A.js content
Ext.define('A.button.Class', {
// @cmd-auto-dependency { defaultType: "Ext.menu.Menu", blame: "instance" }
menu: undefined
});
// B.js content
Ext.create('A.button.Class', {
menu: {...}
});
A the default blame value of 'instance' indicates that B.js should gain the requirement for Ext.menu.Menu. A blame value of 'class' would cause A.js to gain the requirement. A blame value of 'all' would cause both A.js and B.js to gain the requirement.
This config specifies the default type name to use when resolving a config value.
Ext.define("A.button.Class", {
// @cmd-auto-dependency { defaultType: "Ext.menu.Menu" }
// an optional popup menu
menu: undefined
});
Ext.create("A.button.Class", {
// no xtype needed, as the defaultType will be applied
menu: {
items: [...]
}
});
Specifies a property / config on the class definition that will contain the default value to use when resolving the class name.
Ext.define("A.container.Class", {
// @cmd-auto-dependency { defaultTypeProperty: "defaultType" }
items: undefined
});
new A.container.Class({
defaultType: "button",
items: [{
// xtype not needed for this item, as "button" will be used
// as the default type
text: "abc"
},{
xtype: "panel"
}]
});
Similar to requires, but specifies a single class to automatically be required if a truthy value for this config is specified.
Indicates that when an object literal value is supplied, this value should be processed as a key/value container where the values are the configs to inspect, similar to the array form of config value.
Ext.define('A.field.Class', {
// @cmd-auto-dependency { aliasPrefix: "trigger.", isKeyedObject: true}
triggers: null
});
Ext.create('A.field.Class', {
triggers: {
clear: 'clear',
search: {
type: 'search'
}
}
});
Specifies a list of other classes that need to be requires when a config is supplied, but that are not detectable via the value of the config.
Ext.define("An.application.Class", {
// @cmd-auto-dependency { aliasPrefix: "view.", requires: ["Ext.plugin.Viewport"]}
mainView: null
});
Ext.define("A.view.Class", {
alias: "view.main"
});
Ext.create("A.application.Class", {
mainView: "main"
});
Specifies the property to inspect when looking for a type specifier. The default value for this is 'type'.
Ext.define("A.button.Class", {
// @cmd-auto-dependency { defaultType: "Ext.menu.Menu", typeProperty: 'mtype' }
// an optional popup menu
menu: undefined
});
Ext.create("A.button.Class", {
menu: {
// this overrides the default type with a custom value
mtype: 'custom-menu'
items: [...]
}
});
Cmd | Terms of Use