文档帮助

内容

术语、图标和标签访问级别成员类型成员语法成员标志类图标成员图标导航和功能类成员快速导航菜单 Getter 和 Setter 方法历史记录栏搜索和过滤器 API 文档类元数据展开和折叠示例和类成员桌面 -vs- 移动视图查看类源代码

术语、图标和标签

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

访问级别

框架类或其成员可以指定为private或protected。否则，该类/成员为public。Public、protected和private是访问描述符，用于传达如何以及何时使用类或类成员。

Public 类和类成员可供任何其他类或应用程序代码使用，并且可以作为主要产品版本中稳定且持久的部分。公共类和成员可以通过子类安全地扩展。
Protected 类成员是稳定的public成员，旨在供拥有类或其子类使用。受保护的成员可以通过子类安全地扩展。
Private 类和类成员由框架内部使用，不打算供应用程序开发人员使用。私有类和成员可能会随时更改或从框架中删除，恕不另行通知，并且不应在应用程序逻辑中依赖它们。

成员类型

Config - 类的配置选项。
Property - 在实例化类后设置一次。*参见下面的只读。
Method - 类可以执行的操作。方法应被视为实例方法，并且只能从给定类的实例调用。可以直接从类本身调用的静态方法将在方法名称旁边有一个static标签。*参见下面的静态。
Event - 事件特定于框架事件系统，允许类以编程方式引发事件，以便由一个或多个事件处理程序方法处理。DOM 事件虽然由框架事件系统处理，但未在 API 文档中具体描述。*有关 DOM 事件，请参阅 MDN 的事件参考页面。
Theme Variable - 由框架使用的视觉主题引擎使用的变量。
Theme Mixin - 由框架使用的视觉主题引擎使用的函数，可以使用各种主题变量中设置的值。

成员语法

以下是一个示例类成员，我们可以对其进行分析以显示类成员的语法（在本例中，从 Ext.button.Button 类中查看 lookupComponent 方法）。

Ext.container.Container

查看源代码

lookupComponent ( item ) : Ext.Component

protected

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

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

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

参数

item : Object

要添加的配置对象。

返回值

Ext.Component

要添加的组件。

让我们看看成员行的每个部分

展开/折叠 - 在成员行的左侧是一个用于展开和折叠每个成员行以显示/隐藏成员详细信息的控件。
成员名称 - 类成员的名称（在本例中为 lookupComponent）
方法参数 - 方法使用的任何必需或可选参数（或传递给事件处理程序方法）将在方法名称后面的括号中列出（在本例中为 ( item )）
返回类型 - 方法或属性返回的类实例或 JavaScript 对象（在本例中为 Ext.Component）。对于不返回任何内容（除了 undefined）的方法，这可能会被省略，或者可能显示为用正斜杠 / 分隔的多个可能值，表示返回的内容可能取决于方法调用的结果（例如，如果 get 方法调用成功，方法可能会返回一个组件，或者如果失败则返回 false，这将显示为 Ext.Component/Boolean）。
标志 - 适用于成员的任何标志将显示在旁边（在本例中为 PROTECTED - 请参阅下面的标志部分）
成员来源 - 在成员行的右侧是最初描述成员的类（在本例中为 Ext.container.Container）。如果成员来自当前类，则源类将显示为蓝色链接，如果它从祖先类或混合类继承，则显示为灰色。
成员源代码 - 在成员来源类的右侧下方是一个用于查看成员源代码的链接（在本例中为 查看源代码）
参数列表 - 类方法的每个参数都将使用上面括号中找到的相同名称、预期类或对象的类型以及参数的描述列出（在本例中为 item : Object）。
返回值 - 如果类返回的值不是 undefined，则“返回值”部分将记录返回的类或对象的类型以及描述（在本例中为 Ext.Component）
自（示例中未显示） - 一些成员将显示成员首次引入的产品版本（例如 自 3.4.0 起可用 - 示例中未显示）在成员描述之后
默认值（示例中未显示） - 配置通常会显示应用于类实例的默认配置值，如果未覆盖（例如 默认值为：false）

成员标志

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

必需 - 实例化类时必需的配置
可绑定 - 配置有一个 setter，允许通过 ViewModel 绑定设置此配置
只读 - 属性可以读取，但不能用于在运行时配置/重新配置类实例
单例 - 单例类在定义后立即实例化，不能手动实例化
静态 - 静态方法或属性是属于类本身的方法或属性，而不是类的实例
可链式 - 指的是在调用时返回类实例的方法。
这使得可以进行链式方法调用，例如：classInstance.method1().method2().etc();
已弃用 - 计划在未来框架版本中删除的类或成员，并在当前版本中提供以实现向后兼容性。
已弃用的类和成员将有一条消息引导您使用未来的首选类/方法。
已删除 - 已删除的类或成员，仅在文档中存在，作为用户在框架版本之间升级的参考
模板 - 在基类中定义的方法，旨在被子类覆盖
抽象 - 类或成员可以定义为抽象。抽象类和成员建立类结构并提供有限的（如果有的话）代码。类特定的代码将通过子类中的覆盖提供。
可阻止 - 标记为可阻止的事件如果事件处理程序返回 false 则不会触发

