jqGrid学习

jqGrid学习

jqGrid学习之 ------------- 安装

jqGrid安装很简单，只需把相应的css、js文件加入到页面中即可。

按照官网文档：

*

/myproject/css/

o

ui.jqgrid.css

o

/ui-lightness/

+

/images/

+

jquery-ui-1.7.2.custom.css

*

/myproject/js/

o

/i18n/

+

grid.locale-bg.js

+

list of all language files

+

….

o

Changes.txt

o

jquery-1.3.2.min.js

o

jquery.jqGrid.min.js

目录结构如上。

在页面中写法：

...

jqGrid学习之 --------- 皮肤

jqGrid皮肤

从3.5版本开始，jqGrid完全支持jquery UI的theme。我们可以从

https://www.360docs.net/doc/a019050416.html,/themeroller/下载我们所需要的theme。当然，你也可以编辑自己的theme。jqGrid

也并不需要把所有的css文件都引入进来，只需导入核心css文件

“ui.theme.css ” 以及“ui.core.css”即可，文件位于目录

development-bundle/themes下。

jqGrid学习 ----------------- 第一个实例 | jqGrid学习之 --------- 皮肤2009-12-03

jqGrid学习 ----------- 原理

jqGrid是典型的B/S架构，服务器端只是提供数据管理，客户端只提供数据显示。换句话说，jqGrid可以以一种更加简单的方式来展现你数据库的信息，而且也可以把客户端数据传回给服务器端。

对于jqGrid我们所关心的就是：必须有一段代码把一些页面信息保存到数据库中，而且也能够把响应信息返回给客户端。jqGrid是用ajax来实现对请求与响应的处理。

jqGrid学习 ----------------- 第一个实例

1、html文件

jqGrid需要我们事先指定一个table对象，且有一个唯一的id属性。其他表格属性比如Cellspacing、cellpadding跟border 不要自己设置，jqGrid会设置。因为我们要分页，所以要定义一个分页的div对象，同样必须有id属性。

jqGrid的用法：

Java代码

jQuery('#grid_selector').jqGrid( options )

grid_selector就是table的id值，

optoins是一个json对象：

Java代码

{

url:WEB_PATH+'/example/JqGridExample.action',

//url:WEB_PATH+'/excludes/post.jsp',

datatype: 'json',

colNames:['编号','姓名','密码','年龄','地址','出生日期'], colModel:[

{name:'id',index:'id', width:90,sorttype:"int"},

{name:'username',index:'name',

width:110,sorttype:"int"},

{name:'password',index:'password', width:80},

{name:'age',index:'age', width:80},

{name:'address',index:'address', width:80},

{name:'time',index:'time', width:80,sorttype:"date"} ],

imgpath:

WEB_PATH+'/resources/javascript/plugins/jqgrid/css/smoothness/i mages',

rowNum:10,

rowList:[10,20,30],

pager: "pjmap",

multiselect: false,

sortname: 'id',

viewrecords: true,

sortorder: "desc",

jsonReader: {

root: "dataRows",

repeatitems : false

},

caption: "jqGrid test",

height: 220

}

4、服务端文件

Java代码

package com.test.json.action;

import java.util.ArrayList;

import java.util.HashMap;

import java.util.List;

import java.util.Map;

import org.apache.struts2.json.annotations.JSON;

import net.sf.json.JSONArray;

import net.sf.json.JSONObject;

import com.web.action.BaseAction;

public class JqGridAction extends BaseAction {

/**

*

*/

private static final long serialVersionUID = 1L; private int page = 1;

private int total = 3;

private int rows = 0;

private List dataRows = new ArrayList();

public String execute()

{

JSONArray t_list = new JSONArray();

for(int i=0;i<3;i++){

JSONObject student = new JSONObject(); //Map student = new HashMap();

student.put("username","王三");

student.put("password","123");

student.put("age",20+i);

student.put("address","USA");

student.put("id",i);

dataRows.add(i,student);

}

//JSONArray ay =JSONArray.fromObject(rows);

System.out.println("tttttttttttt======"+t_list.toString());

//this.outJsonString(t_list.toString() );

return SUCCESS;

}

//@JSON(serialize=false)

public int getPage()

{

return page;

}

public void setPage(int page)

{

this.page = page;

}

//@JSON(serialize=false)

public int getTotal()

{

return total;

}

public void setTotal(int total) {

this.total = total;

}

//@JSON(serialize=false)

public int getRows()

{

return rows;

}

public void setRows(int rows) {

this.rows = rows;

}

public List getDataRows()

return dataRows;

}

