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

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.


item :  Object

The config object being added.


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.

GXT 3.x


GXT Permutations

A permutation is a application build for a specific purpose built for performance. It does a runtime rebind evaluation or it's called deferred binding.


GXT Properties

Property options that can generate permutations for.

Property Properties Notes
gxt.user.agent IE8, IE9, IE10, IE11, gecko1_8, gecko1_9, safari3, safari4, safari5, chrome, air Browsers and these properties are boiled down to just IE9, IE9, IE10, gecko1_8, safari
gxt.device phone, tablet, desktop Devices
gxt.theme blue, gray, neptune, triton Themes
gxt.css3.enabled true, false Css3 is false for IE8 and IE9. This switches the appearances for themes.

GWT Properties

Property Properties Notes
gwt.logging.logLevel finest Debugging level for GXT logging output.
gwt.logging.enabled true Turns on GXT logging.
CssResource.enableGss true, false GWT 2.7 is off by default. GWT 2.8 is on by default.
CssResource.gssDefaultInUiBinder true, false Enables GSS for UiBinder.
CssResource.conversionMode strict, lenient, off Stop on CSS to GSS conversion.
CssResource.obfuscationPrefix empty Removes the css prefix. obf, debug, pretty, stable-notype, stable-shorttype, stable CSS Resources output class naming format strategy. obf is the default.

Collapsing Properties

Decrease the amount of permutations that are built options.

Collapse all properties

This is on by default when using Super Dev Mode.

  • Collapsing all permutations into one.

      <collapse-all-properties />

Collapsing gxt.device

gxt.device properties causes the permutations to explode.

  • Decrease the amount of permutations for the new gxt.device property.

      <collapse-property name="gxt.device" values="*" />


Only use the CSS3 appearances in the application by setting the property using the gxt.css3.enabled property.

  • <set-property name="gxt.css3.enabled" value="true" />.


Why does GXT 4.0 create so many permutations?

GXT 4.0 has added gxt.device and some other properties which cause the compiled permutation to explode. This can be controlled by changing the projects module descriptor property configurations. To decrease the permuations the properties can be grouped together like the example below.

<!-- Collapse properties for fewer permutations -->
<collapse-property name="gxt.device" values="phone, tablet" />
<!-- group themes -->
<collapse-property name="gxt.theme" values="blue, gray" />

<!-- group modern browsers-->
<collapse-property name="gxt.user.agent" values="air, safari*, chrome*, gecko*, ie11" />
<collapse-property name="user.agent" values="safari*, gecko*" />

<!-- group ie -->
<collapse-property name="gxt.user.agent" values="ie8, ie9, ie10" />
<collapse-property name="user.agent" values="ie*" />

Why does GXT add additional properties, and not use user.agent?

It turns out that "user.agent" can’t be extended easily. The fallback system does nothing helpful for existing CssResource declarations. This means that if GXT added an "ie10" permutation (which it did in 3.0), or wants to have distinct permutations, like Chrome vs Safari permutations (e.g. a permutation to address chrome zoom issues), we might break existing code within your project.

Additionally, GXT adds an ‘os’ property to let us deal with platform issues. This can be 'mac', 'linux', or 'windows' (or 'unknown' after 3.0.3 to deal with Solaris, Chrome OS, etc). There aren't a ton of cases where this is needed, but one example include native OS X checkboxes, which blur as soon as you click them, as opposed to windows, linux, or firefox on mac.

Why don't I need to set user.agent if I set gxt.user.agent?

Since the set of GXT user agent properties is more extensive than GWT user agents, we set the GWT user agent based on the GXT user agent setting with these lines:

<!-- From /com/sencha/gxt/core/Core.gwt.xml about line 110 -->
<!-- Restrict the permutation explosion -->
<set-property name="user.agent" value="ie8">
  <when-property-is name="gxt.user.agent" value="ie8" />
<set-property name="user.agent" value="ie9">
    <when-property-is name="gxt.user.agent" value="ie9" />
    <when-property-is name="gxt.user.agent" value="ie10" />
<set-property name="user.agent" value="gecko1_8">
    <when-property-is name="gxt.user.agent" value="gecko1_8" />
    <when-property-is name="gxt.user.agent" value="gecko1_9" />
<set-property name="user.agent" value="safari">
    <when-property-is name="gxt.user.agent" value="safari3" />
    <when-property-is name="gxt.user.agent" value="safari4" />
    <when-property-is name="gxt.user.agent" value="safari5" />
    <when-property-is name="gxt.user.agent" value="air" />
    <when-property-is name="gxt.user.agent" value="chrome" />
<set-property name="user.agent" value="opera">
  <when-property-is name="gxt.user.agent" value="opera" />

How does GXT.gwt.xml limit the number of permutations, and how can I do it myself?

Thirteen browser properties times three operating systems should then give about 39 permutations unless something is done to restrict those properties. By default, GXT.gwt.xml limits these to the basic 6 permutations with these lines:

<collapse-property name="user.agent.os" values="*" />
<collapse-property name="gxt.user.agent" values="air, safari*, chrome" />
<collapse-property name="gxt.user.agent" values="ie9, ie10" />
<collapse-property name="gxt.user.agent" values="gecko*" />

By not inheriting GXT, you are given the chance to set up your own restriction of permutations. If you don't wish to set those up for yourself, go ahead and inherit GXT itself. More information using <collapse-property> and <collapse-all-properties /> can be found at

Deprecation notes

IE6 and IE7 permutations have been removed in GWT 2.6.0+ and are not included in GXT 3.1.

GXT 3.x