文档帮助

目录

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

术语、图标和标签

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

访问级别

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

成员类型

成员语法

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

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

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

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

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

参数

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）
  • 自从（示例中未显示）- 某些成员将显示该成员首次引入的产品版本（即 Available since 3.4.0 - 示例中未显示），就在成员描述之后
  • 默认值（示例中未显示）- 配置通常显示要应用于类实例的默认配置值（如果未被覆盖）（即 Defaults to: false）

成员标志

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

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

类图标

- 表示框架类

- 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 原始页面除外）都有一个菜单视图，其中包含与该类相关的元数据。此元数据视图将具有以下一项或多项

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

展开和折叠示例和类成员

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

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

桌面与移动视图

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

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

查看类源代码

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

Ext JS 7.8.0 - Modern Toolkit


顶部
指南适用于： modern

目录

ext-gen app CLI - 应用程序生成 App 生成 CLI 选项 可用的 App 模板 可用的主题 ext-gen migrate - 应用程序迁移 ext-build CLI 安装 用法 CLI 参考 结构 示例 命令行帮助： 使用 npx 直接驱动 Sencha Cmd Npx 示例 总结

CLI 参考

本指南是 ExtGen 及其底层工具提供的 Open Tooling CLI 命令的参考。

CLI 工具 描述
ext-gen app [...] App 生成工具。
ext-gen migrate [...] App 依赖迁移工具。
ext-build generate [...] Sencha Cmd CLI 代理。

ext-gen app CLI - 应用程序生成

Ext JS open tooling 需要 NodeJS 和 Java。

App 生成 CLI 选项

以下是可用于生成应用程序的 CLI 选项列表。

示例

ext-gen app (-h) (-d) (-i) (-t 'template') (-m 'moderntheme') (-c 'classictheme') (-n 'name') (-f 'folder')
CLI 选项 别名 描述
-h --help 显示帮助（无参数也显示帮助）
-d --defaults 显示 package.json 的默认值
-i --interactive 以交互模式运行（将显示问题提示）
-t --template 用于生成 Ext JS 模板的名称
-c --classictheme Ext JS classic toolkit 的主题名称（不在 Community Edition 中）
-m --moderntheme Ext JS modern toolkit 的主题名称
-n --name 生成的 Ext JS 应用程序的名称
-f --folder Ext JS 应用程序的文件夹名称（尚未实现）
-v --verbose 详细 npm 消息（仅针对问题）

可用的 App 模板

有几个应用程序模板可用于生成应用程序。使用以下选项之一设置 --template 属性。

示例

ext-gen app --template universalmodern --moderntheme theme-material --name CoolUniversalApp
模板 目标平台 描述
classicdesktop 桌面 Classic toolkit 桌面 App 模板。
classicdesktoplogin 桌面 带有登录模板的 Classic toolkit 桌面 App。
moderndesktop 桌面 Modern toolkit 桌面 App 模板。
moderndesktopminimal 桌面 带有简单桌面 App 模板的 Modern toolkit。
 
universalclassicmodern 移动和桌面 Mobile Modern toolkit 和 Classic toolkit 桌面 App 模板。
universalmodern 移动和桌面 这是一个现代化的通用模板。

可用的主题

这些主题在 ext-gen app 生成中可用。使用以下选项之一设置 --classictheme 或 --moderntheme 属性。

示例

ext-gen app --template universalmodern --moderntheme theme-material --name CoolUniversalApp
主题选项 在 Toolkit 中可用
Modern Toolkit 主题
theme-material Modern Toolkit
theme-ios Modern Toolkit
theme-neptune Modern Toolkit
theme-triton Modern Toolkit
 
Classic Toolkit 主题
theme-classic Classic Toolkit
theme-material Classic Toolkit
theme-neptune Classic Toolkit
theme-neptune-touch Classic Toolkit
theme-crisp Classic Toolkit
theme-crisp-touch Classic Toolkit
theme-triton Classic Toolkit
theme-graphite Classic Toolkit
theme-material Classic Toolkit

ext-gen migrate - 应用程序迁移

