文档帮助

目录

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

术语、图标和标签

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

访问级别

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

成员类型

成员语法

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

Ext.container.Container
查看源代码
lookupComponent ( item ) : Ext.Component
受保护 (protected)

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

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

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

参数

item :  Object

正在添加的配置对象。

返回值
Ext.Component

要添加的组件。

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

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

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

类成员快速导航菜单

在 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 - 混入当前类的类列表
  • 继承的 Mixins (Inherited Mixins) - 混入当前类的祖先的类列表
  • 需要 (Requires) - 实例化类所需定义的所有类
  • 使用 (Uses) - 类在其生命周期的某个时刻可能使用的类列表，但不一定是类最初实例化所必需的
  • 子类 (Subclasses) - 扩展当前类的类

展开和折叠示例和类成员

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

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

桌面 -vs- 移动视图

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

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

查看类源代码

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

Cmd


顶部

目录

前提条件 升级您的应用程序 准备升级 升级 Sencha Cmd 脚手架 升级框架 处理合并冲突 使用可视化合并工具 合并工具辅助属性 替代策略 后续步骤

了解应用升级

本指南解释了如何在应用程序中管理 Sencha Cmd 和 Sencha 框架的升级。

前提条件

建议在继续之前阅读以下指南

升级您的应用程序

生成的应用程序包含两种与 Sencha Cmd 相关联的基本内容：构建脚本（或脚手架）和目标 Sencha SDK 的重要内容。因此，您偶尔需要升级这些部分。您可以使用以下命令执行此操作

sencha app upgrade [ path-to-new-framework ]

“path-to-new-framework”是可选的，用于同时升级 Sencha Cmd 脚手架和应用程序使用的框架。

准备升级

在对应用程序源代码执行任何批量操作时，强烈建议从版本控制方面的“干净”状态开始。也就是说，最好在执行升级之前没有未提交的更改。这样，您可以轻松查看并可能放弃 sencha app upgrade 所做的更改，从而最大限度地减少麻烦。

升级 Sencha Cmd 脚手架

要使用先前版本生成的应用程序来启动新版本的 Sencha Cmd，您可以从应用程序内部运行此命令

sencha app upgrade

这将替换 ".sencha" 的内容，但也会升级 "app.js" 以及少数其他文件。

升级框架

由于生成的应用程序包含它们最初从中生成的 SDK 的副本，因此需要更新应用程序以使用新版本的 SDK。sencha app upgrade 命令将用新的 SDK 副本替换旧的 SDK 副本

sencha app upgrade ../path/to/framework

上面的命令指向下载和解压缩的 SDK 的路径。

重要提示。 不要为此命令使用 -sdk 开关，就像您对 sencha generate app 命令所做的那样。请改用上面显示的命令。

如果您从 Ext JS 4.1 升级到 4.2+，则可能还会对生成的源代码进行一些更改。

处理合并冲突

在 Sencha Cmd 中，代码生成器结合了 3 向合并，以最好地协调其生成的代码与上次生成的代码以及您可能已编辑的代码的当前状态。这种方法允许您以多种方式编辑文件（例如 "app.js"），只要您的更改不与 Sencha Cmd 想要进行的更改重叠即可。

合并过程遵循 "app.js" 的以下伪代码（作为示例）

mv app.js app.js.$old
regenerate last version to app.js.$base
generate new version to app.js
diff3 app.js.$base app.js.$old app.js

在理想情况下，您不会注意到此机制在工作。但是，在某些情况下，您可能会收到一条错误消息，告诉您存在“合并冲突”，并且您需要手动解决此问题。

如果无法重新创建基本版本，则 ".$old" 文件将保留在磁盘上，您可以将其与当前版本进行比较。或者，您可以使用源代码控制系统将当前文件与上次提交的文件进行比较。

当可以生成基本版本（大多数情况下）时，".$old" 文件将被删除，因为冲突以标准方式在目标文件中注释。

<<<<<<< Generated
    // stuff that Sencha Cmd thinks belongs here
=======
    // stuff that you have changed which conflicts
>>>>>>> Custom

使用可视化合并工具

此过程与您在源代码控制系统中对您和另一个用户（在本例中为 Sencha Cmd）都修改过的文件所期望的完全一致。与版本控制一样，解决这些问题的理想方法是使用可视化合并工具。

要配置 Sencha Cmd 在遇到合并冲突时调用合并工具，您需要设置以下两个属性

cmd.merge.tool
cmd.merge.tool.args

如果 cmd.merge.tool 属性很简单，只需程序名称即可（如果该程序在 PATH 中），否则，它可能需要是可执行文件的完整路径。

应根据所需合并工具所需的命令行参数设置相应的 cmd.merge.tool.args 属性。此属性是一个模板，可以包含以下替换标记

cmd.merge.tool.args={base} {user} {generated} {out}

模板首先按空格拆分，然后标记将替换为实际文件名。如果合并工具具有更多自定义需求，则可能需要将 cmd.merge.tool 设置为可以包装合并工具的 shell 脚本。

合并工具辅助属性

Sencha Cmd 提供了属性来帮助配置几种流行的合并工具

对于 p4merge，您可以像这样设置这些属性

cmd.merge.tool=p4merge
cmd.merge.tool.args=${cmd.merge.tool.args.p4merge}

这假设 "p4merge" 在您的 PATH 环境变量中。如果不是，您将需要完全指定可执行文件的路径。

对于 SourceGear

cmd.merge.tool.args=${cmd.merge.tool.args.sourcegear}

对于 kdiff3

cmd.merge.tool.args=${cmd.merge.tool.args.kdiff3}

对于 Syntevo SmartSynchronize 3

cmd.merge.tool.args=${cmd.merge.tool.args.smartsync}

对于 TortoiseMerge（TortoiseSVN 的一部分）

cmd.merge.tool.args=${cmd.merge.tool.args.tortoise}

对于 AraxisMerge

cmd.merge.tool.args=${cmd.merge.tool.args.araxis}

替代策略

如果您对应用程序进行了大量自定义，有时只需在临时位置生成一个新应用程序，然后首先复制其 ".sencha" 文件夹来替换您自己的文件夹，并注意协调您可能已进行的任何更改并将它们合并到新版本中，这样会更简单。

如果您正在使用工作区，则可能需要从生成的应用程序复制 ".sencha/workspace" 文件夹到您的工作区的 ".sencha" 文件夹，以替换那里的旧版本。

后续步骤

Cmd