许多类在使用配置对象创建(实例化)类时都有快捷名称。快捷名称被称为 alias
(别名)(如果类扩展了 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
,则标记为可阻止的事件将不会触发- 表示框架类
- 单例框架类。*有关更多信息,请参阅单例标志
- 组件类型框架类(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 Inspector 可用于检查在容器(例如 Sencha Web Application Manager)内部或移动浏览器中运行的移动应用。
第一步是配置您的应用程序,使其可以连接到 Sencha Inspector。为此,请打开您的应用程序的 app.json
文件并找到“js”数组。接下来,编辑它以包含以下行
"js" : [
..//existing scripts
{
// Use your Machine Name
"path" : "http://MyComputerName:1839/inspector.js",
// Or Use your IP Address
//"path" : "http://123.456.78.90:1839/inspector.js",
"remote" : true,
"bootstrap" : true
}
]
请注意,当调试在远程设备上运行的应用程序时,我们不能使用 http://local.senchainspector.com
作为我们的“path”。这是因为 http://local.senchainspector.com
只是 localhost
的别名。Localhost 始终指向运行应用程序的设备,而 Sencha Inspector 未在远程设备上运行。
将此配置添加到 app.json
后,您还需要将初始化代码添加到您的应用程序。找到 {appRoot}/app/Application.js
,然后修改它以包含 launch()
方法的逻辑,如下例所示
//Do not modify entire Application.js - "DemoClient" is just an example name
Ext.define('DemoClient.Application', {
extend: 'Ext.app.Application',
name: 'DemoClient',
stores: [
'Users'
],
//Add Sencha Inspector init to launch function
launch: function () {
// <debug>
SenchaInspector.init('http://MyComputerName:1839');
// URL needs to match what you defined in app.json
// </debug>
}
});
请注意,我们将对 init()
的调用包装在调试标志内。Sencha Cmd 将在生产构建期间忽略调试块之间的所有代码。
Sencha Inspector 托管一个内部 Web 服务器,该服务器在您机器的 localhost 上运行。此本地 Web 服务器帮助 Sencha Inspector 通过 Web 套接字连接到您的客户端应用程序。这也意味着任何可以连接到您机器的 localhost 的应用程序都可以通过 Sencha inspector 进行分析。
以下设置通常允许应用程序连接到主机操作系统的 localhost
此外,当计算机和移动设备连接到同一 WIFI 网络(并且在同一子网中)时,移动设备可以通过其机器名称或 IP 地址访问远程计算机的 localhost
http://{remote_machine_name_here}:1839/ (例如 http://artmac:1839/ )
http://{remote_machine_ip_here}:1839/ (例如 http://192.168.14.10:1839/ )