表单

表单面板只不过是一个基本的面板，增加了表单处理功能。表单面板可以在 Ext应用程序中使用，无论何时需要从用户那里收集数据。

此外，表单面板可以使用任何容器布局，提供一种方便且灵活的方式来处理字段的定位。表单面板还可以绑定到模型，从而可以轻松地从服务器加载数据并将其提交回服务器。

在后台，表单面板包装了一个基本表单，它处理其所有输入字段管理、验证、提交和表单加载服务。这意味着基本表单的许多配置选项可以直接用于表单面板。

基本表单面板

首先，这里是如何创建一个收集用户数据的简单表单

Ext.create('Ext.form.Panel', {
    renderTo: document.body,
    title: 'User Form',
    height: 350,
    width: 300,
    bodyPadding: 10,
    defaultType: 'textfield',
    items: [
        {
            fieldLabel: 'First Name',
            name: 'firstName'
        },
        {
            fieldLabel: 'Last Name',
            name: 'lastName'
        },
        {
            xtype: 'datefield',
            fieldLabel: 'Date of Birth',
            name: 'birthDate'
        }
    ]
});

此表单将自身呈现给文档正文，并有三个字段 - “名”、“姓”和“出生日期”。使用items配置将字段添加到表单面板。

fieldLabel 配置定义在字段旁边标签中显示的文本，并且 name 配置成为底层 HTML 字段的 name 属性。

请注意此表单面板具有 'textfield' 的 defaultType。这意味着其任何未指定 xtype 的项目（本例中的“名字”和“姓氏”字段）都是 文本字段。

另一方面，“出生日期”字段的 xtype 显式配置为 'datefield'，这使其成为 日期字段。日期字段期望仅包含有效日期数据，并带有用于选择日期的 日期选择器。

字段

字段类型

Ext JS 提供了一组标准字段类型。Ext.form.field 命名空间中的任何字段都可以在表单面板中使用。有关更多信息，请参阅每种字段类型的 API 文档

• Ext.form.field.Checkbox
• Ext.form.field.ComboBox
• Ext.form.field.Date
• Ext.form.field.Display
• Ext.form.field.File
• Ext.form.field.Hidden
• Ext.form.field.HtmlEditor
• Ext.form.field.Number
• Ext.form.field.Radio
• Ext.form.field.Text
• Ext.form.field.TextArea
• Ext.form.field.Time

验证

1. 内置验证

Ext JS 内置对任何类型字段的验证支持，并且一些字段具有内置验证规则。

例如，如果某值输入到 日期字段 中，并且该值无法转换为 Date，则该字段将具有 x-form-invalid-field CSS 类添加到其 HTML 元素中。

如有必要，可以使用 invalidCls 配置更改此 CSS 类。添加 invalidCls 会为输入字段添加红色边框（以及在使用经典主题时添加红色“无效下划线”装饰）

包含无效数据的字段还将显示错误消息。默认情况下，此消息显示为工具提示

可以使用 msgTarget 配置轻松更改字段错误消息的位置，并且 invalidText 配置更改错误消息。

每个字段提供其自己的 invalidText 实现，并且许多字段支持错误消息中的标记替换。

例如，在日期字段的 invalidText 中，任何出现 "{0}" 的地方都将替换为字段的值，并且任何出现 "{1}" 的地方都将替换为所需的日期 格式。

以下代码演示了将错误消息直接放在字段下方，并自定义错误消息文本

{
    xtype: 'datefield',
    fieldLabel: 'Date of Birth',
    name: 'birthDate',
    msgTarget: 'under', // location of the error message
    invalidText: '"{0}" bad. "{1}" good.' // custom error message text
}

2. 自定义验证

某些验证要求无法使用内置验证来满足。实现自定义验证的最简单方法是使用 文本字段 的 regex 配置来应用验证规则，并使用 maskRe 配置来限制可以键入字段的字符。以下是一个验证时间的文本字段示例。

{
    xtype: 'textfield',
    fieldLabel: 'Last Login Time',
    name: 'loginTime',
    regex: /^([1-9]|1[0-9]):([0-5][0-9])(\s[a|p]m)$/i,
    maskRe: /[\d\s:amp]/i,
    invalidText: 'Not a valid time.  Must be in the format "12:34 PM".'
}

虽然上述方法非常适合验证单个字段，但对于具有相同自定义验证的多个字段的应用程序来说，它并不实用。

Ext.form.field.VTypes 类提供了一个创建可重用自定义验证的解决方案。以下是如何创建自定义“时间”验证器

// custom Vtype for vtype:'time'
var timeTest = /^([1-9]|1[0-9]):([0-5][0-9])(\s[a|p]m)$/i;
Ext.apply(Ext.form.field.VTypes, {
    //  vtype validation function
    time: function(val, field) {
        return timeTest.test(val);
    },
    // vtype Text property: The error text to display when the validation function returns false
    timeText: 'Not a valid time.  Must be in the format "12:34 PM".',
    // vtype Mask property: The keystroke filter mask
    timeMask: /[\d\s:amp]/i
});