public void setDataRows(List dataRows)

{

this.dataRows = dataRows;

}

}返回的json数据格式：

Java代码

{"dataRows":[{"password":"123","age":20,"address":"USA","userna me":"王三

","id":0},{"password":"123","age":21,"address":"USA","username"

:"王三

","id":1},{"password":"123","age":22,"address":"USA","username"

:"王三","id":2}],"page":1,"rows":10,"total":3}

jqGrid学习 ------------------ jqGrid参数

url 获取数据的地址

datatype 从服务器端返回的数据类型，默认xml。可选类型：xml，local，json，jsonnp，script，xmlstring，jsonstring，clientside

mtype ajax提交方式。POST或者GET，默认GET colNames 列显示名称，是一个数组对象。

colModel 对显示列属性的设置，是一个数组对象。常用到的属性：name列显示的名称；index传到服务器端用来排序用的列名称；width列宽度；align对齐方式；sortable是否可以排序

pager 定义翻页用的导航栏，必须是有效的html元素。翻页工具栏可以放置在html页面任意位置

rowNum 在grid上显示记录条数，这个参数是要被传递到后台

rowList 一个下拉选择框，用来改变显示记录数，当选择时会覆盖rowNum 参数传递到后台

sortname 默认的排序列。可以是列名称或者是一个数字，这个参数会被提交到后台

viewrecords 定义是否要显示总记录数caption 表格名称

jqGrid学习 ----------- 参数（2）

参数名称参数

类型

描述默认值

是

否

可

以

被

修

改

ajaxGrid Options obje

ct

对ajax参数进行全局设置，可以覆盖ajax事件：

error，complete 和 beforeSend

空值是

ajaxGrid Options obje

ct

对ajax参数进行全局设置空值是

ajaxSele ctOption s obje

ct

对ajax的select参数进行全局设置，设置

editoptions跟searchoptions 参数的select

属性值

空值是

altclass Stri

ng

用来指定行显示的css，可以编辑自己的css文

件，只有当altRows设为 ture时起作用

ui-priorit

y-secondar

y

是

，

但

需

要

重

新

加

载

altRows bool

ean

设置表格 zebra-striped 值false

是

，

需

重

新

加

载

autoenco de bool

ean

当为 ture 时对url进行编码false 是

autowidt h bool

ean

如果为ture时，则当表格在首次被创建时会根

据父元素比例重新调整表格宽度。如果父元素宽

度改变，为了使表格宽度能够自动调整则需要实

现函数：setGridWidth

false 否

caption Stri

ng

定义表格名称空值

否

，

但

是

可

以

用

ap

i

修

改

cellLayo ut inte

ger

定义了单元格padding + border 宽度。通常不

必修改此值。初始值为5，

paddingLef?2+paddingRight?2+borderLeft?

1=5

5 否

cellEdit bool

ean

启用或者禁用单元格编辑功能false 是

cellsubm it Stri

ng

定义了单元格内容保存位置：“remote”，

“clientArray”

‘remote’是

cellurl Stri

ng

单元格提交的url 空值是

colModel arra

y

描述列信息的数组空值否

colNames arra

y[]

放置列名称的数组，必须与colModel大小相同空数组否

datastr Stri

ng

xmlstring或者jsonstring 空值是

datatype stri

ng

表格可以被接受的数据类型：xml，xmlstring，

json，local，function

xml 是

deselect AfterSor t bool

ean

只有当datatype为local时起作用。当排序时

不选择当前行

true 是

directio n stri

ng

表格中文字的显示方向，从左向右（ltr）或者

从右向左（rtr）。

ltr 否

editurl stri

ng

定义对form编辑时的url 空值是

emptyrec ords stri

ng

当返回的数据行数为0时显示的信息。只有当属

性 viewrecords 设置为ture时起作用

在语言包中是

ExpandCo lClick bool

ean

