文档帮助

目录

术语、图标和标签 访问级别 成员类型 成员语法 成员标志 类图标 成员图标 导航和功能 类成员快速导航菜单 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
受保护的

当原始配置对象添加到此容器时调用，无论是在初始化 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（未在示例中显示）- Configs 通常显示要应用于类实例的默认配置值（如果未被覆盖）（即 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 方法

与类配置选项相关的 Getting 和 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 文档页面顶部的类名称来查看类源代码。可以通过单击成员行右侧的“查看源代码”链接来查看类成员的源代码。

Ext JS 7.8.0 - Modern Toolkit


顶部
指南适用于： modern

目录

**在包含的脚本中指定构建配置文件

将现有 Ext JS + Sencha Cmd 应用程序迁移到开放工具和 npm 包

从 ExtGen 7.0.0 开始，我们的开放工具平台能够迁移使用 Sencha Cmd 构建的 Ext JS 应用程序，以使用 ExtGen、Sencha 的开放工具解决方案，该解决方案使用 npm 包、webpack 和其他现代开源工具。本指南提供了将 Sencha Cmd 应用程序迁移到开放工具（ExtGen + npm 包）所需的步骤。

要求

使用开放工具的 Ext JS 应用程序需要以下内容

  • Node 8+

  • npm 4+

  • Webpack 2+

  • Oracle JRE (SE) 8-21 或 OpenJDK 8-21。

ExtGen 的迁移工具

按照以下步骤将您的应用程序从 Sencha Cmd 迁移到开放工具 (ExtGen)

*注意：您必须登录 Sencha npm 注册表才能访问 Ext JS 包。请参阅 入门指南

本文档假设您使用 Sencha Cmd 创建了 Ext JS 应用程序

  1. 安装 ExtGen。使用以下命令在您的机器上安装 Sencha ExtGen

    npm install -g @sencha/ext-gen

  2. ext-gen migrate 命令将现有的 Sencha Cmd 应用程序转换为 ExtGen 应用程序。在您的应用程序文件夹的根目录中运行该命令

    ext-gen migrate

ext-gen migrate 将创建和修改某些文件，以更新现有应用程序以使用 npm 打包。这些文件包括 package.json 和 Sencha 自定义 webpack 插件的 webpack 配置文件。还为您创建了一个 index.js 文件，该文件将放置在项目的根目录中。

创建一个备份文件夹以保存原始文件的备份。

安装 npm 包

使用应用程序文件夹中的以下命令安装 package.json 中现在定义的必需包

npm install

**在包含的脚本中指定构建配置文件

当您创建 Sencha Cmd 应用程序时，会创建应用程序的 app.json 配置文件，其中包含构建配置文件。

为了充分利用开放工具和包含的 npm 脚本，ExtGen 的 webpack 插件需要知道您希望它使用哪个构建配置文件。

通过将您希望使用的构建配置文件添加到通过脚本传递到 webpack 插件的环境变量中，来配置在项目根目录中新创建的 package.json 中定义的两个脚本（dev 和 build）

"dev": "webpack-dev-server --env.profile=<YOUR_PROFILE_HERE e.g. 'classic', 'phone', 'desktop'> --env.browser=yes --env.verbose=no

这是桌面配置文件的示例配置

"dev": "webpack-dev-server --env.profile=desktop --env.browser=yes --env.verbose=no

如果您选择在不指定构建配置文件的情况下使用 OpenTools，Sencha Cmd 默认使用的相同配置文件也将被 webpack 插件使用

运行应用程序

使用应用程序文件夹中的以下命令运行应用程序

npm start

要使用提供的示例脚本，请使用以下命令

npm run-script dev
npm run-script build

Ext JS 7.8.0 - Modern Toolkit