许多类在使用配置对象创建(实例化)类时使用快捷名称。快捷名称称为别名
(如果类扩展了 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 方法调用成功,则方法可能会返回一个组件,或者如果失败则返回 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
,则标记为可阻止的事件将不会触发。- 表示框架类
- 单例框架类。*有关更多信息,请参见单例标志
- 组件类型框架类(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 文档页面顶部的类名来查看类源代码。可以通过单击成员行右侧的“查看源代码”链接来查看类成员的源代码。
从 ExtJS 5.0 开始,开发人员可以使用 Widget Column 类 将组件嵌入网格单元格中。
从 ExtJS 6.2.0 开始,开发人员可以使用 Row Widget 插件 配置一个组件,使其显示在数据行下方(或可配置地显示在上方)的扩展行中。
在本指南中,我们将介绍如何在网格单元格或扩展行中嵌入组件。
Widget Column 允许您轻松地将任何组件嵌入网格单元格中。添加 Widget Column 再简单不过了。只需将您的列分配一个 xtype
为 "widgetcolumn" 并指定其 widget 配置。widget
配置是一个包含要为每个单元格创建的 xtype 的对象。此 xtype
可以引用任何 Ext.Widget 或 Ext.Component 类。
使用 Widget Column 将 Sparkline 小部件添加到网格中,您可以实现令人印象深刻的数据可视化,如下所示。
有关上述图像的实时示例,请访问 Widget Grid。
说够了,让我们看看这个东西的实际效果。在以下示例中,我们创建一个 store,其中包含一组小的记录,这些记录填充了一个带有 Widget Column 的网格。
Widget Column 包含一个进度条小部件,该小部件添加到每一行。
var store = Ext.create('Ext.data.Store', {
fields: ['name','progress'],
data: [
{ name: 'Test 1', progress: 0.10 },
{ name: 'Test 2', progress: 0.23 },
{ name: 'Test 3', progress: 0.86 },
{ name: 'Test 4', progress: 0.31 }
]
});
Ext.create({
xtype: 'grid',
title: 'Widget Column Demo',
store: store,
columns: [{
text: 'Test Number',
dataIndex: 'name',
width: 100
}, {
xtype: 'widgetcolumn',
text: 'Progress',
width: 120,
dataIndex: 'progress',
widget: {
xtype: 'progressbarwidget',
textTpl: '{value:percent}'
}
}],
width: 220,
height: 250,
renderTo: document.body
});
Widget 列的 widget
配置用于定义要嵌入单元格中的组件类型。根据 widget
配置中包含的 xtype
,Widget 列将创建并管理所需组件实例的生命周期。此配置不能是已有的实例,因为 Widget 列需要每个渲染单元格一个实例。
每个实例都自动与网格中的特定记录和行连接。在网格的整个生命周期中,为一行创建的小部件将被“回收”并连接到不同的记录和行。
列的 dataIndex
引用的字段绑定到嵌入组件的 defaultBindProperty
。
从 6.2.0 开始,嵌入网格的组件可以访问 ViewModel 和其中的所有数据。ViewModel 包含两个特定于行的属性
record
recordIndex
该 Row Widget 插件。 允许开发人员指定一个组件嵌入到扩展行中,这与使用 Widget 列非常相似
要启用此功能,请使用 widget
属性配置 RowWidget 插件
plugins: [{
ptype: 'rowwidget',
// The widget definition describes a widget to be rendered into the expansion row.
// It has access to the application's ViewModel hierarchy. Its immediate ViewModel
// contains a record and recordIndex property. These, or any property of the record
// (including association stores) may be bound to the widget.
widget: {
xtype: 'form'
...
嵌入的组件可以访问网格的 ViewModel,包括 record
和 recordIndex
属性。
网格可以使用 rowViewModel 设置进行配置,该设置可以指定要创建的 ViewModel 的 type
,其中可能包括自定义数据和公式,以帮助为小部件提供数据。
该 Ext.Widget 类,或简称为 “小部件”,是一个类似于 Component 的轻量级类,但仅包含一个 Ext.dom.Element 和关联的监听器。这使得小部件与普通组件有很大不同,因为 Ext.Widget 类不是从 Ext.Component 派生的。Component 提供了强大的生命周期管理,这增加了大量的功能。但是,此功能也有一定的成本。
我们为 ExtJS 提供了一些库存小部件。这些包括
与普通组件一样,小部件可以添加到 items 容器。例如,我们可以将 Sparkline 添加到 工具栏
var panel = Ext.create({
xtype: 'panel',
title: 'Title',
frame: true,
renderTo: document.body,
width: 250,
height: 150,
html: 'Some text',
tbar: [{
text: 'Button'
}, '->', {
xtype: 'sparklineline',
fillColor: '#ddf',
width: 100,
height: 20,
values: [2, 3, 0, 4, -1]
}]
});
在 Sparklines 的情况下,您必须提供一个大小(width
和 height
),或者使用 ExtJS 布局 管理器来做到这一点。这是因为内部绘图没有自然大小。
虽然 ExtJS 附带了 "小部件化" 版本的滑块和进度条以及新的 Sparklines,但您很可能需要创建自己的小部件。是否从 Ext.Component 还是 Ext.Widget 派生,实际上取决于所创建类的复杂性。
简单组件通常可以避免像组件生命周期和布局这样的东西,只需将配置属性映射到相关元素,同时响应元素事件(例如“click”、“dblclick”、“mouseover”等)。
要创建小部件,您可以扩展 Ext.Widget 并定义您的元素模板及其 监听器。
Ext.define('MyWidget', {
extend: 'Ext.Widget',
// The element template - passed to Ext.Element.create()
element: {
reference: 'element',
listeners: {
click: 'onClick'
},
children: [{
reference: 'innerElement',
listeners: {
click: 'onInnerClick'
}
}]
},
constructor: function(config) {
// Initializes our element from the template, and calls initConfig().
this.callParent([config]);
// After calling the superclass constructor, the Element is available and
// can safely be manipulated. Reference Elements are instances of
// Ext.Element, and are cached on each Widget instance by reference name.
},
onClick: function() {
// Listeners use this Widget instance as their scope
console.log('element clicked', this);
},
onInnerClick: function() {
// Access the innerElement reference by name
console.log('inner element clicked', this.innerElement);
}
});
对于那些编写过 ExtJS Modern 组件的人来说,这会感觉非常熟悉。这是因为 Ext.Widget 是 ExtJS Modern 中 Ext.AbstractComponent 的增强版本。能够向 element
模板添加 listeners
是这些增强功能之一,但还有其他一些增强功能。有关更多详细信息,请参阅 Ext.Widget 的文档。