JqGrid相關操作 方法列表

1.獲得當前列表行數：$("#gridid").getGridParam("reccount");

2.獲取選中行數據（json）：$("#gridid").jqGrid('getRowData', id);

3.刷新列表:$(refreshSelector).jqGrid('setGridParam', { url: ''), postData: ''}).trigger('reloadGrid'); 

4.選中行：$("#jqGrid").setSelection("1", true);   （Toggles a selection of the row with id = rowid; if onselectrow is true (the default) then the event onSelectRow is launched, otherwise it is not.）//true:重新加載表格數據, false:不重新加載表格數據

5.重置選中行：$("#jqgrid").resetSelection(); //Resets (unselects) the selected row(s). Also works in multiselect mode.

6.清除：$("#jqgrid").clearGridData();   //Clears the currently loaded data from grid. If the clearfooter parameter is set to true, the method clears the data placed on the footer row.

7. $("#jqgrid").setCell(rowid,colname,nData,cssp,attrp); 

//This method can change the content of particular cell and can set class or style properties. Where: 

rowid the id of the row, 
colname the name of the column (this parameter can be a number (the index of the column) beginning from 0 
data the content that can be put into the cell. If empty string the content will not be changed 
class if class is string then we add a class to the cell using addClass; if class is an array we set the new css properties via css 
properties sets the attribute properies of the cell, 

forceup If the parameter is set to true we perform update of the cell instead that the value is empty 

 

8.獲取選中行ID

 var rowid = $("#jqgrid").jqGrid('getGridParam','selrow'); 

var rowid = $("#searchResultList").getGridParam("selrow");
var rowData = $("#searchResultList").getRowData(rowid); /根據行ID，獲取選中行的數據(根據)

//獲取選中的多行ID列表
var selectedIds  = jQuery("#stationList").jqGrid("getGridParam","selarrrow"); 允許多行選擇時使用

=================重點講解================

 

1.1 prmNames選項

prmNames是jqGrid的一個重要選項，用於設置jqGrid將要向Server傳遞的參數名稱。其默認值爲：

  

prmNames : {
    page:"page",    // 表示請求頁碼的參數名稱
    rows:"rows",    // 表示請求行數的參數名稱
    sort: "sidx", // 表示用於排序的列名的參數名稱
    order: "sord", // 表示採用的排序方式的參數名稱
    search:"_search", // 表示是否是搜索請求的參數名稱
    nd:"nd", // 表示已經發送請求的次數的參數名稱
    id:"id", // 表示當在編輯數據模塊中發送數據時，使用的id的名稱
    oper:"oper",    // operation參數名稱（我暫時還沒用到）
    editoper:"edit", // 當在edit模式中提交數據時，操作的名稱
    addoper:"add", // 當在add模式中提交數據時，操作的名稱
    deloper:"del", // 當在delete模式中提交數據時，操作的名稱
    subgridid:"id", // 當點擊以載入數據到子表時，傳遞的數據名稱
    npage: null,
    totalrows:"totalrows" // 表示需從Server得到總共多少行數據的參數名稱，參見jqGrid選項中的rowTotal
}

 

 

可以通過這個選項來自定義當向Server發送請求時，默認發送的參數名稱。
這個參數很重要也很有用，正是通過這個參數，可以方便的改變默 認的request的參數，以符合Server端的需要。比如在prmNames中search默認的值爲"_search"，這在Struts2的 Action中不太方便命名成員變量和getter/ setter。因此可以使用 prmNames: {search: 'search'} 來改變這一默認值爲"search"，這在Struts2的Action對象中就很好設置getter/ setter了，即getSearch()和setSearch()。當然其他名字也是可以的。

 

1.2 jsonReader選項

jsonReader是jqGrid的一個重要選項，用於設置如何解析從Server端發回來的json數據。其默認值爲：

 

jsonReader : {
    root: "rows",   // json中代表實際模型數據的入口
    page: "page",   // json中代表當前頁碼的數據
    total: "total", // json中代表頁碼總數的數據
    records: "records", // json中代表數據行總數的數據
    repeatitems: true, // 如果設爲false，則jqGrid在解析json時，會根據name來搜索對應的數據元素（即可以json中元素可以不按順序）；而所使用的name是來自於colModel中的name設定。
    cell: "cell",
    id: "id",
    userdata: "userdata",
    subgrid: {
        root:"rows",
        repeatitems: true,
        cell:"cell"
    }
}

 

 

可以這樣理解，prmNames設置瞭如何將Grid所需要的參數傳給Server，而jsonReader設置瞭如何去解析從Server端傳回 來的json數據。如果沒有設置jsonReader的話，jqGrid將會根據默認的設置來解析json數據，並顯示在表格裏。但如果傳回來的json 數據，不太符合默認設置（比如內部的結構名不太一樣），那麼就有必要修改這一設置。比如：

 

jsonReader: {
    root:"gridModel",
    page: "page",
    total: "total",
    records: "record",
    repeatitems : false
}

 

 

注1：據其他網友的文章，如果設置repeatitems爲false，不但數據可以亂序，而且不用每個數據元素都要具備，用到哪個找到哪個就可以了。實驗卻是如此。
注2：cell、id在repeatitems爲true時可以用到，即每一個記錄是由一對id和cell組合而成，即可以適用另一種json結構。援引文檔中的例子：

repeatitems爲true時：

 

jQuery("#gridid").jqGrid({
    ...
    jsonReader : {
        root:"invdata",
        page: "currpage",
        total: "totalpages",
        records: "totalrecords"
    },
    ...
});

 

json結構爲：

 

{
    "totalpages": "xxx",
    "currpage": "yyy",
    "totalrecords": "zzz",
    "invdata" : [
                 {"id" :"1", "cell" :["cell11", "cell12", "cell13"]},   // cell中不需要各列的name，只要值就OK了，但是需要保持對應
                 {"id" :"2", "cell" :["cell21", "cell22", "cell23"]},
                 ...
    ]
}

 

 

 

repeatitems爲false時：

 

jQuery("#gridid").jqGrid({
    ...
    jsonReader : {
        root:"invdata",
        page: "currpage",
        total: "totalpages",
        records: "totalrecords",
        repeatitems: false,
        id: "0"
    },
    ...
});

 

json結構爲：

 

{
    "totalpages" : "xxx",
    "currpage" : "yyy",
    "totalrecords" : "zzz",
    "invdata" : [
                 {"invid" : "1","invdate":"cell11", "amount" :"cell12", "tax" :"cell13", "total" :"1234", "note" :"somenote"}, // 數據中需要各列的name，但是可以不按列的順序
                 {"invid" : "2","invdate":"cell21", "amount" :"cell22", "tax" :"cell23", "total" :"2345", "note" :"some note"},
                 ...
    ]
}

 

 

 

 

 

 

 

2. colModel的重要選項 

和jqGrid一樣colModel也有許多非常重要的選項，在使用搜索、排序等方面都會用到。這裏先只說說最基本的。

• name ：爲Grid中的每個列設置唯一的名稱，這是一個必需選項，其中保留字包括subgrid、cb、rn。
• index ：設置排序時所使用的索引名稱，這個index名稱會作爲sidx參數（prmNames中設置的）傳遞到Server。
• label ：當jqGrid的colNames選項數組爲空時，爲各列指定題頭。如果colNames和此項都爲空時，則name選項值會成爲題頭。
• width ：設置列的寬度，目前只能接受以px爲單位的數值，默認爲150。
• sortable ：設置該列是否可以排序，默認爲true。
• search ：設置該列是否可以被列爲搜索條件，默認爲true。
• resizable ：設置列是否可以變更尺寸，默認爲true。
• hidden ：設置此列初始化時是否爲隱藏狀態，默認爲false。
• formatter ：預設類型或用來格式化該列的自定義函數名。常用預設格式有：integer、date、currency、number等（具體參見文檔 ）。

 

 

 

 

3. 第一個實例

 

3.1 服務器端

用於提供數據的Action。爲了可以複用這種專門接受jqGrid傳來參數的Action，我抽象出一個基本類。具體代碼如下：

package cn.gengv.struts2ex.jqGrid;

import java.util.Collections;
import java.util.List;
import com.opensymphony.xwork2.ActionSupport;

@SuppressWarnings("serial")
public abstract class JqGridBaseAction<T> extends ActionSupport {
    // 和jqGrid組件相關的參數屬性
    private List<T> gridModel = Collections.emptyList();
    private Integer rows = 0;
    private Integer page = 0;
    private Integer total = 0;
    private Integer record = 0;
    private String sord;
    private String sidx;
    private String search;

    public abstract int getResultSize();

    public abstract List<T> listResults(int from, int length);

    public String refreshGridModel() {
        try {
            List<T> results = Collections.emptyList();
            record = this.getResultSize();
            int from = rows * (page - 1);
            int length = rows;
            results = this.listResults(from, length);
            this.setGridModel(results);
            total = (int) Math.ceil((double) record / (double) rows);
            return SUCCESS;
        } catch (Exception e) {
            e.printStackTrace();
            this.addActionError(e.getMessage());
            return ERROR;
        }
    }

    public List<T> getGridModel() {
        return gridModel;
    }
    public void setGridModel(List<T> gridModel) {
        this.gridModel = gridModel;
    }
    public Integer getRows() {
        return rows;
    }
    public void setRows(Integer rows) {
        this.rows = rows;
    }
    public Integer getPage() {
        return page;
    }
    public void setPage(Integer page) {
        this.page = page;
    }
    public Integer getTotal() {
        return total;
    }
    public void setTotal(Integer total) {
        this.total = total;
    }
    public Integer getRecord() {
        return record;
    }
    public void setRecord(Integer record) {
        this.record = record;
    }
    public String getSord() {
        return sord;
    }
    public void setSord(String sord) {
        this.sord = sord;
    }
    public String getSidx() {
        return sidx;
    }
    public void setSidx(String sidx) {
        this.sidx = sidx;
    }
    public String getSearch() {
        return search;
    }
    public void setSearch(String search) {
        this.search = search;
    }
}

 

 

說明：

• 其中的成員變量對應着jqGrid的prmNames和jsonReader中的設置。

 

成員變量	對應 prmNames	對應 jsonReader	註釋
rows	rows	-	每頁中現實的記錄行數
search	search	-	是否是用於查詢的請求
sidx	sort	-	用於排序的列名
sord	order	-	排序的方式
page	page	page	當前頁碼
gridModel	-	root	用於得到實際數據的數組名稱
total	-	total	總頁數
record	-	records	總記錄數

 

• refreshGridModel()方法中，主要工作就是爲gridModel、record、total賦值，這些值也將會傳回客戶端。

 

具體的一個實現類：

 

package cn.gengv.struts2ex.jqGrid;
import java.util.Collections;
import java.util.List;
@SuppressWarnings("serial")
public class ListContactsAction extends JqGridBaseAction<Contact> {

    private ContactService contactService;

    @Override
    public String execute() {
        return this.refreshGridModel();
    }

    @Override
    public int getResultSize() {
        return this.contactService.queryResultsCount();
    }

    @Override
    public List<Contact> listResults(int from, int length) {
        List<Contact> results = Collections.emptyList();

        results = this.contactService.queryByPage(from, length);

        return results;
    }
    public void setContactService(ContactService contactService) {
        this.contactService = contactService;
    }

}

 

 

而在struts.xml中，應按如下設置配置action：

 

<action name="jqGrid01" class="cn.gengv.struts2ex.jqGrid.ListContactsAction">
    <result name="success" type="json">
        <param name="includeProperties">
            ^gridModel/[/d+/]/./w+,
            rows, page, total, record
        </param>
        <param name="noCache">true</param>
        <param name="ignoreHierarchy">false</param>
    </result>
</action>

 

 

3.2 客戶端（瀏覽器）

 

javascript部分：

 

$(function(){
    // 配置jqGrid組件
    $("#gridTable").jqGrid({
        url: "jqGrid01.action",
        datatype: "json",
        mtype: "GET",
        height: 350,
        autowidth: true,
        colModel: [
              {name:"id",index:"id",label:"ID",width:40},
              {name:"lastName",index:"lastName",label:"Last Name",width:80,sortable:false},
              {name:"firstName",index:"firstName",label:"First Name",width:80,sortable:false},
              {name:"email",index:"email",label:"E-mail",width:160,sortable:false},
              {name:"telNo",index:"telNo",label:"Tel No",width:120,sortable:false}
        ],
        viewrecords: true,
        rowNum: 15,
        rowList: [15,50,100],
        prmNames: {search: "search"},   //(1)
        jsonReader: {
            root:"gridModel",       // (2)
            records: "record",      // (3)
            repeatitems : false     // (4)
        },
        pager: "#gridPager",
        caption: "聯繫人列表",
        hidegrid: false
    });
});

 

 

其中主要的選項在開頭已經介紹過了，另外需要說明以下幾點：
1、在位置(1)處，爲了配合Server端的Action類中的成員變量命名，將prmNames中search對應的“_search”更改爲“search”。
2、在位置(2)(3)處，爲了配合Server端的Action類中的成員變量命名，將jsonReader中root對應的“rows”更改爲“gridModel”，將records對應的“records”更改爲“record”。
在後面的request和response解析中，就可以看到這些更改的作用。

 

 

 

html部分：

 

要想順利的使用jqGrid，需要想頁面中引入6個文件，其中4個js文件，2個css文件。它們分別是：

• jquery-ui-1.8.1.custom.css（jQuery UI界面的CSS文件）
• ui.jqgrid.custom.css（專用於jqGrid界面的CSS文件）
• jquery-1.4.2.min.js（jQuery的核心）
• jquery-ui-1.8.1.custom.min.js（用於支持jQuery UI界面）
• grid.locale-zh-CN.js（針對jqGrid的locale設置，根據locale不同，選擇不同的尾綴）
• jquery.jqGrid.min.js（jqGrid的核心，可以到jqGrid網站，根據需求選擇模塊下載）

注 ：jqGrid的官方包中原本針對中文的locale js文件是grid.locale-cn.js，但是裏面的某些設置，並沒有做到完全中文化，因此我從Struts2-jQuery插件中分離出grid.locale-zh-CN.js和jquery.ui.datepicker-zh-CN.min.js這兩個文件以備後用。說起來這兩個文件中，針對中文的設置還是不錯的。

引入這6個文件後，創建jqGrid的工作就交給上面寫的javascript代碼來完成了。

 

 

<!DOCTYPE html
PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="zh-CN" lang="zh-CN">
    <head>
        <title>jqGrid01</title>
        <link rel="stylesheet" type="text/css" media="screen" href="../css/themes/aero/jquery-ui-1.8.1.custom.css" mce_href="css/themes/aero/jquery-ui-1.8.1.custom.css" />
        <link rel="stylesheet" type="text/css" media="screen" href="../css/themes/aero/ui.jqgrid.custom.css" mce_href="css/themes/aero/ui.jqgrid.custom.css" />

        <mce:script type="text/javascript" src="../js/jquery-1.4.2.min.js" mce_src="js/jquery-1.4.2.min.js"></mce:script>
        <mce:script src="../js/jquery-ui-1.8.1.custom.min.js" mce_src="js/jquery-ui-1.8.1.custom.min.js" type="text/javascript"></mce:script>
        <mce:script src="../js/i18n/grid.locale-zh-CN.js" mce_src="js/i18n/grid.locale-zh-CN.js" type="text/javascript"></mce:script>
        <mce:script src="../js/jquery.jqGrid.min.js" mce_src="js/jquery.jqGrid.min.js" type="text/javascript"></mce:script>

        <mce:script src="js/jqGrid01.js" mce_src="js/jqGrid01.js" type="text/javascript"></mce:script>
    </head>
    <body>
        <h2>
            jqGrid測試 01
        </h2>
        <div>
            <table id="gridTable"></table>
            <div id="gridPager"></div>
        </div>
    </body>
</html>

 

 

HTML中的代碼，異常簡潔。

 

 

 

 

3.3 整個流程

 

通過Firebug監測request和response就可以看出Server和瀏覽器之間的數據交互。當打開頁面的時候，jqGrid初始化，會向Server發送url中定義的request，並傳遞參數。如下：

 

http://localhost:8085/Hare/jqGridTest/jqGrid01.action?search=false&nd=1278331032140&rows=15&page=1&sidx=&sord=asc

 

jqGrid會根據prmNames中的定義，向Server傳遞參數，例如將jqGrid選項中rowNum的值，作爲參數rows傳遞到Server。

由於我將prmNames中的search設爲“search”，所以參數裏表中出現了這個參數；否則仍會根據原來的默認值，出現“_search”參數。


再看看response，Server發送來的json數據，格式是這樣的：

 

{
    "gridModel": [
            {
                "address": "ADDR-yjfrot4i008toqlrl4dfq9",
                "email": "[email protected]",
                "firstName": "FN-gn7po9c9m",
                "fullName": "LN-3h6d1q FN-gn7po9c9m",
                "id": 23016,
                "idCardNo": "CARD-28ew6dekrv9g8dml4n",
                "lastName": "LN-3h6d1q",
                "nationality": "NAT-6z1xhty2",
                "telNo":: "TEL-x3i4a625i"
            },
            {
                "address": "ADDR-9zeiasrr",
                "email": "[email protected]",
                "firstName": "FN-8mwhw7n",
                "fullName": "LN-yaontk FN-8mwhw7n",
                "id": 23015,
                "idCardNo": "CARD-gqqbd9s4zjexj05sus",
                "lastName": "LN-yaontk",
                "nationality": "NAT-0phliht",
                "telNo":: "TEL-jf4c31"
            },
            {
                "address": "ADDR-o4ml00d98j7xgktl",
                "email": "[email protected]",
                "firstName": "FN-etzsxbaq4",
                "fullName": "LN-uedrek8 FN-etzsxbaq4",
                "id": 23014,
                "idCardNo": "CARD-md9bcyef7wvcc7om6b",
                "lastName": "LN-uedrek8",
                "nationality": "NAT-okbb5",
                "telNo":: "TEL-pp0d00"
            },
            {
                "address": "ADDR-obzar7v7z58uux",
                "email": "[email protected]",
                "firstName": "FN-f1qnbw0x",
                "fullName": "LN-20ug4vxfc FN-f1qnbw0x",
                "id": 23013,
                "idCardNo": "CARD-kzil6hhtpo68izim0b",
                "lastName": "LN-20ug4vxfc",
                "nationality": "NAT-dxidrf",
                "telNo":: "TEL-eug8ydessk"
            },
            {
                "address": "ADDR-r7954tumxw133a9os90l",
                "email": "[email protected]",
                "firstName": "FN-pw1yl8ux",
                "fullName": "LN-nk7qg6by FN-pw1yl8ux",
                "id": 23012,
                "idCardNo": "CARD-0cx02jpey6nivhkr29",
                "lastName": "LN-nk7qg6by",
                "nationality": "NAT-85tl0a",
                "telNo":: "TEL-4aa404"
            },
            {
                "address": "ADDR-jxmudykwu7kcu",
                "email": "[email protected]",
                "firstName": "FN-cjxxxds3",
                "fullName": "LN-3iviu7o FN-cjxxxds3",
                "id": 23011,
                "idCardNo": "CARD-9evl3ul16uldvjango",
                "lastName": "LN-3iviu7o",
                "nationality": "NAT-v2gnaa9",
                "telNo":: "TEL-gzbn1w"
            },
            {
                "address": "ADDR-9xsk62kmdidc",
                "email": "[email protected]",
                "firstName": "FN-iqygy07ku",
                "fullName": "LN-3mrxki FN-iqygy07ku",
                "id": 23010,
                "idCardNo": "CARD-ccypafwru43cqyjo62",
                "lastName": "LN-3mrxki",
                "nationality": "NAT-qjpvfa",
                "telNo":: "TEL-2bqxde"
            },
            {
                "address": "ADDR-t8dizyumbedgbd0u8ml",
                "email": "[email protected]",
                "firstName": "FN-89xwf0",
                "fullName": "LN-8wr6uiig3 FN-89xwf0",
                "id": 23009,
                "idCardNo": "CARD-7t09x2dw3i3y78z24e",
                "lastName": "LN-8wr6uiig3",
                "nationality": "NAT-9uu7xo",
                "telNo":: "TEL-p8ym9rtwy"
            },
            {
                "address": "ADDR-gupoe8jwcqwcjs2u01oa8",
                "email": "[email protected]",
                "firstName": "FN-0amkpy2",
                "fullName": "LN-i73kpz5nc FN-0amkpy2",
                "id": 23008,
                "idCardNo": "CARD-itgmrwwichkzan5220",
                "lastName": "LN-i73kpz5nc",
                "nationality": "NAT-k2aq2t",
                "telNo":: "TEL-2wdhbs"
            },
            {
                "address": "ADDR-gp9q73fzs68agav6",
                "email": "[email protected]",
                "firstName": "FN-w42bd8y",
                "fullName": "LN-utrnn25c FN-w42bd8y",
                "id": 23007,
                "idCardNo": "CARD-rrznb3ihqf94k2wjkv",
                "lastName": "LN-utrnn25c",
                "nationality": "NAT-gs3e9rk",
                "telNo":: "TEL-g8j19nqz9"
            },
            {
                "address": "ADDR-ja8w4gq485m3dn2gr66",
                "email": "[email protected]",
                "firstName": "FN-dxfyd5m5m",
                "fullName": "LN-li98bk FN-dxfyd5m5m",
                "id": 23006,
                "idCardNo": "CARD-indqfrmi13zfazly67",
                "lastName": "LN-li98bk",
                "nationality": "NAT-qglj9sx2",
                "telNo":: "TEL-mzlpe3m"
            },
            {
                "address": "ADDR-rm3r94qanvt1q4drp",
                "email": "[email protected]",
                "firstName": "FN-qkq3w1m",
                "fullName": "LN-0j90sa FN-qkq3w1m",
                "id": 23005,
                "idCardNo": "CARD-8vc92wevyunbpl29c0",
                "lastName": "LN-0j90sa",
                "nationality": "NAT-mv2wzlt",
                "telNo":: "TEL-ntkah0"
            },
            {
                "address": "ADDR-u3gsxpq61e2",
                "email": "[email protected]",
                "firstName": "FN-evno7jy",
                "fullName": "LN-0fuix09 FN-evno7jy",
                "id": 23004,
                "idCardNo": "CARD-jgyf09by0rxboex8ut",
                "lastName": "LN-0fuix09",
                "nationality": "NAT-cw8cctzy",
                "telNo":: "TEL-artsappc2"
            },
            {
                "address": "ADDR-04kfdpp7",
                "email": "[email protected]",
                "firstName": "FN-zz0e74gvh",
                "fullName": "LN-26u851 FN-zz0e74gvh",
                "id": 23003,
                "idCardNo": "CARD-wminx9rykz1sn7xsxz",
                "lastName": "LN-26u851",
                "nationality": "NAT-05uk2c93",
                "telNo":: "TEL-9de2jt4oh",
            },
            {
                "address": "ADDR-i18dy2cew6eizvmvgi0w",
                "email": "[email protected]",
                "firstName": "FN-gt4aice1",
                "fullName": "LN-db6vre9 FN-gt4aice1",
                "id": 23002,
                "idCardNo": "CARD-spwifyvehzkcfj5g7f",
                "lastName": "LN-db6vre9",
                "nationality": "NAT-osiionb",
                "telNo":: "TEL-1vigb907",
            }
      ],
    "page": 1,
    "record": 23013,
    "rows": 15,
    "total": 1535
}

 

 

jqGrid根據jsonReader中的設置，解析json數據。根據jsonReader中的root（我設置的是“gridModel”）， 得到數據記錄數組；根據rows得到每頁顯示的行數；根據page設置當前頁數；根據records（我設置的是“record”）得到所有記錄數量；根 據total得到所有頁數。

由此，jqGrid完成一個request，並將得到的response，解析爲所需的數據，顯示到Grid表格中。

如何操作Grid表格及其數據。

 

jqGrid有很多方法函數，用來操作數據或者操作Grid表格本身。jqGrid的方法有兩種調用方式：

$("#grid_id").jqGridMethod( parameter1,...,parameterN );

或者

$("#grid_id").jqGrid('method', parameter1,...,parameterN );

 

首先介紹一下jqGrid的幾個最常用的方法函數，具體的方法API也可以參考官方文檔（http://www.trirand.com/jqgridwiki/doku.php?id=wiki:methods ）

 

1. getGridParam

 

這個方法用來獲得jqGrid的選項值。它具有一個可選參數name，name即代表着jqGrid的選項名，例如：

var id = $("#gridTable").jqGrid("getGridParam", "selrow");

即可獲得當前選中的行的ID。

 

 

注：selrow是jqGrid選項之一，默認值是null。這是一個只讀選項，代表最後選中行的ID。如果執行翻頁或者排序後，此選項將被設爲null。關於其他選項，後續會有介紹。

 

如果不傳入name參數，則會返回jqGrid整個選項options。

 

 

 

2. getRowData

 

這個方法用來獲得某行的數據。它具有一個rowid參數，jqGrid會根據這個rowid返回對應行的數據，返回的是name:value類型的數組。例如：

 

var getContact = function() {
    var selectedId = $("#gridTable").jqGrid("getGridParam", "selrow");

    var rowData = $("#gridTable").jqGrid("getRowData", selectedId);

    alert("First Name: " + rowData.firstName);
};

 

 

如果rowid未能被找到，則返回一個空數組；如果未設置rowid參數，則以數組的形式返回Grid的所有行數據。

 

 

 

3. addRowData

 

這個方法用於向Grid中插入新的一行。執行成功返回true，否則返回false。它具有4個參數：

• rowid ：新行的id號；
• data ：新行的數據對象，形式爲{name1:value1,name2: value2…}，其中name爲colModel中定義的列名稱name；
• position ：插入的位置（first：表格頂端；last：表格底端；before：srcrowid之前；after：srcrowid之後）；
• srcrowid ：新行將插入到srcrowid指定行的前面或後面。

例如：

 

var addContact = function() {
    var selectedId = $("#gridTable").jqGrid("getGridParam", "selrow");

    var dataRow = {
        id : 99,
        lastName : "Zhang",
        firstName : "San",
        email : "[email protected]",
        telNo : "0086-12345678"
    };

    if (selectedId) {
        $("#gridTable").jqGrid("addRowData", 99, dataRow, "before", selectedId);

    } else {
        $("#gridTable").jqGrid("addRowData", 99, dataRow, "first");

    }
};

 

 

這個方法可以一次性插入多行，data參數必須是[{name1:value1,name2: value2…}, {name1:value1,name2: value2…}]這樣的數組形式，而且rowid參數也應該設爲data參數對象中代表id的field名稱。不過，此時的rowid不用必須是 colModel中的一部分。
例如：

 

var addContact = function() {
    var selectedId = $("#gridTable").jqGrid("getGridParam", "selrow");

    var dataRow = [{
        id : 99,
        lastName : "Zhang",
        firstName : "San",
        email : "[email protected]",
        telNo : "0086-12345678"
    },
    {
        id : 100,
        lastName : "Li",
        firstName : "Si",
        email : "[email protected]",
        telNo : "0086-12345678"
    },
    {
        id : 101,
        lastName : "Wang",
        firstName : "Wu",
        email : "[email protected]",
        telNo : "0086-12345678"
    }];

    if (selectedId) {
        $("#gridTable").jqGrid("addRowData", "id", dataRow, "before", selectedId);

    } else {
        $("#gridTable").jqGrid("addRowData", "id", dataRow, "first");

    }
};

 

 

注：我測試了一下，一次插入多行的情況下，用於設置插入位置的後兩個參數，似乎沒有起作用。插入的幾行數據都被置於Grid的底端。

 

 

 

4. setRowData

這個方法用於爲某行數據設置數據值。執行成功返回true，否則返回false。它具有3個參數：

• rowid ：更新數據的行id；
• data ：更新的數據對象，形式爲{name1:value1,name2: value2…}，其中name爲colModel中定義的列名稱name；這個數據對象，不必設置完全，需要更新哪列，就設置哪列的name:value對；
• cssprop ：如果cssprop爲String類型，則會使用jQuery的addClass爲行增加相應名稱的CSS類；如果爲object類型，則會使用html的css屬性，爲行添加樣式。如果只想增加css樣式而不更新數據，可以將data參數設爲false。

例如：

 

var updateContact = function() {
    var selectedId = $("#gridTable").jqGrid("getGridParam", "selrow");

    var dataRow = {
        lastName : "Li",
        firstName : "Si",
        email : "[email protected]"
    };

    var cssprop = {
        color : "#FF0000"
    };

    $("#gridTable").jqGrid('setRowData', selectedId, dataRow, cssprop);
};

 

 

 

 

5. delRowData

 

這個方法用於刪除某行數據。執行成功返回true，否則返回false。具有一個參數rowid，代表要刪除的行id。例如：

 

var deleteContact = function() {
    var selectedId = $("#gridTable").jqGrid("getGridParam", "selrow");

    $("#gridTable").jqGrid('delRowData', selectedId);
};

 

 

 

 

 

6. setGridParam

 

這個方法與getGridParam對應，用於設置jqGrid的options選項。返回jqGrid對象。參數爲 {name1:value1,name2: value2…}形式的對象（name來自jqGrid的options選項名）。某些選項在設置之後需要trigger("reloadGrid")， 才能顯示出效果。

例如：

 

var changeGridOptions = function() {
    $("#gridTable").jqGrid("setGridParam", {
        rowNum: 50,
        page: 16
    }).trigger('reloadGrid');
};

 

 

注：我測試了一下，這個方法對於設置jqGrid的caption選項似乎無效。大概因此有了setCaption方法。

 

 

 

 

7. setGridWidth

 

爲Grid動態地設定一個新的寬度。兩個參數：

• new_width ：以px爲單位的新寬度值；
• shrink ：作用與jqGrid的shrinkToFit選項相同；如果此參數未設置，則沿用jqGrid的shrinkToFit選項的值。

 

 

 

8. trigger("reloadGrid")

 

根據當前設置，重新載入Grid表格，即意味着向Server發送一個新的請求。此方法只能用於已經構建好的Grid。此外，此方法不會使對colModel所做出的改變生效。應該使用gridUnload來重新載入對colModel的新設置。

 

 

 

9. 其他方法

 

除了以上介紹的的方法外，jqGrid還有其他有用的方法，例如：
addJSONData、clearGridData、hideCol、resetSelection、setCaption、setGridHeight、setLabel、showCol等
以及增強模塊提供的方法，例如：
filterGrid、GridDestroy、GridUnload、setColProp等。

這些方法的具體用法，或淺顯易懂，或不是非常常用。都可以參考官方文檔（http://www.trirand.com/jqgridwiki/doku.php?id=wiki:methods ），得到具體指示。

 

 

 

10. 額外的考慮

 

在上面介紹的增刪改數據行的操作中，jqGrid實際上完成的只是客戶端的操作，主要是DOM的更改工作。但是如果傳到Server的請求失敗了，或者沒有得到想要的返回結果，那jqGrid的處理還繼續嗎？會不會和Server端的數據不同步了呢？
這個問題在下一篇中再討論吧。

 

 

 

 

 

注： 本篇中介紹的方法在jqGrid的Demo中也有介紹，但是我覺得還是自己的實例看起來更直觀，更適合自己理解。

附上代碼：

 

javascript部分：

 

$(function(){
    // 配置jqGrid組件
    $("#gridTable").jqGrid({
        url: "jqGrid01.action",
        datatype: "json",
        mtype: "GET",
        height: 350,
        width: 600,
        colModel: [
              {name:"id",index:"id",label:"編碼",width:40},
              {name:"lastName",index:"lastName",label:"姓",width:80,sortable:false},
              {name:"firstName",index:"firstName",label:"名",width:80,sortable:false},
              {name:"email",index:"email",label:"電子郵箱",width:160,sortable:false},
              {name:"telNo",index:"telNo",label:"電話",width:120,sortable:false}
        ],
        viewrecords: true,
        rowNum: 15,
        rowList: [15,50,100],
        prmNames: {search: "search"},
        jsonReader: {
            root:"gridModel",
            records: "record",
            repeatitems : false
        },
        pager: "#gridPager",
        caption: "聯繫人列表",
        hidegrid: false,
        shrikToFit: true
    });
});
var echoSelRow = function() {
    var id = $("#gridTable").jqGrid("getGridParam", "selrow");

    alert("當前選中行ID：" + id);
};
var getContact = function() {
    var selectedId = $("#gridTable").jqGrid("getGridParam", "selrow");

    var rowData = $("#gridTable").jqGrid("getRowData", selectedId);

    alert("First Name: " + rowData.firstName);
};
var addContact = function() {
    var selectedId = $("#gridTable").jqGrid("getGridParam", "selrow");

    var dataRow = {
        id : 99,
        lastName : "Zhang",
        firstName : "San",
        email : "[email protected]",
        telNo : "0086-12345678"
    };

    if (selectedId) {
        $("#gridTable").jqGrid("addRowData", 99, dataRow, "before", selectedId);

    } else {
        $("#gridTable").jqGrid("addRowData", 99, dataRow, "first");

    }
};
var updateContact = function() {
    var selectedId = $("#gridTable").jqGrid("getGridParam", "selrow");

    var dataRow = {
        lastName : "Li",
        firstName : "Si",
        email : "[email protected]"
    };

    var cssprop = {
        color : "#FF0000"
    };

    $("#gridTable").jqGrid('setRowData', selectedId, dataRow, cssprop);
};
var deleteContact = function() {
    var selectedId = $("#gridTable").jqGrid("getGridParam", "selrow");

    $("#gridTable").jqGrid('delRowData', selectedId);
};
var changeGridOptions = function() {
    $("#gridTable").jqGrid("setGridParam", {
        rowNum: 50,
        page: 16
    }).trigger('reloadGrid');

    $("#gridTable").jqGrid("setCaption", "Contact List").trigger('reloadGrid');

    alert($("#gridTable").jqGrid("getGridParam", "caption"));
    alert($("#gridTable").jqGrid("getGridParam", "rowNum"));
};
var resetWidth = function() {
    $("#gridTable").jqGrid("setGridWidth", 300, false);
};

 

 

 

html部分：

 

view plain

<!DOCTYPE html
PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="zh-CN" lang="zh-CN">
    <head>
        <title>jqGrid02</title>
        <link rel="stylesheet" type="text/css" media="screen" href="../css/themes/aero/jquery-ui-1.8.1.custom.css" mce_href="css/themes/aero/jquery-ui-1.8.1.custom.css" />
        <link rel="stylesheet" type="text/css" media="screen" href="../css/themes/aero/ui.jqgrid.custom.css" mce_href="css/themes/aero/ui.jqgrid.custom.css" />

        <mce:script type="text/javascript" src="../js/jquery-1.4.2.min.js" mce_src="js/jquery-1.4.2.min.js"></mce:script>
        <mce:script src="../js/jquery-ui-1.8.1.custom.min.js" mce_src="js/jquery-ui-1.8.1.custom.min.js" type="text/javascript"></mce:script>
        <mce:script src="../js/i18n/grid.locale-zh-CN.js" mce_src="js/i18n/grid.locale-zh-CN.js" type="text/javascript"></mce:script>
        <mce:script src="../js/jquery.jqGrid.min.js" mce_src="js/jquery.jqGrid.min.js" type="text/javascript"></mce:script>

        <mce:script src="js/jqGrid02.js" mce_src="js/jqGrid02.js" type="text/javascript"></mce:script>
    </head>
    <body>
        <h3>
            jqGrid測試 02
        </h3>
        <div>
            <table id="gridTable"></table>
            <div id="gridPager"></div>
        </div>

        <br />

        <div>
            <button onclick="echoSelRow()">當前行ID</button>
            <button onclick="getContact()">當前聯繫人</button>
            <button onclick="addContact()">添加行</button>
            <button onclick="updateContact()">修改行</button>
            <button onclick="deleteContact()">刪除行</button>
            <button onclick="changeGridOptions()">改變Grid選項</button>
            <button onclick="resetWidth()">改變Grid寬度</button>
        </div>
    </body>
</html>