许多类在使用配置对象创建(实例化)类时都有快捷名称。快捷名称被称为 别名
(如果该类扩展了 Ext.Component,则称为 xtype
)。别名/xtype 列在适用类的类名旁边,以便快速参考。
框架类或其成员可以指定为 private
或 protected
。否则,该类/成员为 public
。Public
、protected
和 private
是访问描述符,用于传达类或类成员应如何以及何时使用。
Public 类和类成员可供任何其他类或应用程序代码使用,并且在主要产品版本中可以被认为是稳定和持久的。公共类和成员可以通过子类安全地扩展。
Protected 类成员是稳定的 public
成员,旨在由拥有类或其子类使用。受保护的成员可以通过子类安全地扩展。
Private 类和类成员由框架内部使用,不供应用程序开发人员使用。私有类和成员可能会随时更改或从框架中省略,恕不另行通知,并且不应在应用程序逻辑中依赖它们。
static
标签。 *见下面的静态。下面是一个示例类成员,我们可以对其进行剖析,以展示类成员的语法(在本例中是从 Ext.button.Button 类查看的 lookupComponent 方法)。
让我们看一下成员行的每个部分
lookupComponent
)( item )
)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 文档使用许多标志来进一步沟通类成员的功能和意图。标签可以用文本标签、缩写或图标表示。
classInstance.method1().method2().etc();
false
,则标记为可阻止的事件将不会触发- 表示框架类
- 单例框架类。 *有关更多信息,请参阅 singleton 标志
- 组件类型框架类(Ext JS 框架中扩展 Ext.Component 的任何类)
- 表示类、成员或指南在当前查看的版本中是新的
- 表示类型为 config
的类成员
- 表示类型为 property
的类成员
- 表示类型为 method
的类成员
- 表示类型为 event
的类成员
- 表示类型为 theme variable
的类成员
- 表示类型为 theme mixin
的类成员
- 表示类、成员或指南在当前查看的版本中是新的
在 API 文档页面的类名正下方是一行按钮,对应于当前类拥有的成员类型。每个按钮显示按类型划分的成员计数(此计数会随着过滤器的应用而更新)。单击按钮会将您导航到该成员部分。将鼠标悬停在成员类型按钮上将显示该类型的所有成员的弹出菜单,以便快速导航。
与类 config 选项相关的 Getter 和 Setter 方法将显示在方法部分以及 API 文档和成员类型菜单的 config 部分,就在它们所作用的 config 下方。Getter 和 Setter 方法文档将在 config 行中找到,以便于参考。
您的页面历史记录保存在本地存储中,并在顶部标题栏正下方显示(使用可用的实际空间)。默认情况下,仅显示与您当前查看的产品/版本匹配的搜索结果。您可以通过单击历史记录栏右侧的 按钮并选择“全部”单选选项来展开显示的内容。这将显示历史记录栏中所有产品/版本的所有最近页面。
在历史记录配置菜单中,您还将看到最近访问页面的列表。结果按“当前产品/版本”和“全部”单选选项过滤。单击 按钮将清除历史记录栏以及保存在本地存储中的历史记录。
如果在历史记录配置菜单中选择“全部”,则将启用“在历史记录栏中显示产品详细信息”的复选框选项。选中后,每个历史页面的产品/版本将与历史记录栏中的页面名称一起显示。将光标悬停在历史记录栏中的页面名称上也会将产品/版本显示为工具提示。
可以使用页面顶部的搜索字段搜索 API 文档和指南。
在 API 文档页面上,还有一个过滤器输入字段,该字段使用过滤器字符串过滤成员行。除了按字符串过滤外,您还可以按访问级别、继承和只读过滤类成员。这是通过使用页面顶部的复选框完成的。
API 类导航树底部的复选框过滤类列表以包含或排除私有类。
单击空的搜索字段将显示您最近 10 次搜索,以便快速导航。
每个 API 文档页面(JavaScript 原始类型页面除外)都有一个与该类相关的元数据菜单视图。此元数据视图将具有以下一项或多项
Ext.button.Button
类具有 Ext.Button
的备用类名称)。备用类名称通常是为了向后兼容性而维护的。可运行的示例 (Fiddles) 默认在页面上展开。您可以使用代码块左上角的箭头单独折叠和展开示例代码块。您还可以使用页面右上角的切换按钮切换所有示例的折叠状态。切换所有状态将在页面加载之间记住。
类成员默认在页面上折叠。您可以使用成员行左侧的箭头图标或全局使用右上角的展开/折叠全部切换按钮来展开和折叠成员。
在较窄的屏幕或浏览器上查看文档将导致针对较小外形尺寸优化的视图。桌面视图和“移动”视图之间的主要区别在于
可以通过单击 API 文档页面顶部的类名来查看类源代码。可以通过单击成员行右侧的“查看源代码”链接来查看类成员的源代码。
本指南讨论如何在您的项目中使用用户扩展。有关创建您自己的扩展的信息,请参阅创建用户扩展指南。
用户扩展功能使您能够将 Architect 外部开发的组件(类)合并到您的 Architect 项目中。来自已为 Architect 打包的用户扩展的组件可以从工具箱中拖动,在 Architect 画布中呈现,通过 Architect 配置面板进行配置,并在 Architect 内部像任何其他组件一样进行维护。
使用这些扩展可以节省您重写其他人已经编码的功能的精力。它们还包括广泛的测试和广泛的社区使用的额外好处。
Architect 用户扩展以易于下载和安装的软件包形式交付。请务必选择与您用于 Architect 项目的框架兼容的软件包。
用户扩展在其自己的沙箱中运行,这提供了在运行从 Web 下载的代码时所需的安全性。
要下载用户扩展
要将用户扩展合并到 Architect 项目中
.aux
扩展名的文件。文件
菜单并选择“安装用户扩展”。.aux
文件并选择它。扩展成功安装后,它将在工具箱中“扩展”下方的其自己的类别中列出。它将包含一个括号中的数字,指示扩展中包含的类总数。
用户扩展中包含的类也可能包含在其他类别中。例如,“拖放区域”和“调度器网格”类都列在“容器”类别下。
形状像拼图的图标表示此类是用户扩展的一部分。当使用用户扩展中的类时,项目检查器中也会显示相同的图标。
如果扩展未成功安装,则该软件包可能缺少文件、关键配置参数或存在其他问题。
Architect 将一些有用的调试信息输出到 Sencha Architect 日志中,以帮助您分析问题。
成功安装用户扩展包后,扩展中的组件将列在工具箱的“扩展”类别下,并且可能在另一个合适的类别下。
您可以像任何其他组件一样将任何组件拖到画布或项目检查器中。您也可以在配置面板中设置其配置。
来自用户扩展的一些组件会自动创建多个顶级组件。例如,一种特殊类型的视图可能带有商店和带有预配置字段的模型。在这种情况下,Architect 会将它们创建为一个链接组。此链接允许 Architect 在您尝试删除作为该链接组的成员的组件时警告您,因为这些组件是相互依赖的。
您还可以使用键盘快捷键 ⌘+ 和 ⌘+- (Mac) 或 Ctrl++ 和 Ctrl+- (Windows 和 Linux) 在选择链接组中的组件之间循环。
当您保存或构建项目时,项目中使用的每个扩展的副本都将保存在您的项目文件夹中,因此它将包含在您未来的项目中。
扩展开发人员控制哪些配置项是可见的,并创建具有合理默认值的其他配置项。然后,最终用户可以根据需要调整这些值。
用户扩展包是版本控制的。您可以在系统上安装用户扩展包的多个版本,但只有最新的(编号最高的)包会加载并在工具箱中可见。
如果您打开一个使用较旧版本的用户扩展包的项目,Architect 会加载该包的较旧版本,但会提示您选择替代方案。
要从您的系统中卸载用户扩展包,请右键单击工具箱中的用户扩展,然后从下拉菜单中选择“卸载扩展”
注意: 您可以通过进入 首选项 屏幕来更改用户扩展的安装位置。在 Mac 上单击 Sencha Architect 下拉菜单中的“首选项”,或在 Windows 和 Linux 上单击“编辑”下拉菜单,然后修改“扩展”字段的值