文档帮助

术语、图标和标签

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

访问级别

框架类或其成员可以指定为privateprotected。否则,该类/成员为publicPublicprotectedprivate是访问描述符,用于传达如何以及何时使用类或类成员。

成员类型

成员语法

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

lookupComponent ( item ) : Ext.Component
protected

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

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

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

参数

item :  Object

要添加的配置对象。

返回值
Ext.Component

要添加的组件。

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

成员标志

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

类图标

- 表示框架类

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

- 组件类型框架类(Ext JS 框架中任何扩展 Ext.Component 的类)

- 表示该类、成员或指南在当前查看的版本中是新的

成员图标

- 表示类型为config的类成员

- 表示类型为property的类成员

- 表示类型为method的类成员

- 表示类型为event的类成员

- 表示类型为主题变量的类成员

- 表示类型为主题混合的类成员

- 表示该类、成员或指南在当前查看的版本中是新的

类成员快速导航菜单

在 API 文档页面上的类名称下方,有一行按钮,对应于当前类拥有的成员类型。每个按钮显示按类型划分的成员数量(此数量会随着应用过滤器而更新)。单击按钮将导航到该成员部分。将鼠标悬停在成员类型按钮上将显示一个弹出菜单,其中包含该类型的所有成员,以便快速导航。

Getter 和 Setter 方法

与类配置选项相关的 Getter 和 Setter 方法将显示在方法部分以及 API 文档和成员类型菜单的配置部分中,位于它们所使用的配置下方。Getter 和 Setter 方法文档将在配置行中找到,以便于参考。

历史记录栏

您的页面历史记录保存在本地存储中,并在顶部标题栏下方显示(使用可用的空间)。默认情况下,仅显示与您当前查看的产品/版本匹配的页面搜索结果。您可以通过单击历史记录栏右侧的按钮并选择“全部”单选按钮来扩展显示的内容。这将显示所有产品/版本的历史记录栏中的所有最近页面。

在历史记录配置菜单中,您还会看到最近页面访问的列表。结果按“当前产品/版本”和“全部”单选按钮过滤。单击按钮将清除历史记录栏以及本地存储中的历史记录。

如果在历史记录配置菜单中选择“全部”,则“在历史记录栏中显示产品详细信息”的复选框选项将被启用。选中后,每个历史页面的产品/版本将与历史记录栏中的页面名称一起显示。将鼠标悬停在历史记录栏中的页面名称上也会显示产品/版本作为工具提示。

搜索和过滤器

可以使用页面顶部的搜索字段搜索 API 文档和指南。

在 API 文档页面上,还有一个过滤器输入字段,使用过滤器字符串过滤成员行。除了按字符串过滤外,还可以按访问级别、继承和只读过滤类成员。这是使用页面顶部的复选框完成的。

API 类导航树底部的复选框过滤类列表,以包含或排除私有类。

单击空搜索字段将显示您最近的 10 次搜索,以便快速导航。

API 文档类元数据

每个 API 文档页面(除了 Javascript 原语页面)都包含一个与该类相关的元数据菜单视图。此元数据视图将包含以下一项或多项

展开和折叠示例和类成员

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

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

桌面 -vs- 移动视图

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

查看类源代码

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

Ext JS 7.8.0


顶部

数据包

数据包是加载和保存应用程序中所有数据的组件。它包含许多类,但其中三个比其他所有类都更重要。

这些类是

以上类几乎被所有应用程序使用。它们由许多卫星类支持。

模型

数据包的核心是 Ext.data.Model。模型代表应用程序中的实体。例如,一个电子商务应用程序可能拥有用户、产品和订单的模型。在最简单的层面上,模型定义了一组字段和相关的业务逻辑。

让我们看一下模型的一些主要部分

创建模型

通常最好从一个通用的基类开始定义你的模型。这个基类允许你轻松地在一个地方为所有模型配置某些方面。它也是配置模式的好地方。模式是应用程序中所有模型的管理器。现在我们将重点关注它两个最实用的配置选项

Ext.define('MyApp.model.Base', {
    extend: 'Ext.data.Model',

    fields: [{
        name: 'id',
        type: 'int'
    }],

    schema: {
        namespace: 'MyApp.model',  // generate auto entityName

        proxy: {     // Ext.util.ObjectTemplate
            type: 'ajax',
            url: '{entityName}.json',
            reader: {
                type: 'json',
                rootProperty: '{entityName:lowercase}'
            }
        }
    }
});

模型基类的适当内容,尤其是它的“字段”,可能在不同的应用程序之间有所不同。

代理

代理模型存储 用于处理模型数据的加载和保存。代理有两种类型:客户端和服务器。

