JqGrid3.6 Cn

Jqgrid 中文文档---整理:沧浪雾月客

Jqgrid 中文文档

jqGrid学习 ----------- 原理....................................................................................2

jqGrid学习之 --------- 皮肤...................................................................................2

jqGrid学习.........................................................................................................2

jQuery学习之：jqGrid表格插件——参数配置........................................................4

jqGrid学习 --------------自定义搜索......................................................................14

jqGrid学习 -------------- 搜索工具栏.....................................................................16

jqGrid学习 -------------- 搜索...............................................................................17

jqGrid学习 -------------- 自定义格式化类型............................................................19

jqGrid学习 -------------- 格式化............................................................................21

jqGrid学习 -------------- 自定义按钮.....................................................................26

jqGrid学习 -------------- 翻页（2）.......................................................................28

jqGrid学习 -------------- 翻页...............................................................................33

jqGrid学习 -------------- 配置 json........................................................................35

jqGrid学习 -------------- 方法...............................................................................37

jqGrid学习 ----------- 事件..................................................................................45

jqGrid学习 ----------- 数据..................................................................................48

jqGrid学习 -------------- ColModel API.................................................................55

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

jqGrid学习 ------------------ jqGrid参数................................................................63

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

使用 jqGrid修改数据并检查................................................................................69

1


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

jqGrid 是典型的 B/S 架构，服务器端只是提供数据管理，客户端只提供数据显

示。换句话说，jqGrid 可以以一种更加简单的方式来展现你数据库的信息，而

且也可以把客户端数据传回给服务器端。

对于 jqGrid 我们所关心的就是：必须有一段代码把一些页面信息保存到数据库

中，而且也能够把响应信息返回给客户端。jqGrid 是用 ajax 来实现对请求与响

应的处理。

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

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

http://jqueryui.com/themeroller/下载我们所需要的 theme。当然，

你也可以编辑自己的 theme。jqGrid

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

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

development-bundle/themes 下。 jqGrid 学习 jqGrid 学习之

------------- 安装

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

按照官网文档：

* /myproject/css/ o ui.jqgrid.css o /ui-lightness/

2

http://a3mao.javaeye.com/blog/539749




+ /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

目录结构如上。

在页面中写法： Java 代码 <!

DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">

1. <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">

2. <head> 3. <meta http-equiv="Content-Type" content="text/html; charse

t=utf-8" /> 4. <title>My First Grid</title> 5. 6. <link rel="stylesheet" type="text/css" media="screen" href="

css/ui-lightness/jquery-ui-1.7.1.custom.css" /> 7. <link rel="stylesheet" type="text/css" media="screen" href="

js/src/css/ui.jqgrid.css" /> 8. <link rel="stylesheet" type="text/css" media="screen" href="

js/src/css/jquery.searchFilter.css" /> 9. 10. <style> 11. html, body { 12. margin: 0;

3

http://a3mao.javaeye.com/?page=2&show_full=true


13. padding: 0; 14. font-size: 75%; 15. } 16. </style> 17. 18. <script src="js/jquery-1.3.2.min.js" type="text/

javascript"></script> 19. <script src="js/src/grid.loader.js" type="text/javascript"></

script> 20. 21. </head> 22. <body> 23. ... 24. </body> 25. </html>

需要说明的是，jquery-ui 的字体大小与 jqgrid 字体大小不一致，故需要在页

面上在加上一段

style 来指定页面上文字大小。

jQuery 学习之： jqGrid 表格插件——参数配置

由于 jqGrid 功能强大，配置比较复杂，在第一个例子中，对于 jqGrid 的配置

参数没有进行什么解释。从现在开始，会陆续介绍 jqGrid 的参数。这些参数的

详细介绍请查看官方文档。由于本人英语水平有限，翻译不好，请多原谅。（为

了保证连贯性，翻译时引用了 http://a3mao.javaeye.com，在此感谢。但在

他的基础上增加了一些内容。）

上有很多 jqGrid 的 API，大家可以查看。

4

http://polaris1119.javaeye.com/blog/559634


在$("#tableId").jqGrid(optional);中，optional 对象包含如下的属性：（属

性按字母顺序排列）

参数名称参数

类型描述默认值

是

否

可

以

被

修

改

ajaxGridOptions

object

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

件：error，complete 和 beforeSend 空值是

ajaxGridOptions

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

ajaxSelectOptions

object

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

editoptions 跟 searchoptions 参数的 select

属性值

空值是

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

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

ui-priority-secondary 是

，

但

需

要

重

5


新

加

载

altRowsboolean 设置表格 zebra-striped 值 false

是

，

需

重

新

加

载

autoencode

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

autowidth

boolean

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

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

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

现函数：setGridWidth

false 否

caption String 定义表格名称空值否

，

但

是

可

以

6


用

api

修

改

cellLayout

integer

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

必修改此值。初始值为

5，paddingLef⇒2+paddingRight⇒2+bord

erLeft⇒1=5

5 否

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

cellsubmit

String

定义了单元格内容保存位置：

“remote”，“clientArray”‘remote’ 是

cellurlString 单元格提交的 url 空值是

colModelarray 描述列信息的数组空值否

colNames

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

datastrString xmlstring或者 jsonstring 空值是

datatype

string

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

xml，xmlstring，json，local，function xml 是

deselectAfterSort

boolean

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

不选择当前行true 是

directionstring

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

右向左（rtr）。ltr 否

7


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

emptyrecords

string

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

性 viewrecords 设置为 ture 时起作用在语言包中是

ExpandColClick

boolean

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

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

ExpandColumn

string

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

有在 treeGrid 为 true 时起作用空值否

footerrow

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

forceFitboolean

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

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

gridstate

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

gridviewboolean

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

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

grid 中，但 treeGrid, subGrid, or

afterInsertRow 不能用

false 是

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

hiddengrid

boolean

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

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

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

且 hidegrid 为 ture 时才起作用

false 否

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

true否

8


当 caption 属性不为空时起效

hoverrows

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

jsonReader

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

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

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

loadonce

boolean

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

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

用

false 否

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

loaduistring

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

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

求时的提示； block 启用 Loading 提示，但是

阻止其他操作

enable 是

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

multikeystring

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

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

，altKey ，ctrlKey

空值是

multiboxonly

boolean

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

multiboxonly 为 ture 时只有选择 checkbox

才会起作用，

false 是

multiselect

boolean 定义是否可以多选 false 否

9


multiselectWidth

integer

当 multiselect 为 true 时设置 multiselect 列

宽度20 否

pageinteger 设置初始的页码 1 是

pagermixed

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

素。可以是'pager', '#pager',

jQuery('#pager').推荐用'#pager'

空值否

pagerpos

string 指定分页栏的位置 center 否

pgbuttons

boolean 是否显示翻页按钮 true 否

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

pgtextstring 当前页信息

语言包中设

置是

prmNames

array

Default valuesprmNames: {page:“page”,rows:“rows”, sort: “sidx”,order: “sord”, search:“_search”,

nd:“nd”, npage:null} 当参数为 null 时不会被

发到服务器端

none 是

postData

array

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

{name1:value1…}空 array 是

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

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

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

录数是 20，那么 records 值是 20，但

reccount 值仍然为 15，而且表格中也只显示

0否

10


15条记录。

recordpos

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

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

recordtext

string

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

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

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

语言包是

resizeclass

string

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

时的效果空值否

rowListarray[]

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

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

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

[] 否

rownumbers

boolean

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

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

rowNuminteger

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

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

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

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

20 是

rownumWidth

integer

如果 rownumbers 为 true，则可以设置

column 的宽度25 否

savedRow

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

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

false否

11


or integer

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

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

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

据都在这几行中加载

scrollOffset

integer 设置垂直滚动条宽度 18 否

scrollrows

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

selarrrow

array-[] 只读属性，用来存放当前选择的行

empty array [] 否

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

shrinkToFit

boolean

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

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

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

true 否

sortableboolean 是否可排序 false 否

sortname

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

sortorder

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

subGridboolean 是否使用 suggrid false 否

subGridModel

array-[] subgrid模型

empty array 否

subGridType

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

subGridUrl

string

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

值加到 url 中空值是

subGridWidth

integer subgrid 列的宽度 20 否

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

[false,''] 否

12


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

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

值：“top”,”bottom”, “both”. 如果工具栏在

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

面则为 “tb_”+表格 id；如果只有一个工具栏

则为 “t_”+表格 id

totaltime

integer

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

跟 json 数据0 否

treedatatype

mixed

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

变null 否

treeGridboolean 启用或者禁用 treegrid模式 false 否

treeGridModel

string treeGrid 所使用的方法 nested 否

treeIcons

array

