文档帮助

术语、图标和标签

许多类在使用配置对象创建(实例化)类时都有快捷名称。快捷名称被称为 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 原始类型页面除外)都有一个与该类相关的元数据菜单视图。此元数据视图将具有以下一项或多项

展开和折叠示例及类成员

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

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

桌面视图与移动视图

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

查看类源代码

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

Architect 4.3


顶部

Architect 项目的团队开发

本指南讨论了作为团队一部分开发 Architect 应用程序的机制。Architect 使用的 MVC 应用程序架构不仅创建了健壮且可移植的应用程序,而且还有利于团队开发环境。专家可以贡献适当的代码部分,用户界面专家创建 View,业务和数据专家开发 Models 和 Stores。

作为团队开发 Architect 应用程序包括以下步骤

  • 选择并设置源代码管理 (SCM) 系统,并建立适当的策略和工作流程。
  • 项目负责人将在 Architect 中设置应用程序项目,保存项目以创建源代码树,并将文件检入 SCM。
  • 所有团队成员在其系统上安装并设置 Architect。
  • 团队成员各自克隆所有项目文件的副本到其本地系统,并继续进行其开发工作,并经常使用“保存”按钮来保存他们所做的工作。
  • 工作应经常检入 SCM,并且团队的所有成员应经常将其本地文件与团队存储库中的文件同步。如果多人修改同一文件,则可以在此时合并更改。
  • 如果您需要与其他组共享您的项目,请创建一个项目存档(.xda 文件),他们可以下载并在其本地安装的 Sencha Architect 应用程序上打开。

Architect 包括一些工具,允许您在不同项目和不同开发人员之间共享代码片段。

设置源代码管理系统

Sencha 强烈建议所有项目的源代码都应在源代码管理 (SCM) 系统下维护。这为文件所做的所有更改提供了详细的历史记录和代码的备份保护。大多数现代 SCM 系统还提供工具,以便在多人修改同一文件时合并更改。SCM 还应使您能够维护不同发布的分支。

Sencha 源代码是在 Git 下开发的,我们的示例项目可公开下载,使用 Git。许多其他优秀的 SCM 可用,并且应该可以与 Sencha Architect 良好地配合使用。

在开始您的项目之前,您应该设置您的 SCM 并定义 Architect 项目将存储在哪里,谁拥有对源代码的何种访问权限,如果适用,设置备份过程,并安排 SCM 的管理和维护。这些主题超出了本指南的范围。

启动 Architect 项目

一个人,可能是团队负责人,需要启动 Architect 项目。

选择您要使用的框架和版本,并选择适当的应用程序模板,或选择空白模板以启动空白项目。

命名您的应用程序

创建 Architect 项目的第一步是命名应用程序。

要命名应用程序

  1. 单击屏幕右上角项目检查器窗口顶部的“应用程序”。

  2. 在配置面板中找到 "name",并将其设置为您的项目名称,例如 "MyProject"。项目名称应以大写字母开头。

这将设置表示应用程序的应用程序节点 。通常,这是一个使用 Viewport 的单页,它使应用程序中的所有类(其模型、视图、控制器和存储)都位于单个命名空间下。当单页准备就绪并且应用程序的所有 JavaScript 都已加载时,将调用应用程序的启动函数。启动函数通常运行启动应用程序的“引导”代码。

对于简单的应用程序,只需为应用程序节点设置 "name" 通常就足够了。对于更复杂的应用程序,您可能需要设置其他配置。

保存您的项目

按照 保存您的项目 中的说明保存您的项目。

当您首次保存项目时,Architect 会为项目创建一个项目目录。
对话框会显示其保存位置。约定是使用您在上一步中分配的应用程序 name 的小写版本来命名目录。因此,如果您为应用程序 name 使用的名称是 "MyProject",则项目的目录将命名为 "myproject"。此约定不是 Architect 强制执行的,但它使跟踪您正在做的事情变得更容易。

有关 Architect 创建的文件和目录的详细列表,请参阅下一节。

将项目检入源代码控制

整个项目都应该进行版本控制,但以下项除外

  • .architect 文件,其中包含用户级设置
  • bootstrap.json
  • build 文件夹
  • ext 文件夹

您可以安全地设置您的 SCM 以忽略这些文件。

团队成员如何开发项目

开发团队的每个成员都应在其本地系统上安装和设置 Sencha Architect 和 Web 服务器。有关说明,请参阅 安装和设置 指南。

在项目负责人将项目检入 SCM 后,每个团队成员都可以将存储库克隆到自己的系统,然后使用 Architect 启动屏幕上的“打开现有项目”链接在本地打开项目并开始编码。

团队成员应经常保存他们的工作,并定期将其更改检入 SCM。

创建项目存档

项目存档是一个包含 Architect 项目所有组件的文件。它可以提供给您开发团队外部的用户,他们可以将其下载到本地磁盘,加载到 Architect 中,并查看或修改它。当您想与 Sencha 社区或项目团队外部的其他人共享您的 Architect 项目时,这可能很有用。

要创建项目存档

  1. 确保项目已构建,而不仅仅是保存。
  2. 在 Architect 中打开项目后,转到“文件”菜单。
  3. 选择“存档项目”。
  4. 在打开的对话框中为项目存档命名,然后单击“保存”。

Architect 创建一个带有 .xda 扩展名的文件,该文件可以上传到服务器、在电子邮件中发送、复制到 USB 驱动器等。然后,另一个人可以下载此文件并在 Architect 内部打开它。如果他们对项目进行修改,他们可以创建一个包含这些更改的存档。

.xda 文件应始终检入您的 SCM,但存档并非旨在提供或替代源代码控制管理来存储和跟踪更改。

共享和重用组件

每个顶级组件都是一个类,它存储在其自己的 .js 文件中。这些组件可以从您的应用程序导出到您的工具箱,或者导出到可以与其他用户共享的文件。子组件可以提升为类,以便可以共享它们,并且可以链接组件的实例,以便应用于一个实例的更改自动应用于所有实例。所有这些都在 使用类 指南中进行了更详细的讨论。

创建自定义应用程序模板和用户扩展

如果您需要共享代码块而不是单个类,您可以创建自定义应用程序模板,用于启动新项目,或用户扩展,可以安装在工具箱中,并像不同应用程序中的其他组件一样使用。有关更多信息,请参阅 创建应用程序模板创建用户扩展

包含在 Architect 外部开发的资源

您的项目代码的某些部分可能在 Architect 外部开发,并作为“资源”包含在您的项目中。通常,这包括

  • JavaScript 代码,通常是执行应用程序业务逻辑的代码。
  • 自定义 CSS。
  • 在 Architect 外部开发的主题。
  • 专用数据文件。

要向您的项目添加资源

  • 一位开发人员手动将资源的文件复制到其本地系统上的项目树中的相应位置。
  • 在 Architect 中,该开发人员按照 使用资源 中的说明将该资源添加到项目中。
  • 然后,该开发人员应在本地构建和预览应用程序,以确保它与新添加的资源一起工作。
  • 将修订后的项目代码检入项目的 SCM。
  • 项目中的其他开发人员必须同步/刷新其项目副本才能在本地访问资源。

请注意,从 Sencha Architect 3.0 开始,在 Architect 外部开发的 JavaScript 代码可以打包为用户扩展,然后将其合并到您的项目中,而不是作为资源包含在其中。

有关更多信息,请参阅 使用资源

Architect 4.3