文档帮助

术语、图标和标签

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

访问级别

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

成员类型

成员语法

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

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 原语页面除外)都有一个与该类相关的元数据菜单视图。此元数据视图将包含以下一个或多个内容

展开和折叠示例和类成员

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

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

台式机 -vs- 移动视图

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

查看类源

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

Sencha Touch 2.4


顶部

在 Sencha Touch 中使用表单

大多数需要用户输入的应用程序都使用表单。在 Sencha Touch 中,表单是对普通 HTML5 表单的包装,具有用于验证和提交数据的附加选项,并提供以有吸引力的视觉样式布局字段的简便方法。

创建表单

表单面板展示了一组表单字段,并提供了加载和保存数据的方式。通常,表单面板包含您想要显示的一组字段,按照 items 配置进行排序,如下例所示

在此示例中,我们创建了一个简单的表单面板,可以用作注册表单以注册服务。我们添加了一个用于用户姓名的普通 文本、一个 电子邮件,最后是一个 密码。在每种情况下,我们都提供了字段上的 name 配置,以便在加载和保存表单上的数据时对其进行识别。

加载数据

使用我们在上面创建的表单,我们可以通过不同的方式将数据加载到其中,最简单的方法是 setValues 方法

form.setValues({
    name: 'Seth',
    email: '[email protected]',
    password: 'secret'
});

您还可以将 model 实例加载到表单中 - 例如,假设您有一个 User 模型,并希望将特定实例加载到表单中

Ext.define('MyApp.model.User', {
    extend: 'Ext.data.Model',
    config: {
        fields: ['name', 'email', 'password']
    }
});

var ed = Ext.create('MyApp.model.User', {
    name: 'Seth',
    email: '[email protected]',
    password: 'secret'
});

form.setRecord(ed);

检索表单数据

从表单面板检索数据通常使用 getValues 方法

var values = form.getValues();

// values now looks like this:
{
    name: 'Seth',
    email: '[email protected]',
    password: 'secret'
}

还可以监听各个字段上的更改事件,以便更及时地了解用户所做的更改。在以下示例中,我们扩展了包含 User 模型的先前代码,并在任何字段更改时更新模型

var form = Ext.create('Ext.form.Panel', {
    listeners: {
        '> field': {
            change: function(field, newValue, oldValue) {
                ed.set(field.getName(), newValue);
            }
        }
    },
    items: [
        // as before
    ]
});

此示例使用了 Sencha Touch 的一项新功能,该功能使您能够指定任何容器的子组件上的侦听器。在这种情况下,我们为表单面板的直接子组件的每个表单字段的 change 事件附加了一个侦听器。侦听器获取触发更改事件的字段的名称,并使用新值更新 model 实例。例如,更改表单中的电子邮件字段将更新模型的电子邮件字段。

提交表单

Sencha Touch 提供了许多提交表单数据的方法。在前面的示例中,我们有一个已更新的 Model 实例,它使我们能够使用 Model 的 save 方法将更改持久保存到我们的服务器,而无需使用传统的表单提交。或者,我们可以使用 submit 方法发送正常的浏览器表单提交

form.submit({
    url: 'url/to/submit/to',
    method: 'POST',
    success: function() {
        alert('form submitted successfully!');
    }
});

在这种情况下,我们在 submit 函数调用中提供了要提交表单的 URL - 或者,您可以在创建表单时设置 url 配置。您可以指定其他参数(有关完整列表,请参阅 submit),包括成功和失败的回调函数,这些函数根据表单提交是否成功而调用。这些函数通常用于在数据保存到服务器后在您的应用程序中执行一些操作。

Sencha Touch 2.4