文档帮助

术语、图标和标签

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

访问级别

框架类或其成员可以指定为 private(私有)或 protected(受保护)。否则,类/成员为 public(公共)。Publicprotectedprivate 是访问描述符,用于传达应如何以及何时使用类或类成员。

成员类型

成员语法

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

lookupComponent ( item ) : Ext.Component
受保护 (protected)

当原始配置对象添加到此容器时调用,无论是在初始化 items 配置期间,还是在添加新项目 added) 或 {@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 原始类型页面除外)都有一个与该类相关的元数据菜单视图。此元数据视图将包含以下一项或多项

展开和折叠示例和类成员

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

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

桌面与移动视图

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

查看类源代码

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

Sencha Test 2.4.0


顶部

定位器

当 Web 应用程序在浏览器中加载时,在测试期间可以引用两个不同的项目层

  1. 组件 (Ext JS / ExtReact)
  2. 元素

组件 (Components) 是物理 Ext JS 或 ExtReact 对象,例如网格或组合框。当您引用像网格这样的组件时,您可以轻松引用其属性和子项,例如其标题、行以及停靠的项目(如工具栏和按钮)。

元素 (Elements) 是这些组件在浏览器中的表示形式 - 您在页面中看到的 HTML 标记。当您引用元素时,没有关于该元素代表什么内容的真正上下文。它很可能只是页面中的一个 div,因此从该层引用网格行和工具栏并不容易。如果未使用 Sencha 框架,您将仅使用元素层。

为了使用 Futures API,您需要知道如何定位组件和元素。

定位器类型

元素和 Ext JS 组件可以通过不同的定位器 (locators) 引用。

定位器是一种选择器类型,类似于 CSS 选择器,它告诉 Sencha Test 如何引用组件或元素。Futures API 支持以下不同的组件和元素定位器策略

  • 组件
    • 组件查询
    • 复合查询
  • 元素
    • At-Path
    • XPath
    • DOM 查询

对于 Ext JS 和 ExtReact 应用程序,您通常会使用组件查询或复合定位器,但我们将在下面讨论其中的每一个,并展示一些示例语法。

组件

在 Ext JS 或 ExtReact 应用程序中,通常使用组件查询或复合查询。

组件查询

这是最常用的定位器策略。它是 Ext JS 和 ExtReact 框架提供的功能,可以定位应用程序的组件。组件查询语法在风格上类似于 DOM 查询。

组件查询在 Ext JS 文档 中进行了深入描述,但我们将在本文中介绍一些示例

按“xtype”引用

在 Ext JS 中,xtype 指的是组件的类型。Ext JS 中的每个开箱即用组件都有一个 xtype。当您浏览 Ext JS 文档时,当您查看 GridComboBox 的文档时,您会注意到该组件的 xtype 列在顶部。有时,一个组件可能列出多个 xtype 别名。

例如,Grid 具有以下可能的 xtype

grid

gridpanel

如果存在多个匹配的组件(多个网格),则需要使定位器更具体,以便它只匹配一个组件。

开发人员通常为应用程序中的自定义组件设置自定义类型。例如,如果开发人员创建了一个用户网格,他们可能会决定给该网格一个 usergrid 或类似的 xtype。因此,您还可以引用开发团队可能指定的自定义类型

usergrid

按“id”或“itemId”引用

一般来说,开发人员在 Ext JS 组件上设置 id 是一种不良做法,因为这会在尝试在页面上创建该组件的多个实例时导致问题。itemId 更常用,因为它不会引起此类冲突。

使用以下语法可以按其 iditemId 引用组件

#userGrid

这可以与 xtype 结合使用,因此在以下示例中,将返回 itemId 为 userGrid 的网格

grid#userGrid

复合查询

您可以使用 => 分隔两部分,在“复合查询”中组合组件查询和 DOM 查询。

例如

#myComponent => div.content

这会在 iditemIdmyComponent 的组件内定位类为 content 的子 div 元素。

元素

如果您的 Web 应用程序不使用像 Ext JS 这样的动态框架,那么元素选择器非常有用。

At-Path

@ 字符开头的定位器称为“at-paths”。at-path 的第一个标记是元素 ID。第一个标记之后是由斜杠分隔的标记名称和偏移量序列,类似于 XPath。

例如

@some-div/span[2]

这标识了作为 id 为“some-div”的元素的直接子元素的第二个“span”元素。

等效的 XPath 表达式将是

//[@id="some-div"]/span[2]

与 XPath 相比,at-paths 的主要优点是紧凑性和速度。这是因为 at-path 使用 getElementById,后跟基于标记名称的简单路径。由于 at-paths 本质上基于 ID,因此它们在为其元素分配有意义的 ID 的应用程序中最有用。

XPath

XPath 可能是最强大的受支持定位器语法。Sencha Test 使用浏览器的 document.evaluate 方法,以及当此方法不存在时的 polyfill

除了属性匹配之外,XPath 还可以向上导航,这与 CSS 选择器不同。

例如

//[id="some-div"]/..

上面的 XPath 选择 ID 为“some-div”的节点的父节点。

注意: Sencha Test 要求所有 XPath 定位器都以斜杠字符开头。通常,XPath 定位器将以“//”开头(如上所示),以便匹配项不从文档根目录开始。

关于 XPath 的一些有用资源

DOM 查询

DOM 查询或 CSS 选择器可能是 Sencha Test 支持的最熟悉的定位器语法。为了区分 DOM 查询定位器与组件查询和复合查询(如上所述),DOM 查询以 >>=> 开头。

上面的路径可以通过以下 DOM 查询近似表示

>> #some-div > span:nth-child(2)

这只是近似相同,因为 nth-child() 不要求第一个子元素也是 span。

Sencha Test 2.4.0