许多类在使用配置对象创建(实例化)类时都有快捷名称。快捷名称被称为 别名
(如果类扩展了 Ext.Component,则称为 xtype
)。别名/xtype 列在适用类的类名旁边,以便快速参考。
框架类或其成员可以指定为 private
或 protected
。否则,类/成员是 public
。Public
、protected
和 private
是访问描述符,用于传达应如何以及何时使用类或类成员。
Public 类和类成员可供任何其他类或应用程序代码使用,并且在主要产品版本中可以作为稳定和持久的内容依赖。公共类和成员可以通过子类安全地扩展。
Protected 类成员是稳定的 public
成员,旨在由拥有类或其子类使用。受保护的成员可以通过子类安全地扩展。
Private 类和类成员在框架内部使用,不供应用程序开发人员使用。私有类和成员可能会随时更改或从框架中省略,恕不另行通知,并且不应在应用程序逻辑中依赖。
static
标签。*请参阅下面的静态。下面是一个示例类成员,我们可以对其进行剖析以显示类成员的语法(在本例中是从 Ext.button.Button 类查看的 lookupComponent 方法)。
让我们看一下成员行的每个部分
lookupComponent
)( item )
)Ext.Component
)。对于除了 undefined
之外不返回任何内容的方法,可以省略此项,或者可以显示为由正斜杠 /
分隔的多个可能值,表示返回的内容可能取决于方法调用的结果(即,如果 get 方法调用成功,方法可能会返回 Component,如果失败,则返回 false
,这将显示为 Ext.Component/Boolean
)。PROTECTED
- 请参阅下面的标志部分)Ext.container.Container
)。如果成员源自当前类,则源类将显示为蓝色链接,如果它从祖先类或混合类继承,则显示为灰色。view source
)item : Object
)列出。undefined
以外的值,则“返回值”部分将注释返回的类或对象类型以及描述(示例中为 Ext.Component
)Available since 3.4.0
- 示例中未显示),紧随成员描述之后Defaults to: false
)API 文档使用许多标志来进一步传达类成员的功能和意图。标签可以由文本标签、缩写或图标表示。
classInstance.method1().method2().etc();
false
,则标记为可阻止的事件将不会触发- 表示框架类
- Singleton 框架类。*有关更多信息,请参阅 singleton 标志
- 组件类型的框架类(Ext JS 框架中扩展 Ext.Component 的任何类)
- 表示类、成员或指南在当前查看的版本中是新的
- 表示类型为 config
的类成员
- 表示类型为 property
的类成员
- 表示类型为 method
的类成员
- 表示类型为 event
的类成员
- 表示类型为 theme variable
的类成员
- 表示类型为 theme mixin
的类成员
- 表示类、成员或指南在当前查看的版本中是新的
在 API 文档页面的类名正下方是一行按钮,这些按钮对应于当前类拥有的成员类型。每个按钮都显示按类型划分的成员计数(此计数会在应用过滤器后更新)。单击按钮将导航到该成员部分。将鼠标悬停在成员类型按钮上将显示该类型的所有成员的弹出菜单,以便快速导航。
Getter 和 setter 方法与类配置选项相关联,它们将显示在方法部分以及 API 文档和成员类型菜单的配置部分中,就在它们所作用的配置下方。getter 和 setter 方法文档将在配置行中找到,以便于参考。
您的页面历史记录保存在本地存储中,并显示在顶部标题栏正下方(使用可用的实际空间)。默认情况下,仅显示的搜索结果是与您当前查看的产品/版本匹配的页面。您可以通过单击历史记录栏右侧的 按钮并选择“全部”单选选项来展开显示的内容。这将显示历史记录栏中所有产品/版本的所有最近页面。
在历史记录配置菜单中,您还将看到最近页面访问的列表。结果按“当前产品/版本”和“全部”单选选项过滤。单击 按钮将清除历史记录栏以及本地存储中保存的历史记录。
如果在历史记录配置菜单中选择“全部”,“在历史记录栏中显示产品详细信息”的复选框选项将启用。选中后,每个历史页面的产品/版本将与历史记录栏中的页面名称一起显示。将光标悬停在历史记录栏中的页面名称上也会将产品/版本显示为工具提示。
可以使用页面顶部的搜索字段搜索 API 文档和指南。
在 API 文档页面上,还有一个过滤器输入字段,该字段使用过滤器字符串过滤成员行。除了按字符串过滤外,您还可以按访问级别、继承和只读过滤类成员。这是通过使用页面顶部的复选框完成的。
API 类导航树底部的复选框过滤类列表,以包含或排除私有类。
单击空的搜索字段将显示您最近 10 次搜索,以便快速导航。
每个 API 文档页面(JavaScript 原始类型页面除外)都有一个与该类相关的元数据菜单视图。此元数据视图将具有以下一项或多项
Ext.button.Button
类具有 Ext.Button
的备用类名)。备用类名通常为了向后兼容性而维护。可运行示例 (Fiddles) 默认在页面上展开。您可以使用代码块左上角的箭头单独折叠和展开示例代码块。您还可以使用页面右上角的切换按钮切换所有示例的折叠状态。切换所有状态将在页面加载之间记住。
类成员默认在页面上折叠。您可以使用成员行左侧的箭头图标或全局使用右上角的展开/折叠所有切换按钮来展开和折叠成员。
在较窄的屏幕或浏览器上查看文档将导致针对较小外形尺寸优化的视图。桌面和“移动”视图之间的主要区别是
可以通过单击 API 文档页面顶部的类名来查看类源代码。可以通过单击成员行右侧的“查看源代码”链接来查看类成员的源代码。
Sencha Test 提供了一个名为“结果归档服务器”的组件。这是可以存储测试结果以供稍后通过 Sencha Test Studio GUI 查看的区域。
要设置归档服务器,必须创建一个名为 storage.json
的配置文件。此文件必须包含一个或多个存储区域定义。
存储区域定义为一个属性,其名称是用户需要知道的键,以便存储结果。该值是一个对象,其中包含其归档文件将存储在相对于服务器根目录的物理路径。
这是一个示例存储区域。
{
"my_storage_key": {
"path": "/mystoragearea"
}
}
注意:用户必须知道键 my_storage_key
,才能在指定服务器上的 /mystoragearea
下的归档文件中存储测试结果。键本身可以是任何值。
这些路径可能包含多个目录级别。这些路径不包含任何特殊含义。服务器管理员可以查看这些路径,以便组织测试结果归档和/或提供跨团队和项目的隔离。键是自由格式的字符串。
在以下示例中,存储区域按团队分隔。每个团队(在本例中为开发人员和 QA)都需要知道他们的密钥,以便将结果存储在各自的存储区域中。
{
"889jwx093jr8wuwer": {
"path": "/developers"
},
"sccmnn840394843": {
"path": "/qa"
}
}
在下一个示例中,团队为他们的每个项目隔离了存储区域。
{
"879fnas9d8jf70sd": {
"path": "/TeamA/project1"
},
"mx348r343mr34cj": {
"path": "/TeamA/project2"
},
"sdnaaa090ilss": {
"path": "/TeamB/project1"
}
}
要启动结果归档服务器,请在专用目录中创建一个 storage.json
文件,并从那里,从您的 CLI 运行以下命令
stc server
然后您应该看到成功消息
Archive server listening on port 1903
这是一个关于如何在机器上设置归档服务器的示例
mkdir archiveserver
cd archiveserver
vim storage.json #configure storage areas - see examples above
stc server
为了将结果归档发送到配置的归档结果服务器,您可以将以下开关与 stc run
一起使用。
-S <server_address>
- 归档服务器地址。例如,如果归档服务器主机 IP 地址为 192.168.1.42
,则该值将为 http://192.168.1.42:1903(包括端口号)。
-K <key>
- 存储区域的密钥。要在 /TeamA/project2
中存储结果(以上示例),该值将为 mx348r343mr34cj
。
在以下示例中,我们正在
tests\unit_tests
的结果teamcity
My WebDriver Pool
的池中192.168.1.42:1903
上的归档服务器上,端口为 1903
mx348r343mr34cj
示例
stc run -o teamcity -p "My WebDriver Pool" -s tests\unit_tests -S http://192.168.1.42:1903 -K mx348r343mr34cj
在服务器上成功存储结果后,预计输出类似于以下内容
Uploading archive to https://127.0.0.1:1903
Server response: 200 - Archive received
user:~$
Client: successfully uploaded test result archive
Receiving archive 28ea1080-a2a5-11e5-ac7d-51ab7d509196.zip
Archive 28ea1080-a2a5-11e5-ac7d-51ab7d509196.zip extracted to /home/user/archiveserver/TeamA/project2/foo/orion/28ea1080-a2a5-11e5-ac7d-51ab7d509196
Server: successfully received test result archive
单个测试项目通常具有多个场景。在这些情况下,您可能希望将多个场景作为 CI 系统中的单个“构建”的一部分运行。这使您可以在 Sencha Studio 中将所有场景结果视为单个结果集。
例如,您可能具有场景 A 和场景 B,并且您希望在每次合并代码时都运行这两个场景。
一旦所有场景完成,归档服务器将合并来自场景 A 和 B 的结果,然后 Sencha Studio 可以将聚合结果显示为一个逻辑构建或测试运行编号。
Sencha Test 使您能够以两种不同的方式合并测试结果。
在此方法中,您需要将 allowOverwrite 键添加到您的配置中。例如
{
"multiscenario": {
"path": "/multiscenario",
"allowOverwrite": true
}
}
您还可以将 overwrite 标志添加到您的 STC 命令中。例如
stc run -s Dashboard -p embedded -S https://127.0.0.1:1903 -K multiscenario -n 6 --overwrite