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
protected

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.

Parameters

item :  Object

The config object being added.

Returns
Ext.Component

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 and inheritance. 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.

Sencha GXT 3.x

Guides
API
modern
classic
Benefits
top

Loading Grid Data wth RequestFactory

Loading data to the grid via RPC, RequestFactory or other data transport.

Reference

Demos

RequestFactory page loading

Initializing the DataProxy for RequestFactory communication.

  • Demo
  • com.sencha.gxt.data.shared.loader.RequestFactoryProxy Javadoc
  • The only difference from RPC vs RequestFactory loading is how the DataProxy is initialized.
  • Example of loading data with RequestFactory:

      private void createSimpleRequestFactoryPageLoadingGrid() {
        // Bean property access to RequestFactory proxy definitions
        PostProxyProperties properties = GWT.create(PostProxyProperties.class);
    
        // RequestFactory Service
        final ExampleRequestFactory requestFactory = GWT.create(ExampleRequestFactory.class);
        requestFactory.initialize(new SimpleEventBus());
    
        // RequestFactory DataProxy
        DataProxy<PagingLoadConfig, PagingLoadResult<PostProxy>> dataProxy = 
            new RequestFactoryProxy<PagingLoadConfig, PagingLoadResult<PostProxy>>() {
          @Override
          public void load(PagingLoadConfig loadConfig, Receiver<? super PagingLoadResult<PostProxy>> receiver) {
            // RequestFactory data request
            PostRequest request = requestFactory.post();
            List<SortInfo> sortInfo = createRequestSortInfo(request, loadConfig.getSortInfo());
            request.getPosts(loadConfig.getOffset(), loadConfig.getLimit(), sortInfo, null).to(receiver);
            request.fire();
          }
        };
    
        // List Store
        ListStore<PostProxy> listStore = new ListStore<PostProxy>(properties.id());
    
        // Paging Loader
        final PagingLoader<PagingLoadConfig, PagingLoadResult<PostProxy>> pagingLoader = 
            new PagingLoader<PagingLoadConfig, PagingLoadResult<PostProxy>>(dataProxy);
        pagingLoader.setRemoteSort(true);
        pagingLoader.addLoadHandler(new LoadResultListStoreBinding<PagingLoadConfig, PostProxy, 
            PagingLoadResult<PostProxy>>(listStore));
    
        // Paging Tool Bar
        PagingToolBar toolBar = new PagingToolBar(50);
        toolBar.bind(pagingLoader);
    
        // Columns
        ColumnConfig<PostProxy, String> forumColumn = new ColumnConfig<PostProxy, 
            String>(properties.forum(), 150, "Forum");
        ColumnConfig<PostProxy, String> subjectColumn = new ColumnConfig<PostProxy, 
            String>(properties.subject(), 150, "Subject");
        List<ColumnConfig<PostProxy, ?>> columns = new ArrayList<ColumnConfig<PostProxy, ?>>();
        columns.add(forumColumn);
        columns.add(subjectColumn);
        ColumnModel<PostProxy> columnModel = new ColumnModel<PostProxy>(columns);
    
        // Grid
        Grid<PostProxy> grid = new Grid<PostProxy>(listStore, columnModel) {
          @Override
          protected void onAfterFirstAttach() {
            super.onAfterFirstAttach();
            Scheduler.get().scheduleDeferred(new ScheduledCommand() {
              @Override
              public void execute() {
                // Only start the load after this grid attaches to DOM.
                pagingLoader.load();
              }
            });
          }
        };
        grid.getView().setForceFit(true);
        grid.setLoadMask(true);
        grid.setLoader(pagingLoader);
        grid.setColumnReordering(true);
    
        // Grid Containers
        FramedPanel panel = new FramedPanel();
        panel.setCollapsible(true);
        panel.setHeadingText("Loading Data with RequestFactory");
        panel.setPixelSize(400, 200);
        panel.addStyleName("margin-10");
    
        VerticalLayoutContainer container = new VerticalLayoutContainer();
        container.setBorders(true);
        container.add(grid, new VerticalLayoutData(1, 1));
        container.add(toolBar, new VerticalLayoutData(1, -1));
        panel.add(container);
    
        widget.add(panel);
      }
    

