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 4.x


ExtJs JsInterop Examples

JsInterop makes it possible to use the ExtJs api in a GXT application. The strategy used below was to hug the ExtJs closely and use generic Java Objects to define types. Using generic Java types allows for quick iteration in the beginning of the wrapper formation. While generic types were used in the example, JsTypes can be created to represent the generic Object.


  • GWT 2.8.0-beta1+

Required for JsTypes

  • Object literals are required for creating the class configs for Ext.create and Ext.define.

      // Use this to create a Object literals for configs
      // Object Literal: { propertyA : 0, propertyB : 1.0, propertyC : "d" };
      @JsType(isNative = true, namespace = JsPackage.GLOBAL, name = "Object")
      public class MyLiteral {
          public Object propertyA;
          public float propertyB;
          public String propertyC


Importing Extjs

ExtJs normally configures loader to load in the pieces that are needed to run the app. So to get it to work with out the micro-loader, the entire monolithic Javascript file has to be imported and attached to the DOM.

  • The import will look like this

      <!doctype html>
        <meta http-equiv="content-type" content="text/html; charset=UTF-8">
        <link type="text/css" rel="stylesheet" href="MyGxtProjectExtJs.css">
        <title>Project Ext Js</title>
              <!-- GWT Module -->
              <script type="text/javascript" src="JsInteropExamples/JsInteropExamples.nocache.js"></script>
              <!-- ExtJs - Compiled Theme CSS -->
              <link rel="stylesheet" type="text/css" href="theme-triton/resources/theme-triton-all.css">
              <link rel="stylesheet" type="text/css" href="triton/resources/charts-all-debug.css">
              <!-- ExtJs All - Start by using debug, and graduate to the minified -->
              <script type="text/javascript" src="ext-all-debug.js"></script> 
              <script type="text/javascript" src="charts-debug.js"></script>
              <!-- ExtJs Theme-->
              <script type="text/javascript" src="theme-triton/theme-triton.js"></script>
              <!-- ExtJs Rendering -->
              <meta http-equiv="X-UA-Compatible" content="IE=edge">
              <meta name="viewport" content="width=device-width, initial-scale=1, maximum-scale=1, user-scalable=no">

Calling Ext.create and Ext.define

After the Javascript API has been loaded Ext can be called by creating a JsType wrapper.

  • JsType for calling Ext functions

      import jsinterop.annotations.JsMethod;
      import jsinterop.annotations.JsPackage;
      import jsinterop.annotations.JsProperty;
      import jsinterop.annotations.JsType;
      @JsType(isNative = true, name = "Ext", namespace = JsPackage.GLOBAL)
      public abstract class Ext {
        @JsProperty(name = "isChrome")
        public static native boolean isChrome();
        public static native void define(String className, java.lang.Object data);
        public static native java.lang.Object create(java.lang.Object config);
        public static native java.lang.Object create(String className, java.lang.Object config);

Defining a Model

ExtJs classes have to be defined on a granular level. Which means the properties and accessors have to be defined. Once the model is defined, a JsType can wrap the model definition. Start by defining the fields for the Model in the config.

  • Model Fields JsType

      @JsType(isNative = true, namespace = JsPackage.GLOBAL, name = "Object")
      public static class Field {
        String name;
        String type;
  • Model Config JsType

      public static class DefineNameValueModelConfig {
        Object extend;
        Object fields;
  • Defining a ExtJs Model behavior - this will create the name space for the model, com.example.NameValueModel

      Field field0 = new Field(); = "name";
      field0.type = "string";
      Field field1 = new Field(); = "value";
      field1.type = "float";
      Field[] fields = new Field[2];
      fields[0] = field0;
      fields[1] = field1;
      DefineNameValueModelConfig config = new DefineNameValueModelConfig();
      config.extend = "";
      config.fields = fields;
      Ext.define("com.example.NameValueModel", config);
  • Finally define the Model using Ext.define

      public static class NameValueModel {
        public String name;
        public Double value;

Creating models

Once the JsType has been created for the model, models can be created like this.

    NameValueModel nvm0 = new NameValueModel(); = "A";
    nvm0.value = 1.0;
    NameValueModel nvm1 = new NameValueModel(); = "B";
    nvm1.value = 2.0;
    NameValueModel nvm2 = new NameValueModel(); = "C";
    nvm2.value = 3.0;
    NameValueModel nvm3 = new NameValueModel(); = "D";
    nvm3.value = 4.0;
    NameValueModel nvm4 = new NameValueModel(); = "E";
    nvm4.value = 5.0;

    NameValueModel[] datas = new NameValueModel[4];
    datas[0] = nvm0;
    datas[1] = nvm1;
    datas[2] = nvm2;
    datas[3] = nvm3;
    datas[4] = nvm4;

Stores and Models

Once a Model has been created it can be used in a Store.

  • First create a Store Config which will be used to createa Store.

      @JsType(isNative = true, namespace = JsPackage.GLOBAL, name = "Object")
      public static class StoreConfig {
        Object model;
        Object fields;
        Object[] data;
        Object autoLoad;
        Object proxy;
  • Then create the Store

      // This example I use Object for the return
      // Simply create JsType for Store and add in the accessors needed for a concrete Java type. 
      Object store = Ext.create("", storeConfig);

GXT 4.x