树的图标，默认值：{plus:'ui-icon-triangle-

1-e',minus:'ui-icon-triangle-1-s',leaf:'ui-icon-radio-off'}

否

treeReader

array

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

后面否

tree_root_level

numeric

root元素的级别， 0 否

urlstring

url null 是

userData

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

empty array 否

userDataOnFooter

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

false是

13


果 userData 的值与 colModel 的值相同，那么

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

viewrecords

boolean 是否要显示总记录数 false 否

viewsortcols

array

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

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

都要显示排序列的图标，false 就是只显示当前

排序列的图标；第二个参数是指图标如何显

示，vertical：排序图标垂直放

置，horizontal：排序图标水平放置；第三个参

数指单击功能，true：单击列可排序，false：

单击图标排序。说明：如果第三个参数为 false

则第一个参数必须为 ture 否则不能排序

否

widthnumber

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

colModel 中定义的宽度计算none 否

xmlReader

array 对 xml 数据结构的描述否

另外 http://a3mao.javaeye.com 还列出了常用的参数。如下：

url 获取数据的地址

datatype从服务器端返回的数据类型，默认 xml。可选类型：

14

http://a3mao.javaeye.com/


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 表格名称

另外，“是否可以被修改”的意思是：在表格创建后，参数是否能够或不能够

被修改。换言之，在表格中的初始默认值能否被修改。

设置全局参数：

15


有时，我们想改变参数的默认值，且希望这种改变能够同时运用于多个表格。此

时，我们可以使用 jQuery 的 extend 函数实现。

这里给一个例子：假设你想有一个行交替变色的表格，且希望所有的表格都是

如此，并且，你不想每次（每构建一个表格）都配置相同的参数。这时你可以使

用这种方式，只需配置一次即可。

Html 代码

1. <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">


3. <head> 4. <meta http-equiv="Content-Type" content="text/html; chars

et=utf-8" /> 5. <title>My First Grid</title> 6. 7. <link rel="stylesheet" type="text/css" media="screen" hre

f="css/ui-lightness/jquery-ui-1.7.1.custom.css" /> 8. <link rel="stylesheet" type="text/css" media="screen" hre

f="css/ui.jqgrid.css" /> 9. 10. <style> 11. html, body { 12. margin: 0; 13. padding: 0; 14. font-size: 75%; 15. } 16. </style> 17. 18. <script src="js/jquery-1.3.2.min.js" type="text/

javascript"></script> 19. <script src="js/i18n/grid.locale-en.js" type="text/

javascript"></script> 20. <script src="js/jquery.jqGrid.min.js" type="text/

javascript"></script> 21. 22. <script type="text/javascript">

16



23. // Here we set a globally the altRows option 24. jQuery.extend(jQuery.jgrid.defaults, { altRows:true }); 25. </script> 26. 27. <script type="text/javascript"> 28. jQuery(document).ready(function(){ 29. jQuery("#list").jqGrid({ 30. url:'example.php', 31. ...

你也可以增加其他你想设置的参数。

覆盖全局参数：

在上面的例子中，我们学习了如何为你的应用程序中所有的表格设置共用的参

数。然而，有些表格可能需要用其他的参数值，即需要对我们上，面设置的全局

参数进行改变，以用于特定的表格。这时，我们可以把相应的参数改过来，即在

特定的表格重新配置一次相应的属性。例如：

Html 代码



3. <head> 4. <meta http-equiv="Content-Type" content="text/html; chars

et=utf-8" /> 5. <title>My First Grid</title> 6. 7. <link rel="stylesheet" type="text/css" media="screen" hre

f="css/ui-lightness/jquery-ui-1.7.1.custom.css" /> 8. <link rel="stylesheet" type="text/css" media="screen" hre

f="css/ui.jqgrid.css" /> 9. 10. <style> 11. html, body { 12. margin: 0;

17



13. padding: 0; 14. font-size: 75%; 15. } 16. </style> 17. 18. <script src="js/jquery-1.3.2.min.js" type="text/



javascript"></script> 21. 22. <script type="text/javascript"> 23. // Here we set a globally the altRows option 24. jQuery.extend(jQuery.jgrid.defaults, { altRows:true }); 25. </script> 26. 27. <script type="text/javascript"> 28. jQuery(document).ready(function(){ 29. jQuery("#list").jqGrid({ 30. url:'example.php', 31. // here we do not want zebra for this grid 32. altRows: false, 33. ...

18


jqGrid 学习 -------------- 自定义搜索

定义自己的查询

Java 代码

1. <div id="mysearch"></div>

JS 中使用

Java 代码

1. jQuery("#mysearch").filterGrid('#grid_id',options);

grid_id:表格 id

options：参数

参数描述默认值

gridModel当为 ture 我们会使用 colModel 中的属性构造查

询条件，所用到的参数：name, index,

edittype, editoptions, search.还有一个参数：

defval：查询条件的默认值；surl：当

edittype:'select'时获取 select 数据的 url，格

式：<select><option value='val1'> Value1

</option><option value='val2'> Value2

false

19


http://a3mao.javaeye.com/?show_full=true



</option>…<option value='valn'> ValueN </option></select>

gridNames gridModel 为 true 时起效，设置查询列的名称 false

filterModel

gridModel 为 false 时起效，格式：

{label:'LableFild', name: 'colname', stype: 'select', defval: 'default_value', surl: 'someurl', sopt:{optins for the

select}}。label：字段显示名称；name：列名；

stype：输入框类型，text或者 select；surl：获

取 select 数据的地址，要求的内容为 html 格式：

<select><option value='val1'> Value1 </option><option value='val2'> Value2 </option>…<option value='valn'> ValueN

</option></select>；sopt：同 editoptions

[]

formtype 定义表单如何被构造，'horizontal' or 'vertical' horizontal

autosearch如果为 true:当点击回车键触发查询；当 select 值

变化时触发查询true

formclass 可以使用的 css filterform

tableclass 可以使用到 table 上的 css filtertable

buttonclass 按钮上使用的 css filterbutton

searchButton 搜索按钮 Search

clearButton 清空数据的按钮 Clear

enableSearch 启用禁用搜索按钮 false

enableClear 启用禁用清空按钮 false

beforeSearch 搜索之前触发的事件 null

20


afterSearch 搜索完成之后触发的事件 null

beforeClear 清空数据之前触发的事件 null

afterClear 清空数据之后触发事件 null

url 搜索数据的 url ‘’

marksearched

当为 true 时，每次查询之后所有查询的列都标记

为可查询列true

查询用到的方法：

Java 代码

1. var sg = jQuery("#mysearch").filterGrid(...)[0]; 2. sg.triggerSearch();

Java 代码 sg.clearSearch();

jqGrid 学习 -------------- 搜索工具栏

搜索工具栏只是在列标题下面构造一个输入框。且使用表格的 url 进行搜索记录

发到服务器端数据格式为 name:value，而且是附加在 postData 之后。

用法

Java 代码

1. ... 2. jQuery("#grid_id").filterToolbar(options); 3. ...

21






如果使用新 API

Java 代码

1. ... 2. jQuery("#grid_id").jqGrid('filterToolbar',options); 3. ...

grid_id：表格 id

options：参数

可选参数类型描述默认

值

autosearch boolean

查询规则，如果是 text 类型则是当按下回车键才

去执行查询；如果是 select 类型的查询则当值改

变时就去执行查询

true

beforeSearch

function执行查询之前触发此事件 null

afterSearch function 查询完成后触发事件 null

beforeClear function清空查询条件值时触发事件 null

afterClear function清空查询条件后触发事件 null

方法：

方法描述

triggerToolbar执行查询时调用此方法

clearToolbar 当清空查询条件值时触发此函数

22



toggleToolbar Toggeles工具栏

示例：

Java 代码

1. ... 2. var sgrid = $("#grid_id")[0]; 3. sgrid.triggerToolbar();

jqGrid 学习 -------------- 搜索表格中所有的列都可以作为搜索条件。

所用到的语言包文件 Java 代码 $.jgrid = {

1. ... 2. search : { 3. caption: "Search...", 4. Find: "Find", 5. Reset: "Reset", 6. odata : ['equal', 'not equal', 'less', 'less or equal','greater','g

reater or equal', 'begins with','does not begin with','is in','is not in','ends with','does not end with','contains','does not contain'],

7. groupOps: [ { op: "AND", text: "all" }, { op: "OR", text: "any" } ],

8. matchText: " match", 9. rulesText: " rules" 10. }, 11. ...

colModel 设置

可选参数类型说明默认值

23





searchboolean 是否是搜索列 true

stype string 搜索类型，text 类型或者 select 类型 text

searchoptions

object 对搜索条件进行一些设置

searchoptions 参数

属性类型说明

dataUrl string 只有当搜索类型为 select才起效

buildSelect

function

只有当 dataUrl 设置时此参数才起效，通过一个 function 来

构建下拉框

dataInitfunction

初始化时调用，用法：dataInit: function(elem) {do

something}通常用在日期的选择上. Example:dataInit :

function (elem) {$(elem).datepicker();}

dataEvents

array

事件列表，用法：dataEvents: [{ type: 'click', data: { i:

7 }, fn: function(e) { console.log(e.data.i); }},{ type: 'keypress', fn: function(e) { console.log('keypress'); } }]

attr object 设置属性值。attr : { title: “Some title” }

searchhidden

boolean

默认情况下，隐藏值不是搜索列。为了使隐藏值可以作为搜索

列则将此设为 true

sopt array

此参数只用到单列搜索上，说明搜索条件。可用值：

['eq','ne','lt','le','gt','ge','bw','bn','in','ni','ew','en','cn','

nc']意思为['equal','not equal', 'less', 'less or

equal','greater','greater or equal', 'begins with','does not begin with','is in','is not in','ends with','does not end with','contains','does not contain']

24


defaultValue

string 默认值

value mixed

只用在搜索类型为 select 下。可以是 string或者 object，如

果为 string 则格式为 value:label，且以“；”结尾；如果

为 object 格式为 editoptions:{value:{1:'One';2:'Two'}}

colModel 用法：

Java 代码

1. <script> 2. jQuery("#grid_id").jqGrid({ 3. ... 4. colModel: [ 5. ... 6. {name:'price', index:'price', width:60, search:true, stype:'t

ext', searchoptions:{dataInit:datePick, attr:{title:'Select Date'}} },

7. ... 8. ] 9. ... 10. }); 11. datePick = function(elem) 12. { 13. jQuery(elem).datepicker(); 14. } 15. </script>

需要说明的：

所有的搜索都是使用 url 来到服务器端查询数据。

当执行搜索时会用查询数据填充 postData array

发送到服务器端搜索字符串的名称为_search

25



当点击刷新按钮时不会使用搜索条件

每个搜索方法都有自己的数据清空方法

jqGrid 学习 -------------- 自定义格式化类型

Java 代码

1. <script> 2. jQuery("#grid_id").jqGrid({ 3. ... 4. colModel: [ 5. ... 6. {name:'price', index:'price', width:60, align:"center", edita

ble: true, formatter:currencyFmatter}, 7. ... 8. ] 9. ... 10. }); 11. 12. function currencyFmatter (cellvalue, options, rowObject) 13. { 14. // do something here 15. return new_format_value 16. } 17. </script>

定义的参数

Java 代码

1. function myformatter ( cellvalue, options, rowObject ) 2. { 3. // format the cellvalue to new format 4. return new_formated_cellvalue; 5. }

cellvalue：要被格式化的值

26





options：对数据进行格式化时的参数设置，格式为：

{ rowId: rid, colModel: cm}

rowObject：行数据

数据的反格式化跟格式化用法相似。

Java 代码


ble: true, formatter:currencyFmatter, unformat:unformatCurrency},

7. ... 8. ] 9. ... 10. }); 11. 12. function currencyFmatter (cellvalue, options, rowObject) 13. { 14. 15. return "$"+cellvalue; 16. } 17. function unformatCurrency (cellvalue, options) 18. { 19. 20. return cellvalue.replace("$",""); 21. } 22. 23. </script>

表格中数据实际值为 123.00，但是显示的是$123.00; 我们使用

getRowData ，getCell 方法取得的值是 123.00。

27



创建通用的格式化函数

定义如下：

Java 代码

1. <script type="text/javascript"> 2. jQuery.extend($.fn.fmatter , { 3. currencyFmatter : function(cellvalue, options, rowdata) { 4. return "$"+cellvalue; 5. } 6. }); 7. jQuery.extend($.fn.fmatter.currencyFmatter , { 8. unformat : function(cellvalue, options) { 9. return cellvalue.replace("$",""); 10. } 11. }); 12. 13. </script>

具体使用：

Java 代码


ble: true, formatter:currencyFmatter}, 7. ... 8. ] 9. ... 10. });

