文档帮助

术语、图标和标签

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

访问级别

框架类或其成员可以指定为 private（私有的）或 protected（受保护的）。否则，该类/成员为 public（公共的）。Public、protected 和 private 是访问描述符，用于传达类或类成员应该如何以及何时使用。

Public 类和类成员可供任何其他类或应用程序代码使用，并且在主要产品版本中可以作为稳定和持久的内容依赖。公共类和成员可以通过子类安全地扩展。
Protected 类成员是稳定的 public 成员，旨在由拥有类或其子类使用。受保护的成员可以通过子类安全地扩展。
Private 类和类成员在框架内部使用，不供应用程序开发人员使用。私有类和成员可能会在任何时候更改或从框架中省略，恕不另行通知，并且不应在应用程序逻辑中依赖。

成员类型

Config（配置） - 类的配置选项。
Property（属性） - 类实例化后设置。*请参阅下面的只读。
Method（方法） - 可以由类执行的操作。方法应被理解为实例方法，并且只能从给定类的实例调用。可以直接从类本身调用的静态方法将在方法名称旁边带有 static（静态）标签。*请参阅下面的静态。
Event（事件） - 事件是框架事件系统特有的，允许类以编程方式引发事件，以便由一个或多个事件处理方法处理。DOM 事件虽然由框架事件系统处理，但未在 API 文档中专门描述。*对于 DOM 事件，请参阅 MDN 的事件参考页面。
Theme Variable（主题变量） - 框架使用的视觉主题引擎使用的变量。
Theme Mixin（主题混入） - 框架使用的视觉主题引擎使用的函数，可以使用在各种主题变量中设置的值。

成员语法

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

Ext.container.Container

查看源代码

lookupComponent ( item ) : Ext.Component

受保护的

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

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

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

参数

item : Object

正在添加的配置对象。

返回值

Ext.Component

要添加的组件。

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

展开/折叠 - 成员行的左侧是一个控件，用于展开和折叠每个成员行以显示/隐藏成员详细信息。
成员名称 - 类成员的名称（在本例中为 lookupComponent）
方法参数 - 方法使用的任何必需或可选参数（或传递给事件处理方法的参数）将列在方法名称旁边的括号内（在本例中为 ( item )）
返回类型 - 方法或属性返回的类实例或 javascript 对象（在本例中为 Ext.Component）。对于不返回除 undefined 之外的任何内容的方法，可以省略此项，或者可以显示为用正斜杠 / 分隔的多个可能值，表示返回的内容可能取决于方法调用的结果（即，如果 get 方法调用成功，则方法可能返回一个 Component，如果失败，则返回 false，这将显示为 Ext.Component/Boolean）。
标志 - 适用于成员的任何标志都将显示在下一个位置（在本例中为 PROTECTED - 请参阅下面的标志部分）
成员来源 - 成员行的右侧是最初描述成员的类（在本例中为 Ext.container.Container）。如果成员源自当前类，则源类将显示为蓝色链接，如果它从祖先类或混入类继承，则显示为灰色。
成员源代码 - 成员来源类右侧下方是查看成员源代码的链接（示例中为 view source）
参数列表 - 类方法的每个参数都将使用上面括号中找到的相同名称、预期的类或对象类型以及参数的描述列出（示例中为 item : Object）。
返回值 - 如果类返回除 undefined 之外的值，则“返回值”部分将注释返回的类或对象类型以及描述（示例中为 Ext.Component）
Since（示例中未显示） - 某些成员将显示成员首次引入的产品版本（即 Available since 3.4.0 - 示例中未显示），紧随成员描述之后
Default（示例中未显示） - 配置通常显示要应用于类实例的默认配置值（如果未被覆盖）（即 Defaults to: false）

成员标志

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

Required（必需） - 实例化类时必需的配置
Bindable（可绑定） - 配置具有 setter，允许通过 ViewModel 绑定设置此配置
Read Only（只读） - 属性可以读取，但不能用于在运行时配置/重新配置类实例
Singleton（单例） - 单例类在定义后立即实例化，并且不能手动实例化
Static（静态） - 静态方法或属性是属于类本身的方法或属性，而不是类的实例
Chainable（可链式调用） - 指的是在调用时返回类实例的方法。
这使得可以进行链式方法调用，例如：classInstance.method1().method2().etc();
Deprecated（已弃用） - 计划在未来框架版本中删除的类或成员，并在当前版本中提供以实现向后兼容性。
已弃用的类和成员将有一条消息，指导您使用首选的类/方法。
Removed（已删除） - 已删除的类或成员，仅在文档中作为在框架版本之间升级的用户的参考存在
Template（模板） - 在基类中定义的方法，旨在由子类重写
Abstract（抽象） - 类或成员可以定义为抽象的。抽象类和成员建立类结构并提供有限的（如果有）代码。特定于类的代码将通过子类中的重写提供。
Preventable（可阻止） - 如果从事件处理程序返回 false，则标记为可阻止的事件将不会触发

类图标

- 表示框架类

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

- 组件类型框架类（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 原始类型页面除外）都有一个与该类相关的元数据菜单视图。此元数据视图将具有以下一个或多个

Alternate Name（备用名称） - 一个或多个附加的类名称同义词（在 Ext JS 6.0.0 中，Ext.button.Button 类具有 Ext.Button 的备用类名称）。通常维护备用类名称以实现向后兼容性。
Hierarchy（层次结构） - 层次结构视图列出了当前类的继承链，从祖先类一直到根基类。
Mixins（混入） - 混入到当前类中的类列表
Inherited Mixins（继承的混入） - 混入到当前类的祖先中的类列表
Requires（需要） - 实例化类所需定义的所有类
Uses（使用） - 类在其生命周期中的某个时间点可能使用的类列表，但不一定是最初实例化类所必需的
Subclasses（子类） - 扩展当前类的类

