文档帮助

内容

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

术语、图标和标签

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

访问级别

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

成员类型

成员语法

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

Ext.container.Container
查看源
lookupComponent ( item ) : Ext.Component
受保护

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

展开和折叠示例和类成员

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

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

桌面 -vs- 移动视图

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

查看类源

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

Sencha Touch 2.4


顶部

使用代理

代理由存储用于处理模型数据的加载和保存。有两种类型的代理：客户端和服务器。客户端代理的示例包括用于在浏览器的内存中存储数据的内存和在可用时使用 HTML 5 本地存储功能的本地存储。服务器代理处理将数据编组到远程服务器，示例包括 Ajax、JsonP 和 Rest。

代理可以直接在模型上定义，如下面的代码示例所示

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

    config: {
        fields: ['id', 'name', 'age', 'gender'],
        proxy: {
            type: 'rest',
            url : '/data/users.json',
            reader: {
                type: 'json',
                rootProperty: 'users'
            }
        }
    }
});

// Uses the User Model's Proxy
Ext.create('Ext.data.Store', {
    model: 'User'
});

这种定义模型的方式有两种帮助。首先，由于使用 User 模型的每个存储都可能需要以相同的方式加载其数据，因此我们避免了为每个存储复制代理定义。其次，我们可以在没有存储的情况下加载和保存模型数据

// Gives us a reference to the User class
var User = Ext.ModelMgr.getModel('User');

var ed = Ext.create('User', {
    name: 'Ed Spencer',
    age : 25
});

// We can save Ed directly without having to add him to a Store first because we
// configured a RestProxy this will automatically send a POST request to the url /users
ed.save({
    success: function(ed) {
        console.log("Saved Ed! His ID is "+ ed.getId());
    }
});

// Load User 1 and do something with it (performs a GET request to /users/1)
User.load(1, {
    success: function(user) {
        console.log("Loaded user 1: " + user.get('name'));
    }
});

还有一些代理利用了 HTML5 的新功能 - LocalStorage 和 SessionStorage。虽然较旧的浏览器不支持这些新的 HTML5 API，但它们非常有用，因此许多应用程序将受益匪浅。

Sencha Touch 2.4