文档帮助

术语、图标和标签

许多类在使用配置对象创建(实例化)类时都有快捷名称。快捷名称被称为 别名(如果类扩展了 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)。如果成员源自当前类,则源类将显示为蓝色链接;如果成员从祖先类或 mixin 类继承,则显示为灰色链接。
  • 成员源代码 - 在成员来源类的右侧下方是查看成员源代码的链接(示例中的 view source
  • 参数列表 - 类方法的每个参数都将使用上面括号中找到的相同名称、预期的类或对象类型以及参数的描述(示例中为 item : Object)列出。
  • 返回值 - 如果类返回除 undefined 以外的值,则“返回值”部分将注明返回的类或对象类型以及描述(示例中为 Ext.Component
  • 始于示例中未显示) - 某些成员将显示该成员首次引入的产品版本(即 Available since 3.4.0 - 示例中未显示),就在成员描述之后
  • 默认值示例中未显示) - 配置通常显示要应用于类实例的默认配置值(如果未被覆盖)(即 Defaults to: false

成员标志

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

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

类图标

- 表示框架类

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

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

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

成员图标

- 指示类型为 config 的类成员

- 指示类型为 property 的类成员

- 指示类型为 method 的类成员

- 指示类型为 event 的类成员

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

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

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

类成员快速导航菜单

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

Getter 和 Setter 方法

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

历史记录栏

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

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

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

搜索和过滤器

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

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

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

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

API 文档类元数据

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

  • 别名 - 一个或多个附加类名同义词(在 Ext JS 6.0.0 中,Ext.button.Button 类具有 Ext.Button 的别名)。通常维护别名是为了向后兼容。
  • 继承关系 - 继承关系视图列出了当前类的继承链,从其祖先类一直到根基类。
  • Mixins - 混合到当前类中的类列表
  • 继承的 Mixins - 混合到当前类的祖先中的类列表
  • 需要 - 实例化类所需定义的所有类
  • 使用 - 类在其生命周期的某个时刻可能使用的类列表,但不一定是类最初实例化所必需的
  • 子类 - 扩展当前类的类

展开和折叠示例和类成员

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

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

桌面视图 -vs- 移动视图

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

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

查看类源代码

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

GXT 4.x


顶部

GXT 入门(使用 Eclipse 标准源文件夹)

要求

下载

如果您是试用客户

访问此页面

如果您是正式客户

从我们的支持门户下载。

构建路径

将 GXT jar 添加到项目“构建路径”。

  1. 在项目中创建一个 lib 目录。

  2. 找到 GXT Jar gxt-x.x.x.jar,然后将其复制到项目的 lib 目录。

  3. lib 目录中,右键单击 gxt-x.x.x.jar,然后选择“添加到构建路径”。

GWT XML 模块配置

配置 GWT 项目以继承 GXT 模块。

  1. 将 GXT 模块插入到项目 GWT XML 模块中。

      <!-- Other module inherits -->
      <inherits name='com.sencha.gxt.ui.GXT' />
    
  2. 删除内置样式 Clean,因为它不受支持。其他样式(如 StandardChromeDark)将与 GXT 一起使用。

     <!-- <inherits name='com.google.gwt.user.theme.clean.Clean'/> -->
    
  3. reset.css 样式表插入到项目 GWT XML 模块中。

     <!-- GXT Stylesheet -->
     <stylesheet src="reset.css" />
    
  4. 当使用 GXT 时,项目 GWT XML 模块将如下所示。

      <?xml version="1.0" encoding="UTF-8"?>
      <!DOCTYPE module PUBLIC "-//Google Inc.//DTD GWT 2.7.0//EN"
          "http://gwtproject.org/doctype/2.7.0/gwt-module.dtd">
      <module rename-to='gxt_project'>
        <!-- Inherit the core Web Toolkit stuff. -->
        <inherits name='com.google.gwt.user.User' />
    
        <!-- Other module inherits -->
        <inherits name='com.sencha.gxt.ui.GXT' />
    
        <!-- GXT stylesheet -->
        <stylesheet src="reset.css" />
    
        <!-- Specify the app entry point class. -->
        <entry-point class='com.sencha.gxt.project.client.GXT_Project' />
    
        <!-- Specify the paths for translatable code -->
        <source path='client' />
        <source path='shared' />
      </module>
    

可选

GXT 内容辅助

配置 Eclipse 内容辅助以首先建议 GXT 组件。

  1. 右键单击项目,然后选择“构建路径”,然后选择“配置构建路径”。

  2. 选择“顺序和导出”选项卡。

  3. 选择 gxt-x.x.x.jar 并将其移到 GWT 库上方。

  4. Eclipse 内容辅助的外观。

验证 GXT 安装

项目设置完成后,通过测试框架验证库是否可用。

  1. 找到入口点类并添加 GXT 小部件。

     TextButton textButton = new TextButton("Verify GXT Works");
     RootPanel.get().add(textButton);
     textButton.addSelectHandler(new SelectHandler() {
       @Override
       public void onSelect(SelectEvent event) {
         MessageBox messageBox = new MessageBox("GXT Works.");
         messageBox.show();
       }
     });
    
  2. 调试项目并验证小部件在应用程序加载后已呈现。

GXT 4.x