类图标

- 表示框架类

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

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

别名 - 一个或多个附加的类名同义词（在 Ext JS 6.0.0 中，Ext.button.Button 类有一个别名为 Ext.Button）。别名通常为了向后兼容而维护。
层次结构 - 层次结构视图列出了当前类的继承链，一直到其祖先类，直到根基类。
Mixins - 混合到当前类的类列表
继承的 Mixins - 混合到当前类祖先的类列表
需要 - 实例化类所需定义的所有类
使用 - 类在其生命周期的某个时刻可能使用的类列表，但不一定需要实例化类。
子类 - 扩展当前类的类

展开和折叠示例和类成员

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

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

桌面 -vs- 移动视图

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

全局导航将位于左侧菜单中，可以通过汉堡菜单图标访问。菜单包含以下内容（在大多数页面上）
- 当前产品的名称（作为指向产品登录页面的链接）
- 用于导航回文档主页的 Sencha 图标
- 产品菜单下拉按钮
- API 文档和指南的导航树选项卡
当前上下文导航和工具位于右侧，可以通过齿轮图标访问。上下文菜单包含以下内容
- 全局搜索输入字段
- (API 文档) 一个“过滤器”选项卡，其中包含成员过滤器、展开/折叠所有示例按钮、展开/折叠所有成员行按钮、访问级别过滤器复选框以及每个成员的计数
- (API 文档) 一个“相关类”选项卡，其中包含与当前类相关的元数据菜单
- (指南) 指南的目录

查看类源代码

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

Cmd

显示私有类

顶部

内容

文件夹在应用程序中需要包本地包远程包本地仓库本地仓库的位置远程仓库包目录名称分配版本管理包版本版本限制解析版本

Sencha Cmd 包

Sencha Cmd 包含 Sencha 包管理器。包旨在解决两个基本问题：消费和分发。本指南重点介绍了这些主题。另请参阅创建 Sencha Cmd 包，了解有关创建和共享包的信息。

`"packages"` 文件夹

由 Sencha Cmd 生成的所有工作区在根目录下都有一个 "packages" 文件夹。此文件夹的位置可以配置，但无论其位置如何，"packages" 文件夹的作用都是作为工作区中所有应用程序（或其他包）使用的所有包的存储库。

packages/       # Container folder for shared Cmd packages
    local/      # Folder for packages generated in this workspace
    remote/     # Folder for packages downloaded into the workspace

当应用程序需要包并下载以满足要求时，包将被添加到 "packages/remote" 文件夹中。当生成包（使用 sencha generate package）时，它将被生成到 "packages/local" 中。

在应用程序中需要包

无论包的来源（是在本地创建还是从远程仓库下载 - 见下文），使用包的方式都是相同的：您在 "app.json" 中的 requires 数组中添加一个条目。为了演示目的，我们添加了一个简单的包，您可以用它进行实验

{
    "name": "MyApp",
    "requires": [
        "cool-stuff"
    ]
}

鉴于上述要求，sencha app build 和 sencha app refresh 现在都将执行将包集成到应用程序中所需的步骤。通常，在更改包要求后，您需要运行 sencha app refresh，以便更新支持“开发模式”所需的元数据。

无论您运行哪个命令，Sencha Cmd 都将下载并将包扩展到您的 "packages/remote" 文件夹。之后，您将在工作区中找到一个 "packages/remote/cool-stuff" 文件夹。

本地包

包的一种用途是简单地保存可用于工作区中多个应用程序的代码或主题。这些包永远不需要分发（超出源代码控制）即可为您的开发提供价值。

要将包添加到工作区，您只需生成该包

sencha generate package common

这会将一个新包生成到 "packages/local/common" 文件夹。该包在其 "package.json" 中也被标记为 local: true。此标志可防止 Sencha Cmd 永远用来自远程存储库的版本覆盖该包（见下文）。如果通过编辑 "workspace.json" 来合并包文件夹（如以前版本中那样），这将变得很重要。

然后，将“common”作为要求添加到应用程序的 "app.json" 中，如上所述

{
    "name": "MyApp",
    "requires": [
        "common"
    ]
}

有关更多详细信息，尤其是关于如何将包分发给其他人的信息，请参阅创建 Sencha Cmd 包。

远程包

虽然本地包在大型应用程序中非常有用，但包最实用的方面之一是能够分发供其他人使用的包。

包是使用包存储库共享和分发的。Sencha Cmd 会自动创建一个“本地存储库”，用于缓存包以及发布包。本指南中未讨论本地存储库在包创作中的作用。有关该主题的详细信息，请参阅创建 Sencha Cmd 包。

