文档帮助

术语、图标和标签

许多类在使用配置对象创建(实例化)时使用快捷名称。快捷名称称为别名(如果类扩展了 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)在页面上展开。您可以使用代码块左上角的箭头单独折叠和展开示例代码块。您也可以使用页面右上角的切换按钮切换所有示例的折叠状态。切换所有状态将在页面加载之间保留。

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

桌面 -vs- 移动视图

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

查看类源代码

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

Sencha Test 2.4.0


顶部

测试其他 Web 应用程序

Sencha Test 能够帮助您使用 WebDriver 场景编写和执行针对非 Sencha Web 应用程序的端到端测试。

通过使用事件记录器和检查工具等功能,您可以快速为页面中的元素生成唯一且稳定的定位器。

本指南将引导您完成使用 Sencha Test 并将其配置为针对非 Sencha Web 应用程序运行测试的典型过程。

创建新项目

  1. 打开 Sencha Studio,并创建一个新项目。本示例使用 AngularJS “待办事项”应用程序,可在 http://todomvc.com/examples/angularjs/ 获取。

    Sample web app

  2. 在“创建项目”窗口中使用此 URL,并定义项目名称和文件夹路径。

    • 名称:项目的名称,例如 ToDoApp
    • 路径:项目将创建的位置。场景和测试套件文件将添加到此位置。
    • URL:正在运行的 Web 应用程序的 Web 地址,例如 http://todomvc.com/examples/angularjs/

      Creating a project

  3. 项目创建后,您将能够单击“新建场景”按钮以创建一个将保存您的测试套件文件的场景。

    • 名称:场景的名称,例如,如果您正在创建端到端测试,您可以将场景命名为 EndToEnd
    • 测试类型:选择 WebDriver 将在浏览器之外单独运行您的测试。这适用于端到端测试。如果您在 Sencha Studio 中选择了测试工程师角色,则此选项将被隐藏,并且新场景将默认使用 WebDriver 类型。

      Creating a scenario

  4. 创建场景后,在树中选择该场景,然后单击“新建测试套件”按钮 >> 从菜单中选择“Jasmine 测试套件”。输入测试套件的名称,例如 AddNew。这将创建一个新的 Jasmine 测试套件文件。.js 文件扩展名会自动添加。

    New test suite

  5. 在新测试套件加载到编辑器后,删除默认的期望,并将测试/规范重命名为更有意义的名称。

    Editing test suite

  6. 通过利用 事件记录器 或使用 Futures API 编写代码来开始编写一些测试。您还可以利用 检查工具 来帮助您创建元素的定位器。在下面的屏幕截图中,事件记录器用于在应用程序中创建一个新的待办事项,然后 Futures API 用于断言新项目已成功添加。检查工具有助于生成添加项目的定位器。

    Writing tests

    以下是测试套件的完整代码。

     describe("AddNew", function() {
         it("should add a new to-do item", function() {
             // Add a new item to the list using Event Recorder generated script
             ST.play([
                 { type: "tap", target: "@new-todo", x: 138, y: 38 },
                 { type: "type", target: "@new-todo", text: "go shopping" },
                 { type: "type", target: "@new-todo", key: "Enter" }
             ]);
    
             // Use Futures APIs to check item added to list
             ST.element('@todo-list/li/div/label')
                 .textLike('go shopping');
         });
     });
    
  7. 通过在树中选择场景,选择一个浏览器(例如 Chrome),然后单击“运行”按钮来运行测试。您应该会看到一个新的浏览器窗口启动,其中加载了应用程序,并执行了步骤。测试应该在短暂等待后通过。

    Running a scenario

更多信息

有关场景和测试套件的更多信息,请参阅 项目、场景和套件指南

Sencha Test 2.4.0