文档帮助

术语、图标和标签

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

访问级别

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

成员类型

成员语法

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

lookupComponent ( item ) : Ext.Component
受保护的

当原始配置对象添加到此容器时调用,无论是在初始化 items 配置期间,还是在 添加新项目或 {@link #insert 插入} 时。

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

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

参数

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 文档页面顶部的类名来查看类源代码。可以通过单击成员行右侧的“查看源代码”链接来查看类成员的源代码。

History :

Cmd 7.8.0

API

顶部

Sencha Cmd Packages

Sencha Cmd 包括 Sencha Package Manager。包旨在解决两个基本问题:消费和分发。本指南重点介绍这些主题。另请参阅 创建 Sencha Cmd Packages,了解有关创建和共享包的信息。

"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 Packages

远程包

虽然本地包在大型应用程序中可能非常有价值,但包最有用的方面之一是分发包供他人使用的能力。

包使用包仓库共享和分发。Sencha Cmd 自动创建一个“本地仓库”,用于缓存包以及发布包。本指南未讨论本地仓库对于包作者的角色。有关该主题的详细信息,请参阅 创建 Sencha Cmd Packages

本地仓库

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

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

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

本地仓库的位置

本地仓库在“旁边”各种版本的文件夹中创建,以方便缓存。例如,用户 Foo 的 Windows 上 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 Packages 中进一步讨论了本地仓库的内容。

远程仓库

为了将包下载到本地仓库,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 addsencha repository remove 命令从此列表中添加和删除仓库。如果您选择托管本地仓库,那么您的本地仓库实际上是其他人的有效远程仓库。有关详细信息,请参阅 创建 Sencha Cmd Packages

包目录

可以使用以下命令显示可用包集在“目录”中列出

sencha package list

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

名称分配

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

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

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

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

版本管理

为了连接包及其使用者(即应用程序或其他包),考虑所涉及的版本非常重要。为了帮助管理这一点,所有包都有版本号,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]?"
    ]
}

以上请求 "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.2)
  • 1.0-1.2?(与版本 1.0 至 1.2(包括 1.2)兼容)

解决版本冲突

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

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

Cmd 7.8.0

Ext JS
ExtAngular
ExtReact
ExtWebComponents
Sencha Test
Cmd
Architect
Themer
IDE Plugins
Sencha Inspector
Fiddle
GXT
Sencha Touch
WebTestIt
Sencha GRUI
Rapid Ext JS
ReExt