许多类在使用配置对象创建(实例化)类时都有快捷名称。快捷名称被称为 别名
(如果类扩展了 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
,则标记为可阻止的事件将不会触发- 表示框架类
- Singleton 框架类。*有关更多信息,请参阅 singleton 标志
- 组件类型框架类(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 Themer 最有用的功能之一是它能够创建主题存档,该存档可以与其他用户共享,然后可以应用于任何 Ext JS 6+ 应用程序。在本指南中,我们将逐步介绍导出和导入主题所需的步骤。我们还将讨论将主题应用于应用程序的可用选项。
Themer 中有两种类型的导出器:Package 和 CSS。一般来说,“Package”用于使用 Sencha Cmd 构建的 ExtJS 应用程序中,而“CSS”用于不使用 Cmd 时。
一旦您对您的主题感到满意,请单击 Publish -> Export Theme Package...
。然后您将看到一个文件对话框,允许您将主题 zip 文件保存到您的计算机。
主题实际上是本地 Ext JS 包,因此 Themer 生成的存档包含标准的 Ext JS 包文件夹结构以及您的主题设置。
注意: 您可以在我们的 Cmd 文档中阅读更多关于包结构的信息。
此文件现在可以与其他用户共享、添加到工作区并应用于应用程序。
要导入主题,请解压缩导出的存档,并将其放置在您的工作区或应用程序的 packages/local
文件夹中。
如果您尚未向您的工作区或应用程序添加任何包,您可能不会在“packages”中找到“local”文件夹。在这种情况下,您可以简单地创建一个名为“local”的文件夹,并将解压缩的主题存档放在其中。
一旦您将主题放置在您的应用程序或工作区的 packages/local 目录中,您就可以从 Themer 中将其应用于应用程序。只需选择“Publish”菜单,然后选择“Apply theme to app(s)”。然后您可以选择要应用主题的应用程序。
您也可以手动将主题应用于您的应用程序。
您可以通过修改应用程序的 app.json
文件将主题应用于应用程序。您只需要修改 theme
值以指向您的新自定义主题。
例如,您的主题可能默认设置为“theme-triton”。如果您的主题名为“theme-foo”,您只需将 theme
值更改为“theme-foo”。
如果您使用的是通用应用程序,则需要更改在“builds”对象中找到的 theme 值。
添加后,您可以通过运行“sencha app watch”来验证主题是否已应用。
可以通过选择 Publish -> Export CSS...
来实现导出为 CSS。这将构建主题包及其所有资源(图像、字体等),并提供构建工件的压缩目录。要将主题应用于您的 ExtJS 应用程序,只需将文件夹解压缩到您的 Web 服务器提供服务的位置,然后将相关的 CSS 文件包含在您的 index.html 中。
注意: 此导出无法使用 Themer 重新打开,因为它是一个已构建版本的主题。请确保安全地保存原始主题包,以便您可以继续使用 Themer 编辑/维护主题。