许多类在使用配置对象创建(实例化)类时都有快捷名称。快捷名称被称为 别名
(如果类扩展了 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 方法调用成功,则方法可能返回 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 框架类。*有关更多信息,请参阅 singleton 标志
- 组件类型框架类(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
的备用类名)。备用类名通常为了向后兼容性而维护。可运行的示例 (Fiddles) 默认在页面上展开。您可以使用代码块左上角的箭头单独折叠和展开示例代码块。您还可以使用页面右上角的切换按钮切换所有示例的折叠状态。切换所有状态将在页面加载之间记住。
类成员默认在页面上折叠。您可以使用成员行左侧的箭头图标或全局使用右上角的展开/折叠所有切换按钮来展开和折叠成员。
在较窄的屏幕或浏览器上查看文档将导致针对较小尺寸优化的视图。桌面视图和“移动”视图之间的主要区别在于
可以通过单击 API 文档页面顶部的类名来查看类源代码。可以通过单击成员行右侧的“查看源代码”链接来查看类成员的源代码。
日历组件(和其他高级 Ext JS 框架包)可以包含在您的 Architect 项目中。在本指南中,我们将逐步介绍如何将 ExtJS SDK 中的高级包连接到您的项目。我们还将逐步介绍在活动项目中使用日历组件所需的添加和配置。
注意: 本指南适用于 Architect 4.1+ 和 Ext JS 6.2+
Architect 附带日历组件,允许您在设计视图中使用日历组件来组合您的项目。但是,要在已保存的项目中使用它们,您需要将高级包文件夹复制到已保存的项目或 Architect 框架库文件夹。以下是您可能需要采取的两个路径,以添加必要的包文件夹以在 Architect 项目中使用。
以下步骤是将日历组件和其他高级包包含在新的 Architect 项目中所需的步骤。
在您计算机的文件浏览器中,打开 Ext JS SDK 附加组件包文件夹。
例如:{ext-addons-7.0.0}/packages
。您应该看到“calendar”文件夹以及其他包含的高级附加组件。
复制“packages”文件夹中的所有文件夹
将高级包文件夹粘贴到 Architect 框架文件夹
Mac:/Users/
PC:c:\Users\pf\Documents\Architect\frameworks\
Linux:~/Documents/Architect/frameworks/
注意: Architect 将使用“frameworks”子文件夹中最新的框架版本。例如,如果您在“frameworks/ext62”文件夹中看到 6.2.0.x 和 6.2.1.x,您需要确保将包从 6.2.1 附加组件下载添加到 6.2.1.x 文件夹。
首次保存项目后,框架资源将复制到项目的输出目录。对于以前保存的项目,您需要通过以下步骤将高级包文件夹复制到项目本身
在您计算机的文件浏览器中,打开 Ext JS SDK 附加组件包文件夹。
例如:{ext-addons-7.0.0}/packages
。您应该看到“calendar”文件夹以及其他包含的高级附加组件。
复制“packages”文件夹中的所有文件夹
将高级包文件夹粘贴到已保存项目文件夹的 {SavePath}/ext/packages
中
注意: 如果您在将包添加到保存文件夹之前已将日历组件添加到您的项目,您需要在复制高级包文件夹后重启 Architect,然后才能预览您的项目。
在 Architect 和您的项目构建都可以访问日历组件的情况下,您可以在组件工具箱面板中搜索“calendar”,并将日历面板拖到设计视图上。可以选择任何日历视图/面板。为了本演练的目的,我们将使用日历面板组件。
从“项目检查器”窗格中,单击“+”按钮,然后选择 存储 > 日历存储
将“日历模型”从“工具箱”面板拖到“项目检查器”窗格中的“模型”节点。日历模型将使用类名“MyCalendars”创建。
在“项目检查器”视图中选择“MyCalendars”存储
在配置面板中搜索“autoLoad”,并在“autoLoad”配置旁边放置一个复选框
在配置面板中搜索“model”,然后选择“MyCalendar”作为“model”配置的值
在配置面板中搜索“eventStoreDefaults”,并将以下内容添加为“eventStoreDefaults”的值
{
proxy: {
type: 'ajax',
url: 'resources/events.json'
}
}
这是一个 events.json
的示例
[{
"id": 1001,
"calendarId": 1,
"endDate": "2016-05-30T01:30:00.000Z",
"startDate": "2016-05-30T00:30:00.000Z",
"title": "Meet with Development"
}, {
"id": 1002,
"calendarId": 1,
"endDate": "2016-05-31T03:00:00.000Z",
"startDate": "2016-05-31T01:00:00.000Z",
"title": "Review with Marketing"
}]
在配置面板中搜索“proxy”,单击“Proxy”配置的 + 按钮,然后选择“Ajax Proxy”
在“项目检查器”视图中,单击“MyCalendars”存储下的“MyAjaxProxy”节点
在配置面板中搜索“url”,并将“url”的值设置为“resources/calendars.json”
这是一个 calendars.json
的示例
[{
"id": 1,
"title": "Personal"
}]
保存您的项目
添加和配置日历存储设置了工作日历所需的结构,以从远程服务器使用日历列表及其事件。在现实世界中,您必须将上面的两个“url”配置替换为您自己的服务器 url。
有关日历组件的其他信息,请参阅 日历指南。您还可以查看 Kitchen Sink 和 Google 日历示例 中的示例。