文档帮助

术语、图标和标签

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

访问级别

框架类或其成员可以指定为 private(私有)或 protected(受保护)。否则,类/成员为 public(公共)。Publicprotectedprivate 是访问描述符,用于传达应如何以及何时使用类或类成员。

成员类型

成员语法

下面是一个示例类成员,我们可以对其进行剖析,以显示类成员的语法(在本例中是从 Ext.button.Button 类查看的 lookupComponent 方法)。

lookupComponent ( item ) : Ext.Component
受保护的

当原始配置对象添加到此容器时调用,无论是在 items 配置的初始化期间,还是在 添加新项时或 {@link #insert 插入} 时调用。

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

当需要对子组件创建应用特殊处理时,可以在子类中重写此方法。

参数

item :  Object

正在添加的配置对象。

返回值
Ext.Component

要添加的组件。

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

成员标志

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

类图标

- 表示框架类

- 单例框架类。 *有关更多信息,请参阅单例标志

- 组件类型框架类(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) 默认在页面上展开。您可以使用代码块左上角的箭头单独折叠和展开示例代码块。您还可以使用页面右上角的切换按钮切换所有示例的折叠状态。所有示例的切换状态将在页面加载之间记住。

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

桌面 -vs- 移动视图

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

查看类源代码

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

Architect 4.3


顶部

应用模板文件结构

有关创建自定义应用模板的说明,请参阅 创建应用模板

已安装的自定义应用模板的文件和目录为

template.json                # Template metadata such as title, category and description 
template.xda                # Project archive containing the template code
preview.png                    # (Optional) Preview PNG image. 
preview/                    # (Optional) Provides a live preview of template within architect        
    app/                    # Any architect app with index.html can be used for preview
        controller/
            Tasks.js
        model/
            Tasks.js
        store/
            Tasks.js
        view/
            FormPanel.js
            MainView.js
            TaskList.js
    index.html
    app.js

默认情况下,自定义应用模板的文件位于 Documents/Architect/Templates 下。模板从文件夹动态读取,这意味着您可以轻松地通过源代码控制或复制/粘贴来共享模板集。

此位置可以在设置中通过转到

Edit Menu > Preferences > File > Templates.

如果更改此位置,任何现有模板都将自动迁移。

重要的是尽量保持模板尽可能精简。当从当前项目或项目归档文件 .xda 文件创建模板时,任何不需要的项目(例如构建文件、用户设置或 SDK 文件)都会自动删除。

模板预览图像

您可以将 preview.png 文件包含在模板中,以便在 Architect 模板浏览器中为用户提供可视化预览。预览图像的建议尺寸为

  • 对于面向桌面或平板电脑的模板:800x600
  • 对于面向手机的模板:325x525

模板预览

您还可以将实时预览与模板一起包含。当您从当前项目或项目归档文件 .xda 文件创建模板时,会自动为您创建一个预览文件夹,但您可以随时编辑预览文件。

注意: 预览文件夹必须包含 index.html 文件才能正常工作。

模板元数据

模板元数据存储在 template.json 中,如下所示

{
    "title": "Button Template",
    "name": "ButtonProject",
    "description": "A template with a big button.",
    "category": "My Templates",
    "framework": "ext42"
}

以下模板值存储在那里。

属性 类型 必需 默认 描述
name string true -- 模板的项目名称。(不应编辑)
framework string true -- 模板框架。示例 “ext42”。(不应编辑)
title string true -- 要在模板浏览器中使用的显示标题。
category string true -- 在模板浏览器中显示模板的类别。
description string false -- 模板的详细描述。
usePreviewImage boolean false false 强制模板使用预览图像而不是实时模板。
profile string false -- 确定模板在模板浏览器中的显示和预览方式。

高级模板编辑

要在创建或导入模板后编辑模板,请直接在本地模板文件夹中编辑它们。您可以直接编辑 template.json 元数据文件、预览图像和实时预览文件。但是,由于实际模板代码在内部存储为项目归档文件 template.xda,因此您必须使用以下方法在 Architect 中对其进行编辑。

  • 在模板文件夹中找到 template.xda 文件。
  • 选择 “File”(文件)> “Import Archive”(导入归档)
  • 根据需要编辑项目,然后保存到临时位置。
  • 选择 “File”(文件)> “Archive Project”(归档项目)。
  • 将新项目归档文件另存为模板文件夹中的 template.xda,覆盖原始归档文件。
  • 确保模板元数据中的 frameworkcategory 值与归档项目的值匹配。

模板版本控制和升级

模板特定于 ExtJS 版本。除非 template.xda 也已升级,否则不应更改 template.json 中的 framework 值。如果要升级模板,最好从模板创建一个新项目,将项目升级到所需的框架,然后从打开的项目创建一个新模板。有关升级项目库版本的更多详细信息,请参阅 使用资源 > 升级库

Architect 4.3