ListStore

客户端记录列表。

• 记录默认可见。
• 所有操作通常在可见的记录列表上执行。
• 过滤将隐藏可见记录。
• <M> 泛型在 ListStore<M> 中表示 bean 模型。

参考

• ListStore Javadocs

列表编辑器

有关将 ListStore 与编辑器一起使用的更多信息，请参阅 ListStoreEditor。

实例化

使用 ModelKeyProvider<M> 初始化 ListStore<M>，它提供唯一的记录标识。

• ModelKeyProvider<M> 是 ListStore<M> 的必需构造函数参数。

• 简单示例

    ListStore<MyData> listStore = ListStore(modelKeyProvider);
  

示例

ListStore可以使用 PropertyAccess 提供程序或匿名 ModelKeyProvider 初始化。

使用属性访问定义实例化

实例化 ListStore 需要 ModelKeyProvider，可以通过属性访问定义提供。有关更多信息，请参阅 PropertyAccess 定义配置。

• 属性访问定义示例

    // 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());
  

使用匿名 ModelKeyProvider 实例化

使用匿名 ModelKeyProvider 实例化 ListStore。

• 匿名 ModelKeyProvider 示例

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

数据操作

下面列出了一些可以操作 ListStore 集合的操作。

添加

添加到 ListStores 集合。

• 一些可用的方法

    // 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);
  

过滤

过滤 ListStore 将隐藏可见项目。

• 记录默认可见。
• 过滤将隐藏可见记录。

• 有关更多信息，请参阅 store filtering。

• 一些可用的方法

    // 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();
  

获取

从 ListStore 获取数据。

• 一些可用的方法

    // 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();        
  

移除

移除和清除 ListStore 中的数据。

• 一些可用的方法

    // 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);
  

排序

对 ListStore 中的记录进行排序。

• 有关更多信息，请参阅 store sorting。

• 一些可用的方法

    // 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();
  

记录

在 ListStore 中使用记录。

• 当 store.autocommit 为 false 时，可以使用记录操作。

• 使用记录可以触发 StoreRecordChangeEvents 和 StoreUpdateEvent 事件。

• 一些可用的方法

    // 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);
  

更新

更新 ListStore 中的数据。

• 一些可用的方法

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

事件

StoreHandlers 一次添加大多数处理程序。尽管可以单独添加这些相同的处理程序。

• 一些可用的方法

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

StoreHandlers

这是 StoreHandlers 的一组。单个处理程序列在下面。

• 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

• 在添加时触发。

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

StoreRemoveEvent

• 在记录移除时触发。

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

StoreUpdateEvent

• 在记录更新时触发。

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

StoreRecordChangeEvent

• 在记录更改时触发。

    listStore.addStoreRecordChangeHandler(new StoreRecordChangeHandler<Stock>() {
        @Override
        public void onRecordChange(StoreRecordChangeEvent<Stock> event) {
        }
    });
  

• 在更改后还原记录的示例。

    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

• 在过滤器选择时触发。

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

StoreClearEvent

• 在清除记录时触发。

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

StoreDataChangeEvent

• 在记录更改时触发。

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

StoreSortEvent

• 在排序选择时触发。

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