文档帮助

术语、图标和标签

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

访问级别

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

成员类型

成员语法

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

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

当原始配置对象添加到此容器时调用,无论是在 items 配置初始化期间,还是在添加新项目 added),或 {@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 原始类型页面除外)都有一个与该类相关的元数据菜单视图。此元数据视图将具有以下一项或多项

展开和折叠示例以及类成员

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

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

桌面 -vs- 移动视图

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

查看类源代码

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

Ext JS 7.8.0 - Modern Toolkit


顶部
指南适用于: modern

开始使用 Cmd 的 Exft JS 插件组件

本指南介绍如何使用 Cmd 将 Ext JS 插件组件之一添加到您的应用程序中。

要求

下载 Ext JS 插件 Zip 文件

您需要下载两个 zip 文件。首先下载 Ext JS SDK Zip 文件。其次下载 Ext JS 插件 zip 文件。

Zip 文件名 插件路径 描述
Ext JS SDK [zip]/packages/* 此 zip 文件包含 Ext JS SDK 和标准插件组件
Ext Premium 插件 [zip]/packages/* Premium 插件包括 Calendar、Exporter、D3、Pivot 和 Froala 编辑器组件

开始试用

如果您已经注册试用,则可以跳过此步骤。此注册表单会向您发送一封电子邮件,其中包含下载链接。

从支持门户下载 Zip 文件

现有客户可以登录到门户的下载部分并下载两个 zip 文件。

将插件组件添加到您的项目

步骤 1:解压 zip 文件

打开 zip 文件并将资源解压到您可以保留作为 Ext JS 资源参考的文件夹中。

步骤 2:复制插件包

在此步骤中,您将插件包复制到您的项目中。在此示例中,我们将使用 Calendar 插件作为示例包。

  • 在您的项目根目录中,创建一个名为 [project]/packages/local 的文件夹。
  • 将插件包 [zip]/calendar 复制到 [project]/packages/local/calendar

步骤 3:在 app.json 中声明包

在项目的 app.json requires 属性中,声明新的包依赖项 calendar 或任何包名称。

app.json 示例

"requires": [
    "font-awesome",

    // Declare the add-on components package here
    "calendar"
],

app.json 的具体示例

{
    "name": "MyApp",
    "namespace": "MyApp",
    "version": "1.0.0.0",
    "framework": "ext",
    "toolkit": "modern",
    "theme": "theme-material",

    /**
     * The list of required packages (with optional versions; default is "latest").
     *
     * For example,
     *
     *      "requires": [
     *          "charts"
     *      ]
     */
    "requires": [
        "font-awesome",

        // Declare the add-on components package here
          "calendar"
    ],

//...

步骤 4:将插件组件添加到视图

在此步骤中,将企业组件添加到应用程序视图之一。在此示例中,calendar 包将添加到 Main.js 视图。

示例

{
    title: 'Home',
    iconCls: 'x-fa fa-home',
    layout: 'fit',
    items: [{
        xtype: 'calendar'
    }]
}

具体示例 [cmd_project]/app/view/main/Main.js

/**
 * This class is the main view for the application. It is specified in app.js as the
 * "mainView" property. That setting causes an instance of this class to be created and
 * added to the Viewport container.
 */
Ext.define('MyApp.view.main.Main', {
    extend: 'Ext.tab.Panel',
    xtype: 'app-main',

    requires: [
        'Ext.MessageBox',
        'Ext.layout.Fit'
    ],

    controller: 'main',
    viewModel: 'main',

    defaults: {
        tab: {
            iconAlign: 'top'
        }
    },

    tabBarPosition: 'bottom',

    items: [
        // TODO - Replace the content of this view to suit the needs of your application.
        {
            title: 'Home',
            iconCls: 'x-fa fa-home',
            layout: 'fit',
            // The following grid shares a store with the classic version's grid as well!
            items: [{
                xtype: 'calendar'
            }]
        },{
            title: 'Users',
            iconCls: 'x-fa fa-user',
            bind: {
                html: '{loremIpsum}'
            }
        },{
            title: 'Groups',
            iconCls: 'x-fa fa-users',
            bind: {
                html: '{loremIpsum}'
            }
        },{
            title: 'Settings',
            iconCls: 'x-fa fa-cog',
            bind: {
                html: '{loremIpsum}'
            }
        }
    ]
});

步骤 5:试用

运行 sencha app watch 以在添加日历后测试应用程序。

下一步

现在您可以开始使用所有 Ext JS 组件的下一步了。

Ext JS 7.8.0 - Modern Toolkit