代理可以在模型基类的模式上直接定义(如上所示)。

客户端代理

客户端代理的示例包括 内存本地存储,它使用 HTML5 本地存储功能。虽然旧的浏览器不支持这些新的 HTML5 API,但它们非常有用,很多应用程序将从它们的存在中受益匪浅。

服务器代理

服务器代理处理数据到远程服务器的编组。这种类型的代理的示例包括 AJAXJSONPREST

模式

模式 是一个实体集合,它们之间存在关联。当一个模型指定一个“模式”配置时,该模式将被所有派生模型继承。在上面的示例中,模式已配置了两个值,它们为该模式中的所有模型建立了默认值。

这些配置中的第一个是“命名空间”。通过指定这个命名空间,所有模型都获得一个简短的名称,称为“实体名称”。这个简短的名称主要在定义模型之间的关联时有用,我们将在后面看到。

示例模式还定义了一个“代理”配置。这是一个对象模板,类似于基于 Ext.XTemplate 的文本模板。区别在于对象模板在给定数据时会生成对象。在这种情况下,该数据用于自动定义所有未明确定义代理的模型的“代理”配置。

这非常有用,因为每个模型实例都可能需要以相同的方式加载其数据,但值略有不同。这避免了为每个模型重复定义代理。

我们在 URL 中指定的 User.jsonurl: '{entityName}.json',应该返回一个 JSON 字符串。

对于这个示例,我们使用了这个

{
  "success": "true",
  "user": [
    {
      "id": 1,
      "name": "Philip J. Fry"
    },
    {
      "id": 2,
      "name": "Hubert Farnsworth"
    },
    {
      "id": 3,
      "name": "Turanga Leela"
    },
    {
      "id": 4,
      "name": "Amy Wong"
    }
  ]
}

存储

模型通常与存储一起使用,存储基本上是记录(模型派生类的实例)的集合。创建存储并加载其数据很简单

var store = new Ext.data.Store ({
    model: 'MyApp.model.User'
});

store.load({
    callback:function(){
        var first_name = this.first().get('name');
         console.log(first_name);
    }
});

我们正在手动加载存储以接收一组 MyApp.model.User 记录。当存储加载的回调函数被触发(完成时)时,记录将被记录。

内联数据

存储也可以内联加载数据。在内部,存储将我们作为 data 传入的每个对象转换为适当的 模型 类型的记录

new Ext.data.Store({
    model: 'MyApp.model.User',
    data: [{
        id: 1,
        name: "Philip J. Fry"
    },{
        id: 2,
        name: "Hubert Farnsworth"
    },{
        id: 3,
        name: "Turanga Leela"
    },{
        id: 4,
        name: "Amy Wong"
    }]
});

排序和分组

存储能够在本地和远程执行排序、过滤和分组。

new Ext.data.Store({
    model: 'MyApp.model.User',

    sorters: ['name','id'],
    filters: {
        property: 'name',
        value   : 'Philip J. Fry'
    }
});

在这个存储中,数据将首先按名称排序,然后按 ID 排序。数据将被过滤,只包含名为“Philip J. Fry”的用户。可以通过存储的 API 随时轻松更改这些项目的属性。

关联

模型可以通过关联 API 链接在一起。大多数应用程序都处理许多不同的模型,并且这些模型几乎总是相关的。一个博客撰写应用程序可能具有 User 和 Post 模型。每个 User 创建 Posts。因此,在这种情况下,一个用户可以拥有多个帖子,但一个帖子只会有一个 User 创建它。这被称为多对一关系。我们可以这样表达这种关系

Ext.define('MyApp.model.User', {
    extend: 'MyApp.model.Base',

    fields: [{
        name: 'name',
        type: 'string'
    }]
});

Ext.define('MyApp.model.Post', {
    extend: 'MyApp.model.Base',

    fields: [{
        name: 'userId',
        reference: 'User', // the entityName for MyApp.model.User
        type: 'int'
    }, {
        name: 'title',
        type: 'string'
    }]
});

在您的应用程序中表达不同模型之间的丰富关系很容易。每个模型可以与其他模型建立任意数量的关联。此外,您的模型可以按任何顺序定义。一旦您拥有此模型类型的记录,就可以轻松地遍历关联数据。例如,如果您想获取用户的全部帖子,您可以执行以下操作

// Loads User with ID 1 and related posts and comments
// using User's Proxy
MyApp.model.User.load(1, {
    callback: function(user) {
        console.log('User: ' + user.get('name'));

        user.posts(function(posts){
            posts.each(function(post) {
                console.log('Post: ' + post.get('title'));
            });
        });
    }
});