当为true时，点击展开行的文本时，treeGrid

就能展开或者收缩，不仅仅是点击图片

true 否

ExpandCo lumn stri

ng

指定那列来展开tree grid，默认为第一列，只

有在treeGrid为true时起作用

空值否

footerro w bool

ean

当为true时，会在翻页栏之上增加一行false 否

forceFit bool

ean

当为ture时，调整列宽度不会改变表格的宽度。

当shrinkToFit 为false时，此属性会被忽略

false 否

gridstat e stri

ng

定义当前表格的状态：'visible' or 'hidden' visible 否

gridview bool

ean

构造一行数据后添加到grid中，如果设为true

则是将整个表格的数据都构造完成后再添加到

grid中，但treeGrid, subGrid, or

afterInsertRow 不能用

false 是

height mixe

d

表格高度，可以是数字，像素值或者百分比150 否

hiddengr id bool

ean

当为ture时，表格不会被显示，只显示表格的

标题。只有当点击显示表格的那个按钮时才会去

初始化表格数据。只有当caption 属性不为空而

且hidegrid为ture时才起作用

false 否

hidegrid bool

ean

启用或者禁用控制表格显示、隐藏的按钮，只有

当caption 属性不为空时起效

true 否

hoverrow s bool

ean

当为false时mouse hovering会被禁用false 是

jsonRead er arra

y

描述json 数据格式的数组，否

lastpage inte

ger

只读属性，定义了总页数0 否

lastsort inte

ger

只读属性，定义了最后排序列的索引，从0开始0 否

loadonce bool

ean

如果为ture则数据只从服务器端抓取一次，之

后所有操作都是在客户端执行，翻页功能会被禁

用

false 否

loadtext stri

ng

当请求或者排序时所显示的文字内容

Loading...

.

否

loadui stri

ng

当执行ajax请求时要干什么。disable禁用ajax

执行提示；enable默认，当执行ajax请求时的

提示；block启用Loading提示，但是阻止其他

操作

enable 是

mtype stri

ng

请求的类型：(“POST” or “GET”)GET 是

multikey stri

ng

只有在multiselect设置为ture时起作用，定

义使用那个key来做多选。shiftKey，altKey，

ctrlKey

空值是

multibox only bool

ean

只有当multiselect = true.起作用，当

multiboxonly 为ture时只有选择checkbox才

会起作用，

false 是

multisel ect bool

ean

定义是否可以多选false 否

multisel ectWidth inte

ger

当multiselect为true时设置multiselect列

宽度

20 否

page inte

ger

设置初始的页码 1 是

pager mixe

d

指定分页栏对象，必须为一个有效的html元素。

可以是'pager', '#pager', jQuery('#pager').

推荐用'#pager'

空值否

pagerpos stri

ng

指定分页栏的位置center 否

pgbutton s bool

ean

是否显示翻页按钮true 否

pginput bool

ean

是否显示跳转页面的输入框true 否

pgtext stri

ng

当前页信息

语言包中设

置

是

prmNames arra

y

Default valuesprmNames:

{page:“page”,rows:“rows”, sort:

“sidx”,order: “sord”,

search:“_search”, nd:“nd”, npage:null}

当参数为null时不会被发到服务器端

none 是

postData arra

y

此数组内容直接赋值到url上，参数类型：

{name1:value1…}

空array 是

reccount inte

ger

只读属性，定义了grid中确切的行数。通常情

况下与records属性相同，但有一种情况例外，

假如rowNum=15，但是从服务器端返回的记录数

是20，那么records值是20，但reccount值仍

然为15，而且表格中也只显示15条记录。

0 否

recordpo s stri

ng

定义了记录信息的位置： left, center, right right 否

records inte

ger

只读属性，定义了返回的记录数none 否

recordte xt stri

ng

显示记录数信息。{0} 为记录数开始，{1}为记

录数结束。 viewrecords为ture时才能起效，

语言包是

且总记录数大于0时才会显示此信息

resizecl ass stri

ng

定义一个class到一个列上用来显示列宽度调整

时的效果

空值否

rowList arra

y[]

一个数组用来调整表格显示的记录数，此参数值

会替代rowNum参数值传给服务器端。如果为空

则不显示，设置格式：[10,20,30]。

