许多类在使用配置对象创建(实例化)类时使用快捷名称。快捷名称称为别名
(如果类扩展 Ext.Component,则称为xtype
)。对于可应用的类,别名/xtype 会列在类名称旁边,以便快速参考。
框架类或其成员可以指定为私有
或受保护
。否则,类/成员为公共
。公共
、受保护
和私有
是访问描述符,用于传达如何以及何时使用类或类成员。
公共类和类成员可供任何其他类或应用程序代码使用,并且可以依赖于主要产品版本中稳定的持久性。公共类和成员可以通过子类安全地扩展。
受保护类成员是稳定的公共
成员,旨在供拥有类或其子类使用。受保护的成员可以通过子类安全地扩展。
私有类和类成员由框架内部使用,不打算供应用程序开发人员使用。私有类和成员可能会随时更改或从框架中省略,恕不另行通知,并且不应依赖于应用程序逻辑。
static
标签。*参见下面的静态。下面是一个示例类成员,我们可以对其进行分析以显示类成员的语法(在本例中,从 Ext.button.Button 类中查看的 lookupComponent 方法)。
让我们看看成员行的每一部分
lookupComponent
)( item )
)Ext.Component
)。对于不返回 undefined
的方法,可以省略此项,或者可能显示用正斜杠 /
分隔的多个可能值,表示返回的内容可能取决于方法调用的结果(即,如果 get 方法调用成功,方法可能返回 Component,如果失败则返回 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
的备用类名)。备用类名通常用于向后兼容。可运行示例(Fiddle)在页面上默认展开。你可以使用代码块左上角的箭头单独折叠和展开示例代码块。你还可以使用页面右上角的切换按钮切换所有示例的折叠状态。在页面加载之间会记住切换全部状态。
类成员在页面上默认折叠。你可以使用成员行左侧的箭头图标或全局使用右上角的展开/折叠全部切换按钮来展开和折叠成员。
在较窄的屏幕或浏览器上查看文档将导致针对较小尺寸优化视图。桌面视图和“移动”视图之间的主要区别是
可以通过单击 API 文档页面顶部的类名称来查看类源。可以通过单击成员行右侧的“查看源”链接来查看类成员的源。
模型通常与存储一起使用,存储基本上是模型实例的集合。设置存储并加载其数据的方式如下
Ext.create('Ext.data.Store', {
model: 'User',
proxy: {
type: 'ajax',
url : 'users.json',
reader: 'json'
},
autoLoad: true
});
在此示例中,我们配置存储以使用Ajax 代理,提供从中加载数据的 URL 的名称和用于解码数据的读取器。在本例中,服务器返回 JSON,因此我们设置了Json 读取器来读取响应。
存储会自动从 users.json
URL 加载一组 User 模型实例。此 URL 应返回类似于以下内容的 JSON 字符串
{
success: true,
users: [
{ id: 1, name: 'Greg' },
{ id: 2, name: 'Seth' }
]
}
存储还可以内联加载其数据。在内部,Store
将我们作为数据传递的每个对象转换为Model实例
Ext.create('Ext.data.Store', {
model: 'User',
data: [
{ firstName: 'Greg', lastName: 'Barry' },
{ firstName: 'Seth', lastName: 'Lemmons' },
{ firstName: 'Mitch', lastName: 'Simoens' },
{ firstName: 'Fred', lastName: 'Mosby' }
]
});
存储能够在本地执行排序、筛选和分组,以及支持远程排序、筛选和分组
Ext.create('Ext.data.Store', {
model: 'User',
sorters: ['name', 'id'],
filters: {
property: 'name',
value : 'Ed'
},
groupField: 'age',
groupDir: 'DESC'
});
在我们创建的存储中,数据首先按名称排序,然后按 ID 排序;最后,筛选仅包括名称为 Ed
的用户,并且按年龄降序对数据进行分组。使用 Store API,你可以随时更改排序、筛选和分组。