ExtJs Grid相关组件及属性

 

Ext.grid.GridPanel
主要配置项：
store：表格的数据集
columns：表格列模式的配置数组，可自动创建ColumnModel列模式
autoExpandColumn：自动充满表格未用空间的列，参数为列id，该id不能为0
stripeRows：表格是否隔行换色，默认为false
cm、colModel：表格的列模式，渲染表格时必须设置该配置项
sm、selModel：表格的选择模式，默认为Ext.grid.RowSelectionModel
enableHdMenu：是否显示表头的上下文菜单，默认为true
enableColumnHide：是否允许通过标题中的上下文菜单隐藏列，默认为true
loadMask：是否在加载数据时显示遮罩效果，默认为false
view：表格视图，默认为Ext.grid.GridView
viewConfig：表格视图的配置对象
autoExpandMax：自动扩充列的最大宽度，默认为1000
autoExpandMin：自动扩充列的最小宽度，默认为50
columnLines：是否显示列分割线，默认为false
disableSelection：是否禁止行选择，默认为false
enableColumnMove：是否允许拖放列，默认为true
enableColumnResize：是否允许改变列宽，默认为true
hideHeaders：是否隐藏表头，默认为false
maxHeight：最大高度
minColumnWidth：最小列宽，默认为25
trackMouseOver：是否高亮显示鼠标所在的行，默认为true

主要方法：
getColumnModel()：取得列模式
getSelectionModel()：取得选择模式
getStore()：取得数据集
getView()：取得视图对象
reconfigure( Ext.data.Store store, Ext.grid.ColumnModel colModel )：使用一个新的数据集和列模式重新配置表格组件

Ext.grid.Column
主要配置项：
id：列id
header：表头文字
dataIndex：设置列与数据集中数据记录的对应关系，值为数据记录中的字段名称。如果没有设置该项则使用列索引与数据记录中字段的索引进行对应
width：列宽
align：列数据的对齐方式
hidden：是否隐藏列，默认为false
fixed：是否固定列宽，默认为false
menuDisabled：是否禁用列的上下文菜单，默认为false
resizable：是否允许改变列宽，默认为true
sortable：是否允许排序，默认为true
renderer：设置列的自定义单元格渲染函数
传入函数的参数有：
value：数据的原始值
metadata：元数据对象，用于设置单元格的样式和属性，该对象包含的属性有：
css：应用到单元格TD元素上的样式名称
attr：一个HTML属性定义字符串，例如'style="color:blue"'
record：当前数据记录对象
rowIndex：单元格的行索引
colIndex：单元格的列索引
store：数据集对象
xtype：列渲染器类型，默认为gridcolumn，其它可选值有booleancolumn、numbercolumn、datecolumn、templatecolumn等
editable：是否可编辑，默认为true
editor：编辑器
groupName：
emptyGroupText：
groupable：

Ext.grid.ColumnModel
主要配置项：
columns：字段数组
defaultSortable：是否进行默认排序，默认为false
defaultWidth：默认宽度

主要方法：
findColumnIndex( String col )：根据给定的dataIndex查找列索引
getColumnById( String id )：取得指定id对应的列
getColumnCount( Boolean visibleOnly )：取得列总数
getColumnHeader( Number col )：取得列的表头
getColumnId( Number index )：取得列id
getDataIndex( Number col )：取得列对应的数据字段名
getIndexById( String id )：取得列索引
getTotalWidth( Boolean includeHidden )
isCellEditable( Number colIndex, Number rowIndex )
isFixed()
isHidden( Number colIndex )
setColumnHeader( Number col, String header )
setColumnWidth( Number col, Number width, Boolean suppressEvent )
setDataIndex( Number col, String dataIndex )
setEditable( Number col, Boolean editable )
setEditor( Number col, Object editor )
setHidden( Number colIndex, Boolean hidden )
setRenderer( Number col, Function fn )

Ext.grid.AbstractSelectionModel
主要方法：
lock()：锁定选择区域
unlock()：解锁选择区域
isLocked()：当前选择区域是否被锁定

Ext.grid.CellSelectionModel
主要方法：
clearSelections( Boolean preventNotify )：清除选择区域
getSelectedCell()：取得当前选择的单元格，返回一数组，其格式：[rowIndex, colIndex]
hasSelection()：当前是否有选择区域
select( Number rowIndex, Number colIndex, [Boolean preventViewNotify], [Boolean preventFocus], [Ext.data.Record r] )：选择指定单元格

Ext.grid.RowSelectionModel
主要配置项：
singleSelect：是否单选模式，默认为false，即可以选择多条数据

