文档帮助

术语、图标和标签

许多类在使用配置对象创建(实例化)类时都有快捷名称。快捷名称被称为 alias(如果类扩展了 Ext.Component,则称为 xtype)。别名/xtype 列在适用类的类名旁边,以便快速参考。

访问级别

框架类或其成员可以指定为 privateprotected。否则,类/成员为 publicPublicprotectedprivate 是访问描述符,用于传达应该如何以及何时使用类或类成员。

成员类型

成员语法

下面是一个示例类成员,我们可以对其进行剖析,以显示类成员的语法(在本例中,从 Ext.button.Button 类查看的 lookupComponent 方法)。

让我们看一下成员行的每个部分

  • 展开/折叠 - 在成员行的左侧是一个控件,用于展开和折叠每个成员行以显示/隐藏成员详细信息。
  • 成员名称 - 类成员的名称(本例中为 lookupComponent
  • 方法参数 - 方法使用的任何必需或可选参数(或传递给事件处理程序方法的参数)将列在方法名称旁边的括号内(本例中为 ( item )
  • 返回类型 - 方法或属性返回的类实例或 javascript 对象(本例中为 Ext.Component)。对于不返回除 undefined 之外任何内容的方法,可以省略此项,或者可以显示为以斜杠 / 分隔的多个可能值,表示返回的内容可能取决于方法调用的结果(即,如果 get 方法调用成功,方法可能会返回一个 Component,如果失败,则返回 false,这将显示为 Ext.Component/Boolean)。
  • 标志 - 适用于成员的任何标志都将显示在旁边(本例中为 PROTECTED - 请参阅下面的标志部分)
  • 成员来源 - 在成员行的右侧是最初描述成员的类(本例中为 Ext.container.Container)。如果成员源自当前类,则源类将显示为蓝色链接,如果它从祖先类或混合类继承,则显示为灰色。
  • 成员源代码 - 在成员来源类右侧下方是查看成员源代码的链接(示例中为 view source
  • 参数列表 - 类方法的每个参数都将使用上面括号中找到的相同名称、期望的类或对象类型以及参数的描述列出(示例中为 item : Object)。
  • 返回值 - 如果类返回除 undefined 之外的值,则“返回值”部分将注释返回的类或对象类型以及描述(示例中为 Ext.Component
  • 自从示例中未显示) - 某些成员将显示该成员首次引入的产品版本(即 Available since 3.4.0 - 示例中未显示),就在成员描述之后
  • 默认值示例中未显示) - Configs 通常显示要应用于类实例的默认配置值(如果未被覆盖)(即 Defaults to: false

成员标志

API 文档使用许多标志来进一步传达类成员的功能和意图。标签可以用文本标签、缩写或图标表示。

  • Required - 实例化类时必需的 config
  • Bindable - config 具有 setter,允许通过 ViewModel 绑定设置此 config
  • Read Only - 属性可以读取,但不能用于在运行时配置/重新配置类实例
  • Singleton - Singleton 类在定义后立即实例化,不能手动实例化
  • Static - 静态方法或属性是属于类本身的方法或属性,而不是类的实例
  • Chainable - 指的是在调用时返回类实例的方法。
    这使得可以进行链式方法调用,例如:classInstance.method1().method2().etc();
  • Deprecated - 计划在未来框架版本中删除的类或成员,并在当前版本中提供以实现向后兼容性。
    已弃用的类和成员将包含一条消息,指导您了解未来首选的类/方法。
  • Removed - 已删除的类或成员,仅在文档中作为升级框架版本的用户的参考
  • Template - 在基类中定义的方法,旨在由子类覆盖
  • Abstract - 类或成员可以定义为抽象类。抽象类和成员建立类结构并提供有限的(如果有)代码。特定于类的代码将通过子类中的覆盖来提供。
  • Preventable - 如果从事件处理程序返回 false,则标记为可阻止的事件将不会触发

类图标

- 表示框架类

- 单例框架类。*有关更多信息,请参阅单例标志

- 组件类型的框架类(Ext JS 框架中扩展 Ext.Component 的任何类)

- 表示类、成员或指南在当前查看的版本中是新的

成员图标

- 表示类型为 config 的类成员

- 表示类型为 property 的类成员

- 表示类型为 method 的类成员

- 表示类型为 event 的类成员

- 表示类型为 theme variable 的类成员

- 表示类型为 theme mixin 的类成员

- 表示类、成员或指南在当前查看的版本中是新的

类成员快速导航菜单

在 API 文档页面上的类名正下方是一行按钮,对应于当前类拥有的成员类型。每个按钮显示按类型划分的成员计数(此计数会在应用过滤器时更新)。单击按钮会将您导航到该成员部分。将鼠标悬停在成员类型按钮上将显示该类型的所有成员的弹出菜单,以便快速导航。

Getter 和 Setter 方法

与类 config 选项相关的 Getter 和 Setter 方法将显示在方法部分以及 API 文档和成员类型菜单的 configs 部分中,就在它们工作的 config 下方。Getter 和 Setter 方法文档将在 config 行中找到,以便于参考。

历史记录栏

您的页面历史记录保存在本地存储中,并显示在顶部标题栏正下方(使用可用的实际空间)。默认情况下,仅显示的搜索结果是与您当前查看的产品/版本匹配的页面。您可以通过单击历史记录栏右侧的 按钮并选择“全部”单选按钮来展开显示的内容。这将显示历史记录栏中所有产品/版本的所有最近页面。

在历史记录配置菜单中,您还将看到最近页面访问的列表。结果按“当前产品/版本”和“全部”单选按钮过滤。单击 按钮将清除历史记录栏以及本地存储中保存的历史记录。

如果在历史记录配置菜单中选择“全部”,则将启用“在历史记录栏中显示产品详细信息”的复选框选项。选中后,每个历史页面的产品/版本将在历史记录栏中与页面名称一起显示。将光标悬停在历史记录栏中的页面名称上也会将产品/版本显示为工具提示。

搜索和过滤器

可以使用页面顶部的搜索字段搜索 API 文档和指南。

在 API 文档页面上,还有一个过滤器输入字段,该字段使用过滤器字符串过滤成员行。除了按字符串过滤外,您还可以按访问级别、继承和只读过滤类成员。这是使用页面顶部的复选框完成的。

API 类导航树底部的复选框过滤类列表,以包含或排除私有类。

单击空白搜索字段将显示您最近 10 次搜索,以便快速导航。

API 文档类元数据

每个 API 文档页面(JavaScript 原始类型页面除外)都有一个菜单视图,其中包含与该类相关的元数据。此元数据视图将具有以下一项或多项

  • Alternate Name - 一个或多个附加的类名同义词(在 Ext JS 6.0.0 中,Ext.button.Button 类具有 Ext.Button 的备用类名)。备用类名通常为了向后兼容性而维护。
  • Hierarchy - 层次结构视图列出了当前类的继承链,一直到其祖先类,直到根基类。
  • Mixins - 混合到当前类中的类列表
  • Inherited Mixins - 混合到当前类的祖先中的类列表
  • Requires - 类实例化所需定义的所有类
  • Uses - 类在其生命周期中的某些时刻可能使用的类列表,但不一定是类最初实例化所必需的
  • Subclasses - 扩展当前类的类

展开和折叠示例和类成员

可运行的示例 (Fiddles) 默认在页面上展开。您可以使用代码块左上角的箭头单独折叠和展开示例代码块。您还可以使用页面右上角的切换按钮切换所有示例的折叠状态。切换所有状态将在页面加载之间记住。

类成员默认在页面上折叠。您可以使用成员行左侧的箭头图标或全局使用右上角的展开/折叠全部切换按钮来展开和折叠成员。

桌面与移动视图

在较窄的屏幕或浏览器上查看文档将导致针对较小外形尺寸优化的视图。桌面视图和“移动”视图之间的主要区别在于

  • 全局导航将位于左侧菜单中,可通过汉堡菜单图标访问。菜单包含以下内容(在大多数页面上)
    • 当前产品的名称(作为指向产品着陆页面的链接)
    • 用于导航回文档主页的 Sencha 图标
    • 产品菜单下拉按钮
    • API 文档和指南的导航树标签
  • 当前上下文导航和工具位于右侧,可通过齿轮图标访问。上下文菜单包含以下内容
    • 全局搜索输入字段
    • API 文档)“过滤器”选项卡,其中包含成员过滤器、展开/折叠所有示例按钮、展开/折叠所有成员行按钮、访问级别过滤器复选框以及每个成员的计数
    • API 文档)“相关类”选项卡,其中包含与当前类相关的元数据菜单
    • 指南)指南的目录