jqGrid 学习 -------------- 格式化

jqGrid 的格式化是定义在语言包中

Java 代码

28






1. $jgrid = { 2. ... 3. formatter : { 4. integer : {thousandsSeparator: " ", defaultValue: '0'}, 5. number : {decimalSeparator:".", thousandsSeparator: " ", d

ecimalPlaces: 2, defaultValue: '0.00'}, 6. currency : {decimalSeparator:".", thousandsSeparator: " ",

decimalPlaces: 2, prefix: "", suffix:"", defaultValue: '0.00'}, 7. date : { 8. dayNames: [ 9. "Sun", "Mon", "Tue", "Wed", "Thr", "Fri", "Sat", 10. "Sunday", "Monday", "Tuesday", "Wednesday", "Thursd

ay", "Friday", "Saturday" 11. ], 12. monthNames: [ 13. "Jan", "Feb", "Mar", "Apr", "May", "Jun", "Jul", "Aug", "Se

p", "Oct", "Nov", "Dec", 14. "January", "February", "March", "April", "May", "June", "J

uly", "August", "September", "October", "November", "December"

15. ], 16. AmPm : ["am","pm","AM","PM"], 17. S: function (j) {return j < 11 || j > 13 ? ['st', 'nd', 'rd', 'th']

[Math.min((j - 1) % 10, 3)] : 'th'}, 18. srcformat: 'Y-m-d', 19. newformat: 'd/m/Y', 20. masks : { 21. ISO8601Long:"Y-m-d H:i:s", 22. ISO8601Short:"Y-m-d", 23. ShortDate: "n/j/Y", 24. LongDate: "l, F d, Y", 25. FullDateTime: "l, F d, Y g:i:s A", 26. MonthDay: "F d", 27. ShortTime: "g:i A", 28. LongTime: "g:i:s A", 29. SortableDateTime: "Y-m-d\\TH:i:s", 30. UniversalSortableDateTime: "Y-m-d H:i:sO", 31. YearMonth: "F, Y" 32. }, 33. reformatAfterEdit : false 34. }, 35. baseLinkUrl: '', 36. showAction: '', 37. target: '',

29


38. checkbox : {disabled:true}, 39. idName : 'id' 40. } 41. ...

这些设置可以通过 colModel 中的 formatoptions 参数修改

Java 代码

1. jQuery("#grid_id").jqGrid({ 2. ... 3. colModel : [ 4. ... 5. {name:'myname', ... formatter:'number', ...}, 6. ... 7. ], 8. ... 9. });

此实例是对名为“myname”的列进行格式化，格式化类是“number”，假如

初始值为“1234.1”则格式化后显示为“1 234.10” 。

如果给某列进行格式化：

Java 代码

1. jQuery("#grid_id").jqGrid({ 2. ... 3. colModel : [ 4. ... 5. {name:'myname', ... formatter:'currency', formatoptions:

{decimalSeparator:",", thousandsSeparator: ",", decimalPlaces: 2, prefix: "$ "} } ,

6. ... 7. ], 8. ... 9. });

这个设置会覆盖语言包中的设置。

30




预先设置的格式化类

类型可选值说明

integer

thousandsSeparator,defaulValue

thousandsSe

parator：对数

字使用千分位

分隔符；

defaulValue

保持原始值不

改变

number

decimalSeparator,thousandsSeparator,decimalPlaces,defaulValue

对数据进行不

同的分隔

currency

decimalSeparator,thousandsSeparator,decimalPlaces,defaulValue,prefix,suffix

同 number，

但是要在附加

prefix 跟

suffix

date srcformat,newformat

srcformat：

对输入数值进

行格式化；

newformat：

对输出进行格

式化

email none如果是 email

31


类型则会附加

mailto:

link target

默认的 targer

是 null，如果

设置此值就会

添加一个超链

接

showlink

baseLinkUrl,showAction,addParam,target,idName

baseLinkUrl

：原始链接；

showAction：

会在链接之后

附加一些信

息；

addParam：

会在 idName

后附加额外参

数；target：

附加属性；

idName：附

加在

showAction

后的第一个参

数，默认为 id

32


checkbox

disabled默认禁用，是

否可以被修改

select

none

select 类型的格式化实例：

原始数据

Java 代码

1. <script> 2. jQuery("#grid_id").jqGrid({ 3. ... 4. colModel : [ {name:'myname', edittype:'select', editoptions:

{value:"1:One;2:Two"}} ... ], 5. ... 6. }); 7. </script>

使用格式化后

Java 代码

1. <script> 2. jQuery("#grid_id").jqGrid({ 3. ... 4. colModel : [ {name:'myname', edittype:'select', formatter:'s

elect', editoptions:{value:"1:One;2:Two"}} ... ] 5. ... 6. }); 7. </script>

结果是，表格的数据值为 1或者 2 但是现实的是 One或者 Two。

对超链接使用 select 类型的格式化：

Java 代码

33





1. <script> 2. jQuery("#grid_id").jqGrid({ 3. ... 4. colModel: [ {name:'myname', edittype:'select', formatter:'sel

ect', formatoptions:{baseLinkUrl:'someurl.php', addParam: '&action=edit'}, ...}

5. ... 6. ] 7. ... 8. }); 9. </script>

输出结果：

Java 代码

1. http://localhost/someurl.php?id=123&action=edit

如果想改变 id 值则

Java 代码

1. <script> 2. jQuery("#grid_id").jqGrid({ 3. ... 4. colModel: [ {name:'myname', edittype:'select', formatter:'sel

ect', formatoptions:{baseLinkUrl:'someurl.php', addParam: '&action=edit', idName:'myid'}, ...}

5. ... 6. ] 7. ... 8. }); 9. </script>

输出为

Java 代码

1. http://localhost/someurl.php?myid=123&action=edit

34





jqGrid 学习 -------------- 自定义按钮

用法：

Java 代码

1. <script> 2. ... 3. jQuery("#grid_id").navGrid("#pager",...).navButtonAdd("#pag

er",{parameters}); 4. ... 5. </script>

如果使用新 API

Java 代码

1. <script> 2. ... 3. jQuery("#grid_id").jqGrid('navGrid',"#pager",...).jqGrid('navBu

ttonAdd',"#pager",{parameters}); 4. ... 5. </script>

默认参数

Java 代码

1. { caption:"NewButton", buttonicon:"ui-icon-newwin", onClickButton:null, position: "last", title:"", cursor: "pointer"}

caption：按钮名称，可以为空，string 类型

buttonicon：按钮的图标，string 类型，必须为 UI theme图标

onClickButton：按钮事件，function 类型，默认 null

position：first或者 last，按钮位置

35






title：string 类型，按钮的提示信息

cursor：string 类型，光标类型，默认为 pointer

id：string 类型，按钮 id

如果设置多个按钮：

Java 代码

1. ... 2. jQuery("#grid_id") 3. .navGrid('#pager',{edit:false,add:false,del:false,search:false}) 4. .navButtonAdd('#pager',{ 5. caption:"Add", 6. buttonicon:"ui-icon-add", 7. onClickButton: function(){ 8. alert("Adding Row"); 9. }, 10. position:"last" 11. }) 12. .navButtonAdd('#pager',{ 13. caption:"Del", 14. buttonicon:"ui-icon-del", 15. onClickButton: function(){ 16. alert("Deleting Row"); 17. }, 18. position:"last" 19. }); 20. ...

按钮间的分隔

Java 代码

1. <script> 2. ... 3. jQuery("#grid_id").navGrid("#pager",...).navButtonAdd("#pag

er",{parameters}).navSeparatorAdd("#pager",{separator_parameters}};

4. ...

36




5. </script>

默认参数：

Java 代码

1. {sepclass : “ui-separator”,sepcontent: ''}

sepclass：ui-jqgrid 的属性名

sepcontent：分隔符的内容

jqGrid 学习 -------------- 翻页（ 2 ）

jqGrid 的翻页导航是一个方法，你可以事先定义一些其他操作，比如：编辑、

新增、删除及搜索。也可以增加自定义的函数。导航工具栏是定义到翻页控件上

的。定义如下：

Java 代码

1. ... 2. <body> 3. ... 4. <table id="list"></table> 5. <div id="gridpager"></div> 6. ... 7. </body>

JS 的用法：

Java 代码

1. <script> 2. ... 3. jQuery("#grid_id").jqGrid({ 4. ...

37






5. pager : '#gridpager', 6. ... 7. }); 8. jQuery("#grid_id").navGrid('#gridpager',

{parameters},prmEdit, prmAdd, prmDel, prmSearch, prmView);

9. ... 10. </script>

如果使用新 API：

Java 代码

1. <script> 2. ... 3. jQuery("#grid_id").jqGrid({ 4. ... 5. pager : '#gridpager', 6. ... 7. }); 8. jQuery("#grid_id").jqGrid('navGrid','#gridpager',

{parameters},prmEdit, prmAdd, prmDel, prmSearch, prmView);

9. ... 10. </script>

或者：

Java 代码

1. <script> 2. ... 3. jQuery("#grid_id").jqGrid({ 4. ... 5. pager : '#gridpager', 6. ... 7. }).navGrid('#gridpager',{parameters}, prmEdit, prmAdd, prm

Del, prmSearch, prmView); 8. ... 9. </script>

38




grid_id ：表格 id

gridpager ：导航栏 id

parameters ：参数列表

prmEdit, prmAdd, prmDel, prmSearch, prmView ：事件

参数使用：

Java 代码

1. $.jgrid = { 2. ... 3. search : { 4. caption: "Search...", 5. Find: "Find", 6. Reset: "Reset", 7. odata : ['equal', 'not equal', 'less', 'less or equal','greater','g

reater or equal', 'begins with','does not begin with','is in','is not in','ends with','does not end with','contains','does not contain'],

8. groupOps: [ { op: "AND", text: "all" }, { op: "OR", text: "any" } ],

9. matchText: " match", 10. rulesText: " rules" 11. }, 12. edit : { 13. addCaption: "Add Record", 14. editCaption: "Edit Record", 15. bSubmit: "Submit", 16. bCancel: "Cancel", 17. bClose: "Close", 18. saveData: "Data has been changed! Save changes?", 19. bYes : "Yes", 20. bNo : "No", 21. bExit : "Cancel", 22. }, 23. view : { 24. caption: "View Record", 25. bClose: "Close" 26. }, 27. del : { 28. caption: "Delete",

39



29. msg: "Delete selected record(s)?", 30. bSubmit: "Delete", 31. bCancel: "Cancel" 32. }, 33. nav : { 34. edittext: "", 35. edittitle: "Edit selected row", 36. addtext:"", 37. addtitle: "Add new row", 38. deltext: "", 39. deltitle: "Delete selected row", 40. searchtext: "", 41. searchtitle: "Find records", 42. refreshtext: "", 43. refreshtitle: "Reload Grid", 44. alertcap: "Warning", 45. alerttext: "Please, select row", 46. viewtext: "", 47. viewtitle: "View selected row" 48. }, 49. ...

详细参数说明

属性类型说明默认值

add boolean是否启用新增功能，当点击按钮时

会触发 editGridRow 事件true

addicon string给新增功能设置图标，只有 UI

theme里的图标才可以使用ui-icon-plus

addtext string 新增按钮上的文字空

addtitle string当鼠标移到新增按钮上时显示的提

示新增一行

alertcap string当我们 edit,delete or view 一行警告

40


记录时出现的提示信息

alerttext string当 edit,delete or view 一行记录

时的文本提示请选择一行记录

closeOnEscape

boolean 是否可以使用 esc键关闭对话框 true

del boolean是否启用删除功能，启用时会触发

事件 delGridRow true

delicon string设置删除按钮的图标，只有 UI

theme里的图标才可以使用ui-icon-trash

deltext string 设置到删除按钮上的文字信息空

deltitle string当鼠标移到删除按钮上时出现的提

示删除锁选择的行

edit boolean是否启用可编辑功能，当编辑时会

触发事件 editGridRow true

editicon string设置编辑按钮的图标，只有 UI

theme里的图标才可以使用ui-icon-pencil

edittext string 编辑按钮上文字空

edittitle string当鼠标移到编辑按钮上出现的提示

信息编辑所选择的行

position string 定义按钮位置，可选值 left,

center and right. left

refresh boolean是否启用刷新按钮，当点击刷新按

true

41


钮时会触发

trigger(“reloadGrid”)事件，而且

会清空搜索条件值

refreshicon string设置刷新图标，只有 UI theme里

的图标才可以使用ui-icon-refresh

refreshtext string 刷新按钮上文字信息空

refreshtitle string 当鼠标移到刷新按钮上的提示信息重新加载

refreshstate string

指明表格如何刷新。firstpage：从

第一页开始刷新；current：只刷

新当前页内容

firstpage

afterRefresh function 当点击刷新按钮之后触发此事件 null

search boolean是否启用搜索按钮，会触发

searchGrid 事件true

searchhicon string设置搜索按钮的图标，只有 UI

theme里的图标才可以使用ui-icon-search

searchtext string 搜索按钮上的文字空

searchtitle string 当鼠标移到搜索按钮上的提示信息搜索

view boolean 是否启用查看按钮，会触发事件

viewGridRow false

viewicon string设置查看按钮的图标，只有 UI

theme里的图标才可以使用

ui-icon-document

42


viewtext string 查看按钮上文字空

viewtitle string 当鼠标移到查看按钮上的提示信息查看所选记录

实例：

Java 代码

1. <script> 2. ... 3. jQuery("#grid_id").jqGrid({ 4. ... 5. pager : '#gridpager', 6. ... 7. }).navGrid('#gridpager',{view:true, del:false}, 8. {}, // use default settings for edit 9. {}, // use default settings for add 10. {}, // delete instead that del:false we need this 11. {multipleSearch : true}, // enable the advanced searching 12. {closeOnEscape:true} /* allow the view dialog to be closed w

hen user press ESC key*/ 13. ); 14. ... 15. </script>

jqGrid 学习 -------------- 翻页

jqGrid 的翻页要定义在 html里，通常是在 grid 的下面，且是一个 div 对象：

Java 代码

1. <body> 2. ... 3. <table id="list"></table> 4. <div id="gridpager"></div> 5. ... 6. </body>

43





js 代码：

Java 代码

1. jQuery("#grid_id").jqGrid({ 2. ... 3. pager : '#gridpager', 4. ... 5. });

不必给翻页设置任何的 css 属性。在 jqGrid里定义的翻页可以是：:pager :

'#gridpager', pager : 'gridpager' or pager : jQuery('#gridpager'). 推

荐使用前两个，当使用其他方式时 jqGrid 的导入导出功能时会引起错误。

导航栏的属性：

Java 代码

1. $.jgrid = { 2. defaults : { 3. recordtext: "View {0} - {1} of {2}", 4. emptyrecords: "No records to view", 5. loadtext: "Loading...", 6. pgtext : "Page {0} of {1}" 7. }, 8. ... 9. }

如果想改变这些设置：

1、方法一：

Java 代码

1. jQuery.extend(jQuery.jgrid.defaults,{emptyrecords: "Nothing to display",...});

44





2、方法二：

Java 代码

1. jQuery("#grid_id").jqGrid({ 2. ... 3. pager : '#gridpager', 4. emptyrecords: "Nothing to display", 5. ... 6. });

导航栏的属性

属性名类型说明默认值

是否

可以

被修

改

lastpage integer 只读属性，总页数 0 NO

pager mixed导航栏对象，必须是一个有效的 html元

素，位置可以随意空字符串NO

pagerpos string定义导航栏的位置，默认分为三部分：翻

页，导航工具及记录信息center NO

pgbuttonsboolean 是否显示翻页按钮 true NO

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

pgtext string页面信息，第一个值是当前页第二个值是

总页数语言包 YES

45



reccount integer

只读属性，实际记录数，千万不能跟

records 参数搞混了，通常情况下他们是

相同的，假如我们定义 rowNum=15，但

我们从服务器端返回的记录为 20 即

records=20，而 reccount=15，表格中

也显示 15条记录。

0 NO

recordpos string 定义记录信息的位置，可选值：left,

center, rightright NO

records integer 只读属性，从服务器端返回的记录数 none NO

recordtext string显示记录的信息，只有当 viewrecords 为

true 时起效，且记录数必须大于 0语言包 yes

rowList array[] 可以改变表格可以显示的记录数，格式为

[10,20,30]

空

array[]no

rowNum integer 设置表格可以显示的记录数 20 yes

viewrecords

boolean 是否要显示总记录数信息 false no

所有这些参数都是可以修改的，比如：

Java 代码

1. <script> 2. ... 3. jQuery("#grid_id").setGridParam({rowNum:10}).trigger("reloa

dGrid"); 4. ... 5. </script>

46



跟翻页相关的事件只有一个：onPaging

事件名参数说明

onPaging

pgButton

当点击翻页按钮但还为展现数据时触发此事件，当然这跳转

栏输入页码改变页时也同样触发此事件。参数 pgButton 可

选值： first,last,prev,next

jqGrid 学习 -------------- 配置 json

IE8，FF3 以及 Chrome 3已经支持 JSON，配置：

Java 代码






css/ui.jqgrid.css" /> 9. 10. <script src="js/jquery-1.3.2.min.js" type="text/


javascript"></script> 12. <script type="text/javascript"> 13. jQuery.jgrid.useJSON = true; 14. </script> 15. <script src="js/jquery.jqGrid.min.js" type="text/

javascript"></script> 16. 17. </head>

47




18. <body> 19. ... 20. </body> 21. </html>

要注意下面这段代码

Java 代码

1. <script type="text/javascript"> 2. jQuery.jgrid.useJSON = true; 3. </script>

这段代码要放到语言包之后 jqGrid.js 文件之前。

如果浏览器不支持 JSON，那么我们只能用 eval函数解析 json。

除了 jqGrid 本身提供对 json 的类库外，我们可以使用 JSON.parse 来处理

JSON，配置如下：

Java 代码






css/ui.jqgrid.css" /> 9. 10. <script src="js/json2.js" type="text/javascript"></script> 11. <script src="js/jquery-1.3.2.min.js" type="text/

javascript"></script>

48




12. <script src="js/i18n/grid.locale-en.js" type="text/javascript"></script>

13. <script src="js/jquery.jqGrid.min.js" type="text/javascript"></script>

14. <script type="text/javascript"> 15. jQuery.extend(jQuery.jgrid,{ 16. parse:function(jsstring) { 17. return JSON.parse(jsstring); 18. } 19. }); 20. </script> 21. 22. </head> 23. <body> 24. ... 25. </body> 26. </html>

jqGrid 学习 -------------- 方法

jqGrid 的方法，从 3.6 开始已经完全兼容 jQuery UI 库。

用法：

Java 代码

1. <script> 2. ... 3. jQuery("#grid_id").jqGridMethod( parameter1,...parameterN ); 4. ... 5. </script>

grid_id:表格的 id；jqGridMethod：用到表格上的方法；parameter1,…

parameterN ：参数列表

此方法并不是返回请求的数据值而是返回一个 jqGrid 对象。

Java 代码

49





1. <script> 2. ... 3. jQuery("#grid_id").setGridParam({...}).hideCol("somecol").trig

ger("reloadGrid"); 4. ... 5. </script>

如果使用新的 API：

Java 代码

1. <script> 2. ... 3. jQuery("#grid_id").jqGrid('method', parameter1,...parameterN

); 4. ... 5. </script>

grid_id:表格 id；jqGrid：表格实例；method：表格支持的方法名；

parameter1,...parameterN ：参数列表

具体实例：

Java 代码

1. <script> 2. ... 3. jQuery("#grid_id").jqGrid('setGridParam',

{...}).jqGrid('hideCol',"somecol").trigger("reloadGrid"); 4. ... 5. </script>

jqGrid 配置使用新的 api

Java 代码

50










css/ui.jqgrid.css" /> 9. 10. <script src="js/jquery-1.3.2.min.js" type="text/


javascript"></script> 12. <script type="text/javascript"> 13. jQuery.jgrid.no_legacy_api = true; 14. </script> 15. <script src="js/jquery.jqGrid.min.js" type="text/

javascript"></script> 16. 17. </head> 18. <body> 19. ... 20. </body> 21. </html>

要注意

Java 代码

1. <script type="text/javascript"> 2. jQuery.jgrid.no_legacy_api = true; 3. </script>

这段代码必须放在语言包之后 jqGrid.js 文件之前。

51



jqGrid 方法

方法名参数返回

值说明

addJSONData datanone

使用传来的 data 数据填充表格。使用方

法：var mygrid =

jQuery(”#”+grid_id)[0];var myjsongrid = eval(”(”+jsonresponse.responseText+”)”); mygrid.addJSONData(myjsongrid); myjsongrid = null; jsonresponse =null;

addRowDatarowid,data, position, srcrowid

成功

为

true,

否则

为

false

根据参数插入一行新的数据，rowid 为

新行的 id，data 为新行的数

据，position 为新增行的位

置，srcrowid 为新增行的参考位

置。data 数据格式：

{name1:value1,name2: value2…}

name 为在 colModel 中指定的名称

addXMLData datanone

根据传来的数据填充表格。用法：var

mygrid = jQuery(”#”+grid_id)[0]; mygrid.addXmlData(xmlresponse.responseXML);

clearGridData clearfooter jqGri

d 对

象

清除表格当前加载的数据。如果

clearfooter 为 true 时则此方法删除表

52


格最后一行的数据

delRowData rowid

成功

为

true

否则

为

false

根据 rowid删除行，但不会从服务器端

删除数据

footerDataaction,data, format

jgGri

d 对

象

设置或者取得底部数据。action：“get”

或者“set”，默认为“get”，如果为

“get”返回值为 name:value，name

为 colModel 中名称。如果为“set”则值

为 name：value，name 是 colModel

中的名称。format：默认为 true，当为

true 时，在设置新值时会调用

formatter 格式化数值

getCell rowid, iCol

单元

格内

容

返回指定 rowid，iCol 的单元格内

容，iCol既可以是当前列在 colModel 中

的位置索引也可以是 name 值。注意：在

编辑行或者单元格时不能使用此方法，

此时返回的并不是改变的值，而是原始

值

getCol colname, returntype, mathoperati

array[] or

返回列的值。colname既可以是当前列

53


onvalue

在 colModel 中的位置索引也可以是

name 值。returntype 指定返回数据的

类型，默认为 false。当为 false 时，返

回的数组中只包含列的值，当为 true 时

返回数组是对象数组，具体格式

{id:rowid, value:cellvalue} ，id 为行

的 id，value 为列的值。如：

[{id:1,value:1},{id:2,value:2}

…]。mathoperation 可选值为'sum,

'avg', 'count'

getDataIDs nonearray[] 返回当前 grid里所有数据的 id

getGridParam name

mixed value

返回请求的参数信息

getIndrowid,rowcontent

mixed

如果 rowcontent 为 false，返回行所在

的索引位置，id 为行 id。rowcontent 默

认为 false。如果 rowconent 为 ture 则

返回的为行对象，如果找不到行则返回

falsegetRowData rowid or

nonearray{} 返回指定行的数据，返回数据类型为

name:value，name 为 colModel 中的

名称，value 为所在行的列的值，如果根

据 rowid找不到则返回空。在编辑模式下

不能用此方法来获取数据，它得到的并

54


不是编辑后的值

hideColcolnameor[colnames]

jqGri

d 对

象

如果参数为一个列名则隐藏此列，如果

给定的是数组则隐藏指定的所有列。格

式： [“name1”,”name2”]

remapColumns

permutation, updateCells, keepHeader

none

调整表格列的显示顺序,permutation 为

当前列的顺序，假如值是[1,0,2]，那么

第一列就会在第二位显示。如果

updateCells 为 ture 则是对单元格数据

进行重新排序，如果 keepHeader 为

true 则对 header 数据显示位置进行调

整

resetSelection none

jqGri

d 对

象

选择或者反选行数据，在多选模式下也

同样起作用

setCaption caption

jqGri

d 对

象

设置表格的标题

setCell rowid,colname, data, class, properties

jqGri

d 对

象

改变单元格的值。rowid：当前行 id；

colname：列名称，也可以是列的位置

索引，从 0 开始；data：改变单元格的

内容，如果为空则不更新；class：如果

是 string 则会使用 addClass 方法将其

55


加入到单元格的 css 中，如果是 array

则会直接加到 style 属性中；

properties：设置单元格属性

setGridParam object

jqGri

d 对

象

设置 grid 的参数。有些参数的修改必须

要重新加载 grid才可以生效，这个方法

可以覆盖事件

setGridHeight new_height

jqGri

d 对

象

动态改变 grid 的高度，只能对单元格的

高度进行设置而不能对表格的高度进行

动态修改。new_height：可以是象素

值，百分比或者"auto"

setGridWidthnew_width,shrink

jqGri

d 对

象

动态改变表格的宽度。new_width:表格

宽度，象素值；shrink：true或者

false，作用同 shrinkToFit

setLabelcolname, data, class, properties

jqGri

d 对

象

给指定列设置一个新的显示名

称。colname：列名称，也可以是列的位

置索引，从 0 开始；data：列显示名

称，如果为空则不修改；class：如果是

string 则会使用 addClass 方法将其加

入到单元格的 css 中，如果是 array 则

会直接加到 style 属性中；properties：

设置 label 的属性

56


setRowDatarowid,data, cssprop

成功

true

否则

false

更新行的值，rowid 为行 id。data 值格

式：{name1:value1,name2:

value2…} name 为 colModel 中名

称；cssprop：如果是 string 则会使用

addClass 方法将其加入到行的 css 中，

如果是 array或者对象则会直接加到

style 属性中

setSelectionrowid,onselectrow

jqGri

d 对

象

选择或反选指定行。如果 onselectrow

为 ture 则会触发事件

onSelectRow，onselectrow 默认为

ture

showCol colnamejqGrid

显示列。colname 可以是数组

[“name1”,”name2”],但是 name1或

者 name2 必须是 colModel 中的 name

trigger(“reloadGrid”)

none

jqGri

d 对

象

重新加载当前表格，也会向服务器发起

新的请求

updateColumns

nonenone

同步表格的宽度，用在表格拖拽时，用

法：var mygrid=jQuery(”#grid_id”)

[0];mygrid.updateColumns();

57


jqGrid 的通用方法和设置

这些方法并不和 jqGrid 对象绑定，可以随意使用：

Java 代码

1. <script> 2. ... 3. jQuery.jgrid.jqGridFunction( parameter1,...parameterN ); 4. ... 5. </script>

jgrid.jqGridFunction 是函数名

parameter1,…parameterN 参数列表

函数名参数返回值说明

ajaxOptions 空对象 none

这个函数可以改变 jqgrid 中用到的

ajax 请求参数，这个函数可以覆盖

当前所有 ajax 请求设置。从 3.6 版

本开始起有 3 个级别的 ajax 设置：

第一个级别就是在模块中设置 ajax

请求；第二个级别就是通过此函数

设置；第三级别的设置是控制全局

ajax 请求的设置：

jQuery.extend(jQuery.ajax({method specific options}, ajaxOptions,

ThirdLevelajaxSettinds)); 当然

我们也可以单独设置 ajax 的参数

58



jqID string 解析后的

string

转义字符串，把两个反斜杠(\\)转化

为单个反斜杠(\)

jgrid.htmlDecode string 转换后

string把转码后的字符串还原

jgrid.htmlEncode string 编码后的

string把字符串编码

jgrid.format string 格式化后

string

简单字符串模板。用法：Example

jQuery.jqgformat(“Please enter a value between {0} and

{1}.”, 4, result : “Please

enter a value between 4 and 8.”

jgrid.getCellIndex

cell index这个方法是用来修复在 ie7里的一

个 bug

jgrid.stringToDoc xmlstring xmlDoc 把 xmlstring转换为 dom 对象

jgrid.stripHtml contentnew_content 去掉 html标签返回标签中内容

jgrid.parsejsonstring 对象

把一个 jsonstring转换为 json 对

象，

jqGrid 的方法

方法名参数返回

值说明

filterGrid

grid_id,params

HTML

对象

构造 jqGrid 的查询界面。grid_id:表格 id；

params：参数

59


filterToolbar

params

jqGrid

对象同上。不同的是搜索输入框在 header层下方

getColProp

colnamearray{}

返回指定列的属性集合。name 为 colModel 中名

称

GridDestroy

grid_id

成功

tru

e 否

则

false

从 dom 上删除此 grid

GridUnload

grid_id

成功

tru

e 否

则

false

跟 GridDestroy 不同的是 table 对象跟 pager 对

象并不会被删除，以便下次使用

setGridState

state

jqGrid

对象

设置 grid 的状态，显示或者隐藏。这个方法不会

触发 onHeaderClick 事件。

setColProp

colname, properties

jqGrid

对象

设置新的属性，对于动态改变列属性是非常有用

的，但是有些属性的修改并不会起效。用法：

jQuery(”#grid_id”).setColProp('colname',{editoptions:{value:“True:False”}});

sortGrid

colname, reload

jqGrid

对象

按指定列进行排序。效果同

setGridParam({sortname:'myname'}).trigg

er('reloadGrid'). 如果 reload 为 true 则会重新

加载数据

60


updateGridRows

data,rowidname,jsonreader

成功

tru

e 否

则为

false

修改表格中某行的数据，data 数据格式：

[{name:value,name1:value1…},

{name:value,name2:value2…}]，name 为

colModel 中的名称；rowidname某行的名

称。jsonreader：boolean 值，默认 false。如果

为 true 则是定义数据的格式，data 的值并不是

name：value形式而只是 value

jqGrid 学习 ----------- 事件

jqGrid 中的事件：

语法：

Java 代码

1. var lastSel; 2. jQuery("#gridid").jqGrid({ 3. ... 4. onSelectRow: function(id){ 5. if(id && id!==lastSel){ 6. jQuery('#gridid').restoreRow(lastSel); 7. lastSel=id; 8. } 9. jQuery('#gridid').editRow(id, true); 10. }, 11. ... 12. });

事件参数备注

afterInsertRow rowidrowdatarowelem 当插入每行时触发。rowid插入

当前行的 id；rowdata插入行

61




的数据，格式为 name:

value，name 为 colModel 中

的名字

beforeRequest none

向服务器端发起请求之前触发

此事件但如果 datatype 是一

个 function 时例外

beforeSelectRow rowid, e

当用户点击当前行在未选择此

行时触发。rowid：此行 id；

e：事件对象。返回值为 ture或

者 false。如果返回 true 则选择

完成，如果返回 false 则不会选

择此行也不会触发其他事件

gridComplete none

当表格所有数据都加载完成而

且其他的处理也都完成时触发

此事件，排序，翻页同样也会

触发此事件

loadComplete xhr

当从服务器返回响应时执

行，xhr：XMLHttpRequest

对象

loadError xhr,status,error如果请求服务器失败则调用此

方法。xhr：XMLHttpRequest

62


对象；satus：错误类型，字符

串类型；error：exception 对

象

onCellSelect rowid,iCol,cellcontent,e

当点击单元格时触发。rowid：

当前行 id；iCol：当前单元格

索引；cellContent：当前单元

格内容；e：event 对象

ondblClickRow rowid,iRow,iCol,e

双击行时触发。rowid：当前行

id；iRow：当前行索引位置；

iCol：当前单元格位置索引；

e:event 对象

onHeaderClick gridstate

当点击显示/隐藏表格的那个按

钮时触发；gridstate：表格状

态，可选值：visible or

hidden

onPaging pgButton

点击翻页按钮填充数据之前触

发此事件，同样当输入页码跳

转页面时也会触发此事件

onRightClickRow rowid,iRow,iCol,e在行上右击鼠标时触发此事

件。rowid：当前行 id；

iRow：当前行位置索引；

iCol：当前单元格位置索引；

63


e：event 对象。此事件不支持

opera游览器

onSelectAll aRowids,status

multiselect 为 ture，且点击

头部的 checkbox 时才会触发

此事件。aRowids：所有选中行

的 id集合，为一个数

组。status：boolean变量说

明 checkbox 的选择状

态，true选中 false 不选中。无

论 checkbox 是否选

择，aRowids 始终有值

onSelectRow rowid,status

当选择行时触发此事

件。rowid：当前行 id；

status：选择状态，当

multiselect 为 true 时此参数

才可用

onSortCol index,iCol,sortorder当点击排序列但是数据还未进

行变化时触发此事件。index：

name 在 colModel 中位置索

引；iCol：当前单元格位置索

引；sortorder：排序状态：

64


desc或者 asc

resizeStart event, index

当开始改变一个列宽度时触发

此事件。event：event 对象；

index：当前列在 colModel 中

位置索引

resizeStop newwidth, index

当列宽度改变之后触发此事

件。newwidth：列改变后的宽

度；index：当前列在

colModel 中的位置索引

serializeGridData postData

向服务器发起请求时会把数据

进行序列化，用户自定义数据

也可以被提交到服务器端

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

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

clientSide、xmlstring、jsonstring

、script、function (…)。

Json 数据

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

Java 代码

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

65




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 当前页

66



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"]}, 8. ... 9. ] 10. }

* page * total

67




* records

定义翻页所需要的信息

Java 代码

1. jQuery("#gridid").jqGrid({ 2. ... 3. jsonReader : { 4. root:"invdata", 5. page: "currpage", 6. total: "totalpages", 7. records: "totalrecords" 8. }, 9. ... 10. });

服务器端返回数据：

Java 代码

1. { 2. totalpages: "xxx", 3. currpage: "yyy", 4. totalrecords: "zzz", 5. invdata : [ 6. {id:"1", cell:["cell11", "cell12", "cell13"]}, 7. {id:"2", cell:["cell21", "cell22", "cell23"]}, 8. ... 9. ] 10. }

* cell

当前行所包含的单元格数据

Java 代码

1. jQuery("#gridid").jqGrid({ 2. ... 3. jsonReader : { 4. root:"invdata",

68





5. page: "currpage", 6. total: "totalpages", 7. records: "totalrecords", 8. cell: "invrow" 9. }, 10. ... 11. });

从服务器端返回数据：

Java 代码

1. { 2. totalpages: "xxx", 3. currpage: "yyy", 4. totalrecords: "zzz", 5. invdata : [ 6. {id:"1", invrow:["cell11", "cell12", "cell13"]}, 7. {id:"2", invrow:["cell21", "cell22", "cell23"]}, 8. ... 9. ] 10. }

* id

行 id

Java 代码

1. jQuery("#gridid").jqGrid({ 2. ... 3. jsonReader : { 4. root:"invdata", 5. page: "currpage", 6. total: "totalpages", 7. records: "totalrecords", 8. cell: "invrow", 9. id: "invid" 10. }, 11. ... 12. });

69





Java 代码

1. { 2. totalpages: "xxx", 3. currpage: "yyy", 4. totalrecords: "zzz", 5. invdata : [ 6. {invid:"1", invrow:["cell11", "cell12", "cell13"]}, 7. {invid:"2", invrow:["cell21", "cell22", "cell23"]}, 8. ... 9. ] 10. }

cell 可以设置为空字符串，id 也可以设置为数字：

Java 代码

1. jQuery("#gridid").jqGrid({ 2. ... 3. jsonReader : { 4. root:"invdata", 5. page: "currpage", 6. total: "totalpages", 7. records: "totalrecords", 8. cell: "", 9. id: "0" 10. }, 11. ... 12. });

从服务器端返回：

Java 代码

1. { 2. totalpages: "xxx", 3. currpage: "yyy", 4. totalrecords: "zzz", 5. invdata : [

70





6. {"1","cell11", "cell12", "cell13"}, 7. {"2",,"cell21", "cell22", "cell23"}, 8. ... 9. ] 10. }

* repeatitems

指明每行的数据是可以重复的，如果设为 false，则会从返回的数据中按名字

来搜索元素，这个名字就是 colModel 中的名字：

Java 代码

1. jQuery("#gridid").jqGrid({ 2. ... 3. jsonReader : { 4. root:"invdata", 5. page: "currpage", 6. total: "totalpages", 7. records: "totalrecords", 8. repeatitems: false, 9. id: "0" 10. }, 11. ... 12. });


Java 代码

1. { 2. totalpages: "xxx", 3. currpage: "yyy", 4. totalrecords: "zzz", 5. invdata : [ 6. {invid:"1",invdate:"cell11", amount:"cell12", tax:"cell13", to

tal:"1234", note:"somenote"}, 7. {invid:"2",invdate:"cell21", amount:"cell22", tax:"cell23", to

tal:"2345", note:"some note"}, 8. ... 9. ]

71




10. }

此例中，id 属性值为“invid”。

一旦当此属性设为 false 时，我们就不必把所有在 colModel 定义的 name 值

都赋值。因为是按 name 来进行搜索元素的，所以他的排序也不是按 colModel

中指定的排序结果。

Java 代码

1. { 2. totalpages: "xxx", 3. currpage: "yyy", 4. totalrecords: "zzz", 5. invdata : [ 6. {invid:"1",invdate:"cell11", note:"somenote"}, 7. {invid:"2", amount:"cell22", tax:"cell23", total:"2345"}, 8. ... 9. ] 10. }

用户数据（user data）

在某些情况下，我们需要从服务器端返回一些参数但并不想直接把他们显示到

表格中，而是想在别的地方显示，那么我们就需要用到 userdata标签。

Java 代码

1. jsonReader: { 2. ... 3. userdata: "userdata", 4. ... 5. }


72




Java 代码

1. { 2. total: "xxx", 3. page: "yyy", 4. records: "zzz", 5. userdata: {totalinvoice:240.00, tax:40.00}, 6. rows : [ 7. {id:"1", cell:["cell11", "cell12", "cell13"]}, 8. {id:"2", cell:["cell21", "cell22", "cell23"]}, 9. ... 10. ] 11. }

在客户端我们得到的数据为：

Java 代码

1. userData = {totalinvoice:240.00, tax:40.00}

在客户端我们可以有下面两种方法得到这些额外信息：

1. 使用 getGridParam 方法:

Java 代码

1. jQuery("grid_id").getGridParam('userData')

2. 使用 getUserData()方法

Java 代码

1. jQuery("grid_id").getUserData()

如果想获得某个值则为：

73






Java 代码

1. jQuery("grid_id").getUserDataItem( key )

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

74





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

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

select, checkbox, password, button, image and file.

text

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

75


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 搜索数据时的 urlempty string

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

分比150

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

关系none

unformat function ‘unformat’单元格值 null

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

name * width * resizable * label (method avail.)

76


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

参数名称参数

类型描述默认值

是

否

可

以

被

修

改

ajaxGridOptions

object

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

件：error，complete 和 beforeSend 空值是

ajaxGridOptions

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

ajaxSelectOptions

object

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

editoptions 跟 searchoptions 参数的 select

属性值

空值是

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

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

ui-priority-secondary 是

，

但

需

要

重

新

77



加

载

altRowsboolean 设置表格 zebra-striped 值 false

是

，

需

重

新

加

载

autoencode

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

autowidth

boolean

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

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

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

现函数：setGridWidth

false 否

caption String 定义表格名称空值否

，

但

是

可

以

用

a

78


pi

修

改

cellLayout

integer

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

必修改此值。初始值为

5，paddingLef⇒2+paddingRight⇒2+bord

erLeft⇒1=5

5 否

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

cellsubmit

String

定义了单元格内容保存位置：

“remote”，“clientArray”‘remote’ 是

cellurlString 单元格提交的 url 空值是

colModelarray 描述列信息的数组空值否

colNames

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

datastrString xmlstring或者 jsonstring 空值是

datatype

string

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

xml，xmlstring，json，local，function xml 是

deselectAfterSort

boolean

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

不选择当前行true 是

directionstring

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

右向左（rtr）。ltr 否

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

emptyrecords

string 当返回的数据行数为 0 时显示的信息。只有当属在语言包中是

79


性 viewrecords 设置为 ture 时起作用

ExpandColClick

boolean

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

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

ExpandColumn

string

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

有在 treeGrid 为 true 时起作用空值否

footerrow

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

forceFitboolean

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

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

gridstate

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

gridviewboolean

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

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

grid 中，但 treeGrid, subGrid, or

afterInsertRow 不能用

false 是

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

hiddengrid

boolean

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

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

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

且 hidegrid 为 ture 时才起作用

false 否

hidegridboolean

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

当 caption 属性不为空时起效true 否

hoverrows

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

80


jsonReader

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

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

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

loadonce

boolean

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

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

用

false 否

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

loaduistring

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

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

求时的提示； block启用 Loading 提示，但是

阻止其他操作

enable 是

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

multikeystring

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

义使用那个 key 来做多

选。shiftKey，altKey，ctrlKey

空值是

multiboxonly

boolean

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

multiboxonly 为 ture 时只有选择 checkbox

才会起作用，

false 是

multiselect

boolean 定义是否可以多选 false 否

multiselectWidth

integer

当 multiselect 为 true 时设置 multiselect 列

宽度20 否

81


pageinteger 设置初始的页码 1 是

pagermixed

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

素。可以是'pager', '#pager',

jQuery('#pager').推荐用'#pager'

空值否

pagerpos

string 指定分页栏的位置 center 否

pgbuttons

boolean 是否显示翻页按钮 true 否

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

pgtextstring 当前页信息

语言包中设

置是

prmNames

array

Default valuesprmNames: {page:“page”,rows:“rows”, sort: “sidx”,order: “sord”, search:“_search”,

nd:“nd”, npage:null} 当参数为 null 时不会被

发到服务器端

none 是

postData

array

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

{name1:value1…}空 array 是

reccountinteger

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

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

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

录数是 20，那么 records 值是 20，但

reccount 值仍然为 15，而且表格中也只显示

15条记录。

0 否

recordpos

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

82


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

recordtext

string

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

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

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

语言包是

resizeclass

string

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

时的效果空值否

rowListarray[]

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

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

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

[] 否

rownumbers

boolean

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

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

rowNuminteger

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

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

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

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

20 是

rownumWidth

integer

如果 rownumbers 为 true，则可以设置

column 的宽度25 否

savedRow

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

scroll boolean or integer

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

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

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

false否

83


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

据都在这几行中加载

scrollOffset

integer 设置垂直滚动条宽度 18 否

scrollrows

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

selarrrow

array-[] 只读属性，用来存放当前选择的行

empty array [] 否

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

shrinkToFit

boolean

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

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

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

true 否

sortableboolean 是否可排序 false 否

sortname

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

sortorder

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

subGridboolean 是否使用 suggrid false 否

subGridModel

array-[] subgrid模型

empty array 否

subGridType

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

subGridUrl

string

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

值加到 url 中空值是

subGridWidth

integer subgrid 列的宽度 20 否

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

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

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

[false,''] 否

84


值：“top”,”bottom”, “both”. 如果工具栏在

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

面则为 “tb_”+表格 id；如果只有一个工具栏

则为 “t_”+表格 id

totaltime

integer

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

跟 json 数据0 否

treedatatype

mixed

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

变null 否

treeGridboolean 启用或者禁用 treegrid模式 false 否

treeGridModel

string treeGrid 所使用的方法 nested 否

treeIcons

array

树的图标，默认值：{plus:'ui-icon-triangle-

1-e',minus:'ui-icon-triangle-1-s',leaf:'ui-icon-radio-off'}

否

treeReader

array

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

后面否

tree_root_level

numeric

root元素的级别， 0 否

urlstring

url null 是

userData

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

empty array 否

userDataOnFooter

boolean

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

果 userData 的值与 colModel 的值相同，那么

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

false 是

85


viewrecords

boolean 是否要显示总记录数 false 否

viewsortcols

array

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

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

都要显示排序列的图标，false 就是只显示当前

排序列的图标；第二个参数是指图标如何显

示，vertical：排序图标垂直放

置，horizontal：排序图标水平放置；第三个参

数指单击功能，true：单击列可排序，false：

单击图标排序。说明：如果第三个参数为 false

则第一个参数必须为 ture 否则不能排序

否

widthnumber

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

colModel 中定义的宽度计算none 否

xmlReader

array 对 xml 数据结构的描述否

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

url 获取数据的地址

datatype

从服务器端返回的数据类型，默认 xml。可选类型：

xml，local，json，jsonnp，script，xmlstring，jsonstring，

clientside

mtype ajax 提交方式。POST或者GET，默认 GET

colNames 列显示名称，是一个数组对象。

colModel对显示列属性的设置，是一个数组对象。常用到的属性：name 列

86



显示的名称；index 传到服务器端用来排序用的列名称；width

列宽度；align 对齐方式；sortable 是否可以排序

pager定义翻页用的导航栏，必须是有效的 html元素。翻页工具栏可以

放置在 html 页面任意位置

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

rowList一个下拉选择框，用来改变显示记录数，当选择时会覆盖

rowNum 参数传递到后台

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

到后台

viewrecords 定义是否要显示总记录数

caption 表格名称

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

1、html 文件

Java 代码






css/ui.jqgrid.css" />

87




9. 10. <style> 11. html, body { 12. margin: 0; 13. padding: 0; 14. font-size: 75%; 15. } 16. </style> 17. 18. <script src="js/jquery-1.3.2.min.js" type="text/



javascript"></script> 21. 22. <script type="text/javascript"> 23. $(document).ready(function(){ 24. jQuery("#jsonmap").jqGrid({ 25. url:WEB_PATH+'/example/JqGridExample.action', 26. //url:WEB_PATH+'/excludes/post.jsp', 27. datatype: 'json',

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

29. colModel:[ 30. {name:'id',index:'id', width:90,sorttype:"int"}, 31. {name:'username',index:'name', width:110,sorttype:"int

"}, 32. {name:'password',index:'password', width:80}, 33. {name:'age',index:'age', width:80}, 34. {name:'address',index:'address', width:80}, 35. {name:'time',index:'time', width:80,sorttype:"date"} 36. ], 37. 38. imgpath: WEB_PATH+'/resources/javascript/plugins/

jqgrid/css/smoothness/images', 39. rowNum:10, 40. rowList:[10,20,30], 41. pager: "pjmap", 42. 43. multiselect: false, 44. sortname: 'id', 45. viewrecords: true, 46. sortorder: "desc",

88


47. jsonReader: { 48. root: "dataRows", 49. repeatitems : false 50. }, 51. caption: "jqGrid test", 52. height: 220 53. }).navGrid('pjmap', 54. {view:true,edit:true,add:false,del:false}, 55. {closeOnEscape:true} 56. ); 57. 58. }); 59. </script> 60. 61. </head> 62. <body> 63. <table id="jsonmap" ></table> 64. <div id="pjmap" ></div> 65. 66. </body> 67. </html>

jqGrid 需要我们事先指定一个 table 对象，且有一个唯一的 id 属性。其他表

格属性比如 Cellspacing、cellpadding 跟 border 不要自己设置，jqGrid 会设

置。

因为我们要分页，所以要定义一个分页的 div 对象，同样必须有 id 属性。

jqGrid 的用法：

Java 代码

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

grid_selector 就是 table 的 id 值，

optoins 是一个 json 对象：

89



Java 代码

1. { 2. url:WEB_PATH+'/example/JqGridExample.action', 3. //url:WEB_PATH+'/excludes/post.jsp', 4. datatype: 'json',

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

6. colModel:[ 7. {name:'id',index:'id', width:90,sorttype:"int"}, 8. {name:'username',index:'name', width:110,sorttype:"int"

}, 9. {name:'password',index:'password', width:80}, 10. {name:'age',index:'age', width:80}, 11. {name:'address',index:'address', width:80}, 12. {name:'time',index:'time', width:80,sorttype:"date"} 13. ], 14. 15. imgpath: WEB_PATH+'/resources/javascript/plugins/

jqgrid/css/smoothness/images', 16. rowNum:10, 17. rowList:[10,20,30], 18. pager: "pjmap", 19. 20. multiselect: false, 21. sortname: 'id', 22. viewrecords: true, 23. sortorder: "desc", 24. jsonReader: { 25. root: "dataRows", 26. repeatitems : false 27. }, 28. caption: "jqGrid test", 29. height: 220 30. }

4、服务端文件

Java 代码

1. package com.test.json.action; 2.

90




3. import java.util.ArrayList; 4. import java.util.HashMap; 5. import java.util.List; 6. import java.util.Map; 7. 8. import org.apache.struts2.json.annotations.JSON; 9. 10. import net.sf.json.JSONArray; 11. import net.sf.json.JSONObject; 12. 13. 14. import com.web.action.BaseAction; 15. 16. public class JqGridAction extends BaseAction 17. { 18. 19. /** 20. * 21. */ 22. private static final long serialVersionUID = 1L; 23. 24. 25. private int page = 1; 26. 27. private int total = 3; 28. 29. private int rows = 0; 30. 31. private List dataRows = new ArrayList(); 32. 33. public String execute() 34. { 35. JSONArray t_list = new JSONArray(); 36. for(int i=0;i<3;i++){ 37. JSONObject student = new JSONObject(); 38. //Map student = new HashMap();

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

40. student.put("password","123"); 41. student.put("age",20+i); 42. student.put("address","USA"); 43. student.put("id",i); 44. dataRows.add(i,student); 45. }

91


46. 47. //JSONArray ay =JSONArray.fromObject(rows); 48. System.out.println("tttttttttttt======"+t_list.toString()); 49. //this.outJsonString(t_list.toString() ); 50. return SUCCESS; 51. } 52. 53. //@JSON(serialize=false) 54. public int getPage() 55. { 56. return page; 57. } 58. 59. public void setPage(int page) 60. { 61. this.page = page; 62. } 63. 64. //@JSON(serialize=false) 65. public int getTotal() 66. { 67. return total; 68. } 69. 70. public void setTotal(int total) 71. { 72. this.total = total; 73. } 74. 75. //@JSON(serialize=false) 76. public int getRows() 77. { 78. return rows; 79. } 80. 81. public void setRows(int rows) 82. { 83. this.rows = rows; 84. } 85. 86. public List getDataRows() 87. { 88. return dataRows; 89. }

92


90. 91. public void setDataRows(List dataRows) 92. { 93. this.dataRows = dataRows; 94. } 95. 96. 97. }

返回的 json 数据格式：

Java 代码

1. {"dataRows":

[{"password":"123","age":20,"address":"USA","username":"王

三","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}

11:43

浏览 (329)

使用 jqGrid 修改数据并检查

文章分类:Web 前端

93

http://www.javaeye.com/blogs/category/web

http://konglx.javaeye.com/blog/692472



jqGrid 可以有三种方式，让我们来修改显示在 jqGrid 中的数据。这三种方式分

别是：

Cell Editing——只允许修改某一个单元格内容.（所有图片均来自 jqGrid 的

wiki或者 jqGrid 的 Demo截图）

Inline Editing——允许在 jqGrid 中直接修改某一行的数据

Form Editing——弹出一个新的编辑窗口进行编辑和新增

94


暂时先不管这三种方式，我们来看看如何让一个 jqGrid 的数据能够进行编辑呢？

其实很简单，就是在 jqGrid 的 colModel 属性中，设置几个属性：

editable

可选值是 true或者 false，默认是 false。用来说明这个列的数据是否可编辑

特别要注意的是，jqGrid 的隐藏字段就算设置了这个属性为 true，一样不能被

编辑。在 Cell Editing 以及 Inline Editing模式下，只能通过把这些字段设置为

可见来修改。在 Form Editing模式下，可以通过 editoptions 参数来设置是否

可以修改隐藏列。

edittype

可选的值是'text', 'textarea', 'select', 'checkbox', 'password',

'button', 'image', 'file'以及'custom'。默认值是 text。

根据名字就可以看出来，这个属性是设置编辑框的 HTML样式的。比如，设

置为 text 值，并且可以在 editoptions 中设置 size 以及 maxlength等属性。

这样生成的 HTML样式有点类似<input type="text" size="10"

maxlength="15"/>这样。

95


其中有几个要注意：

设置 checkbox 的时候，需要在 editoptions 中指定 value 值，第一个值应

该是 checked 的时候的值。比如 editoptions:{value:"Yes:No"}会设定这个

checkbox 编辑框，选中的时候，值是 Yes，没选中的时候值是 No。建议最好

都设定一下这个值。

设置 select 的时候，editoptions 中需要设定 select 下拉框的值。

一种方式是用字符串设置 editoptions 的 value 属性，像这样

editoption: { value: “FE:FedEx; IN:InTime; TN:TNT” }，这就为下拉框设

置了三个可选值。注意，冒号前面的代表的是值，冒号后面代表的是显示值。

第二种方式是用对象来设置 editoptions 的 value 属性，这个时候，

value 值要用{}包括起来，像这样： editoptions:{value:

{1:'One',2:'Two'}}。

第三种方式，是为 editoptions 设置 dataUrl 参数。意思就是 select 的值

是通过一个 URL 来获取的，比如一个 Ajax 请求的返回值。特别需要注意的是，

在这种情况下，URL 的返回值必须是包括 select 以及 option 这些 HTML标签

的。就像这样：<select><option value="1">One</option><option

value="2">Two</option></select>.这种情况下，还可以在 editoptions

中设置是否允许多选，size等等。

设置 image 的时候，editoptions 的 src 属性用来指定图片的地址。

custom 类型就是通过一个函数来指定需要编辑的元素，并返回需要提交的

值。

函数的定义在 editoptions 中说明，分别是 custom_element 用来指定

96


哪一个函数用来创建编辑框，注意这里函数必须返回一个新的 DOM元素，函

数的参数一个是值 Value，另外一个是 colModel 的 editoptions 值。

另外一个是 custom_value，这个函数用来在编辑完成之后返回本编辑

框的值，这个函数的参数是元素对象。大概的调用格式如下：

<script>

//创建一个 input输入框

function myelem (value, options) { var el = document.createElement("input"); el.type="text"; el.value = value; return el; }

//获取值

function myvalue(elem) { return $(elem).val(); } jQuery("#grid_id").jqGrid({ ... colModel: [ ... {name:'price', ..., editable:true, edittype:'custom', editoptions:{custom_element: myelem, custom_value:myvalue} }, ... ] ... }); </script>

editoptions

除了上面介绍的 editoptions选项外，我们还可以设置 defaultValue等等，

更复杂的东西，比如 dataEvents 就不介绍了。

editrules

editrules 是用来设置一些可用于可编辑列的 colModel 的额外属性的。大多

97


数的时候是用来在提交到服务器之前验证用户的输入合法性的。比如 editrules:

{edithidden:true, required:true....}。

可选的属性包括：

edithidden：只在 Form Editing模式下有效，设置为 true，就可以让隐

藏字段也可以修改。

required：设置编辑的时候是否可以为空（是否是必须的）。

number：设置为 true，如果输入值不是数字或者为空，则会报错。

integer：

minValue：

maxValue：

email：

url：检查是不是合法的 URL地址。

date：

time：

custom：设置为 true，则会通过一个自定义的 js函数来验证。函数定义在

custom_func 中。

custom_func:传递给函数的值一个是需要验证 value，另一个是定义在

colModel 中的 name 属性值。函数必须返回一个数组，一个是验证的结果，

true或者 false，另外一个是验证错误时候的提示字符串。形如[false,”Please

enter valid value”]这样。

自定义验证的例子：

<script> function mypricecheck(value, colname) {

98


if (value < 0 && value >20) return [false,"Please enter value between 0 and 20"]; else return [true,""]; }

jQuery("#grid_id").jqGrid({ ... colModel: [ ... {name:'price', ..., editrules:{custom:true, custom_func:mypricecheck....}, editable:true }, ... ] ... }); </script> < function mypricecheck(value, colname) { if (value < 0 && value >20) return [false,"Please enter value between 0 and 20"]; else return [true,""]; } jQuery("#grid_id").jqGrid({ ... colModel: [ ... {name:'price', ..., editrules:{custom:true, custom_func:mypricecheck....}, editable:true }, ... ] ... }); // >

formoptions（只在 Form Editing 方式下有效），他的主要作用是用来重

新排序 Form 中的编辑元素，同时可以在编辑元素前或者编辑元素后增加一些

信息（比如，一些提示信息，或者一个红色的*表示必须要填写等等）。

可选的属性如下：

elmprefix：字符串值，如果设置了，则会在编辑框之后出现一些内容(可能

是 HTML 的内容)

elmsuffix：字符串值，如果设置了，则会在编辑框之前出现一些内容(可能

是 HTML 的内容)

label：字符串值，如果设置了，则这个值会替换掉 colNames 中的值出现

作为该编辑框的标签显示

rowpos：数字值，决定元素行在 Form 中的位置（相对于文本标签 again

99


with the text-label）

colpos：数字值，决定元素列在 Form 中的位置（相对于标签 again with

the label）

两个编辑框可以有相同的 rowpos 值，但是 colpos 值不同，这会把这两个

编辑框放到 Form 的同一行中。

特别注意：如果设置了 rowpos 以及 colpos 的值，强烈推荐为所有的其他

编辑元素都设置这些值。

100

Documents

JqGrid3.6 Cn