本地存储库

许多操作都隐式地使用本地存储库。当 Sencha Cmd 在 "app.json" 中遇到 requires 语句时，它会遵循以下基本步骤

查看工作区以确定包是否已存在。
检查本地存储库以确定是否已下载某个版本。
查看定义的远程存储库集以确定是否有任何存储库包含该包。
从远程存储库下载包并将其添加到本地存储库。

下载包后，后续对该包的要求将不再需要下载；该包将在本地存储库中找到。

本地存储库的位置

本地存储库是在“旁边”的各种版本中创建的文件夹，以方便缓存。例如，Sencha Cmd 在 Windows 上为用户 Foo 的默认安装目录可能类似于以下内容

C:\Users\Foo\bin\Sencha\Cmd\n.n.n.n

鉴于该安装目录，本地存储库将位于

C:\Users\Foo\bin\Sencha\Cmd\repo

可以通过编辑 Sencha Cmd 安装文件夹中的 "sencha.cfg" 来更改此位置。

本地存储库的内容将在创建 Sencha Cmd 包中进一步讨论。

远程存储库

为了将包下载到本地存储库，Sencha Cmd 必须了解远程存储库。默认情况下，Sencha Cmd 会自动将 Sencha 包存储库添加为名为“sencha”的远程存储库。

要查看远程存储库列表，请运行 sencha repository list 命令

> sencha repository list
...
[INF] Remote repository connections (1):
[INF]
[INF]     sencha - http://cdn.sencha.com/cmd/packages/

您可以使用 sencha repository add 和 sencha repository remove 命令添加和删除此列表中的存储库。如果您选择托管本地存储库，那么您的本地存储库实际上是其他人的有效远程存储库。有关此方面的详细信息，请参阅创建 Sencha Cmd 包。

包目录

可用的包集列在“目录”中。您可以使用以下命令显示全局目录的内容

sencha package list

列出包时，您会注意到列表中包含名称和版本。

名称分配

由于 Sencha Cmd 的仓库管理是分布式的，您可以根据需要添加或删除远程仓库，因此没有通用的包命名空间。如果您保留了与 Sencha 包仓库的默认“sencha”连接，那么您可以将该仓库的内容视为命名标准。

Sencha 发布的包（不包含在 Sencha 框架内）将使用以下形式的名称

sencha-*
ext-*
touch-*
cmd-*

所有以上述前缀开头的包名称均由 Sencha 在 Sencha 包仓库中保留。建议您即使断开与 Sencha 包仓库的连接，也要避免与这些名称冲突。

版本管理

为了将包与其使用者（即应用程序或其他包）连接起来，必须考虑所涉及的版本。为了帮助管理这一点，所有包都有版本号，这些版本号由requires语句用于处理版本限制。

包版本

所有包都由其名称和版本号的组合来描述。但是，对于包的每个版本，还有一个版本号来描述其向后兼容性级别。此版本是包创建者所做的声明，他们认为其包的特定版本向后兼容某个特定的先前版本级别。

在"package.json"描述符中，有两个重要的属性：version和compatVersion。例如

{
    ...
    "version": "n.n.n",
    "compatVersion": "2.4.2",
    ...
}

此数字必须采用以下格式

\d+(\.\d+)*

版本限制

在使用上面的requires属性时，我们只指定了包名称以使示例尽可能简单。这确切地意味着“最新版本”。在某些情况下，这是可以接受的，但如果该包的下一个版本是完全重新设计并且不提供任何向后兼容性级别，则这可能是一个有风险的要求。

为了保护您的应用程序免受这种情况的影响，我们可以更改require语句以使其非常严格并锁定我们想要的版本号

{
    "name": "MyApp",
    "requires": [
        "[email protected]"
    ]
}

这种方法有其用武之地，但它会阻止即使是包的维护版本也被提取。在项目的最后阶段，这可能正是我们想要的，但在开发过程中，我们可能希望稍微不那么严格一些，并接受任何兼容的版本。

以下更改将实现这一点

{
    "name": "MyApp",
    "requires": [
        "[email protected]?"
    ]
}

以上请求"ext-easy-button"的最新可用版本，该版本已将自身描述为与版本 1.0 向后兼容。

其他限制版本匹配的方法是

-1.2（无下限 - 最高版本 1.2）
1.0-（无上限 - 版本 1.0 或更高）
1.0+（与上面相同 - 版本 1.0 或更高）
1.0-1.2（版本 1.0 到 1.2 包含在内）
1.0-1.2?（与版本 1.0 到 1.2 包含在内兼容）

解析版本

鉴于所有所需和可用版本，Sencha Cmd 将确定最佳匹配包集，并确保这些包在您的工作区中。

如果存在相互排斥的要求，此过程可能会失败。在这种情况下，您将看到一条错误消息，解释哪些要求无法满足。

内容