文档帮助

术语、图标和标签

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

访问级别

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

成员类型

成员语法

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

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

  • 展开/折叠 - 在成员行的左侧是一个控件,用于展开和折叠每个成员行以显示/隐藏成员详细信息。
  • 成员名称 - 类成员的名称(本例中为 lookupComponent
  • 方法参数 - 方法使用的任何必需或可选参数(或传递给事件处理方法的参数)将列在方法名称旁边的括号内(本例中为 ( item )
  • 返回类型 - 方法或属性返回的类实例或 javascript 对象(本例中为 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(自 3.4.0 版本起可用)- 未在示例中显示),紧接在成员描述之后
  • 默认值未在示例中显示) - 配置通常显示要应用于类实例的默认配置值(如果未被覆盖)(即 Defaults to: false(默认为:false))

成员标志

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

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

类图标

- 表示框架类

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

- 组件类型框架类(Ext JS 框架中扩展 Ext.Component 的任何类)

- 表示类、成员或指南在当前查看的版本中是新的

成员图标

- 表示类型为 config(配置)的类成员

- 表示类型为 property(属性)的类成员

- 表示类型为 method(方法)的类成员

- 表示类型为 event(事件)的类成员

- 表示类型为 theme variable(主题变量)的类成员

- 表示类型为 theme mixin(主题 mixin)的类成员

- 表示类、成员或指南在当前查看的版本中是新的

类成员快速导航菜单

在 API 文档页面上的类名正下方是一行按钮,对应于当前类拥有的成员类型。每个按钮显示按类型划分的成员计数(此计数在应用过滤器后会更新)。单击按钮会将您导航到该成员部分。将鼠标悬停在成员类型按钮上将显示该类型的所有成员的弹出菜单,以便快速导航。

Getter 和 Setter 方法

与类配置选项相关的 Getter 和 Setter 方法将显示在方法部分以及 API 文档和成员类型菜单的配置部分中,就在它们所作用的配置下方。Getter 和 Setter 方法文档将在配置行中找到,以便于参考。

历史记录栏

您的页面历史记录保存在本地存储中,并显示在顶部标题栏下方(使用可用的实际空间)。默认情况下,仅显示的搜索结果是与您当前查看的产品/版本匹配的页面。您可以通过单击历史记录栏右侧的 按钮并选择“全部”单选按钮来扩展显示的内容。这将显示所有产品/版本的所有最近页面访问历史记录。

在历史记录配置菜单中,您还将看到最近访问页面的列表。结果按“当前产品/版本”和“全部”单选按钮进行过滤。单击 按钮将清除历史记录栏以及保存在本地存储中的历史记录。

如果在历史记录配置菜单中选择“全部”,则“在历史记录栏中显示产品详细信息”复选框选项将启用。选中后,每个历史页面的产品/版本将与历史记录栏中的页面名称一起显示。将光标悬停在历史记录栏中的页面名称上也会将产品/版本显示为工具提示。

搜索和过滤器

可以使用页面顶部的搜索字段搜索 API 文档和指南。

在 API 文档页面上,还有一个过滤器输入字段,该字段使用过滤器字符串过滤成员行。除了按字符串过滤外,您还可以按访问级别、继承和只读过滤类成员。这是通过使用页面顶部的复选框完成的。

API 类导航树底部的复选框过滤类列表以包含或排除私有类。

单击空的搜索字段将显示您最近 10 次搜索,以便快速导航。

API 文档类元数据

每个 API 文档页面(Javascript 原始类型页面除外)都有一个与该类相关的元数据菜单视图。此元数据视图将具有以下一项或多项

  • Alternate Name(备用名称)- 一个或多个附加的类名同义词(在 Ext JS 6.0.0 中,Ext.button.Button 类有一个备用类名 Ext.Button)。维护备用类名通常是为了向后兼容性。
  • Hierarchy(层次结构)- 层次结构视图列出了当前类的继承链,从祖先类一直到根基类。
  • Mixins(混入)- 混入到当前类中的类列表
  • Inherited Mixins(继承的混入)- 混入到当前类的祖先类中的类列表
  • Requires(需要)- 实例化类所需定义的所有类
  • Uses(使用)- 类在其生命周期的某个时刻可能使用的类列表,但不一定是类最初实例化时所必需的
  • Subclasses(子类)- 扩展当前类的类

展开和折叠示例和类成员

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

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

桌面视图 vs 移动视图

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

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

查看类源代码

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

Cmd


顶部

Sencha Cmd 包

Sencha Cmd 包括 Sencha Package Manager(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 buildsencha 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 语句时,它遵循以下基本步骤

  • 在工作区中查找以查看包是否已存在。
  • 检查本地仓库以查看是否已下载版本。
  • 查看定义的远程仓库集,以查看是否有任何仓库包含该包。
  • 从远程仓库下载包并添加到本地仓库。

一旦包被下载,后续对此包的需求将不需要下载;该包将在本地仓库中找到。

本地仓库的位置

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

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 Package Repository(Sencha 包仓库)添加为名为 “sencha” 的远程仓库。

要查看远程仓库列表,请运行 sencha repository list 命令

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

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

包目录

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

sencha package list

当您列出包时,您会注意到该列表包括名称和版本。

名称分配

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

由 Sencha 发布(未包含在 Sencha Framework 内部)的包将使用以下形式的名称

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

所有以前缀开头的包名称均由 Sencha 保留,相对于 Sencha Package Repository。建议即使您断开与 Sencha Package Repository 的连接,也应避免与这些名称冲突。

版本管理

为了连接包及其使用者(即,应用程序或其他包),考虑所涉及的版本非常重要。为了帮助管理这一点,所有包都有版本号,requires 语句使用这些版本号来处理版本限制。

包版本

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

"package.json" 描述符中,有两个重要的属性:versioncompatVersion。例如

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

此数字必须是以下格式

\d+(\.\d+)*

版本限制

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

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

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

这种方法有其位置,但是它甚至阻止了包的维护版本被拾取。在项目的最后阶段,这可能正是所期望的,但是在开发过程中,也许我们希望稍微宽松一些并接受任何兼容版本。

以下更改将执行此操作

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

以上请求具有版本 1.0 向后兼容性的最新可用版本的 "ext-easy-button"

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

  • -1.2(没有下限 - 最高版本 1.2)
  • 1.0-(没有上限 - 版本 1.0 或更高版本)
  • 1.0+(与上述相同 - 版本 1.0 或更高版本)
  • 1.0-1.2(版本 1.0 到 1.2,包括 1.2)
  • 1.0-1.2?(与版本 1.0 到 1.2 兼容,包括 1.2)

版本解析

给定所有期望的和可用的版本,Sencha Cmd 将确定最佳匹配包集,并确保这些包在您的工作区中。

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

Cmd