查看类源代码

可以通过单击 API 文档页面顶部的类名来查看类源代码。可以通过单击成员行右侧的“查看源代码”链接来查看类成员的源代码。

GXT 4.x


顶部

ComboBoxes

GXT 中的 Combobox 选择。

参考

示例

在此处的示例链接中研究源代码。

ComboBoxes

层次结构

简单字符串 ComboBox

简单的字符串组合框已准备好用于字符串列表。

  • StringComboBox 示例。

      StringComboBox combo = new StringComboBox();
      combo.add("Item 1");
      combo.add("Item 2");
      combo.add("Item 3");
      combo.add("Item 4");
    

任何模型 ComboBox

任何模型 ComboBox 都适合任何类型的模型列表。

  • 任何模型 ComboBox<M> 示例。

      ListStore<Company> store = new ListStore<Company>(new ModelKeyProvider<Company>() {
        @Override
        public String getKey(Company item) {
          return item.getId().toString();
        }
      });
      store.add(new Company("0", "Company 1"));
      store.add(new Company("1", "Company 2"));
      store.add(new Company("2", "Company 3"));
      store.add(new Company("3", "Company 4"));
    
      LabelProvider<Company> labelProvider = new LabelProvider<Company>() {
        @Override
        public String getLabel(Company item) {
          if (item.getName() == null) {
            return "";
          }
          return item.getName();
        }
      };
    
      ComboBox<Company> combo = new ComboBox<Company>(store, labelProvider);
    
  • ComboBox<M> 示例中使用的模型。

      public class Company {
        private String id;
        private String name;
    
        public Company(String id, String name) {
          this.id = id;
          this.name = name;
        }
    
        public String getId() {
          return id;
        }
    
        public String getName() {
          return name;
        }
      }
    

