许多类在使用配置对象创建(实例化)类时具有用于快捷方式的名称。此快捷方式名称称为别名
(如果类扩展 Ext.Component,则称为xtype
)。对于适用的类,别名/xtype 会列在类名称旁边以供快速参考。
框架类或其成员可以指定为private
或protected
。否则,类/成员为public
。Public
、protected
和private
是访问描述符,用于传达如何以及何时使用类或类成员。
Public类和类成员可供任何其他类或应用程序代码使用,并且可以在主要产品版本中作为稳定且持久的内容。Public 类和成员可以通过子类安全地进行扩展。
Protected类成员是稳定的public
成员,旨在供拥有类或其子类使用。Protected 成员可以通过子类安全地进行扩展。
框架内部使用Private类和类成员,不打算供应用程序开发人员使用。Private 类和成员可能会在任何时候更改或从框架中省略,并且不应在应用程序逻辑中依赖它们。
static
标签。*请参见下文的“静态”。下面是一个示例类成员,我们可以对其进行剖析以显示类成员的语法(在本例中,从 Ext.button.Button 类查看 lookupComponent 方法)。
我们来看一下成员行的每一部分
lookupComponent
)( item )
)Ext.Component
)。对于不返回 undefined
之外的任何内容的方法,可以省略此项,或者可能显示用正斜杠 /
分隔的多个可能值,表示返回的内容可能取决于方法调用的结果(即,如果 get 方法调用成功,则方法可能返回一个组件,如果失败则返回 false
,将显示为 Ext.Component/Boolean
)。PROTECTED
- 请参阅下面的标志部分)Ext.container.Container
)。如果成员源自当前类,则源类将显示为蓝色链接;如果成员是从祖先类或混合类继承的,则显示为灰色。查看源
)item : Object
)列出。undefined
之外的值,则“返回”部分将记录返回的类或对象类型以及描述(本例中为 Ext.Component
)自 3.4.0 起可用
- 示例中未显示)默认为:false
)API 文档使用许多标志来进一步传达类成员的功能和意图。标签可以用文本标签、缩写或图标表示。
classInstance.method1().method2().etc();
false
,则不会触发- 表示框架类
- 单例框架类。*有关更多信息,请参阅单例标志
- 组件类型框架类(Ext JS 框架中扩展 Ext.Component 的任何类)
- 表示类、成员或指南在当前查看的版本中是新的
- 表示类型为 config
的类成员
- 表示类型为 property
的类成员
- 表示类型为 method
的类成员
- 表示类型为 event
的类成员
- 表示类型为 theme variable
的类成员
- 表示类型为 theme mixin
的类成员
- 表示类、成员或指南在当前查看的版本中是新的
在 API 文档页面上类名称正下方是与当前类拥有的成员类型相对应的按钮行。每个按钮按类型显示成员数(此计数在应用筛选器时更新)。单击按钮将导航到该成员部分。将鼠标悬停在成员类型按钮上将显示一个弹出菜单,其中包含该类型的所有成员,以便快速导航。
与类配置选项相关的 Getter 和 Setter 方法将显示在方法部分以及 API 文档和成员类型菜单的配置部分中,它们位于与其一起工作的配置正下方。Getter 和 Setter 方法文档将位于配置行中,以便于参考。
您的页面历史记录保存在本地存储中,并显示在顶部标题栏正下方(使用可用空间)。默认情况下,仅显示与您当前正在查看的产品/版本匹配的搜索结果。您可以通过单击历史记录栏右侧的 按钮并选择“全部”单选选项来扩展显示内容。这将显示历史记录栏中所有产品/版本的所有近期页面。
在历史记录配置菜单中,您还将看到最近访问的页面列表。结果按“当前产品/版本”和“全部”单选选项进行筛选。单击 按钮将清除历史记录栏以及保存在本地存储中的历史记录。
如果在历史记录配置菜单中选择了“全部”,则将启用“在历史记录栏中显示产品详细信息”复选框选项。选中后,每个历史页面的产品/版本将与历史记录栏中的页面名称一起显示。将光标悬停在历史记录栏中的页面名称上还将显示产品/版本作为工具提示。
可以使用页面顶部的搜索字段搜索 API 文档和指南。
在 API 文档页面上还有一个筛选器输入字段,它使用筛选器字符串筛选成员行。除了按字符串筛选外,您还可以按访问级别、继承和只读筛选类成员。这是使用页面顶部的复选框完成的。
API 类导航树底部的复选框筛选类列表以包括或排除私有类。
单击空搜索字段将显示您最近的 10 次搜索,以便快速导航。
每个 API 文档页面(Javascript 原始页面除外)都有一个与该类相关的元数据菜单视图。此元数据视图将具有以下一个或多个
Ext.button.Button
类有一个备用类名 Ext.Button
)。备用类名通常用于向后兼容。可运行的示例(小提琴)在页面上默认展开。您可以使用代码块左上角的箭头单独折叠和展开示例代码块。您还可以使用页面右上角的切换按钮切换所有示例的折叠状态。切换所有状态将在页面加载之间记住。
类成员在页面上默认折叠。您可以使用成员行左侧的箭头图标或使用右上角的展开/折叠全部切换按钮全局展开和折叠成员。
在较窄的屏幕或浏览器上查看文档将导致针对较小尺寸优化视图。桌面和“移动”视图之间的主要区别是
可以通过单击 API 文档页面顶部的类名来查看类源代码。可以通过单击成员行右侧的“查看源代码”链接来查看类成员的源代码。
本指南讨论作为团队的一部分开发 Architect 应用程序的机制。Architect 使用的 MVC 应用程序架构不仅可以创建健壮且可移植的应用程序,而且还适用于团队开发环境。专家可以贡献适当部分的代码,用户界面专家创建视图,而业务和数据专家开发模型和存储。
作为团队开发 Architect 应用程序包括以下步骤
Architect 包含允许您在不同项目和不同开发人员之间共享代码片段的功能。
Sencha 强烈建议将所有项目的源代码保存在源代码管理 (SCM) 系统中。这将提供对所有文件所做更改的详细历史记录以及代码的备份保护。大多数现代 SCM 系统还提供工具,以便在多个人修改同一文件时合并更改。SCM 还应允许你为不同的版本维护分支。
Sencha 源代码是在 Git 下开发的,我们的示例项目可公开下载,使用 Git。还有许多其他优秀的 SCM 可用,并且应该可以很好地与 Sencha Architect 配合使用。
在开始你的项目之前,你应该设置你的 SCM 并定义 Architect 项目的存储位置、谁拥有何种源代码访问权限、在适当情况下设置备份程序,并安排 SCM 的管理和维护。这些主题超出了本指南的范围。
一个人,可能是团队负责人,需要启动 Architect 项目。
选择你想要使用的框架和版本,并选择一个合适的应用程序模板,或选择空白模板来启动一个空白项目。
创建 Architect 项目的第一步是命名应用程序。
要命名应用程序
单击位于屏幕右上角的项目检查器窗口顶部的“应用程序”。
在配置面板中找到 "name"
,并将其设置为你的项目名称,例如 "MyProject"
。项目名称应以大写字母开头。
这将设置表示应用程序的应用程序节点 类。通常,这是一个使用视口的单页,它使应用程序中的所有类(其模型、视图、控制器和存储)驻留在一个名称空间下。当单页准备就绪且应用程序的所有 JavaScript 加载完成后,将调用应用程序的启动函数。启动函数通常运行启动应用程序的“引导”代码。
对于简单的应用程序,通常只需为应用程序节点设置 "name"
即可。对于更复杂的应用程序,你可能需要设置其他配置。
按照 保存你的项目 中的说明保存你的项目。
当你第一次保存项目时,Architect 将为该项目创建一个项目目录。
该对话框将向你显示保存的位置。惯例是使用你在上一步中分配的应用程序 name
的小写版本来命名目录。因此,如果你用于应用程序 name
的名称是 "MyProject"
,则项目的目录将被命名为 "myproject"
。此惯例不受 Architect 强制执行,但它可以让你更容易地跟踪你在做什么。
请参阅下一部分,了解 Architect 创建的文件和目录的详细列表。
整个项目应进行版本控制,但有以下例外
你可以安全地设置你的 SCM 以忽略这些文件。
开发团队的每个成员都应在他们的本地系统上安装并设置 Sencha Architect 和 Web 服务器。有关说明,请参阅 安装和设置 指南。
在项目负责人将项目检入 SCM 后,每个团队成员都可以将存储库克隆到自己的系统,然后使用 Architect 启动屏幕上的“打开现有项目”链接在本地打开项目并开始编码。
团队成员应经常保存他们的工作,并定期将他们的更改检入 SCM。
项目存档是一个包含 Architect 项目所有组件的文件。它可以提供给开发团队之外的用户,他们可以将其下载到本地磁盘,加载到 Architect 中,并对其进行审查或修改。当你想要与 Sencha 社区或项目团队之外的其他人员共享你的 Architect 项目时,这将非常有用。
要创建项目存档
Architect 会创建一个扩展名为 .xda 的文件,该文件可上传到服务器、通过电子邮件发送、复制到 USB 驱动器,等等。然后,其他人可以下载此文件并在 Architect 中将其打开。如果他们对项目进行修改,则可以创建一个包含这些更改的存档。
.xda 文件应始终检入到 SCM 中,但存档并非旨在提供或取代源代码管理以存储和跟踪更改。
每个顶级组件都是一个存储在其自己的 .js 文件中的类。这些组件可以从您的应用程序导出到工具箱,或导出到可与其他用户共享的文件中。子组件可以提升为类,以便可以共享,并且可以链接组件的实例,以便对一个实例应用的更改自动应用到所有实例。所有这些内容都在使用类指南中进行了更详细的讨论。
如果您需要共享代码块而不是单个类,则可以创建用于启动新项目或可安装在工具箱中并像不同应用程序中的其他组件一样使用的用户扩展的自定义应用程序模板。有关更多信息,请参阅创建应用程序模板和创建用户扩展。
项目代码的某些部分可能在 Architect 外部开发,并作为“资源”包含到您的项目中。通常包括
向项目添加资源
请注意,从 Sencha Architect 3.0 开始,在 Architect 外部开发的 JavaScript 代码可以打包为用户扩展,然后将其合并到您的项目中,而不是将其作为资源包含在内。
有关更多信息,请参阅使用资源。