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, 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


top

ListStore

A client side list of records.

  • Records are visible by default.
  • All operations are typically performed on the visible list of records.
  • Filtering will hide visible records.
  • The <M> generic in ListStore<M> represents the bean model.

Reference

List Editors

For using the ListStore with editors see more on ListStoreEditor.

Instantiation

Initialize the ListStore<M> with the ModelKeyProvider<M> which provides the unique record identification.

  • ModelKeyProvider<M> is required constructor argument for ListStore<M>.

  • Simple Example:

      ListStore<MyData> listStore = ListStore(modelKeyProvider);
    

Examples

The ListStore can be initialized with a PropertyAccess provider or with a anonymous ModelKeyProvider.

Instantiation with property access definitions

Instantiating the ListStore requires a ModelKeyProvider which can be provided through a property access definition. See more on PropertyAccess<M> definition configurations.

  • Property access definition Example:

      // Define the keyProvider as a property.
      public interface StockProperties extends PropertyAccess<Stock> {
        @Path("id")
        ModelKeyProvider<Stock> key();
      }
    
      // Instantiate the grid properties.
      private static final StockProperties gridProperties = GWT.create(StockProperties.class);
    
      // Instantiate the ListStore.
      ListStore<Stock> listStore = new ListStore<Stock>(gridProperties.key());
    

Instantiation with anonymous ModelKeyProvider

Instantiating the ListStore with an anonymous ModelKeyProvider.

  • Anonymous ModelKeyProvider Example:

      ListStore<Stock> listStore = new ListStore<Stock>(new ModelKeyProvider<Stock>() {
        @Override
        public String getKey(Stock item) {
          return String.valueOf(item.getId());
        }
      });
    

Data Manipulation

Listed below are some of the operations that can manipulate the ListStores collection.

Adding

Adding to the ListStores collection.

  • Some of the available methods:

      // add an item
      listStore.add(item);
    
      // add item at the visible index
      boolean success = listStore.add(index, item);
    
      // add a collection
      boolean success = listStore.addAll(items);
    
      // add a collection starting at visible index
      boolean success = listStore.addAll(index, items);
    
      // replace all the items
      listStore.replaceAll(items);
    

Filtering

Filtering the ListStore will hide visible items.

  • Records are visible by default.
  • Filtering will hide visible records.
  • See more on store filtering.

  • Some of the available methods:

      // get the attached filters 
      LinkedHashSet<StoreFilter<Stock>> filters = listStore.getFilters();
    
      // are the filters enabled
      boolean enabled = listStore.isEnableFilters();
    
      // remove a filter
      listStore.removeFilter(StoreFilter<M> filter);
    
      // remove all the filters
      listStore.removeFilters();
    
      // enable or disable attached filters
      listStore.setEnableFilters(boolean enableFilters);
    
      // get all the attached filters
      LinkedHashSet<StoreFilter<Stock>> filters = listStore.getFilters();
    

Getting

Getting data from the ListStore.

  • Some of the available methods:

      // get the item at the visible index
      M item = listStore.get(index);
    
      // find the item based on its unique identifier. 
      M item = listStore.findModelWithKey(java.lang.String key);
    
      // gets all the items
      List<M> items = listStore.getAll();
    
      // find the visible index of an item
      int index = listStore.indexOf(item);
    
      // find a sublist of the visible items
      List<M> subItemsList = listStore.subList(int start, int end);
    
      // find the model in the list
      M model = listStore.findModel(M model);
    
      // do the models key match
      Boolean matching = listStore.hasMatchingKey(M model1, M model2);
    
      // find the keyProvider
      ModelKeyProvider<M> provider = listStore.getKeyProvider();
    
      // get the list store size of visible items
      listStore.size();        
    

Removing

Removing and clearing data in the ListStore.

  • Some of the available methods:

      // removes all the records.
      listStore.clear();
    
      // remove record from visible index
      M model = listStore.remove(index);
    
      // remove item matching model unique identifier
      boolean success = listStore.remove(item);
    

Sorting

Sorting records in the ListStore.

  • See more on store sorting.

  • Some of the available methods:

      // add a sort
      listStore.addSortInfo(StoreSortInfo<M> info);
    
      // add a sort at index
      listStore.addSortInfo(int index, StoreSortInfo<M> info);
    
      // clear the sort
      listStore.clearSortInfo();
    
      // re-apply a sort
      listStore.applySort(boolean suppressEvent);
    
      // get the sort configuration        
      List<StoreSortInfo<Stock>> sortInfo = listStore.getSortInfo();
    

Records