展开和折叠示例和类成员

可运行的示例 (Fiddles) 默认在页面上展开。您可以使用代码块左上角的箭头单独折叠和展开示例代码块。您还可以使用页面右上角的切换按钮切换所有示例的折叠状态。切换所有状态将在页面加载之间记住。

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

桌面与移动视图

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

全局导航将位于左侧菜单中，可通过汉堡菜单图标访问。菜单包含以下内容（在大多数页面上）
- 当前产品的名称（作为产品着陆页的链接）
- 用于导航回文档主页的 Sencha 图标
- 产品菜单下拉按钮
- API 文档和指南的导航树选项卡
当前上下文导航和工具位于右侧，可通过齿轮图标访问。上下文菜单包含以下内容
- 全局搜索输入字段
- （API 文档）“过滤器”选项卡，其中包含成员过滤器、展开/折叠所有示例按钮、展开/折叠所有成员行按钮、访问级别过滤器复选框以及每个成员的计数
- （API 文档）包含与当前类相关的元数据菜单的“相关类”选项卡
- （指南）指南的目录

查看类源代码

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

Ext JS 7.8.0 - Classic Toolkit

显示私有类

顶部

指南适用于： classic

在网格中使用组件

自 ExtJS 5.0 以来，开发人员已经能够使用 Widget 列类将组件嵌入到网格单元格中。

从 ExtJS 6.2.0 开始，开发人员可以使用 Row Widget 插件配置要在数据行下方的扩展行（或可配置地在上方）中显示的组件。

在本指南中，我们将介绍如何将组件嵌入到网格单元格或扩展行中。

Widget 列

Widget 列允许您轻松地将任何 Component 嵌入到网格单元格中。添加 Widget 列非常容易。只需为您的列分配 “widgetcolumn” 的 xtype 并指定其 widget 配置。widget 配置是一个对象，其中包含为每个单元格创建的 xtype。此 xtype 可以引用任何 Ext.Widget 或 Ext.Component 类。

使用 Widget 列向网格添加 Sparkline widget，您可以实现令人印象深刻的数据可视化，如下所示。

有关上述图像的实时示例，请访问 Widget Grid。

说得够多了，让我们看看它的实际效果。在以下示例中，我们创建一个 store，其中包含少量记录，这些记录使用 Widget 列填充网格。

Widget 列包含一个进度条 widget，该 widget 被添加到每一行。

展开代码

JS 运行

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 配置用于定义要嵌入到单元格中的组件类型。根据 widget 配置中包含的 xtype，Widget 列将创建和管理所需组件实例的生命周期。此配置不能是已存在的实例，因为 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，其中可能包括自定义数据和公式，以帮助为 widget 提供数据。

请参阅 Row Widget Grid

什么是 Widget？

Ext.Widget 类，或简称为 “widget”，是一个类似于 Component 的轻量级类，但仅由 Ext.dom.Element 和关联的监听器组成。这使得 Widget 与普通 Component 非常不同，因为 Ext.Widget 类不是从 Ext.Component 派生的。Component 提供了强大的生命周期管理，这增加了很多功能。然而，此功能也带来了一些成本。

我们为 ExtJS 提供了一些库存 Widget。这些包括

进度条 (Ext.Progress 或 “progressbarwidget”)
滑块 (Ext.slider.Widget 或 “sliderwidget”)
Sparklines (Ext.sparkline.*)
- Line (“sparklineline”)
- Bar (“sparklinebar”)
- Discrete (“sparklinediscrete”)
- Bullet (“sparklinebullet”)
- Pie (“sparklinepie”)
- Box (“sparklinebox”)
- TriState (“sparklinetristate”)

使用 Widget

与普通 Component 一样，Widget 可以添加到 Container 的 items 中。例如，我们可以将 Sparkline 添加到 toolbar

展开代码

JS 运行

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 layout 管理器来执行此操作。这是因为内部绘图没有自然大小。

自定义 Widget

虽然 ExtJS 附带了 Slider 和 Progressbar 以及新的 Sparklines 的“widget 化”版本，但在大多数情况下，您可能希望创建自己的 Widget。决定是从 Ext.Component 派生还是从 Ext.Widget 派生，实际上取决于所创建类的复杂性。
简单的组件通常可以避免诸如 Component 生命周期和布局之类的事情，只需将配置属性映射到关联的元素，同时响应元素事件（如 'click'、'dblclick'、'mouseover' 等）。

要创建 Widget，您可以扩展 Ext.Widget 并定义您的元素模板及其 listeners。

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 Component 的人来说，这会感到非常熟悉。这是因为 Ext.Widget 是 ExtJS Modern 中 Ext.AbstractComponent 的增强版本。将 listeners 添加到 element 模板的能力是这些增强功能之一，但还有其他一些。有关更多详细信息，请参阅 Ext.Widget 上的文档。

目录

术语、图标和标签

访问级别

成员类型

成员语法

成员标志

类图标

成员图标

导航和功能

类成员快速导航菜单

Getter 和 Setter 方法

历史记录栏

搜索和过滤器

API 文档类元数据

展开和折叠示例和类成员

桌面与移动视图

查看类源代码

Ext JS 7.8.0 - Classic Toolkit

目录

在网格中使用组件

Widget 列

了解 “widget” 配置

行身组件。

什么是 Widget？

使用 Widget

自定义 Widget

Ext JS 7.8.0 - Classic Toolkit