文档帮助

术语、图标和标签

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

访问级别

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

成员类型

成员语法

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

lookupComponent ( item ) : Ext.Component
受保护

在初始化items配置期间或添加新项目时将原始配置对象添加到此容器时调用,或者添加或{@link #insert 插入}

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

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

参数

item :  Object

正在添加的配置对象。

返回
Ext.Component

要添加的组件。

我们来看看成员行中的各个部分

成员标志

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

类图标

- 表示框架类

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

- 组件类型框架类(Ext JS 框架内任何扩展 Ext.Component 的类)

- 表示类、成员或指南在当前查看版本中是新的

成员图标

- 表示类型为 config 的类成员

- 表示类型为 property 的类成员

- 表示类型为 method 的类成员

- 表示类型为 event 的类成员

- 表示类型为 theme variable 的类成员

- 表示类型为 theme mixin 的类成员

- 表示类、成员或指南在当前查看版本中是新的

类成员快速导航菜单

在 API 文档页面中类名称正下方是与当前类拥有的成员类型相对应的按钮行。每个按钮按类型显示成员数(此计数在应用筛选器时会更新)。单击按钮将导航到该成员部分。将鼠标悬停在成员类型按钮上将显示一个弹出菜单,其中包含该类型的所有成员,以便快速导航。

Getter 和 Setter 方法

与类配置选项相关的 Getting 和 Setter 方法将显示在方法部分以及 API 文档和成员类型菜单的配置部分中,它们位于所处理配置的正下方。Getter 和 Setter 方法文档将位于配置行中,以便于参考。

历史记录栏

您的页面历史记录保存在 localstorage 中,并显示在顶部标题栏正下方(使用可用空间)。默认情况下,显示的唯一搜索结果是与您当前查看的产品/版本匹配的页面。您可以通过单击历史记录栏右侧的 按钮并选择“全部”单选选项来展开显示内容。这将在历史记录栏中显示所有产品/版本的所有近期页面。

在历史记录配置菜单中,您还将看到近期页面访问列表。结果按“当前产品/版本”和“全部”单选选项进行筛选。单击 按钮将清除历史记录栏以及保存在本地存储中的历史记录。

如果在历史记录配置菜单中选择了“全部”,则“在历史记录栏中显示产品详细信息”复选框选项将启用。选中后,每个历史页面的产品/版本将与历史记录栏中的页面名称一起显示。将光标悬停在历史记录栏中的页面名称上也将以工具提示的形式显示产品/版本。

搜索和筛选器

可以使用页面顶部的搜索字段搜索 API 文档和指南。

在 API 文档页面上,还有一个筛选器输入字段,它使用筛选器字符串筛选成员行。除了按字符串筛选外,您还可以按访问级别、继承和只读筛选类成员。这是使用页面顶部的复选框完成的。

API 类导航树底部的复选框筛选类列表以包括或排除私有类。

单击空搜索字段将显示您最近的 10 次搜索,以便快速导航。

API 文档类元数据

每个 API 文档页面(Javascript 原语页面除外)都有一个与该类相关的元数据的菜单视图。此元数据视图将具有以下一项或多项

展开和折叠示例和类成员

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

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

桌面 -vs- 移动视图

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

查看类源

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

Sencha Inspector


顶部

检查移动应用

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 用作我们的“路径”。这是因为 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 套接字连接到客户端应用。这也意味着 Sencha Inspector 可以分析任何可以连接到机器 localhost 的应用。

在主机操作系统上运行的应用

以下设置通常允许应用连接到主机操作系统的 localhost

  • 在台式机上运行的移动模拟器(例如 Android 模拟器、iOS 模拟器)中的应用
  • 在桌面容器应用(例如 Sencha 的 Web Application Manager)中运行的应用

远程设备上的应用

此外,当计算机和移动设备连接到同一 WIFI 网络(并且位于同一子网上)时,移动设备可以通过其机器名称或 IP 地址访问远程计算机的 localhost

  • http://{remote_machine_name_here}:1839/(例如 http://artmac:1839/)

  • http://{remote_machine_ip_here}:1839/(例如 http://192.168.14.10:1839/)

学习路径

Sencha Inspector