常用选项

一些常用的 ComboBox 配置选项。

隐藏光标

隐藏输入中闪烁的光标。

  • 示例

      combo.setEditable(false);
    

触发操作

触发器是导致组合框展开列表选择的原因。

操作 结果
TriggerAction.ALL 展开整个列表。
TriggerAction.QUERY 使用输入作为查询展开过滤列表。
  • TriggerAction.ALL 的示例。

      ComboBox<Company> combo = new ComboBox<Company>(store, labelProvider);
      combo.setTriggerAction(TriggerAction.ALL);
    

  • TriggerAction.QUERY 的示例。

      ComboBox<Company> combo = new ComboBox<Company>(store, labelProvider);
      combo.setTriggerAction(TriggerAction.QUERY);
    

最小自动完成字符数

设置最小字符数,然后自动完成展开列表。

  • 示例 setMinChars(4)

      ComboBox<Company> combo = new ComboBox<Company>(store, labelProvider);
      combo.setMinChars(4);
    

自动填充提前输入

提前输入或自动填充字符。

  • setTypeAhead(true) 的示例。

ComboBoxcombo = new ComboBox(store, labelProvider); combo.setTypeAhead(true);

加载数据

设置加载器以从服务器或其他位置加载数据。以下两个示例中唯一不同的是 Proxy 接线,并且还有许多其他可能的配置。高级组合框示例 有一个更复杂的加载器示例,该示例也使用了远程查询。

  • 使用 DataProxy 的 setLoader(loader) 示例。

      // The Store
      ListStore<Company> store = new ListStore<Company>(new ModelKeyProvider<Company>() {
        @Override
        public String getKey(Company item) {
          return item.getId().toString();
        }
      });
    
      // The Data proxy tells how to fetch the data
      DataProxy<ListLoadConfig, ListLoadResult<Company>> proxy = new DataProxy<ListLoadConfig, ListLoadResult<Company>>() {
        @Override
        public void load(ListLoadConfig loadConfig, Callback<ListLoadResult<Company>, Throwable> callback) {
          // A client example to show data fetching in a proxy
          final List<Company> companies = new ArrayList<Company>();
          for (int i = 0; i < 5; i++) {
            Company company = getCompany(i);
            companies.add(company);
          }
    
          ListLoadResult<Company> result = new ListLoadResultBean<Company>(companies);
          callback.onSuccess(result);
        }
      };
    
      // The Loader wiring
      final ListLoader<ListLoadConfig, ListLoadResult<Company>> loader = new ListLoader<ListLoadConfig, ListLoadResult<Company>>(proxy);
      loader.addLoadHandler(new LoadResultListStoreBinding<ListLoadConfig, Company, ListLoadResult<Company>>(store));
    
      LabelProvider<Company> labelProvider = new LabelProvider<ComboboxExampleTest.Company>() {
        @Override
        public String getLabel(Company item) {
          if (item.getName() == null) {
            return "";
          }
          return item.getName();
        }
      };
    
      ComboBox<Company> combo = new ComboBox<Company>(store, labelProvider);
      combo.setLoader(loader);
    
  • 使用 RpcProxy 的 setLoader(loader) 示例。

      // The Store
      ListStore<Company> store = new ListStore<Company>(new ModelKeyProvider<Company>() {
        @Override
        public String getKey(Company item) {
          return item.getId().toString();
        }
      });
    
      // The Proxy
      RpcProxy<ListLoadConfig, ListLoadResult<Company>> proxy = new RpcProxy<ListLoadConfig, ListLoadResult<Company>>() {
        @Override
        public void load(ListLoadConfig loadConfig, final AsyncCallback<ListLoadResult<Company>> asyncCallback) {
          //rpcService.fetchData(loadConfig, asyncCallback);
        }
      };
    
      // The Loader wiring
      final ListLoader<ListLoadConfig, ListLoadResult<Company>> loader = new ListLoader<ListLoadConfig, ListLoadResult<Company>>(proxy);
      loader.addLoadHandler(new LoadResultListStoreBinding<ListLoadConfig, Company, ListLoadResult<Company>>(store));
    
      LabelProvider<Company> labelProvider = new LabelProvider<ComboboxExampleTest.Company>() {
        @Override
        public String getLabel(Company item) {
          if (item.getName() == null) {
            return "";
          }
          return item.getName();
        }
      };
    
      ComboBox<Company> combo = new ComboBox<Company>(store, labelProvider);
      combo.setLoader(loader);
    

加载 HTML 和文本

在服务器获取数据时显示加载 HTML 或文本。对于 html,可以使用旋转的图像来显示为加载中。

  • 使用 setLoadingText(text) 的示例。

      ComboBox<Company> combo = new ComboBox<Company>(store, labelProvider);
      combo.setLoader(loader);
      combo.setLoadingText("Loading...");
    

  • 使用 setLoadingHtml(html) 的示例。

      ComboBox<Company> combo = new ComboBox<Company>(store, labelProvider);
      combo.setLoader(loader);
      combo.setLoadingHtml(SafeHtmlUtils.fromSafeConstant("<span style=\"color:red;\">Loading...</span>"));
    

提交选择

通过在列表视图折叠时调用 finishEditing,从展开的列表视图中选择时运行验证并提交值。

  • 选择时完成编辑的示例。

      combo.addCollapseHandler(new CollapseHandler() {
        @Override
        public void onCollapse(CollapseEvent event) {
          combo.finishEditing();
        }
      });
    

GXT 4.x