文档帮助

内容

术语、图标和标签 访问级别 成员类型 成员语法 成员标志 类图标 成员图标 导航和功能 类成员快速导航菜单 Getter 和 Setter 方法 历史记录栏 搜索和过滤器 API 文档类元数据 展开和折叠示例和类成员 桌面 -vs- 移动视图 查看类源代码

术语、图标和标签

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

访问级别

框架类或其成员可以指定为private或protected。否则，该类/成员为public。Public、protected和private是访问描述符，用于传达如何以及何时使用该类或类成员。

成员类型

成员语法

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

Ext.container.Container
查看源代码
lookupComponent ( item ) : Ext.Component
protected

在初始化items配置期间或添加新项目时，将原始配置对象添加到此容器时调用added), or {@link #insert inserted.

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

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

参数

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）在页面上默认展开。您可以使用代码块左上角的箭头单独折叠和展开示例代码块。您还可以使用页面右上角的切换按钮切换所有示例的折叠状态。切换所有状态将在页面加载之间记住。

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

桌面与移动视图

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

查看类源代码

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

Ext JS 7.8.0


顶部

内容

什么是 MVC？ 什么是 MVVM？ 回头客 MVC 和 MVVM 构建示例应用程序 应用程序概述 文件结构 命名空间 应用程序 app.js Application.js 视图 控制器配置 ViewModel 配置 控制器 ViewModels 模型和存储 模型 字段 存储 下一步

应用程序架构简介

Ext JS 支持 MVC 和 MVVM 应用程序架构。这两种架构方法都共享某些概念，并专注于沿逻辑线划分应用程序代码。每种方法都有其优势，具体取决于它选择如何划分应用程序的各个部分。

本指南的目的是为您提供有关构成这些架构的组件的基础知识。

什么是 MVC？

在 MVC 架构中，大多数类要么是模型、视图，要么是控制器。用户与视图交互，视图显示模型中保存的数据。控制器监控这些交互，然后根据需要通过更新视图和模型来响应交互。

视图和模型通常彼此不知道，因为控制器负责指导更新。一般来说，控制器将包含 MVC 应用程序中的大部分应用程序逻辑。理想情况下，视图几乎没有（如果有的话）业务逻辑。模型主要是数据的接口，并包含业务逻辑来管理对该数据的更改。

MVC 的目标是明确定义应用程序中每个类的职责。由于每个类都具有明确定义的职责，因此它们隐式地与更大的环境分离。这使得应用程序更容易测试和维护，并且其代码更易于重用。

什么是 MVVM？

MVC 和 MVVM 之间的关键区别在于 MVVM 具有一个称为 ViewModel 的视图抽象。ViewModel 使用一种称为“数据绑定”的技术来协调模型数据和视图对该数据的呈现之间的变化。

结果是模型和框架执行尽可能多的工作，最大限度地减少或消除直接操作视图的应用程序逻辑。

返回用户

Ext JS 5 引入了对 MVVM 架构的支持，以及对 MVC 中 (C) 的改进。虽然我们鼓励您调查并利用这些改进，但重要的是要注意，我们已尽一切努力确保现有的 Ext JS 4 MVC 应用程序继续正常运行。

MVC 和 MVVM

为了了解这些选择如何融入您的应用程序，我们应该首先进一步定义各种缩写代表什么。

  • (M) 模型 - 这是您的应用程序的数据。一组类（称为“模型”）定义了其数据的字段（例如，具有用户名和密码字段的用户模型）。模型知道如何通过数据包持久保存自身，并且可以通过关联链接到其他模型。

    模型通常与存储一起使用，为网格和其他组件提供数据。模型也是您可能需要的任何数据逻辑的理想位置，例如验证、转换等。

  • (V) 视图 - 视图是任何类型的视觉表示的组件。例如，网格、树和面板都被认为是视图。

  • (C) 控制器 - 控制器用作维护视图逻辑以使您的应用程序正常运行的地方。这可能包括渲染视图、路由、实例化模型以及任何其他类型的应用程序逻辑。

  • (VM) ViewModel - ViewModel 是一个管理特定于视图数据的类。
    它允许感兴趣的组件绑定到它，并在该数据发生变化时更新。

这些应用程序架构为您的框架代码提供了结构和一致性。遵循我们建议的约定将带来许多重要的优势

  • 每个应用程序都以相同的方式工作，因此您只需学习一次。

  • 在应用程序之间共享代码很容易。

  • 您可以使用 Sencha Cmd 创建应用程序的优化生产版本。

构建示例应用程序

在我们开始逐步介绍这些部分之前，让我们使用 Sencha Cmd 构建一个示例应用程序。首先，下载并解压缩 Ext JS SDK。接下来，从您的命令行发出以下命令

sencha -sdk local/path/to/ExtJS generate app MyApp MyApp
cd app
sencha app watch

注意：如果您不熟悉上述内容，请查看我们的 入门指南。

应用程序概述

在我们开始讨论构成 MVC、MVVM、MVC+VM 模式的部分之前，让我们看一下 Cmd 生成的应用程序的结构。

文件结构

Ext JS 应用程序遵循统一的目录结构，每个应用程序都相同。在我们推荐的布局中，所有 Store、Model、ViewModel 和 ViewController 类都放置在 app 文件夹中（其中 Model 放置在 model 文件夹中，Store 放置在 store 中，ViewModel/Controller 放置在 view 中）。最佳实践是将 ViewControllers 和 ViewModels 逻辑地分组到 app/view/ 文件夹中的子文件夹中，使用与您用于视图本身的类似命名结构（请参阅下面的“app/view/main/”和“classic/src/view/main/”文件夹）。

命名空间

每个类的第一行都是一种地址。这个“地址”称为命名空间。命名空间的公式是

<AppName>.<foldername>.<ClassAndFileName>

在您的示例应用程序中，“MyApp”是 AppName，“view”是文件夹名称，“main”是子文件夹名称，“Main”是类和文件名。根据这些信息，框架将在以下位置查找名为 Main.js 的文件

// Classic
classic/src/view/main/Main.js

// Modern
modern/src/view/main/Main.js

// Core
// "MyApp.view.main.MainController" shared between toolkits would be located at:
app/view/main/MainController.js

如果找不到该文件，Ext JS 会抛出错误，直到您解决问题。

应用程序

让我们从查看 index.html 开始评估应用程序。

<!DOCTYPE HTML>
<html manifest="">
<head>
    <meta http-equiv="X-UA-Compatible" content="IE=edge">
    <meta charset="UTF-8">

    <title>MyApp</title>


    <script type="text/javascript">
        var Ext = Ext || {}; // Ext namespace won't be defined yet...

        // This function is called by the Microloader after it has performed basic
        // device detection. The results are provided in the "tags" object. You can
        // use these tags here or even add custom tags. These can be used by platform
        // filters in your manifest or by platformConfig expressions in your app.
        //
        Ext.beforeLoad = function (tags) {
            var s = location.search,  // the query string (ex "?foo=1&bar")
                profile;

            // For testing look for "?classic" or "?modern" in the URL to override
            // device detection default.
            //
            if (s.match(/\bclassic\b/)) {
                profile = 'classic';
            }
            else if (s.match(/\bmodern\b/)) {
                profile = 'modern';
            }
            else {
                profile = tags.desktop ? 'classic' : 'modern';
                //profile = tags.phone ? 'modern' : 'classic';
            }

            Ext.manifest = profile; // this name must match a build profile name

            // This function is called once the manifest is available but before
            // any data is pulled from it.
            //
            //return function (manifest) {
                // peek at / modify the manifest object
            //};
        };
    </script>


    <!-- The line below must be kept intact for Sencha Cmd to build your application -->
    <script id="microloader" type="text/javascript" src="bootstrap.js"></script>

</head>
<body></body>
</html>

Ext JS 使用 Microloader 加载 app.json 文件中描述的应用程序资源。这取代了将它们添加到 index.html 的需要。使用 app.json，所有应用程序元数据都存在于一个位置。
Sencha Cmd 然后可以以简单高效的方式编译您的应用程序。

app.json 有大量注释，并提供了一个很好的资源，用于了解它接受的配置信息。

有关 beforeLoad 部分和特定于平台的构建的更多信息，请参阅 为多个环境和屏幕开发指南。

app.js

当我们之前生成应用程序时，我们创建了一个类（在 Application.js 中）并启动了它的实例（在 app.js 中）。您可以在下面看到 app.js 的内容

/*
 * This file is generated and updated by Sencha Cmd. You can edit this file as
 * needed for your application, but these edits will have to be merged by
 * Sencha Cmd when upgrading.
 */
Ext.application({
    name: 'MyApp',

    extend: 'MyApp.Application',

    requires: [
        'MyApp.view.main.Main'
    ],

    // The name of the initial view to create. With the classic toolkit this class
    // will gain a "viewport" plugin if it does not extend Ext.Viewport. With the
    // modern toolkit, the main view will be added to the Viewport.
    //
    mainView: 'MyApp.view.main.Main'

    //-------------------------------------------------------------------------
    // Most customizations should be made to MyApp.Application. If you need to
    // customize this file, doing so below this section reduces the likelihood
    // of merge conflicts when upgrading to new versions of Sencha Cmd.
    //-------------------------------------------------------------------------
});

通过为 mainView 指定一个容器类，您可以使用任何类作为您的 Viewport。在上面的示例中，我们确定 MyApp.view.main.Main（一个 TabPanel 类）作为我们的 Viewport。

mainView 配置指示应用程序创建指定的视图并附加 Viewport 插件。这将视图连接到文档主体。

Application.js

每个 Ext JS 应用程序都从 应用程序类 的实例开始。此类旨在由 app.js 启动，也可以实例化以进行测试。

以下 Application.js 内容是在您使用 Sencha Cmd 生成应用程序时自动创建的。 

Ext.define('MyApp.Application', {
    extend: 'Ext.app.Application',

    name: 'MyApp',

    stores: [
        // TODO: add global / shared stores here
    ],

    launch: function () {
        // TODO - Launch the application
    },

    onAppUpdate: function () {
        Ext.Msg.confirm('Application Update', 'This application has an update, reload?',
            function (choice) {
                if (choice === 'yes') {
                    window.location.reload();
                }
            }
        );
    }
});

应用程序类 包含应用程序的全局设置，例如应用程序的命名空间、共享存储等。onAppUpdate 方法在应用程序过时时调用（浏览器缓存版本与服务器上的最新版本）。系统会提示用户重新加载应用程序以使用当前构建。

视图

视图不过是一个组件，它是 Ext.Component 的子类。
视图包含应用程序的所有视觉方面。

如果您打开启动应用程序的 classic/src/view/main/Main.js 文件，您应该看到以下代码。

Ext.define('MyApp.view.main.Main', {
    extend: 'Ext.tab.Panel',
    xtype: 'app-main',

    requires: [
        'Ext.plugin.Viewport',
        'Ext.window.MessageBox',

        'MyApp.view.main.MainController',
        'MyApp.view.main.MainModel',
        'MyApp.view.main.List'
    ],

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

    ui: 'navigation',

    tabBarHeaderPosition: 1,
    titleRotation: 0,
    tabRotation: 0,

    header: {
        layout: {
            align: 'stretchmax'
        },
        title: {
            bind: {
                text: '{name}'
            },
            flex: 0
        },
        iconCls: 'fa-th-list'
    },

    tabBar: {
        flex: 1,
        layout: {
            align: 'stretch',
            overflowHandler: 'none'
        }
    },

    responsiveConfig: {
        tall: {
            headerPosition: 'top'
        },
        wide: {
            headerPosition: 'left'
        }
    },

    defaults: {
        bodyPadding: 20,
        tabConfig: {
            plugins: 'responsive',
            responsiveConfig: {
                wide: {
                    iconAlign: 'left',
                    textAlign: 'left'
                },
                tall: {
                    iconAlign: 'top',
                    textAlign: 'center',
                    width: 120
                }
            }
        }
    },

    items: [{
        title: 'Home',
        iconCls: 'fa-home',
        // The following grid shares a store with the classic version's grid as well!
        items: [{
            xtype: 'mainlist'
        }]
    }, {
        title: 'Users',
        iconCls: 'fa-user',
        bind: {
            html: '{loremIpsum}'
        }
    }, {
        title: 'Groups',
        iconCls: 'fa-users',
        bind: {
            html: '{loremIpsum}'
        }
    }, {
        title: 'Settings',
        iconCls: 'fa-cog',
        bind: {
            html: '{loremIpsum}'
        }
    }]
});

请注意，视图不包含任何应用程序逻辑。视图的所有逻辑部分都应包含在 ViewController 中，我们将在下一节中讨论。

此视图中两个有趣的片段是 controller 和 viewModel 配置。

下一个有趣的视图是位于 classic/src/main/view/List 的“列表”视图。

/**
 * This view is an example list of people.
 */
Ext.define('MyApp.view.main.List', {
    extend: 'Ext.grid.Panel',
    xtype: 'mainlist',

    requires: [
        'MyApp.store.Personnel'
    ],

    title: 'Personnel',

    store: {
        type: 'personnel'
    },

    columns: [
        { text: 'Name',  dataIndex: 'name' },
        { text: 'Email', dataIndex: 'email', flex: 1 },
        { text: 'Phone', dataIndex: 'phone', flex: 1 }
    ],

    listeners: {
        select: 'onItemSelected'
    }
});

控制器配置

controller 配置允许您为视图指定一个 ViewController。当以这种方式在视图上指定 ViewController 时，它将成为您的事件处理程序和引用的容器。这使 ViewController 与视图中触发的组件和事件建立一对一的关系。我们将在下一节中详细讨论控制器。

ViewModel 配置

viewModel 配置允许您为视图指定一个 ViewModel。ViewModel 是此组件及其子视图的数据提供者。ViewModel 中包含的数据通常通过向想要呈现或编辑此数据的组件添加绑定配置来使用。

在“主”视图中，您可以看到主选项卡面板的标题 title 绑定到 ViewModel。这意味着 title 将由数据的“name”值填充，该值在 ViewModel 中管理。如果 ViewModel 的数据发生变化，title 的值将自动更新。我们将在本文档的后面部分讨论 ViewModel。

控制器

接下来，让我们看看控制器。启动应用程序生成的 ViewController MainController.js 看起来像这样

Ext.define('MyApp.view.main.MainController', {
    extend: 'Ext.app.ViewController',

    alias: 'controller.main',

    onItemSelected: function (sender, record) {
        Ext.Msg.confirm('Confirm', 'Are you sure?', 'onConfirm', this);
    },

    onConfirm: function (choice) {
        if (choice === 'yes') {
            //
        }
    }
});

如果你回顾你的列表视图，List.js，你会注意到一个用于grid选择事件的函数指定。该handler映射到父视图Main.js中的名为onItemSelected的函数，控制器。如你所见，此控制器已准备好处理该事件，无需任何特殊设置。

这使得为你的应用程序添加逻辑变得非常容易。你只需要定义onItemSelected函数，因为你的控制器与其视图之间存在一对一的关系。

选择网格行后，将创建一个消息框。此消息框包含其自身的函数调用，其中包含onConfirm，该函数的作用域限定为此相同的控制器。

ViewControllers 的设计目的是

  • 使用“监听器”和“引用”配置使与视图的连接变得显而易见。

  • 利用视图的生命周期来自动管理其关联的 ViewController。从实例化到销毁，Ext.app.ViewController 与引用它的组件绑定。同一视图类的第二个实例将获得自己的 ViewController 实例。当这些视图被销毁时，它们关联的 ViewController 实例也将被销毁。

  • 提供封装，使嵌套视图变得直观。

ViewModels

接下来，让我们看看ViewModel。如果你打开你的app/view/main/MainModel.js文件，你应该看到以下代码

Ext.define('MyApp.view.main.MainModel', {
    extend: 'Ext.app.ViewModel',

    alias: 'viewmodel.main',

    data: {
        name: 'MyApp',

        loremIpsum: 'Lorem ipsum dolor sit amet, consectetur adipisicing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat. Duis aute irure dolor in reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla pariatur. Excepteur sint occaecat cupidatat non proident, sunt in culpa qui officia deserunt mollit anim id est laborum.'
    }

    //TODO - add data, formulas and/or methods to support your view
});

ViewModel 是一个管理数据对象的类。然后，此类允许对这些数据感兴趣的视图绑定到它并被通知更改。ViewModel 与 ViewController 一样，由引用它的视图拥有。由于 ViewModel 与视图相关联，因此它们也能够链接到祖先组件在组件层次结构中拥有的父 ViewModel。这允许子视图简单地“继承”其父 ViewModel 的数据。

我们在“Main.js”中使用 ViewModel 配置创建了从视图到 ViewModel 的链接。此链接允许使用 setter 将配置绑定到自动将数据从 viewModel 设置到视图上，以声明方式。数据在“MainModel.js”示例中是内联的。也就是说，你的数据可以是任何东西，可以来自任何地方。数据可以由任何类型的代理（AJAX、REST 等）提供。

模型和存储

模型 和 存储 构成了你的应用程序的信息网关。你的大部分数据都是由这两个类发送、检索、组织和“建模”的。

模型

Ext.data.Model 表示你的应用程序中任何类型的可持久化数据。每个模型都有字段和函数，允许你的应用程序“建模”数据。模型最常与存储一起使用。存储然后可以被数据绑定组件（如网格、树和图表）使用。

我们的示例应用程序当前不包含模型，因此让我们添加以下代码

Ext.define('MyApp.model.User', {
    extend: 'Ext.data.Model',
    fields: [
        {name: 'name',  type: 'string'},
        {name: 'age',   type: 'int'}
    ]
});

如上面命名空间部分所述，你可能希望创建User.js，它将位于“app/model/”下。

字段

Ext.data.Model 描述包含称为“字段”的值或属性的记录。Model 类可以使用fields配置声明这些字段。在这种情况下，name被声明为字符串，而 age 是整数。API 文档中提供了其他字段类型。

虽然声明字段及其类型有充分的理由，但这样做不是必需的。如果你不包含 fields 配置，数据将自动读取并插入数据对象。如果你需要以下内容，你可能希望定义你的字段

  • 验证

  • 默认值

  • 转换函数

让我们设置一个商店，看看这两个如何协同工作。

商店

一个 商店 是客户端记录（模型类实例）的缓存。商店提供对其中包含的记录进行排序、过滤和查询的功能。

此示例应用程序不包含商店，但不用担心。只需定义您的商店并分配模型。

Ext.define('MyApp.store.Users', {
    extend: 'Ext.data.Store',
    alias: 'store.users',
    model: 'MyApp.model.User',
    data : [
     {firstName: 'Seth', age: '34'},
     {firstName: 'Scott', age: '72'},
     {firstName: 'Gary', age: '19'},
     {firstName: 'Capybara', age: '208'}
    ]
});

将以上内容添加到 Users.js 中，该文件应放在 app/store/ 中。

如果您想要商店的全局实例，可以将商店添加到 Application.js 的商店配置中。Application.js 中的商店配置如下所示

stores: [
    'Users'
],

在此示例中，商店直接包含数据。大多数现实情况需要您使用模型或商店上的代理来收集数据。代理允许在您的数据提供者和应用程序之间进行数据传输。

您可以在我们的 数据指南 中了解更多关于模型、商店和数据提供者的信息。

下一步

我们创建了一个强大且实用的应用程序，称为 票务应用程序。此应用程序管理登录/注销会话，包含数据绑定，并在使用 MVC+VM 架构时显示“最佳实践”。此示例已添加大量注释，以便尽可能清晰。

我们建议您花一些时间探索 票务应用程序，以了解有关理想 MVC+VM 应用程序架构的更多信息。

Ext JS 7.8.0