Working with records in the ListStore.

  • Record operations can be used when store.autocommit is false.
  • Working with records can fire StoreRecordChangeEvents and StoreUpdateEvent events.

  • Some of the available methods:

      // does the record exist
      boolean hasRecord = listStore.hasRecord(M data);
    
      // Gets records with uncommitted changes
      Collection<Store<M>.Record> modifiedItems = listStore.getModifiedRecords();
    
      // Get the model record and if it doesn't exist it will create a record by default. 
      // Don't create a record by wrapping this with: if (listStore.hasRecord(M data)) { // get record } 
      ListStore<M>.Record record = listStore.getRecord(item);
    
      // commit changes to the model
      listStore.commitChanges();
    
      // is autocommit on
      boolean autoCommit = listStore.isAutoCommit();
    
      // Cancel changes
      listStore.rejectChanges();
    
      // autocommit will update the model immediately. Otherwise que changes
      listStore.setAutoCommit(boolean isAutoCommit);
    

Updating

Updating data in the ListStore.

  • Some of the available methods:

      // replaces record matching model unique identifier
      listStore.update(item);
    

Events

The StoreHandlers adds most of the handlers at one time. Although it is possible to add these same handlers separately.

  • Some of the available methods:

      // fire an event from the listStore.
      listStore.fireEvent(event);
    

StoreHandlers

This is a group of the StoreHandlers. The individual handlers are listed below this.

  • Example of the StoreHandlers:

      StoreHandlers<Stock> handlers = new StoreHandlers<Stock>() {
        @Override
        public void onAdd(StoreAddEvent<Stock> event) {
        }
    
        @Override
        public void onRemove(StoreRemoveEvent<Stock> event) {
        }
    
        @Override
        public void onFilter(StoreFilterEvent<Stock> event) {
        }
    
        @Override
        public void onClear(StoreClearEvent<Stock> event) {
        }
    
        @Override
        public void onUpdate(StoreUpdateEvent<Stock> event) {
        }
    
        @Override
        public void onDataChange(StoreDataChangeEvent<Stock> event) {
        }
    
        @Override
        public void onRecordChange(StoreRecordChangeEvent<Stock> event) {
        }
    
        @Override
        public void onSort(StoreSortEvent<Stock> event) {
        }
      };
      listStore.addStoreHandlers(handlers);
    

StoreAddEvent

  • Fires on add.

      listStore.addStoreAddHandler(new StoreAddHandler<Stock>() {
        @Override
        public void onAdd(StoreAddEvent<Stock> event) {
        }
      });
    

StoreRemoveEvent

  • Fires on record removal.

      listStore.addStoreRemoveHandler(new StoreRemoveHandler<Stock>() {
        @Override
        public void onRemove(StoreRemoveEvent<Stock> event) {
        }
      });
    

StoreUpdateEvent

  • Fires on record update.

      listStore.addStoreUpdateHandler(new StoreUpdateHandler<Stock>() {
          @Override
          public void onUpdate(StoreUpdateEvent<Stock> event) {
          }
      });
    

StoreRecordChangeEvent

  • Fires on record change.

      listStore.addStoreRecordChangeHandler(new StoreRecordChangeHandler<Stock>() {
          @Override
          public void onRecordChange(StoreRecordChangeEvent<Stock> event) {
          }
      });
    
  • Example reverting a record after change.

      final DoubleField priceField = new DoubleField();
      priceField.addValidator(new MaxNumberValidator<Double>(99.99));
    
      // record whether the entry of the record was valid
      priceField.addInvalidHandler(new InvalidHandler() {
        @Override
        public void onInvalid(InvalidEvent event) {
          invalidPriceRecord = true;
        }
      });
      // record whether the entry of the record was valid
      priceField.addValidHandler(new ValidHandler() {
        @Override
        public void onValid(ValidEvent event) {
          invalidPriceRecord = false;
        }
      });
    
      // Listen for record changes and revert the incorrect entries.
      store.addStoreRecordChangeHandler(new StoreRecordChangeHandler<Plant>() {
        @Override
        public void onRecordChange(StoreRecordChangeEvent<Plant> event) {
          Store<Plant>.Record record = event.getRecord();
          // revert value if invalid
          if (invalidPriceRecord) {
            record.revert();
          }
        }
      });
    

StoreFilterEvent

  • Fires on filter selection.

      listStore.addStoreFilterHandler(new StoreFilterHandler<Stock>() {
          @Override
          public void onFilter(StoreFilterEvent<Stock> event) {
          }
      });
    

StoreClearEvent

  • Fires on clearing the records.

      listStore.addStoreClearHandler(new StoreClearHandler<Stock>() {
          @Override
          public void onClear(StoreClearEvent<Stock> event) {
          }
      });
    

StoreDataChangeEvent

  • Fires on record change.

      listStore.addStoreDataChangeHandler(new StoreDataChangeHandler<Stock>() {
          @Override
          public void onDataChange(StoreDataChangeEvent<Stock> event) {
          }
      });
    

StoreSortEvent

  • Fires on sort selection.

      listStore.addStoreSortHandler(new StoreSortHandler<Stock>() {
          @Override
          public void onSort(StoreSortEvent<Stock> event) {    
          }
      });
    

GXT 3.x