主要方法：
clearSelections( [Boolean fast] )：清除所有选择区域
deselectRange( Number startRow, Number endRow )：取消范围内的行选择
deselectRow( Number row, [Boolean preventViewNotify] )：取消指定行的选择状态
each( Function fn, [Object scope] )：遍历所有选择行，并调用指定函数。当前被选行将传入该函数中
getCount()：得到选择的总行数
getSelected()：得到第一个被选记录
getSelections()：得到所有被选记录的数组
hasNext()：判断当前被选行之后是否还有记录可以选择
hasPrevious()：判断当前被选行之前是否还有记录可以选择
hasSelection()：是否已选择了数据
isIdSelected( String id )：判断指定id的记录是否被选择
isSelected( Number/Record index )：判断指定记录或记录索引的数据是否被选择
selectAll()：选择所有行
selectFirstRow()：选择第一行
selectLastRow( [Boolean keepExisting] )：选择最后行
keepExisting：是否保持已有的选择
selectNext( [Boolean keepExisting] )：选择当前选择行的下一行
selectPrevious( [Boolean keepExisting] )：选择当前选择行的上一行
selectRange( Number startRow, Number endRow, [Boolean keepExisting] )：选择范围内的所有行
selectRecords( Array records, [Boolean keepExisting] )：选择一组指定记录
selectRow( Number row, [Boolean keepExisting], [Boolean preventViewNotify] )：选择一行
row：行索引
selectRows( Array rows, [Boolean keepExisting] )：选择多行
rows：行索引数组

Ext.grid.CheckboxSelectionModel
主要配置项：
singleSelect：是否单选模式，默认为false，即可以选择多条数据
checkOnly：是否只能通过点击checkbox列进行选择，默认为false
sortable：是否允许checkbox列排序，默认为false
width：checkbox列的宽度，默认为20

Ext.grid.RowNumberer
主要配置项：
header：行号列表头显示的内容
width：列宽，默认为23

Ext.grid.GridView
主要配置项：
enableRowBody：是否包含行体
sortAscText：表格标题菜单中升序的文字描述
sortDescText：表格标题菜单中降序的文字描述
columnsText：表格标题菜单中列对应的文字描述
autoFill：是否自动扩展列以充满整个表格，默认为false
forceFit：是否强制调整表格列宽以适用表格的整体宽度，防止出现水平滚动条，默认为false

主要方法：
focusCell( Number row, Number col )：将焦点移到指定单元格
focusRow( Number row )：将焦点移动指定行
getCell( Number row, Number col )：取得指定单元格对应的td元素
getHeaderCell( Number index )：取得指定表头对应的td元素
getRow( Number index )：取得指定行对应的tr元素
getRowClass( Record record, Number index, Object rowParams, Store store )：得到附加到表格行上的样式名
record：当前行的数据记录对象
index：当前行的索引
rowParams：渲染时传入到行模板中的配置对象，通过它可以为行体定制样式，该对象只在enableRowBody为true时才生效，可能的属性如下：
body：渲染到行体中的HTML代码片段
bodyStyle：应用到行体tr元素style属性的字符串
cols：应用到行体td元素colspan属性的值，默认为总列数
store：表格数据集
refresh( [Boolean headersToo] )：刷新表格组件
scrollToTop()：滚动表格到顶端

Ext.grid.EditorGridPanel
主要配置项：

clicksToEdit：设置点击单元格进入编辑模式的点击次数，默认为2
autoEncode：是否自动编码/解码HTML内容，默认为false
selModel：默认为Ext.grid.CellSelectionModel

主要方法：
startEditing( Number rowIndex, Number colIndex )：开始编辑指定单元格
stopEditing( [Boolean cancel] )：结束编辑操作

Ext.grid.GroupingView
主要配置项：
enableGroupingMenu：是否在表头菜单中进行分组控制，默认为true
groupByText：表头菜单中分组控制的菜单文字，默认为'Group By This Field'
enableNoGroups：是否允许用户关闭分组功能，默认为true
showGroupsText：在表头菜单中启用分组和禁用分组的菜单文字，默认为'Show in Groups'
groupTextTpl：用于渲染分组信息的模板，默认为'{text}'，常用的可选值有：
text：列标题:组字段值
gvalue：组字段的值
startRow：组行索引
enableGrouping：是否对数据分组，默认为true
hideGroupedColumn：是否隐藏分组列，默认为false
ignoreAdd：在向表格中添加数据时是否刷新表格，默认为false
showGroupName：是否在分组行上显示分组字段的名字，默认为true
startCollapsed：初次显示时分组是否处于收缩状态，默认为false

主要方法：
collapseAllGroups()：收缩所有分组行
expandAllGroups()：展开所有分组行
getGroupId( String value )：根据分组字段值取得组id
toggleAllGroups( [Boolean expanded] )：切换所有分组行的展开或收缩状态
toggleGroup( String groupId, [Boolean expanded] )：切换指定分组行的展开或收缩状态

Ext.data.GroupingStore
groupField：分组字段
groupOnSort：是否在分组字段上排序，默认为false
remoteGroup：是否远程分组数据，默认为false。如果是远程分组数据，则通过groupBy参数发送分组字段名