文档帮助

术语、图标和标签

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

访问级别

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

成员类型

成员语法

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

lookupComponent ( item ) : Ext.Component
protected

当原始配置对象在 items 配置的初始化期间添加到此容器,或者当新项目 added) 或 {@link #insert inserted} 时调用。

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

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

参数

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) 默认在页面上展开。您可以使用代码块左上角的箭头单独折叠和展开示例代码块。您还可以使用页面右上角的切换按钮切换所有示例的折叠状态。切换所有状态将在页面加载之间记住。

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

桌面 -vs- 移动视图

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

查看类源代码

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

Themer 1.4.4


顶部

将 Themer 连接到您的应用程序

从 Themer 1.1.0 开始,您可以将 Themer 与现有应用程序连接,并实时查看对应用程序中自定义主题所做的更改。您无需更改创建应用程序或自定义主题的方式即可利用此功能。

支持的浏览器

目前,以下浏览器支持使用 Themer 检查应用程序

  • Google Chrome
  • Mozilla Firefox
  • Microsoft Edge*
  • Safari*

* 这些浏览器不支持从浏览器窗口启用/禁用检查(Cmd/Ctrl + I)。

建立连接

一旦您在 Themer 中创建了应用程序和自定义主题,请按照以下步骤将您的应用程序连接到 Themer

  1. 复制下面的配置对象并将其添加到应用程序的 app.json 文件中的“js”块

     {
         "path": "https://:8900/resources/themer/js/themerInspect.js",
         "remote": true,
         "bootstrap": true
     }
    
  2. 从您的终端/命令行 CD 进入您的应用程序目录并运行

     "sencha app watch -fashion"
    

    注意: 确保您运行的是 Cmd 6.2.0 或更高版本

  3. 当运行“sencha app watch -fashion”时,您会看到类似这样的行

     [INF] Application available at [https://:1841](https://:1841)
    

    在您的浏览器中访问 https://:1841(使用 app watch 进程指示的应用程序位置,因为端口可能不同 - 为了方便起见,我们将在本指南中继续引用端口 1841)。

  4. 您的应用程序和 Themer 现在应该已连接。您可以在 Themer 中确认与应用程序的连接。在 Themer 中,单击“查看 > 已连接的应用程序”。“已连接的应用程序”对话框现在应显示类似以下内容

    Sencha 应用程序: https://:1841

您的应用程序现在已在浏览器中与 Themer 同步。您可以连接同一网络上的其他浏览器,以同时查看更改发生在多个浏览器/平台上。当您连接其他浏览器时,连接将更新并在“已连接的应用程序”窗口中反映出来。

实时更新

现在您的应用程序已连接到 Themer,您在 Themer 中对自定义主题所做的更改将实时反映在您的浏览器窗口中(或您指向 https://:1841 的尽可能多的浏览器中)。尝试在 Themer 的“主题默认值”视图中更改基本颜色。

当颜色更改时,连接的浏览器中的应用程序将与 Themer 中的组件视图一起更新。Themer 中支持的任何组件的各个方面都可以更新,更改会实时反映在您连接的应用程序中。

轻松的应用检查

除了更改 Themer 中任何可用的组件外,您还可以直接在自己的应用程序中检查组件。

要在应用程序中检查组件,首先单击 Themer 中的“检查”按钮(或者,您可以在 Themer 或应用程序窗口聚焦的情况下使用热键 Ctrl-i / Command-i)。Themer 现在将显示“正在浏览器中检查应用程序”。在“检查”选项处于活动状态的情况下,将光标悬停在应用程序中的组件上。符合主题设置条件的组件将以红色虚线轮廓框起来。

单击符合条件的组件将以红色突出显示该组件,并在 Themer 中显示其主题设置选项。以这种方式对主题所做的更改将应用于主题本身,并在您的应用程序中实时更新,就像您在 Themer 中单独进行更改一样。

要关闭“检查”选项,您可以单击 Themer 中的“检查”按钮或按 Ctrl-i / Command-i。当您将鼠标悬停在应用程序中的组件上时,您将不再看到以红色突出显示的组件。

断开/重新连接您的应用

您可以关闭任何连接的应用程序窗口/选项卡以将其与 Themer 断开连接。

重新进入 https://:1841 将随时将应用程序重新连接到 Themer。您可以通过选择“查看 > 已连接的应用程序”来验证 Themer 中的连接。要断开 Themer 与任何和所有打开的应用程序窗口的连接,您可以通过在命令行中按 Ctrl-c / Command-c 来停止“sencha app watch -fashion”进程。

Themer 1.4.4