文档帮助

术语、图标和标签

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

访问级别

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

成员类型

成员语法

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

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

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

成员标志

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

  • 必需 - 实例化类时的必需配置
  • 可绑定 - 配置具有一个 setter,允许通过 ViewModel 绑定设置此配置
  • 只读 - 可以读取该属性,但不能用于在运行时配置/重新配置类实例
  • 单例 - 单例类在定义后立即实例化,并且不能手动实例化
  • 静态 - 静态方法或属性是属于类本身的方法或属性,而不是类的实例
  • 可链接 - 指在调用时返回类实例的方法。
    这允许链接方法调用,例如:classInstance.method1().method2().etc();
  • 已弃用 - 计划在未来框架版本中删除的类或成员,并在当前版本中提供以保持向后兼容性。
    已弃用的类和成员将有一条消息,指导您在将来使用首选类/方法。
  • 已删除 - 仅在文档中作为参考存在的已删除类或成员,供在框架版本之间升级的用户使用
  • 模板 - 在基类中定义的方法,旨在由子类覆盖
  • 抽象 - 类或成员可以定义为抽象。抽象类和成员建立类结构,并提供有限的代码(如果有)。类特定代码将通过子类中的覆盖来提供。
  • 可预防 - 标记为可预防的事件不会触发,如果从事件处理程序返回 false

类图标

- 表示框架类

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

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

  • 备用名称 - 一个或多个其他类名称同义词(在 Ext JS 6.0.0 中,Ext.button.Button 类有一个备用类名称 Ext.Button)。备用类名称通常用于向后兼容。
  • 层次结构 - 层次结构视图列出了当前类的继承链,从其祖先类一直到根基类。
  • Mixins - 混合到当前类的类列表
  • 继承的 Mixins - 混合到当前类祖先的类列表
  • Requires - 实例化类所需的已定义的所有类
  • Uses - 在其生命周期的某个时刻类可能使用的类列表,但对于最初实例化类而言并非必需
  • Subclasses - 扩展当前类的类

展开和折叠示例和类成员

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

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

桌面 -vs- 移动视图

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

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

查看类源

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

WebTestIt


顶部

元素

每个网站或应用程序都由 UI 构建块或元素组成。有不同形式的元素,如图像、文本、链接、按钮等。UI 逻辑定义了与这些元素交互的可能性。你的网站或应用程序的业务逻辑定义了元素在什么条件下可见、可点击、隐藏等。

我们在引言中已经注意到,自动化框架负责识别你想要检查的元素,并操作或断言它们。为了实现这一点,每个元素都由一个选择器标识。

选择器

选择器是网站或应用程序可视结构中的元素定位器。在大多数现代 UI 描述语言(如 HTML)中,此结构是分层的。如果你将选择器传递给自动化框架,它会将规则应用于当前活动页面,并尝试定位由其描述的元素。

注意

如果无法定位元素,则不会自动导致测试失败。但是,对于可靠的测试执行,为元素提供可靠的选择器至关重要。

Sencha WebTestIt 在元素选项卡中支持你使用选择器,该选项卡使你能够定义和组织页面对象的选取器。

每个选择器都表示为遵循特定规则集的字符串值。这些规则集被称为策略

选择器类型

在你的网站或应用程序中可靠地定位对象需要什么?你可能会认为最简单的方法是通过每个元素的唯一 ID 来引用它。我们也完全同意你这一点!但实际上,经常会出现这种情况,即此方法不起作用

  • 在许多网站和应用程序中,并未为每个元素提供 ID。
  • 一些 UI 框架为每个元素分配自动生成的随机 ID。
  • 应用程序中动态生成的对象不能有固定的 ID。

对于那些不能仅依赖 ID 的情况,有选择器策略可以帮助你根据元素在 UI 层次结构中的位置或它具有的其他属性来定位元素。Sencha WebTestIt 支持以下选择器策略

  • XPath – XPath 策略允许您分层遍历 HTML 文档。它基于这样一个事实,即 HTML 结构的每一层都类似于文件系统中的文件夹结构。因此,您可以从上到下遍历文档以查找元素。在此处 查找 XPath 的示例和教程
  • CSS – 您可以使用元素的样式描述来在 UI 中找到它。CSS 选择器基本上与您用于定义网站或应用程序样式的相同。您可以在此处 找到 CSS 的示例
  • link-text – 一个非常简单的策略是 link-text。它扫描应用程序中 <a> 标记的内容,并搜索完全或部分匹配。请注意,这仅适用于超链接。

提示

建议的元素选择器顺序为 id >name > CSS > XPath。请记住这一点,以便为您的测试生成强大的选择器。

您可以使用不同的方法来创建选择器。Google Chrome 等浏览器使您能够从其开发工具中将选择器复制到剪贴板。

Sencha WebTestIt 中的元素选项卡

元素选项卡用于管理页面对象中的元素和选择器。它与当前打开的页面对象同步。

1 + 按钮 单击以创建新元素+ 按钮,单击以创建新元素。

2 元素: 单击名称以展开元素的属性

  • 名称: 在代码中引用时元素的名称。
  • 选择器: 用于查找元素的选择器。
  • 策略: 用于查找元素的选择器策略。

3 屏幕截图指示器: 如果启用,则表示此元素有可用的屏幕截图。将鼠标悬停在此指示器上以查看屏幕截图。单击以打开屏幕截图。

4 代码引用: 单击以跳转到代码中元素的定义。

5 删除按钮: 单击以删除元素。仅当元素未在项目中的任何位置使用时,此操作才有效。

6 关闭按钮: 单击以关闭元素的详细信息。

手动添加元素

若要将新元素添加到当前活动的页面对象文件,请按照以下说明进行操作

  1. 单击+ 按钮。
  2. 在新创建的元素存根中

    1. 提供名称
    2. 填写选择器
    3. 选择要使用的策略
    4. 单击关闭按钮。

管理 CSS 策略的多个选择器

如果您使用 CSS 作为策略,则可以指定多个选择器来识别 SUT 中的元素。您会注意到有一个附加选择器字段。如果需要,您可以单击+ 以添加更多选择器。您可以单击 以删除该行中的选择器。

文件同步

Sencha WebTestIt 中的元素选项卡与页面对象文件同步。作为使用 UI 的替代方法,您可以直接编辑页面对象文件。在您键入时,更改将反映回元素选项卡。

手动提供屏幕截图

您可以为手动和/或自动生成元素提供自己的屏幕截图。项目结构中有一个 screenshots 文件夹,其中包含自动生成的所有屏幕截图。您可以在此文件夹中提供自己的屏幕截图,或指定其他位置。

提示

如果您在项目中看不到 screenshots 文件夹,请单击项目选项卡中的 按钮以显示所有文件。如果您仍然看不到该文件夹,则是因为您还没有任何屏幕截图。在这种情况下,手动创建文件夹。

为元素添加屏幕截图

  1. 在页面对象源代码中找到元素。

  2. 在元素上方添加装饰注释:// 附加数据:{"img":"your/path/your_filename.png"}

  3. 用屏幕截图的实际位置替换 your/path/your_filename.png

  4. 如果图像文件的路径可以成功解析,Sencha WebTestIt 将立即激活您刚刚编辑的元素的屏幕截图指示器。

WebTestIt