[] 否

rownumbe rs bool

ean

如果为ture则会在表格左边新增一列，显示行

顺序号，从1开始递增。此列名为'rn'.

false 否

rowNum inte

ger

设置表格中显示的记录数，参数会被自动传到后

台。如果此参数设为10，但是从服务器端返回

15条记录，那么在表格中只会显示10条记录。

如果设为-1则禁用此检查

20 是

rownumWi dth inte

ger

如果rownumbers为true，则可以设置column的

宽度

25 否

savedRow arra

y

只读属性，只用在编辑模式下保存数据空值否

scroll bool

ean

or

inte

ger

创建一个动态滚动的表格，当为true时，翻页

栏被禁用，使用垂直滚动条加载数据，且在首次

访问服务器端时将加载所有数据到客户端。当此

参数为数字时，表格只控制可见的几行，所有数

据都在这几行中加载

false 否

scrollOf fset inte

ger

设置垂直滚动条宽度18 否

scrollro ws bool

ean

当为true时让所选择的行可见false 是

selarrro w arra

y-[]

只读属性，用来存放当前选择的行

empty array

[]

否

selrow stri

ng

只读属性，最后选择行的id null 否

shrinkTo Fit bool

ean

此属性用来说明当初始化列宽度时候的计算类

型，如果为ture，则按比例初始化列宽度。如果

为false，则列宽度使用colModel指定的宽度

true 否

sortable bool

ean

是否可排序false 否

sortname stri

ng

排序列的名称，此参数会被传到后台空字符串是

sortorde r stri

ng

排序顺序，升序或者降序（asc or desc）asc 是

subGrid bool

ean

是否使用suggrid false 否

subGridM arra subgrid模型empty array 否

odel y-[]

subGridT ype mixe

d

如果为空则使用表格的dataType null 是

subGridU rl stri

ng

加载subgrid数据的url，jqGrid会把每行的id

值加到url中

空值是

subGridW idth inte

ger

subgrid列的宽度20 否

toolbar arra

y

表格的工具栏。数组中有两个值，第一个为是否

启用，第二个指定工具栏位置（相对于body

layer），如：[true,”both”] 。工具栏位置

可选值：“top”,”bottom”, “both”. 如果

工具栏在上面，则工具栏id为“t_”+表格id；

如果在下面则为“tb_”+表格id；如果只有一

个工具栏则为“t_”+表格id

[false,''] 否

totaltim e inte

ger

只读属性，计算加载数据的时间。目前支持xml

跟json数据

0 否

treedata type mixe

d

数据类型，通常情况下与datatype相同，不会

变

null 否

treeGrid bool

ean

启用或者禁用treegrid模式false 否

treeGrid Model stri

ng

treeGrid所使用的方法nested 否

treeIcon s arra

y

树的图标，默认值：

{plus:'ui-icon-triangle-1-e',minus:'ui-ic

on-triangle-1-s',leaf:'ui-icon-radio-off'

}

否

treeRead er arra

y

扩展表格的colModel且加在colModel定义的后

面

否

tree_roo t_level nume

ric

root元素的级别，0 否

url stri

ng

url null 是

userData arra

y

从request中取得的一些用户信息empty array 否

userData OnFooter bool

ean

当为true时把userData放到底部，用法：如果

userData的值与colModel的值相同，那么此列

就显示正确的值，如果不等那么此列就为空

false 是

viewreco rds bool

ean

是否要显示总记录数false 否

viewsort cols arra

y

定义排序列的外观跟行为。数据格式：

[false,'vertical',true].第一个参数是说，是

否

否都要显示排序列的图标，false就是只显示当前排序列的图标；第二个参数是指图标如何显示，vertical：排序图标垂直放置，horizontal：排序图标水平放置；第三个参数指单击功能，true：单击列可排序，false：单击图标排序。说明：如果第三个参数为false则第一个参数必须为ture否则不能排序

width numb

er

如果设置则按此设置为主，如果没有设置则按

colModel中定义的宽度计算

none 否

xmlReade r arra

y

对xml数据结构的描述否

jqGrid学习 -------------- ColModel API

ColModel 是jqGrid里最重要的一个属性，设置表格列的属性。

用法：

Java代码

