文档帮助

内容

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

术语、图标和标签

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

访问级别

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

Public 类和类成员可供任何其他类或应用程序代码使用，并且可以作为主要产品版本中稳定且持久的成员。公共类和成员可以通过子类安全地扩展。
Protected 类成员是稳定的public成员，旨在供拥有类或其子类使用。受保护的成员可以通过子类安全地扩展。
Private 类和类成员由框架内部使用，不打算由应用程序开发人员使用。私有类和成员可能会随时更改或从框架中删除，恕不另行通知，并且不应在应用程序逻辑中依赖它们。

成员类型

Config - 类的配置选项。
Property - 在实例化类后设置一次。*参见下面的只读。
Method - 类可以执行的操作。方法应被视为实例方法，只能从给定类的实例调用。可以直接从类本身调用的静态方法将在方法名称旁边有一个static标签。*参见下面的静态。
Event - 事件特定于框架事件系统，允许类以编程方式引发事件，由一个或多个事件处理程序方法处理。DOM 事件虽然由框架事件系统处理，但没有在 API 文档中特别描述。*有关 DOM 事件，请参阅 MDN 的事件参考页面。
Theme Variable - 由框架使用的视觉主题引擎使用的变量。
Theme Mixin - 由框架使用的视觉主题引擎使用的函数，可以使用各种主题变量中设置的值。

成员语法

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

Ext.container.Container

查看源代码

lookupComponent ( item ) : Ext.Component

protected

