文档帮助

术语、图标和标签

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

访问级别

框架类或其成员可以指定为 private 或 protected。否则，类/成员为 public。Public、protected 和 private 是访问描述符，用于传达类或类成员应如何以及何时使用。

Public 类和类成员可供任何其他类或应用程序代码使用，并且在主要产品版本中可以作为稳定且持久的内容依赖。Public 类和成员可以通过子类安全地扩展。
Protected 类成员是稳定的 public 成员，旨在由拥有类或其子类使用。Protected 成员可以通过子类安全地扩展。
Private 类和类成员在框架内部使用，不供应用程序开发人员使用。Private 类和成员可能随时更改或从框架中省略，恕不另行通知，并且不应在应用程序逻辑中依赖它们。

成员类型

Config - 类的配置选项。
Property - 类实例化后设置。*请参阅下面的只读。
Method - 可以由类执行的操作。方法应被理解为实例方法，并且只能从给定类的实例调用。可以直接从类本身调用的静态方法将在方法名称旁边带有 static 标签。*请参阅下面的静态。
Event - 事件是框架事件系统特有的，允许类以编程方式引发事件，以便由一个或多个事件处理程序方法处理。DOM 事件虽然由框架事件系统处理，但在 API 文档中没有具体描述。*有关 DOM 事件，请参阅 MDN 的事件参考页面。
Theme Variable - 框架使用的视觉主题引擎使用的变量。
Theme Mixin - 框架使用的视觉主题引擎使用的函数，可以使用在各种主题变量中设置的值。

成员语法

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

Ext.container.Container

查看源代码

lookupComponent ( item ) : Ext.Component

受保护的

