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


Grid Filtering

Grid filtering drills records listed by hiding them.


com.sencha.gxt.widget.core.client.grid.filters.Filter Javadoc

Value providers reference

PropertyAccess provides the bean model property access value provider definitions for the filters. Value providers define which properties are getting filtered in the bean.


  • Initializing the bean model value provider property definitions and then initialize the Filter. In this example the String filter has been instantiated using a property access value provider definition.

      // Provide the bean PropertyAccess definition
      private static final StockProperties gridProperties = GWT.create(StockProperties.class);
      StringFilter<Stock> stringFilter = new StringFilter<Stock>(;


  • Adding filters to a Grid example:

      // setup the filters with value provider definitions 
      NumericFilter<Stock, Double> lastFilter = new NumericFilter<Stock, Double>(gridProperties.last(), new DoublePropertyEditor());
      StringFilter<Stock> nameFilter = new StringFilter<Stock>(;
      DateFilter<Stock> dateFilter = new DateFilter<Stock>(gridProperties.lastTrans());
      BooleanFilter<Stock> booleanFilter = new BooleanFilter<Stock>(gridProperties.split());
      ListFilter<Stock, String> listFilter = new ListFilter<Stock, String>(gridProperties.industry(), typeStore);
      // batch the filters together and initialize the grid with them 
      GridFilters<Stock> filters = new GridFilters<Stock>();
      // initialize the filters with the grid
      // add the filters to grid

Filter options

The Filter defines which data members in the store's collection can be filtered and how. Below are listed the possible filter types which can configured for the bean model member variables. Providing the filter will setup the controls in the grid or tree.




Numeric property editors

Numeric property editor defines the the number type format for the filter.

  • Double:

      NumericFilter<M, Double> filter = 
          new NumericFilter<M, Double>(dblValueProvider, new DoublePropertyEditor());
  • BigDecimal:

      NumericFilter<M, BigDecimal> filter = 
          new NumericFilter<M, BigDecimal>(bdValueProvider, new BigDecimalPropertyEditor());
  • BigInteger (GXT 3.0.4+):

      NumericFilter<M, BigInteger> filter = 
          new NumericFilter<M, BigInteger>(bintValueProvider, new BigIntegerPropertyEditor());
  • Float:

      NumericFilter<M, Float> filter = 
          new NumericFilter<M, Float>(flValueProvider, new FloatPropertyEditor());
  • Integer (GXT 3.0.4+):

      NumericFilter<M, Integer> filter = 
          new NumericFilter<M, Integer>(intValueProvider, new IntegerPropertyEditor());
  • Long:

      NumericFilter<M, Long> filter = 
          new NumericFilter<M, Long>(lngValueProvider, new LongPropertyEditor());



Change the filter behavior with these operations.


  • Getting filter configuration properties:

      // Returns a list of filter configurations.
      List<FilterConfig> config = stringFilter.getFilterConfig();
      Menu menu = stringFilter.getMenu();
      StringFilterMessages messages = stringFilter.getMessages();
      // Number of milliseconds to wait after user interaction to fire an update (defaults to 500).
      int buffer = stringFilter.getUpdateBuffer();
      //Template method to be implemented by all subclasses that is to get and return the value of the filter.
      Object value = stringFilter.getValue();
      ValueProvider<? super Stock, String> valueProvider = stringFilter.getValueProvider();
      // Returns true if the fitler has enough information to be activatable.
      boolean activatable = stringFilter.isActivatable();
      // Returns true if the filter is active.


  • Setting the fitler configuration properties:

      stringFilter.setActive(active, suppressEvent);
      // sets local sensitive messages
      // Number of milliseconds to wait after user interaction to fire an update (defaults to 500).



  • Fires on filter activation.

      StringFilter<M> stringFilter = new StringFilter<M>(;
      stringFilter.addActivateHandler(new ActivateHandler<Filter<M,?>>() {
        public void onActivate(ActivateEvent<Filter<M, ?>> event) {


  • Fires on filter deactivation.

      StringFilter<M> stringFilter = new StringFilter<M>(;
      stringFilter.addDeactivateHandler(new DeactivateHandler<Filter<M,?>>() {
        public void onDeactivate(DeactivateEvent<Filter<M, ?>> event) {


  • Fires on update.

      StringFilter<M> stringFilter = new StringFilter<M>(;
      stringFilter.addUpdateHandler(new UpdateHandler() {
        public void onUpdate(UpdateEvent event) {

Changing Behavior

Remove Filter

To remove the filter from the grid resetting the context menu checkbox filter.setActive can be used.

  • Example of disabling the filter using setActive.

      nameFilter.setActive(false, false);

GXT 3.x