在初始化items配置期间或添加新项目时，将原始配置对象添加到此容器时调用added), or {@link #insert inserted.

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

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

参数

item : Object

要添加的配置对象。

返回值

Ext.Component

要添加的组件。

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

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

成员标志

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

必需 - 实例化类时必需的配置。
可绑定 - 该配置有一个 setter，它允许通过 ViewModel 绑定设置该配置。
只读 - 可以读取该属性，但不能用于在运行时配置/重新配置类实例。
单例 - 单例类在定义后立即实例化，不能手动实例化。
静态 - 静态方法或属性是属于类本身的方法或属性，而不是类的实例。
可链式调用 - 指的是调用时返回类实例本身的方法。
这使得可以进行链式方法调用，例如：classInstance.method1().method2().etc();
已弃用 - 计划在未来框架版本中删除的类或成员，并在当前版本中提供以实现向后兼容性。
已弃用的类和成员将包含一条消息，指导您使用未来的首选类/方法。
已删除 - 已删除的类或成员，仅在文档中存在，作为用户在框架版本之间升级的参考。
模板 - 在基类中定义的方法，旨在被子类覆盖。
抽象 - 类或成员可以定义为抽象。抽象类和成员建立类结构并提供有限的代码（如果有）。类特定的代码将通过子类中的覆盖提供。
可阻止 - 如果事件处理程序返回 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 原语页面）都有一个菜单视图，其中包含与该类相关的元数据。此元数据视图将包含以下一项或多项

别名 - 一个或多个其他类名同义词（在 Ext JS 6.0.0 中，Ext.button.Button 类有一个别名为 Ext.Button）。别名通常为了向后兼容而维护。
层次结构 - 层次结构视图列出了当前类的继承链，一直到其祖先类，直到根基类。
Mixins - 混合到当前类中的类列表
继承的 Mixins - 混合到当前类祖先中的类列表
需要 - 为实例化类而需要定义的所有类
使用 - 类在其生命周期的某个时刻可能使用的类列表，但不一定需要实例化类。
子类 - 扩展当前类的类

展开和折叠示例和类成员

默认情况下，可运行示例（Fiddles）在页面上展开。您可以使用代码块左上角的箭头分别折叠和展开示例代码块。您也可以使用页面右上角的切换按钮切换所有示例的折叠状态。切换所有状态将在页面加载之间保留。

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

桌面 -vs- 移动视图

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

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

查看类源代码

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

Architect 4.3

显示私有类

顶部

安装和设置

本指南提供有关在您的系统上安装和运行 Sencha Architect 的说明。它还讨论了在您完成和发布第一个项目之前所需的其它软件。

本指南还旨在为您提供清晰的路径，以避免与 Sencha Architect 安装相关的常见应用程序构建问题。了解各种依赖项以确保干净安装非常重要。

支持的操作系统

Windows（包括 10 和 11）
macOS（包括 Apple M1 和 M2）
Linux（Ubuntu 20.04 和 22.04）

下载

如果您没有 Sencha Architect，可以下载一个免费且完整的 30 天试用版。

下载 Sencha Architect.

所需依赖项

在运行安装程序之前，让我们看一下依赖项。Sencha Architect 需要以下项目

Java 运行时环境 (JRE)

这对于支持基于 Ext JS 5 及更低版本的项目是必需的。

我们还需要 Ruby，您可以从这里下载

Ruby

Java 和 Ruby 必须通过命令行可用。安装程序在安装这些工具时会将它们添加到 PATH 系统变量中。

这些变量偶尔会丢失或根本无法添加。发生这种情况时，这些工具在命令行上不可用，Sencha Architect 也无法访问它们。正确设置这些路径非常重要。

Linux

如果您运行的是 Ubuntu 17+，您可能需要安装 libconfg-2.so.4 库。您可以通过运行以下命令来安装它

sudo apt-get install libgconf-2-4

设置系统变量

让我们看一下在各种支持的操作系统上设置系统路径变量。

Windows

Windows 7

从开始菜单中选择计算机。
从菜单中选择系统属性。
单击高级系统设置 > 高级选项卡。
在系统变量下单击环境变量，然后单击 PATH。
在编辑窗口中，通过将类的路径添加到 PATH 的值来修改 PATH。如果您没有 PATH 项目，您可以选择添加一个新变量，并将 PATH 作为名称，并将类的路径作为值。
关闭窗口并重新打开命令提示符窗口。

Windows 8

将鼠标指针拖动到屏幕右下角
单击搜索图标并输入：控制面板
单击控制面板 > 系统 > 高级
在系统变量下单击环境变量，然后单击 PATH。
在编辑窗口中，通过将类的路径添加到 PATH 的值来修改 PATH。如果您没有 PATH 项目，您可以选择添加一个新变量，并将 PATH 作为名称，并将类的路径作为值。
关闭窗口并重新打开命令提示符窗口。

Windows 10

单击 Windows 徽标并输入：控制面板。
单击系统 > 高级系统设置 > 高级选项卡。
在系统变量下单击环境变量，然后单击 PATH。
在编辑窗口中，通过将类的路径添加到 PATH 的值来修改 PATH。如果您没有 PATH 项目，您可以选择添加一个新变量，并将 PATH 作为名称，并将类的路径作为值。
关闭窗口并重新打开命令提示符窗口。

Mac OSX / Linux

编辑 ~/ .bash_profile
使用以下行（包含工具的路径）修改 PATH 变量
```
 export PATH=<PATH-TO-ADD-HERE>:$PATH
```
保存，关闭文件，并打开一个新的终端窗口

注意：.bash_profile 是一个隐藏文件。默认情况下，这些类型的文件在 Finder 中是隐藏的。要启用隐藏文件，请从命令行运行以下命令

defaults write com.apple.finder AppleShowAllFiles TRUE
killall Finder

依赖项安装

Java 运行时环境 (JRE)

首先，访问 Oracle 下载页面获取 Java JRE 的副本。

Sencha Architect 需要 JRE 才能正确使用 Sencha Cmd。您需要 Cmd 来生成有效的构建，因此必须正确安装 Java。

打开一个命令行工具来测试 Java 是否已正确安装。

Mac OSX

Mac OSX 用户只需打开 Terminal。

Windows

Windows 用户可以通过从开始屏幕输入 cmd 来打开命令行。

命令行可用后，发出以下命令。

java -version

如果安装正确，它应该输出类似于这样的版本信息

>java -version
java version "1.8.0_40"
Java(TM) SE Runtime Environment (build 1.8.0_40-b27)
Java HotSpot(TM) 64-Bit Server VM (build 25.40-b25, mixed mode)

注意：64 位 Sencha Architect 安装程序需要 64 位 JRE。

将 Java 添加到您的 PATH

Windows

将以下信息添加到您的系统变量中，以便将 Java 添加到您的 PATH

variable name: 
JAVA_HOME
variable value: 
c:\Program Files\Java\jre1.8.0_91\

variable name: 
PATH
variable value: 
%PATH%;%JAVA_HOME%\bin\

Mac OSX / Linux

除非您有意更改 Java 路径，否则 Java 很可能安装在此处

/Library/Java/JavaVirtualMachines/<java version>/.

将以下行添加到您的 ~/.bash_profile 中，以将 Java 添加到您的 PATH

export JAVA_HOME=/Library/Java/JavaVirtualMachines/jre1.8.0_91/Contents/Home
export PATH=$JAVA_HOME/bin:$PATH

有关更多信息，请参阅：http://java.com/en/download/help/path.xml

Ruby

Sencha Architect 在使用 Ext JS 5 及更低版本构建主题时，在应用程序构建过程中使用 Ruby。

Sencha Architect 支持 Ruby 1.9 和 2.0。

要检查 Ruby 是否已正确安装，请运行以下命令

> ruby -v

如果安装正确，它应该输出类似于这样的版本信息

> ruby -v
ruby 2.0.0p451 (2014-02-24 revision 45167) [universal.x86_64-darwin13]

Windows

Windows 用户将不得不下载 Ruby。如果 Ruby 尚未安装，您可以从这里下载。

确保您以管理员权限运行 Ruby 安装程序。要启用管理员权限，请右键单击安装程序可执行文件并选择“以管理员身份运行”。在安装过程中，您需要勾选允许将 Ruby 添加到 PATH 变量的复选框。

Mac OSX / Linux

Mac OSX 机器上会自动安装 Ruby。无需执行其他操作。

完成第三方依赖项

Sencha Architect 还使用 Sencha Cmd 和 Sencha 框架。您无需安装 Sencha Cmd 或框架，因为它们与 Architect 一起提供。当其他依赖项正确安装后，运行 Sencha Architect 安装程序。

对于 Windows 用户，最好使用与依赖项相同的管理员权限安装 Sencha Architect，以便 Sencha Architect 可以访问它们。

Sencha Cmd

Sencha Cmd 封装了一套非常有用的工具。您不仅可以使用它来构建应用程序，还可以构建主题、生成代码或使用内置的 Web 服务器（Jetty）。

Sencha Architect 需要 Sencha Cmd 才能正确构建应用程序。由于 Sencha Architect 运行在 Sencha Cmd 之上，因此它们被打包在一起，因此无需进一步安装。

启用 Sencha Cmd

Sencha Cmd 还需要在 Sencha Architect 中启用。这应该在第一次保存时默认完成。

通过导航到以下位置，可以验证是否可以手动启用 Sencha Cmd

    Edit > Project Settings > Framework.

需要注意的是，当构建工具被禁用时，CDN 将用于框架。路径在检查器中的 Library 节点下的 Library Base Path 中设置。这仅应设置为构建工具禁用的项目。如果用户清除路径作为默认值，将使用 CDN 路径。

Sencha 框架

Architect 会自动下载并安装您需要的 Sencha 框架。这意味着您无需手动安装 Ext JS。

但是，您可以通过在“许可证”下指定位置来切换到其他受支持的 Ext JS 遗留版本

您可以在下面找到更详细的说明。

应用程序许可证

Sencha 通过您选择的框架提供不同的选项来许可您的应用程序。有关更多信息，请参阅 Sencha 许可证和政策。

注意： 这并不涉及 Sencha Architect 的许可，而是指您应用程序的框架许可。

要更改应用程序许可证

单击编辑 > 项目设置 > 框架。
单击构建工具 > 已启用 - 如果您禁用构建工具，Architect 假设您将自行处理构建应用程序和设置其许可证。通过启用构建工具，Architect 为每个许可证选择提供最佳软件。
单击许可证选择
- 商业：Architect 为免费或付费应用程序提供的默认许可证
- 完整或自定义路径：用于 Sencha Complete Bundle
单击保存。

注意：对于 Sencha Complete，单击 Sencha Complete 或自定义路径，然后单击浏览按钮以找到 Ext JS 框架目录。

默认情况下，Ext JS 框架由 Sencha Complete 安装程序安装在以下目录中。

在以下地址中，是用户名，是 Complete，n.n.n 是版本号，build 是构建号。

Mac OS X：

/Users/<User>/bin/Sencha/<pkg>/ext-n.n.n.build

Windows 7+：

C:\Users\<User>\bin\Sencha\<pkg>\ext-n.n.n.build

Ubuntu：

/home/user/bin/Sencha/<pkg>/ext-n.n.n.build

创建项目目录

创建目录的位置和名称因操作系统和 Web 服务器而异。如果您使用的是本地 Web 服务器，则需要将目录存储在 localhost 的 Web 可访问区域中的某个位置。例如，XAMPP 的 htdocs 目录或 Linux 的 /var/www/html。

如果您使用的是 Sencha Cmd Web 服务器，则可以使用任何目录作为您的项目目录。

首次保存项目后，Architect 会在同一位置为项目创建一个新目录。将任何其他项目资产存储在 Architect 创建的目录中。这包括数据和附加资源，例如图像。

配置 IIS 以提供 JSON 文件

如果您运行的是 IIS Web 服务器，请确保将 application/x-json 添加为 MIME 类型。IIS 需要设置 MIME 类型才能正确提供 JSON 文件。如果没有设置，JSON 文件在
预览项目时将返回错误。

另请参阅

下一步

安装软件后，请继续

现在您已经了解了如何设置 Sencha Architect 并处理其所有依赖项。我们希望这能帮助您快速入门，以便您可以直接开始构建。如果您想了解更多关于 Sencha 工具和框架的信息，您可以参加我们的 Sencha 培训课程，或者查看我们的论坛，获取大量有用的信息。