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



We are pleased to announce the release of GXT 4. This release includes a lot of great new features, examples, and themes, along with general improvements. Let's take a look at what's new in GXT 4!

GXT 4.1.0 updates

GXT 4.1.0 has upgraded GWT to 2.9.0 and Java to Java 11.

GXT 4.0.4 updates

GXT 4.0.4 includes defect fixes that will improve the progress with GXT 4.x. Users can now see improvements in the grid components, layout, selection, and more.

GXT 4.0.3 updates

GXT 4.0.3 includes a couple hundred defect fixes and minor improvements. Some of these fixes could seem like regressions because they fix a behavior that may have been worked around. Or a workaround might exist for the issue. Overall, our goal is to fix edge cases that show up and slow application development. We are proud to announce that we made a huge effort in this relase to smooth out the wrinkles.

GXT 4.0.3 notable updates

We've made some exciting updates that should improve development with GXT 4.x.

  • The margins have been fixed in the vertical layout container and css float layout containers.
  • You'll find margins work better with vertical and child horziontal layouts.
  • The flow layout sizing has been improved drastically. So you'll find less edge cases show up when laying out your widgets.
  • Improvements have gone into flow sizing when you use 100% x 100% flow sizing instead of pixel sizes for widgets that require a size.
  • The checkbox events have been improved, so they work with edge and won't fire two events.
  • The checkbox cell will work better in the cell widgets, like grid and tree.
  • The Combo will work with IE11.
  • You'll find more Javadoc on the GWT SDK versions.
  • You'll also find the GXT past version of Javadoc. Check out the Javadoc links on the left.
  • In GXT 4.0.3, all the private methods have been refactored into protected methods so it's easier to extend the classes.
  • The Canvas and SVG charts can be instantiated separately. So you don't have to use just one surface type in your app.

Quality Assurance

I'm exited to announce that we have an excellent QA partner that does our QA. And in this round of testing QA found all the common issues you might find. I was impressed that they were able to help test our product so we can make sure we provide something with out regressions. Not only did we fix regressions we fixed outstanding issues. And with this help, we spent a considerable amount of time painstakingly fixing and improving GXT. It was such awesome experience to have such a great partner to help with this GXT release.

GXT 4.0.3 Examples

We've added more examples.

  • The explorer examples have been extracted from our framework so you can fork and experiment with it. This is pretty exciting because this should make learning GXT much easier.
  • We've also added a new simple example of using large grids. Find the links on the GXT guides home page.
  • The desktop examples have been added back to the repertoire as well. Find the links on the GXT guides home page.
  • We've added more projects you can fork and try out GXT easily. Find the links on the GXT guides home page.

Tablet Support with Touch Gestures

GXT 4 provides support for devices with touch-screen input, including tablets and touch-screen laptops, by introducing the touch and gesture system. This allows existing GXT applications to run on touch-screen devices with little or no modification.

Triton Theme

We've added a new Triton theme in GXT 4 (inspired by Triton in Ext JS 6). It is a common theme available for both desktop and tablet applications. You can learn more about theming your project in the Themes guide.

New Example Application

We are excited to introduce our new Executive Dashboard example application. This application demonstrates how great an application can look and feel with some custom theming alongside the GXT componentry. The Executive Dashboard example showcases how the GXT framework is the perfect choice for your applications. You can find the eDash source code in the [eDash example WAR] ( under 'WEB-INF/classes'.

In addition, the GXT Explorer example set has been updated to GXT 4 using the new Triton theme.

In GXT 4.0.3, you can use Ext JS components with GXT. To learn more, view the following examples:

Basic Form:


Simple Bar Chart:


Many SafeHtml enhancements have been made across our APIs. Most methods that accept HTML now take SafeHtml instead of String. Those that do still take String (such as SomeClass.setHTML(String), for UiBinder compatibility) will automatically sanitize the input via our ExpandedHtmlSanitizer. If you want your markup used verbatim you must use the SafeHtml methods.

Find out more about SafeHtml in the Safe HTML guide.

API Changes & Bug Fixes

Any API changes and bug fixes are listed in the release notes for 4.0.

GXT 4.x