ExtGen 的 migrate 命令是一个有用的实用程序，可以将使用 Sencha Cmd 构建的现有 ExtJS 应用程序迁移到使用 Open Tooling (ExtGen) 的 ExtJS 应用程序。

ext-gen migrate

有关 ext-gen migrate 的完整文档，请单击此处。

ext-build CLI

ExtBuild 在 Sencha 的 npm 项目中提供 Sencha Cmd 功能。需要 Node 和 Java。

安装

  1. 安装 npm（我们假设您已预先安装 node.js）。
  2. npm install -g @sencha/ext-build

用法

CLI 参考

结构

ext-build generate app (sdk) (template) (name) (path)\ ext-build generate viewpackage (profile) (viewname)

命令 描述
generate, gen, g 创建新的应用程序或 viewpackage
application, app, a 与 generate 命令一起使用以生成新的应用程序
viewpackage 与 generate 命令一起使用以生成新的 viewpackage
migrate 将现有的 Sencha Cmd 应用程序迁移到 Open Tooling
CLI 选项 描述
--builds 选定的构建配置文件（--builds "desktop:modern,theme-material;phone:modern,theme-material;" 是默认值）
--debug 显示调试信息
--force （如果存在应用程序，则在生成应用程序之前删除应用程序（请小心使用！）
--sdk （Ext JS sdk 的路径 - 当前生成应用程序需要，无法从 sdk 文件夹运行...）
--template （要使用的应用程序模板的名称 - 当前只有一个 - universalmodern）
profile （要在其中生成 viewpackage 的构建配置文件的名称）
viewname （viewpackage 的名称

示例

// Generate an application, specifying the SDK version and template
ext-build generate app --sdk 'Ext/ext-7.0.0' --template 'universalmodern' MyApp ./MyApp

// Generate an application, specifying the SDK version and template
ext-build gen app -s 'Ext/ext-7.0.0' -t 'universalmodern' MyApp ./MyApp
eb g a -s 'Ext/ext-7.0.0' -t 'universalmodern' MyApp ./MyApp

// Generate a new viewpackage named "settings" for the desktop build profile (configured in app.json) in an existing application
ext-build generate viewpackage desktop settings

// Generate a new viewpackage named "detail" for the phone build profile (configured in app.json) in an existing application
ext-build generate viewpackage phone detail

命令行帮助：

ext-build 或 eb

使用 npx 直接驱动 Sencha Cmd

许多 ExtJS 用户熟悉的丰富生态系统 Sencha Cmd 仍然可以在 ExtGen 应用程序中使用。

调查 node_modules 内部的 @sencha 包，您会看到 Sencha Cmd 以及其他框架包。打开 cmd 包，您会找到 Sencha Cmd 二进制文件。您如何从应用程序中使用此二进制文件？

首先，如果您熟悉 Sencha Cmd，您会记得在安装期间，您可能已将 Sencha Cmd 添加到您的 $PATH，二进制文件通常安装在您的用户 bin 目录中。Npm 项目也有一个 bin，位于 node_modules/.bin。在此文件夹内，您将看到通过 npm 提供给您的项目的二进制文件。

npm 社区创建了 npx 包。Npx 将检查请求的二进制文件是否通过您的 $PATH 可用，或者是否在您项目的 node_modules/.bin 中可用。

为了利用旧的工作流程，或利用额外的 Sencha 马力，您可以直接从 ExtGen 应用程序的根目录使用npx 包 + sencha cmd CLI 语法。

Npx 示例

app watch

// Sencha Cmd
sencha app watch desktop

// Npx + Sencha Cmd
npx sencha app watch desktop

compile

// Sencha Cmd
sencha compile -classpath=js exclude -not -namespace Ext and concat ext-all-dev.js

// Npx + Sencha Cmd
npx sencha compile -classpath=js exclude -not -namespace Ext and concat ext-all-dev.js

总结

简而言之，您以前可能习惯使用的几乎所有相同的 Sencha Cmd 功能仍然可以通过简单地在您的 Sencha Cmd CLI 语法前面加上 npx 指令来访问。

Ext JS 7.8.0 - Modern Toolkit