文档帮助

术语、图标和标签

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

访问级别

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

成员类型

成员语法

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

lookupComponent ( item ) : Ext.Component
受保护

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

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

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

参数

item :  对象

要添加的配置对象。

返回
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 基本类型页面除外)都有一个与该类相关的元数据的菜单视图。此元数据视图将包含以下一个或多个

展开和折叠示例和类成员

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

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

桌面与移动视图

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

查看类源

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

Themer 1.4.4


顶部

共享主题

Sencha Themer 最有用的部分之一是它能够创建主题存档,可以与其他用户共享,然后可以将该存档应用于任何 Ext JS 6+ 应用程序。在本指南中,我们将逐步介绍导出和导入主题所需的步骤。我们还将讨论将主题应用于应用程序的可用选项。

导出主题

Themer 中有两种类型的导出器:包和 CSS。一般来说,“包”用于使用 Sencha Cmd 构建的 ExtJS 应用程序,而“CSS”用于使用 Cmd 时。

Sencha 包

对主题感到满意后,单击发布 -> 导出主题包...。然后,您将看到一个文件对话框,允许您将主题 zip 文件保存到您的计算机。

主题实际上是本地 Ext JS 包,因此 Themer 生成的存档包含标准 Ext JS 包文件夹结构以及您的主题设置。

注意:您可以在我们的Cmd 文档中阅读有关包结构的更多信息。

此文件现在可以与其他用户共享、添加到工作区并应用于应用程序。

导入主题

要导入主题,请解压导出的存档,并将其放置在工作区或应用程序的 packages/local 文件夹中。

如果您尚未向工作区或应用程序添加任何包,则“packages”中可能没有“local”文件夹。在这种情况下,您可以简单地创建一个名为“local”的文件夹,并将解压的主题存档放置其中。

应用共享主题

将主题放置在应用程序或工作区的 packages/local 目录中后,您可以从 Themer 中将其应用到应用程序。只需选择“发布”菜单,然后选择“将主题应用到应用程序”。然后,您可以选择要将主题应用到的应用程序。

您还可以手动将主题应用到应用程序。

手动应用主题

您可以通过修改应用程序的 app.json 文件将主题应用到应用程序。您只需修改 theme 值,使其指向您新的自定义主题即可。

例如,您的主题可能默认设置为“theme-triton”。如果您的主题名为“theme-foo”,则只需将 theme 值更改为“theme-foo”即可。

如果您使用的是通用应用程序,则需要更改“builds”对象中找到的主题值。

添加后,您可以通过运行“sencha app watch”来验证是否已应用该主题。

CSS

可以通过选择 发布 -> 导出 CSS... 来实现导出为 CSS。这将构建主题包及其所有资产(图像、字体等),并提供构建工件的压缩目录。要将主题应用到您的 ExtJS 应用程序,只需将文件夹解压缩到 Web 服务器提供的某个位置,然后在 index.html 中包含相关的 CSS 文件即可。

注意:此导出无法使用 Themer 重新打开,因为它是一个已构建的主题版本。确保您安全地保留原始主题包,以便您可以继续使用 Themer 编辑/维护主题。

Themer 1.4.4