文档帮助

术语、图标和标签

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

访问级别

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

成员类型

成员语法

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

lookupComponent ( item ) : Ext.Component
protected

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

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

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

参数

item :  Object

正在添加的配置对象。

返回值
Ext.Component

要添加的组件。

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

成员标志

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

类图标

- 表示框架类

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

- 组件类型框架类(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”链接来查看类成员的源代码。

WebTestIt


顶部

使用 Sencha WebTestIt 代码片段

我们正在构建 Sencha WebTestIt 以加快您的速度。当您将页面对象、测试甚至只是辅助类放在一起时,您不想一遍又一遍地编写相同的代码。为了帮助您解决这个问题,Sencha WebTestIt 附带了大量的代码片段,在本文中,我们将向您展示如何使用其中的一些代码片段并找到更多。

注意

本文中指定的所有键盘快捷键均假定为默认设置。可以通过 帮助 → 键盘快捷键 更改键绑定。

代码片段简介

代码片段是(通常很小的)代码片段,很可能在整个项目中多次使用。例如,当您要创建测试时,您希望每次都实例化一个页面对象实例。对于页面对象,您需要创建新操作并使用步骤填充它们。

代码片段消除了记忆和重复输入相同代码(或复制粘贴)的枯燥工作。让我们看一些例子

创建操作和使用元素

在页面对象文件中,创建页面对象操作并使用步骤(例如“单击”或“悬停”)填充它们。虽然您可以使用我们的拖放功能来实现此目的,但您可以使用代码片段节省一些时间。

要创建新操作,请在类主体中的某个位置开始键入 newAction,并在建议中找到相应的代码片段。键盘快捷键 Ctrl+I →Ctrl+A (⌘I → ⌘A on Mac) 也有效。

要在操作内部使用元素,请在操作方法中开始键入要使用的元素的名称。例如,如果您想“单击”名为 checkOutButton 的元素,请键入 checkOutButton_click,代码片段应出现在您的自动完成建议中。

创建测试存根和实例化页面对象

在测试文件中,您将创建大量测试。只需将光标放在测试类的主体 (Java) 或 describe 块 (TypeScript) 中,然后开始键入 newTest。或者,您可以使用键盘快捷键 Ctrl+I → Ctrl+T (⌘I → ⌘T on Mac)。

创建测试存根后,您可以在内部键入 initPo。此代码片段创建您选择的页面对象类的实例,并使用您指定的 URL 调用“open”函数。键盘快捷键 Ctrl+I → Ctrl+P (⌘I → ⌘P on Mac) 执行相同的操作。

通用代码片段

如果您使用过其他 IDE,您会期望无论上下文如何,都可以使用某些代码片段。例如 try/catch、if/else 或各种类型的循环。当然,Sencha WebTestIt 也为您考虑到了。只需开始键入关键字,例如 trycatchifelse

“填写”您的代码片段

您可能已经注意到,新插入的代码片段的某些部分已突出显示。欢迎使用代码片段的交互模式。在此模式下,您可以按 Tab 键在这些框之间切换(Shift+Tab 向后移动),以像填写表格一样填写代码片段。

借助此功能,连续多次插入相同的代码片段应该很容易,只是每次的值都不同。

使用上下文菜单和自动完成功能探索代码片段

这些只是您可以在 Sencha WebTestIt 中找到的一些代码片段示例。我们正在不断添加更多像这样的有用代码片段。

根据经验,您可以在右键单击上下文菜单中找到其中一些代码片段,甚至可以在自动完成建议中找到更多代码片段,可通过 Ctrl+. (⌘. on Mac) 访问。

结论

阅读本文后,您将熟悉代码片段、如何使用它们以及如何找到它们。这应该有助于您更有效地编写页面对象和测试。

WebTestIt