文档帮助

术语、图标和标签

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

访问级别

框架类或其成员可以指定为私有受保护。否则,该类/成员为公共公共受保护私有是访问描述符,用于传达类或类成员的使用方式和时机。

成员类型

成员语法

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

lookupComponent ( item ) : Ext.Component
受保护

当在items 配置的初始化期间,或当添加新项目时,将原始配置对象添加到此容器时调用添加),或{@link #insert 插入}。

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

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

参数

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

展开和折叠示例和类成员

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

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

桌面 -vs- 移动视图

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

查看类源代码

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

Sencha Test 2.4.0


顶部

浏览器内测试与 WebDriver 测试

有两种测试模式:浏览器内和 WebDriver。

示例

测试和调试模式

浏览器内测试

在 Sencha Test 1.x 中,规范和应用程序代码都在浏览器中一起运行。因此,您可以使用 Ext.create() API 在规范中直接创建 Ext JS 组件实例,例如。

然后,您可以通过使用 Ext 命名空间以及使用 Futures API 来直接与组件和对象交互。

虽然 Sencha Test 2.x 中的浏览器内测试仍然如此,但 WebDriver 测试需要不同的方法。

使用浏览器内模式调试的示例:

WebDriver 测试

由于测试和应用程序代码不一起执行,因此必须利用 Futures API 来在两者之间进行通信。

在 WebDriver 测试的上下文中,不能引用 Ext 或应用程序命名空间,因为它们将是未定义的(因为测试与浏览器分开运行)。

您不会在规范中直接创建和操作 Ext JS 组件,而是使用 Futures API 来定位应用程序中已存在的组件。然后,您可以利用 API 与任何组件或元素交互。

这样,基于 WebDriver 的测试侧重于对现有应用程序的功能测试,而不是对任意代码的单元测试。

使用 WebDriver 模式调试的示例:

Sencha Test 2.4.0