使用 RequestFactory 加载 Grid 数据

通过 RPC、RequestFactory 或其他数据传输方式将数据加载到网格。

参考

• com.sencha.gxt.data.shared.loader.DataProxy Javadoc
• com.sencha.gxt.data.shared.loader.FilterConfigBean Javadoc
• com.sencha.gxt.data.shared.loader.FilterPagingLoadConfig Javadoc
• com.sencha.gxt.data.shared.loader.PagingLoader Javadoc
• com.sencha.gxt.data.shared.SortInfo Javadoc
• com.sencha.gxt.data.shared.SortInfoBean Javadoc

演示

• RequestFactory 加载器演示

RequestFactory 页面加载

初始化用于 RequestFactory 通信的 DataProxy。

• 演示
• com.sencha.gxt.data.shared.loader.RequestFactoryProxy Javadoc
• RPC 与 RequestFactory 加载的唯一区别在于 DataProxy 的初始化方式。

• 使用 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 页面加载

将 PagingLoadConfig 替换为 FilterPagingLoadConfig 并添加 bean 过滤配置。

• 演示
• com.sencha.gxt.data.shared.loader.RequestFactoryProxy Javadoc<
• RequestFactoryProxy 具有一些辅助方法，可以将 SortInfo 和 FilterConfig 传递到服务器。

• 使用上述代码片段的示例，请注意 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));
  

• 配置 Grid 过滤器 UI 选项。有关设置 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);
  

• 在服务器端，loadConfig 列表携带随请求发送的过滤器

    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 页面加载

将 SortInfo 发送到服务器。

• PagingLoadConfig 包含 SortInfo，可以发送回服务器。

• 将远程排序设置为 true，以便在 PagingLoadConfig 中发送 SortInfo

    pagingLoader.setRemoteSort(true);