当原始配置对象添加到此容器时调用，无论是在 items 配置的初始化期间，还是在添加新项目 added 或 {@link #insert inserted} 时调用。

此方法将传递的对象转换为实例化的子组件。

当需要对子组件创建应用特殊处理时，可以在子类中覆盖此方法。

参数

item : Object

正在添加的配置对象。

返回值

Ext.Component

要添加的组件。

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

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

成员标志

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

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

类图标

- 表示框架类

- Singleton 框架类。*有关更多信息，请参阅 singleton 标志

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

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

成员图标

- 表示 config 类型的类成员

- 表示 property 类型的类成员

- 表示 method 类型的类成员

- 表示 event 类型的类成员

- 表示 theme variable 类型的类成员

- 表示 theme mixin 类型的类成员

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

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

Getter 和 Setter 方法

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

历史记录栏

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

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

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

搜索和过滤器

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

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

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

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

API 文档类元数据

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

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

展开和折叠示例以及类成员

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

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

桌面 -vs- 移动视图

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

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

查看类源代码

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

Sencha Test 2.4.0

显示私有类

顶部

Futures API 简介

问题

您可能知道，当动态 Web 应用程序（例如 Ext JS 应用程序）在浏览器中加载时，HTML 会在需要新视图和组件时动态创建。

Ext JS 还允许渲染同一视图的多个实例，因此每当组件作为 HTML 元素渲染到页面时，所有 id 属性都是动态生成的。

Ext JS 通过页面上的自定义 div 标签以及包装标准 HTML 表单输入来渲染其组件。

例如，Ext JS 网格中的列在渲染到浏览器时，将具有类似于此的 HTML 标记

...
  <div class="x-gridcolumn x-component x-size-monitored x-paint-monitored x-resizable x-layout-box-item x-layout-hbox-item x-flexed x-stretched x-widthed" 
    id="ext-gridcolumn-1" data-componentid="ext-gridcolumn-1" 
    style="min-width: 40px; -webkit-box-flex: 1; flex: 1 1 0px;">
    <div class="x-title-el" id="ext-element-93">
      <div class="x-text-el" id="ext-element-94">Name</div>
    </div>
    ...
  </div>
  <div class="x-gridcolumn x-component x-size-monitored x-paint-monitored x-resizable x-layout-box-item x-layout-hbox-item x-flexed x-stretched x-widthed" 
    id="ext-gridcolumn-2" data-componentid="ext-gridcolumn-2" 
    style="min-width: 40px; -webkit-box-flex: 1; flex: 1 1 0px;">
    <div class="x-title-el">
      <div class="x-text-el" id="ext-element-99">Type</div>
    </div>
    ...
  </div>
...

在标准测试工具中，如果我们想引用网格的列之一，我们可能会尝试使用与该列关联的元素的 id，但在上面的示例中，您可以看到列的 id 类似于此

id="ext-gridcolumn-2"

这种类型的自动输出使得标准测试工具很难可靠地定位页面上的元素，因为标识符会定期更改。

其他测试工具也无法感知 Ext JS 组件与 Web 页面上该组件的物理表示（渲染的 HTML）之间的链接。

Futures API

Sencha Test 的强大功能之一是其内置的 Ext JS 和 ExtReact 组件感知能力，这通过使用 Futures API 实现。

Futures API 是一套 JavaScript 辅助方法，可让您更可靠（且更轻松）地引用 Ext JS 和 ExtReact 组件以及这些组件中的项目，以及页面中的其他元素。

例如，如果我们想在测试中与特定网格的行进行交互，我们可以使用以下代码

it('Should click on a row in the Assets grid', function() {
    ST.grid('assetgrid')
        .rowAt(2)
        .click();
});

仅使用几行简单的代码，我们就能够通过特定定位器（在本例中，使用网格的 xtype）引用 Ext JS 网格，并且一旦我们有了对它的引用，就有了用于引用行的内置方法。一旦我们有了行，我们就可以通过 .click() 方法模拟用户单击网格的该部分。

我们将上面示例中的所有方法都称为链式方法；这就是我们可以一个接一个地附加方法的地方。

断言

通过使用 Futures API，您通常不需要进行特定的 Jasmine 断言，例如

expect(something).toBe(something)

相反，在上一节中显示的示例中，仅通过执行 ST.grid('assetgrid') 的优点，如果网格在默认超时时间段（5 秒）内未找到，则该失败将导致关联的测试失败，并显示错误，指示在等待网格被定位时发生超时。

同样，如果网格中索引 2 处没有行，则 .rowAt(2) 将导致测试失败，并显示错误，指示未找到预期的行。

处理时序问题

由于 Ext JS 等框架的动态特性，组件可能在执行测试时尚未完全渲染到页面，或者网格的数据可能尚未加载。

Futures API 为您处理这些时序问题。在下面的示例中，如果没有与定义的定位器 (assetgrid) 匹配的网格，则它将等待一个网格变为可用（在默认超时时间段内）。

it('Should click on a row in the Assets grid', function() {
    ST.grid('assetgrid')
        .rowAt(2)
        .click();
});

相同的逻辑适用于网格中的行。如果网格必须从远程服务器加载数据，则在网格在屏幕上渲染后，可能会有一秒钟的延迟，直到从服务器检索数据并填充到网格中。如果在调用 .rowAt(2) 时网格中没有行，则 Futures API 将等待一行变为可用，然后再继续执行下一个操作。

排队 Futures API

当您在同一测试中使用单独的 ST. Future API 调用时，Sencha Test 会自动将它们排队并按照它们在测试中编写的顺序执行。

例如

it('Should click on a row in the Assets grid', function() {
    ST.grid('assetgrid')
        .rowAt(2)
        .click();

    ST.component('assetform')
        .visible();
});

Sencha Test 将对上述每个操作进行排队，并按照下面显示的顺序执行它们。只有在前一个操作完成后，它才会移动到下一个操作。

查找具有与 assetgrid 匹配的定位器的网格
引用索引 2 处的行
单击行
查找具有与 assetform 匹配的定位器的组件
检查 assetform 是否可见

本质上，Futures API 是一个接一个同步运行的，而不是异步运行的，在异步运行中，API 可以一起运行或以随机顺序运行。

失败和超时

在上一节中显示的示例中，如果在索引 2 处未找到行，则会导致 .rowAt(2) 对该特定操作发出超时失败。

因此，.click() 将被跳过，以及该测试中的所有剩余操作。然后，Sencha Test 将继续执行测试套件中的下一个测试。

目录

术语、图标和标签

访问级别

成员类型

成员语法

成员标志

类图标

成员图标

导航和功能

类成员快速导航菜单

Getter 和 Setter 方法

历史记录栏

搜索和过滤器

API 文档类元数据

展开和折叠示例以及类成员

桌面 -vs- 移动视图

查看类源代码

Sencha Test 2.4.0

目录

Futures API 简介

问题

Futures API

断言

处理时序问题

排队 Futures API

失败和超时

更多信息

Sencha Test 2.4.0