jquery easyui datagrid使用參考

創建datagrid

在頁面上添加一個div或table標籤，然後用jquery獲取這個標籤，並初始化一個datagrid。代碼如下：

頁面上的div標籤：

<div id="magazineGrid">
</div>

js代碼：

$('#magazineGrid').datagrid({
    height: 340,
    url: 'url',
    method: 'POST',
    queryParams: { 'id': id },
    idField: '產品ID',
    striped: true,
    fitColumns: true,
    singleSelect: false,
    rownumbers: true,
    pagination: false,
    nowrap: false,
    pageSize: 10,
    pageList: [10, 20, 50, 100, 150, 200],
    showFooter: true,
    columns: [[
        { field: 'ck', checkbox: true },
        { field: '刊名', title: '刊名', width: 180, align: 'left' },
        { field: '類別', title: '類別', width: 150, align: 'left' },
        { field: '月份', title: '月份', width: 100, align: 'left' },
        { field: '期次', title: '期次', width: 100, align: 'left' },
        { field: '價格', title: '價格', width: 100, align: 'right' },
        { field: '訂閱數', title: '訂閱數', width: 100, align: 'right' },
        { field: '庫存數', title: '庫存數', width: 100, align: 'right' },
        { field: '郵寄方式', title: '郵寄方式', width: 80, align: 'left' },
        { field: '數量', title: '數量', width: 80, align: 'left',
            editor: {
                type: 'numberbox',
                options: {
                    min: 0,
                    precision: 0
                }
            }
        }
    ]],
    onBeforeLoad: function (param) {
    },
    onLoadSuccess: function (data) {
        
    },
    onLoadError: function () {
        
    },
    onClickCell: function (rowIndex, field, value) {
        
    }
});

 

ajax請求返回的數據格式

datagrid在創建完成後會根據url請求數據，這是通過ajax來完成的。服務器在完成請求處理後應返回帶有rows屬性的數據，如果用到分頁，還需要有total屬性：

var rst = new { total = iTotalCount, rows = entityList };

說到ajax請求，難免需要在請求的時候傳入一些查詢條件，我通常是在onBeforeLoad事件中添加查詢條件的：

onBeforeLoad: function (param) {
    var bId = $("#txtBId").val();
    var AllSearchKey = $("#txtAllSearchKey").val();
    param.bId = bId;
    param.AllSearchKey = AllSearchKey;
}

 

分頁處理

如果要啓用分頁，在datagrid配置中，首先要加入如下配置：

pagination: true,

這樣一來我們的datagrid底部就會出現一個分頁工具欄。

這個時侯，datagrid在請求數據的時候會自動的添加分頁的信息：

• page：當前請求的頁碼
• rows：每頁要顯示的行數

在服務器端獲取到這兩個參數值，然後通過獲取數據庫中的總數據行數來完成數據處理。

 

關於checkbox列

上面的js代碼創建的datagrid本身已經添加了checkbox列，就是第一列。checkbox列將會自適應寬度。

{ field: 'ck', checkbox: true },

 

關於rownumber列

rownumber列的配置是在全局設置的，如果設置爲true則會添加一列來顯示行號。

rownumbers: true

 

行編輯功能的實現

datagrid本身提供了行編輯的功能。只需要兩個步驟：

1. 設置列的editor屬性
2. 手動觸發編輯

第一步，我們需要在column配置中指明editor，editor有兩個屬性，type和options，有效的type字符串有：

text,textarea,checkbox,numberbox,validatebox,datebox,combobox,combotree

options則對應這些控件的具體配置，包括事件等。

editor: {
    type: 'numberbox',
    options: {
        min: 0,
        precision: 0
    }
}

如果不需要特殊的options配置，直接將type字符串賦給editor即可。

editor:'text'

第二步，我們需要監聽datagrid的onRowClick事件，或者onCellClick事件，我更願意監聽onCellClick事件，可以根據點擊不同的字段來進入編輯模式，並設置單元格編輯控件的focus。

onClickCell: function (rowIndex, field, value) {
    beginEditing(rowIndex, field, value)
}

這裏調用了beginEditing方法：

var editIndex = undefined;
var beginEditing = function (rowIndex, field, value) {
    if (field != "數量")
        return;

    if (rowIndex != editIndex) {
        if (endEditing()) {
            $('#magazineGrid').datagrid('beginEdit', rowIndex);
            editIndex = rowIndex;

            var ed = $('#magazineGrid').datagrid('getEditor', { index: rowIndex, field: '數量' });
            $(ed.target).focus().bind('blur', function () {
                endEditing();
            });
        } else {
            $('#magazineGrid').datagrid('selectRow', editIndex);
        }
    }
}
var endEditing = function () {
    if (editIndex == undefined) { return true }
    if ($('#magazineGrid').datagrid('validateRow', editIndex)) {
        var ed = $('#magazineGrid').datagrid('getEditor', { index: editIndex, field: '數量' });
        var number = $(ed.target).numberbox('getValue');
        $('#magazineGrid').datagrid('getRows')[editIndex]['數量'] = number;
        $('#magazineGrid').datagrid('endEdit', editIndex);
        $('#magazineGrid').datagrid('selectRow', editIndex);
        editIndex = undefined;
        return true;
    } else {
        return false;
    }
}

 

列格式化輸出 formatter

在列的配種中設置formatter

formatter: function (value, row, index) {
    if (row.user) {
        return row.user.name;
    } else {
        return value;
    }
}

 

使用工具欄

toolbar: [{
    text: 'Add',
    iconCls: 'icon-add',
    handler: function () { alert('add') }
}, {
    text: 'Cut',
    iconCls: 'icon-cut',
    handler: function () { alert('cut') }
}, '-', {
    text: 'Save',
    iconCls: 'icon-save',
    handler: function () { alert('save') }
}],

 

使用CardView效果

cardView效果是這樣的：

cardView的代碼：

var cardview = $.extend({}, $.fn.datagrid.defaults.view, {
    renderRow: function (target, fields, frozen, rowIndex, rowData) {
        var cc = [];
        cc.push('<td colspan=' + fields.length + ' style="padding:10px 5px;border:0;">');
        if (!frozen) {
            var aa = rowData.itemid.split('-');
            var img = 'shirt' + aa[1] + '.gif';
            cc.push('<img src="images/' + img + '" style="width:150px;float:left">');
            cc.push('<div style="float:left;margin-left:20px;">');
            for (var i = 0; i < fields.length; i++) {
                var copts = $(target).datagrid('getColumnOption', fields[i]);
                cc.push('<p><span class="c-label">' + copts.title + ':</span> ' + rowData[fields[i]] + '</p>');
            }
            cc.push('</div>');
        }
        cc.push('</td>');
        return cc.join('');
    }
});
$(function () {
    $('#tt').datagrid({
        view: cardview
    });
});

cardView其實是使用了datagrid的view配置，重寫了其默認的renderRow方法。基於這種實現，我們可以顯示更多樣式的view。