上面的关联导致在模型中添加了一个新函数。每个 User 模型都有许多 Posts,这添加了我们使用的 user.posts() 函数。调用 user.posts() 返回一个使用 Post 模型配置的 Store

关联不仅有助于加载数据。它们对于创建新记录也很有用

user.posts().add({
    userId: 1,
    title: 'Post 10'
});

user.posts().sync();

这将实例化一个新的 Post,该 Post 会自动在 userId 字段中获得 User 的 ID。调用 sync() 通过其代理(最终由模式的代理配置定义)保存新的 Post。这是一个异步操作,您可以传递回调函数,如果您希望在操作完成时收到通知。

关联的“反向”也会在 Post 模型上生成新方法

MyApp.model.Post.load(1, {
    callback: function(post) {

        post.getUser(function(user) {
            console.log('Got user from post: ' + user.get('name'));
        });                           
    }
});

MyApp.model.Post.load(2, {
    callback: function(post) {
        post.setUser(100);                         
    }
});

加载函数 getUser() 是异步的,需要一个回调函数来获取用户实例。setUser() 方法只是将 userId(有时称为“外键”)更新为 100 并保存 Post 模型。像往常一样,可以传入回调函数,这些回调函数将在保存操作完成后触发 - 无论成功与否。

加载嵌套数据

当定义关联时,加载记录的行为也可以在单个请求中加载关联记录。例如,考虑以下服务器响应

{
    "success": true,
    "user": [{
        "id": 1,
        "name": "Philip J. Fry",
        "posts": [{
            "title": "Post 1"
        },{
            "title": "Post 2"
        },{
            "title": "Post 3"
        }]
    }]
}

框架可以自动解析单个响应中的嵌套数据,例如上面的数据。我们无需为 User 数据发出一个请求,为 Posts 数据发出另一个请求,而可以将所有数据返回到单个服务器响应中。

验证

模型还提供大量支持来验证数据。为了演示,我们将基于上面使用的示例。首先,让我们在 User 模型中添加一些验证

Ext.define('MyApp.model.User', {
    extend: 'Ext.data.Model',
    fields: ...,

    validators: {
        name: [
            'presence',
            { type: 'length', min: 7 },
            { type: 'exclusion', list: ['Bender'] }
        ]
    }
});

验证器定义为一个对象,该对象以字段名称为键,映射到定义有效字段的规则。这些规则表示为验证器对象配置或这些配置的数组。我们示例中的验证器验证 name 字段,该字段的长度应至少为 7 个字符,并且该值应为除“Bender”以外的任何值。

一些验证需要额外的可选配置 - 例如,长度验证可以接受 min 和 max 属性,格式可以接受匹配器等。Ext JS 中内置了五个验证,添加自定义规则也很容易。

首先,让我们认识一下内置的验证

  • 存在 - 确保字段具有值。零被视为有效值,但空字符串则不被视为有效值。
  • 长度 - 确保字符串的长度介于最小长度和最大长度之间。这两个约束都是可选的。
  • 格式 - 确保字符串与正则表达式格式匹配。在上面的示例中,我们确保 age 字段仅包含数字。
  • 包含 - 确保值在特定值集中(例如,确保性别为男性或女性)。
  • 排除 - 确保值不是特定值集中的一个值(例如,将“admin”等用户名列入黑名单)。

现在我们已经了解了不同的验证,让我们尝试对 User 实例使用它们。我们将创建一个用户并对其运行验证,并注意任何错误

// now lets try to create a new user with as many validation
// errors as we can
var newUser = new MyApp.model.User({
    id: 10,
    name: 'Bender'
});

// run some validation on the new user we just created
console.log('Is User valid?', newUser.isValid());

//returns 'false' as there were validation errors

var errors = newUser.getValidation(),
    error  = errors.get('name');

console.log("Error is: " + error);

这里的关键函数是 getValidation(),它运行所有配置的验证并返回一个记录,该记录由每个字段的第一个出现的错误填充,或者对于有效字段填充布尔值 true。验证记录是延迟创建的,并且仅在请求时更新。

在这种情况下,第一个错误向我们显示:name 字段上的“长度必须大于 7”。

所以让我们提供一个包含超过 7 个字符的名称。

newUser.set('name', 'Bender Bending Rodriguez');
errors = newUser.getValidation();

此用户记录现在满足所有验证条件。该记录存在,包含超过 7 个字符,并且姓名不匹配 Bender。

newUser.isValid() 现在将返回 true。当我们调用 getValidation() 时,验证记录将被更新,不再是脏数据,并且所有字段都将设置为 true。

Ext JS 7.8.0