1.jQuery("#gridid").jqGrid({

2....

3. colModel: [ {name:'name1', index:'index1'...}, {...}, ... ],

4....

5.});

属性数据类型备注默认值

align string 定义单元格对齐方式；可选值：left,

center, right.

left

classes string 设置列的css。多个class之间用空格分隔，

如：'class1 class2' 。表格默认的css属

性是ui-ellipsis

empty

string

datefmt string 对日期列进行格式化。”/”, ”-”,

and ”.”都是有效的日期分隔符。y,Y,yyyy

年YY, yy 月m,mm for monthsd,dd 日.

ISO Date

(Y-m-d)

defval string 查询字段的默认值空editable boolean 单元格是否可编辑false

editoptions array 对列进行编辑时设置的一些属性empty array

editrules array 对于可编辑单元格的一些额外属性设置empty array

edittype string 可以编辑的类型。可选值：text, textarea, select, checkbox, password, button,

text

image and file.

fixed boolean 列宽度是否要固定不可变false formoptions array 对于form进行编辑时的属性设置empty formatoptions array 对某些列进行格式化的设置none formatter mixed 对列进行格式化时设置的函数名或者类型none hidedlg boolean 是否显示或者隐藏此列false hidden boolean 在初始化表格时是否要隐藏此列false

index string 当排序时定义排序字段名称的索引，参数名

为sidx

empty

string

jsonmap string 定义了返回的json数据映射none

key boolean 当从服务器端返回的数据中没有id时，将

此作为唯一rowid使用，默认只能有一个id

属性

false

label string 如果colNames为空则用此值来作为列的显

示名称，如果都没有设置则使用name 值

none

name string 必输项，表格列的名称，所有关键字，保留

字都不能作为名称使用包括subgrid, cb

and rn.

Required

resizable boolean 是否可以被resizable true

search boolean 在搜索模式下，定义此列是否可以作为搜索

列

true

searchoptions array 设置搜索参数empty sortable boolean 是否可排序true

sorttype string 用在当datatype为local时，定义搜索列

的类型，可选值：int/integer - 对integer

排序float/number/currency - 排序数字

date - 排序日期text - 排序文本

text

stype string 定义搜索元素的类型text

surl string 搜索数据时的url empty string

width number 默认列的宽度，只能是象素值，不能是百分

比

150

xmlmap string 定义当前列跟返回的xml数据之间的映射关

系

none

unformat function ‘unformat’单元格值null

有一些参数当表格初始化完成后是不能被修改的： *

name

*

width

*

resizable

*

label (method avail.)

jqGrid学习 ----------- 数据

jqGrid可支持的数据类型：xml、json、jsonp、local or clientSide、xmlstring、jsonstring

、script、function (…)。

Json数据

需要定义jsonReader来跟服务器端返回的数据做对应，其默认值：

Java代码

1.jQuery("#gridid").jqGrid({

2....

3. jsonReader : {

4. root: "rows",

5. page: "page",

6. total: "total",

7. records: "records",

8. repeatitems: true,

9. cell: "cell",

10. id: "id",

11. userdata: "userdata",

12. subgrid: {root:"rows",

13. repeatitems: true,

14. cell:"cell"

15. }

16. },

17....

18.});

这样服务器端返回的数据格式：

Java代码

1.{

2. total: "xxx",

3. page: "yyy",

4. records: "zzz",

5. rows : [

6. {id:"1", cell:["cell11", "cell12", "cell13"]},

7. {id:"2", cell:["cell21", "cell22", "cell23"]},

8. ...

9. ]

10.}

jsonReader的属性

total 总页数

page 当前页

records 查询出的记录数

rows 包含实际数据的数组

id 行id

cell 当前行的所有单元格

* root

这个元素指明表格所需要的数据从哪里开始。

Java代码

1.jQuery("#gridid").jqGrid({

2....

3. jsonReader : {root:"invdata"},

4....

5.});

从服务器端返回数据格式为：

Java代码

1.{

2. total: "xxx",

3. page: "yyy",

4. records: "zzz",

5. invdata : [

6. {id:"1", cell:["cell11", "cell12", "cell13"]},

7. {id:"2", cell:["cell21", "cell22", "cell23"]},