RequestFactory page loading with remote filtering

Swap out the PagingLoadConfig with FilterPagingLoadConfig and add the bean filtering configuration.

  • Demo
  • com.sencha.gxt.data.shared.loader.RequestFactoryProxy Javadoc<
  • The RequestFactoryProxy has some helper methods to pass along the SortInfo and FilterConfig to the server.
  • Example using the above snippet, notice the FilterPagingLoadConfig:

      // RequestFactory DataProxy
      DataProxy<FilterPagingLoadConfig, PagingLoadResult<PostProxy>> dataProxy = 
          new RequestFactoryProxy<FilterPagingLoadConfig, PagingLoadResult<PostProxy>>() {
        @Override
        public void load(FilterPagingLoadConfig loadConfig, Receiver<? super PagingLoadResult<PostProxy>> receiver) {
          PostRequest request = requestFactory.post();
    
          // createRequestSrequestInfo(...) is a helper method to translate SortInfo for RequestFactory
          List<SortInfo> sortInfo = createRequestSortInfo(request, loadConfig.getSortInfo());
    
          // createRequestFilter(...) is a helper method to translate FilterConfig for RequestFactory
          List<FilterConfig> filterConfig = createRequestFilterConfig(request, loadConfig.getFilters());
    
          // requestFactory request
          request.getPosts(loadConfig.getOffset(), loadConfig.getLimit(), sortInfo, filterConfig).to(receiver);
          request.fire();
        }
      };
    
      // List Store
      ListStore<PostProxy> listStore = new ListStore<PostProxy>(properties.id());
    
      // Paging Loader
      final PagingLoader<FilterPagingLoadConfig, PagingLoadResult<PostProxy>> pagingLoader = 
          new PagingLoader<FilterPagingLoadConfig, PagingLoadResult<PostProxy>>(dataProxy) {
        @Override
        protected FilterPagingLoadConfig newLoadConfig() {
          // Bean filtering configuration for sending the filtering config to server
          return new FilterPagingLoadConfigBean();
        }
      };
      pagingLoader.setRemoteSort(true);
      pagingLoader.addLoadHandler(new LoadResultListStoreBinding<FilterPagingLoadConfig, PostProxy, 
          PagingLoadResult<PostProxy>>(listStore));
    
  • Configure the Grid filter UI options. More about setting up Grid Filtering.

      // Grid Ui Filters
      StringFilter<PostProxy> forumFilter = new StringFilter<PostProxy>(properties.forum());
      StringFilter<PostProxy> subjectFilter = new StringFilter<PostProxy>(properties.subject());
    
      GridFilters<PostProxy> filters = new GridFilters<PostProxy>();
      filters.initPlugin(grid);
      filters.setLocal(false);
      filters.addFilter(forumFilter);
      filters.addFilter(subjectFilter);
    
  • On the server side the loadConfig list carries the filters sent with the request:

      public PostPagingLoadResultBean getPosts(int offset, int limit, List<SortInfoBean> sortInfo, 
          List<FilterConfigBean> filterConfig) {
          if (filterConfig != null && filterConfig.size() != 0) {
                  for (FilterConfigBean filter : filterConfig) {
                      String type = filter.getType();
                      String test = filter.getValue();
                      String path = filter.getField();
                      String comparison = filter.getComparison();
                      // Do some server filter magic. 
                  }
          }
          //...
      }
    

RequestFactory page loading with remote sorting

Sending the SortInfo to the server.

  • The PagingLoadConfig contains the SortInfo and can be sent back to the server.
  • Set the remote sort to true for sending the SortInfo in the PagingLoadConfig:

      pagingLoader.setRemoteSort(true);
    

Sencha GXT 3.x

Ext JS
Sencha Test
Cmd
Sencha Themer
GXT
IDE Plugins
Sencha Inspector
Architect
Sencha Fiddle
Touch
Offline Documentation

Sencha Test

2.0.1 2.0.0 1.0.3

Cmd

Cmd

Sencha Themer

1.1.0 1.0.2

GXT

4.x 3.x

IDE Plugins

IDE Plugins

Sencha Inspector

Sencha Inspector

Sencha Fiddle

Sencha Fiddle

Offline Documentation

Offline Documentation