文档帮助

术语、图标和标签

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

访问级别

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

成员类型

成员语法

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

lookupComponent ( item ) : Ext.Component
protected

在初始化items配置期间,或添加新项目时,将原始配置对象添加到此容器时调用added), or {@link #insert inserted.

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

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

参数

item :  Object

要添加的配置对象。

返回值
Ext.Component

要添加的组件。

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

成员标志

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

类图标

- 表示框架类。

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

- 组件类型框架类(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 原语页面)都具有与该类相关的元数据的菜单视图。此元数据视图将包含以下一项或多项

展开和折叠示例和类成员

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

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

桌面与移动视图

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

查看类源代码

可以通过单击 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 组件与其在网页上的物理表示(渲染的 HTML)之间的链接。

Futures API

Sencha Test 的强大功能之一是它通过使用 Futures API 内置了对 Ext JS 和 ExtReact 组件的了解。

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

网格中的行也适用相同的逻辑。如果网格需要从远程服务器加载数据,则网格在屏幕上渲染后可能会有 1 秒的延迟,直到从服务器检索到数据并填充到网格中。如果在调用 .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 将排队上述每个操作,并按以下所示的顺序执行它们。它只有在先前操作完成之后才会转到下一个操作。

  1. 找到与 assetgrid 匹配的定位器的网格
  2. 引用索引为 2 的行
  3. 点击该行
  4. 找到与 assetform 匹配的定位器的组件
  5. 检查 assetform 是否可见

本质上,Futures API 按顺序同步运行,而不是异步运行,其中 API 可以同时运行,或者以随机顺序运行。

失败和超时

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

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

更多信息

有关 Futures API 内部工作原理的更多详细信息,请查看 ST.future.Element 的文档

Sencha Test 2.4.0