创建自定义验证器后，可以使用 vtype 配置在整个应用程序的文本字段中使用它

{
    fieldLabel: 'Last Login Time',
    name: 'loginTime',
    vtype: 'time'
}

请参阅 验证示例 以获取实际演示。有关自定义验证的更多信息，请参阅 VTypes 的 API 文档。

处理数据

提交表单

将数据提交到服务器的最简单方法是使用 url 配置 基本表单。由于 表单面板 封装了一个基本表单，因此我们可以在表单面板上直接使用任何基本表单的配置选项

Ext.create('Ext.form.Panel', {
    ...
    url: 'add_user',
    items: [
        ...
    ]
});

表单的 submit 方法可用于将数据提交到配置的 url

Ext.create('Ext.form.Panel', {
    ...
    url: 'add_user',
    items: [
        ...
    ],
    buttons: [
        {
            text: 'Submit',
            handler: function() {
                var form = this.up('form'); // get the form panel
                if (form.isValid()) { // make sure the form contains valid data before submitting
                    form.submit({
                        success: function(form, action) {
                           Ext.Msg.alert('Success', action.result.msg);
                        },
                        failure: function(form, action) {
                            Ext.Msg.alert('Failed', action.result.msg);
                        }
                    });
                } else { // display error alert if the data is invalid
                    Ext.Msg.alert('Invalid Data', 'Please correct form errors.')
                }
            }
        }
    ]
});

在上面的示例中，一个按钮配置了一个 handler，用于处理表单提交。该 handler 执行以下操作

1. 首先，必须获取一个对表单面板的引用。
2. 然后，在提交之前调用 isValid 方法，以验证没有字段具有验证错误。
3. 最后，调用 submit 方法，并传递两个回调函数 - success 和 failure。在这些回调函数中，action.result 指的是已解析的 JSON 响应。

上面的示例期望一个类似于以下内容的 JSON 响应

{ "success": true, "msg": "User added successfully" }

将表单绑定到模型

在 Ext JS 中，Model 类用于表示各种类型的数据，以及在服务器上检索和更新数据。表示用户的模型将定义用户具有的 字段，以及用于加载和保存数据的 代理

Ext.define('MyApp.model.User', {
    extend: 'Ext.data.Model',
    fields: ['firstName', 'lastName', 'birthDate'],
    proxy: {
        type: 'ajax',
        api: {
            read: 'data/get_user',
            update: 'data/update_user'
        },
        reader: {
            type: 'json',
            root: 'users'
        }
    }
});

可以使用 loadRecord 方法，直接从 Model 将数据加载到 表单面板 中

MyApp.model.User.load(1, { // load user with ID of "1"
    success: function(user) {
        userForm.loadRecord(user); // when user is loaded successfully, load the data into the form
    }
});

最后，表单面板的 updateRecord 方法用于使用表单数据更新记录，而不是使用 submit 方法来保存数据，并且调用模型的 save 方法将数据保存到服务器

Ext.create('Ext.form.Panel', {
    ...
    url: 'add_user',
    items: [
        ...
    ],
    buttons: [
        {
            text: 'Submit',
            handler: function() {
                var form = this.up('form'), // get the form panel
                    record = form.getRecord(); // get the underlying model instance
                if (form.isValid()) { // make sure the form contains valid data before submitting
                    form.updateRecord(record); // update the record with the form data
                    record.save({ // save the record to the server
                        success: function(user) {
                            Ext.Msg.alert('Success', 'User saved successfully.')
                        },
                        failure: function(user) {
                            Ext.Msg.alert('Failure', 'Failed to save user.')
                        }
                    });
                } else { // display error alert if the data is invalid
                    Ext.Msg.alert('Invalid Data', 'Please correct form errors.')
                }
            }
        }
    ]
});

模型绑定示例

布局

布局用于处理 Ext JS 应用程序中组件的大小和位置。表单面板 可以使用任何 容器布局。有关布局的更多信息，请参阅 布局和容器指南。

例如，可以使用 HBox 布局轻松地水平定位表单中的字段

Ext.create('Ext.form.Panel', {
    renderTo: document.body,
    title: 'User Form',
    height: 300,
    width: 585,
    defaults: {
        xtype: 'textfield',
        labelAlign: 'top',
        padding: 10
    },
    layout: 'hbox',
    items: [
        {
            fieldLabel: 'First Name',
            name: 'firstName'
        },
        {
            fieldLabel: 'Last Name',
            name: 'lastName'
        },
        {
            xtype: 'datefield',
            fieldLabel: 'Date of Birth',
            name: 'birthDate'
        }
    ]
});