easyui-datagrid 编辑模式详解

   一，建立编辑器

 

       从api得知，扩展一种新的编辑器类型，需要提供以上几个方法。项目中正好需要一个checkbox 类型编辑器，但在easyui中并没提供这样的编辑器，那我们可以通过扩展编辑器来解决，扩展如下

 $.extend($.fn.datagrid.defaults.editors, {
    checkbox: {//调用名称
        init: function (container, options) {
           //container 用于装载编辑器 options,提供编辑器初始参数
            var input = $('<input type="checkbox" class="datagrid-editable-input">').appendTo(container);
           //这里我把一个 checkbox类型的输入控件添加到容器container中
           // 需要渲染成easyu提供的控件，需要时用传入options,我这里如果需要一个combobox，就可以 这样调用 input.combobox(options);
            return input;
        },
        getValue: function (target) {
           //datagrid 结束编辑模式，通过该方法返回编辑最终值
           //这里如果用户勾选中checkbox返回1否则返回0
            return $(target).prop("checked") ? 1 : 0;
        },
        setValue: function (target, value) {
           //datagrid 进入编辑器模式，通过该方法为编辑赋值
            //我传入value 为0或者1，若用户传入1则勾选编辑器
            if (value)
                $(target).prop("checked", "checked")
        },
        resize: function (target, width) {
           //列宽改变后调整编辑器宽度
            var input = $(target);
            if ($.boxModel == true) {
                input.width(width - (input.outerWidth() - input.width()));
            } else {
                input.width(width);
            }
        }
    }
});

 新的编辑扩展好以后，跟系统默认的编辑器使用方式一样：

 

二 , 获取编辑器

 

datagrid 通过调用 beginEdit 传入要开始编辑行的对应的索引，该行进入编辑模式。通过 endEdit 或者 cancleEdit结束编辑模式，endEdit会提交一个数据变更记录，cancleEdit会还原为初始数据。

getEditors以及getEditor 返回指定行当前编辑器，getEditor 底层调用getEditors 方法。getEditors 返回一个编辑器对象数组。

三，编辑器事件

   一个项目中存在这样三个需求

    1，根据不同的操作结果，渲染不同编辑控件的操作模式，如以下图所示，用户选择小组1，日期控制范围必须到天，右侧日期控件提供按天选择展示。用户选择小组6，日期控制范围到月就可以了，右侧日期控件提供按月选择展示。

    2，列表中存在开始日期，和结束日期必须控制开始日期不能大于结束日期或者结束日期不能大于开始日期

    3，根据用户选择的开始日期，提取对应的年份。

 

 

针对这两个需求，该怎么实现呢？

   先来了解下datagrid在编辑模式提供哪些可用事件，以及如何扩展一个新数据验证规则

API中提供事件：

 

扩展数据验证规则：

$.extend($.fn.validatebox.defaults.rules, {
   //验证开始日期只能小于结束日期
    sdatecompare: {
        validator: function (value, param) {
            var end = param[0];
            if (typeof end == 'string') {
                end = $(param[0]);//结束日期 selector
            }
            if (!end.datebox("getValue")) {
                return true;
            }
            var endDate = new Date(end.datebox("getValue"));
            var CurDate = new Date(value);
            return CurDate < endDate;
        },
        message: '开始日期必须小于结束日期'
    },
    edatecompare: {
        validator: function (value, param) {
            var start = param[0];
            if (typeof start == 'string') {
                start = $(param[0]); //开始日期 selector
            }
            if (!start.datebox("getValue") || !value) {
                return true;
            }
            var startDate = new Date(start.datebox("getValue"));
            var CurDate = new Date(value);
            $.fn.validatebox.defaults.rules.edatecompare.message = '结束日期必须大于开始日期';
            return CurDate > startDate;
        },
        message: ''
    },
});

     有了以上两点基本知识，这三个需求处理起来就很顺利了。第一个需求，根据不同的数据渲染不同的界面。在此我看到了 onBeforeEdit 根据字面意思就是在开始编辑之前，官方解释，用户在开始编辑一行数据时触发。也就是说，在这个事件激发之前，datagrid根本还没有建立或初始编辑器控件，而我们又知道datagrid 编辑是通过列属性中editor中options渲染控件的，那在这里改变options的值不就好了么，于是在onBeforeEdit我敲上了一下js代码：

var zSelected = fazgl.grdtnz.datagrid("getSelected");
var ksOpts = $(this).datagrid("getColumnOption", "F_KSRQ");
var jsOpts = $(this).datagrid("getColumnOption", "F_JSRQ");
var rendmodes = ["year", 'month'];//easyui calendar 中扩展一个mode属性，用于显示选择到月或者到天
$.extend(ksOpts.editor.options, { mode: rendmodes[zSelected.F_SFFT] });
$.extend(jsOpts.editor.options, { mode: rendmodes[zSelected.F_SFFT] });

     通过验证这个思路完全正确，合理处理了根据不同数据展现不同界面的需求。第一个需求到此结束，现在聚焦到第二个需求，开始日期必须小于结束日期，从上面扩展的数据验证规则sdatecompare和edatecompare，我们知道需要传入一个被比较日期控件的selector。那该怎么实现呢？在回看一下 API，其中有onBeginEdit 这么一个事件，通过查阅源码，了解到datagrid在激发该事件时已经对应的编辑控件已经创建完毕，那通过datagrid 提供方法 getEditors或者getEditor得到编辑器，其中的target不就是需要的selector么！ 于是乎，我在onBeginEdit 中敲下了如下代码：

            var editors = $(this).datagrid("getEditors", index);
            var ed_Ksrq = editors[0];//开始日期编辑器
            var ed_Jsrq = editors[1];//结束日期编辑器
            //easyui 日期控件从 textbox扩展，所有需要得到对应textbox的options才能加入验证规则
            var ksopts = $(ed_Ksrq.target).datebox("textbox").validatebox("options");
            ksopts.validType = ksopts.validType || {};//如果编辑器最初设置，对应编辑器validType为null,这里做下为空判断
            $.extend(ksopts.validType, { sdatecompare: [ed_Jsrq.target] });
            var jsopts = $(ed_Jsrq.target).datebox("textbox").validatebox("options");
            jsopts.validType = jsopts.validType || {};
            $.extend(jsopts.validType, { edatecompare: [ed_Ksrq.target] });

      经过测试，思路完全正确，成功实现动态加入验证规则。有了以上经验，对于第三个需求，感觉已经没有什么难度了，datagrid提供 onEndEdit（销毁编辑器前） ，onAfterEdit（销毁编辑器后），都会返回 一个changes 对象，里边保存了变更的数据,于是我在onEndEdit 写下了如下代码：

 var nrow = {};

            //判断是否有更改开始日期

            if (changes["F_KSRQ"]) {

                var kAry = changes.F_KSRQ.split("-");

                var date = new Date(parseInt(kAry[0]), parseInt(kAry[1]) - 1);

                nrow["F_NIAN"] = date.getFullYear();

                nrow["F_KSY"] = kAry[1];

                nrow.F_KSRQ = row.F_KSRQ + "-" + "01";

            }

          //更新数据

            $(this).datagrid("updateRow", {

                index: index,

                row: nrow

            });

            nrow = null;

这样就 onCancelEdit 这个事件没有讲解了，不过根据api也明白是在什么时候调用的，可以做哪些事，还等待合适的需求又来在讲解！

2015-11-24