文档帮助

术语、图标和标签

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

访问级别

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

成员类型

成员语法

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

lookupComponent ( item ) : Ext.Component
protected

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

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

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

参数

item :  Object

正在添加的配置对象。

返回
Ext.Component

要添加的组件。

我们来看看成员行的每一部分

成员标志

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

类图标

- 表示框架类

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

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

展开和折叠示例和类成员

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

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

桌面 -vs- 移动视图

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

查看类源

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

Sencha Inspector


顶部

演示应用检查

如果你按照连接演示应用指南进行操作,则现在应该在 Sencha Inspector 中显示 DemoClient 应用程序。

Inspector Demo Client

单击 Demo Client 以对其进行检查。这将打开检查窗口。

Open Inspection Window

查找应用详情

在我们深入研究应用程序本身之前,让我们先了解一些基本信息。

单击最后一个选项卡“应用详情”,你应该会看到以下内容

  • 浏览器和版本。

  • Ext JS、Toolkit 和 Cmd 版本。

  • 其他信息,如主题、许可证等。

这是提交支持工单、在 Sencha 论坛中提问或仅仅确认你对应用程序可能有的某些假设时至关重要的信息。

探索组件树

接下来,单击第一个选项卡“组件”。

在左侧,你应该会看到应用程序中当前可用的所有组件。在右侧,你将看到每个所选组件的属性、方法和其他信息。

在大多数情况下,你将希望在树中找到特定组件。你可以手动深入树中,或使用筛选框搜索组件的 ID 或 xtype。

你甚至可以使用预定义的筛选器来查找特定内容,例如查找存在布局问题的组件或查找使用 ViewModel、ViewController 或数据绑定的组件。

让我们浏览几个示例。

筛选布局错误

例如,应用程序包含 feedlist 类(DemoClient.view.feed.List)的一个实例。此类演示了过度嵌套的布局。

要找到它,请选择“布局错误”的预定义筛选器。接下来,深入树中以查找 xtype 为 feedlist 的组件,其布局以红色突出显示。

Layout Error

将鼠标悬停在高亮显示的文本上以查看错误。您应该会看到一个简要说明,解释为什么此组件在布局中报告错误。

在此特定情况下,feedlist 是一个使用“fit”布局的组件。但是,如果您清除过滤器,您会注意到它的唯一子项是一个 grid。Sencha Inspector 只是指出 feedlist 正在包装一个 grid,而没有添加任何其他布局功能。这通常表明 grid 可能嵌套过多)。

注意:Sencha Inspector 识别可能导致已知性能或布局问题的模式。这并不总是意味着实际存在问题。

过滤 VM、VC 和数据绑定

接下来,让我们使用过滤器框来查找 feedpost 的实例。单击树中的组件,然后开始探索其 ViewController。

View Controllers

如果您使用文本“foo”过滤组件的详细信息,您会看到 fooBar() 列在 ViewController 面板下。您可能会注意到它的颜色与 ViewController 方法列表中的其他项目不同。它以绿色文本显示,因为此方法是在此类上定义的。如果它是从父类继承的,它将以不同的方式显示。

接下来,清除过滤器并打开 ViewModel 面板。您会注意到 ViewModel 上定义的几个属性遇到错误。例如,“link”尚未分配值!

如果您打开数据绑定面板,您会看到另一个错误。在这种情况下,绑定到“collapsible”的值是 {feeed}。正如您所看到的,此绑定拼写错误,因为它应该是 {feed}

存储

接下来,让我们单击“存储”选项卡。

在左上角,您应该看到应用程序中当前可用的存储。从列表中选择一个存储。

您现在可以探索存储的基本配置、模型和代理信息。在左下角的网格中,您可以选择一个记录,然后在右下角的网格中探索其原始数据。

布局

接下来,单击“布局运行”选项卡。

单击“监视”,然后切换到浏览器。开始与应用程序进行交互。当您返回 Sencha Inspector 时,您应该看到已记录了几个布局运行。

在 Ext JS 中,页面和组件布局由框架使用 JavaScript 管理。任何时候添加、删除或调整组件大小时,框架都需要重新计算布局。显而易见的影响是,如果框架需要花费很长的 CPU 周期来重新计算组件的大小和位置,则可能会出现性能问题。

打开一个布局运行,您可以准确地看到受影响的组件。您甚至可以选择一个具有 xtype 的组件并单击“显示”。这将为您提供有关树中组件的更多信息。

事件

接下来,单击“事件”选项卡。

类似地,Sencha Inspector 还允许您在应用程序运行时监视事件触发。

单击“监视”,然后切换到浏览器。开始与应用程序进行交互,然后返回 Sencha Inspector。您应该看到已记录了各种事件。这些都是应用程序中触发的事件,包括组件和 Ext.Element 事件。

当您与应用程序进行交互时,许多事件将触发。您可以通过选择“过滤鼠标事件”来过滤掉很多噪音,这将隐藏“itemmouseenter”、“mouseout”等事件。

架构

最后,单击“应用程序架构”选项卡。

通常,了解在任何给定时间应用程序中是否已加载某些类非常有用。您可以通过手动展开树或过滤列表来探索应用程序架构。

学习路径

Sencha Inspector