全称 mx.datacontrols.DataGrid
命名空间 mx.datacontrols
DataGrid
继承层次结构 DataGridPagedControlControl
源文件 ~\mx\scripts\datacontrols\DataGrid.js
提供一个显示数据表格的控件。

示例 1

以下为 DataGrid 的示例。
JavaScript 代码
var dataGrid = new mx.datacontrols.DataGrid({ baseUrl: "http://bruce-pc:8892/mx/rest/getData" });

示例 2

以下为 DataGrid 的示例。说明了如何创建一个带查询框的表格。
JavaScript 代码
//创建一个带查询框的表格,查询框有姓名,学校,学院,性别四个查询条件,其中性别查询条件为下拉框。 var dataGrid = new mx.datacontrols.DataGrid({ baseUrl: "http://bruce-pc:8892/mx/rest/getData", searchBox: { initHidden: false, fields: [ { name: "name", caption: "姓名" }, { name: "school", caption: "学校" }, { name: "xueyuan", caption: "学院" }, { name: "sex", caption: "性别" , editorType: "DropDownEditor" } ] } });

示例 3

以下为 DataGrid 的示例。说明了如何创建一个每页10条数据,列允许排序,第一列显示 CheckBox,不显示表格列分割线的表格
JavaScript 代码
//创建一个每页10条数据,列允许排序,第一列显示 CheckBox,不显示表格列分割线的表格。 var dataGrid = new mx.datacontrols.DataGrid({ baseUrl: "http://bruce-pc:8892/mx/rest/getData", displayColSplitLine: false,//不显示表格列分割线 pageSize: 10,//每页10条数据 height:"80%", allowSorting:true,//列允许排序 displayCheckBox:true,//第一列显示 CheckBox columns: [ { name: "name", caption: "姓名", width:150, align:"right", dataAlign:"center" }, { name: "school", caption: "学校" }, { name: "xueyuan", caption: "学院" } ] });

示例 4

以下为 DataGrid 的示例。说明了如何创建一个个性化列头的表格。
JavaScript 代码
//创建一个姓名列列头标题靠右显示,数据居中显示的表格,宽度为150px。 var dataGrid = new mx.datacontrols.DataGrid({ baseUrl: "http://bruce-pc:8892/mx/rest/getData", columns: [ { name: "name", caption: "姓名", width:150, align:"right", dataAlign:"center" }, { name: "school", caption: "学校" }, { name: "xueyuan", caption: "学院" } ] });

示例 5

以下为 DataGrid 的示例。说明了如何创建一个可编辑的表格,并且自定义渲染单元格。
JavaScript 代码
//创建一个可编辑的表格,性别列的值为“1”时,显示为“男”,否则显示为“女”。并且性别列进行编辑时显示为下拉框。其他默认为文本框。 var sexData = [ { text: "男", value: "1" }, { text: "女", value: "2" } ]; var dataGrid = new mx.datacontrols.DataGrid({ baseUrl: "http://bruce-pc:8892/mx/rest/getData", allowEditing: true, columns: [ { name: "name", caption: "姓名", width:150, align:"right", dataAlign:"center" }, { name: "school", caption: "学校" }, { name: "xueyuan", caption: "学院" }, { name: "sex", caption: "性别", width:"auto", renderCell: function(p_item, $p_cell) { var value = null; if (parseInt(p_item.getValue("sex")) == 1) { value = "男"; } else { value = "女"; } $p_cell.text(value); }, editorType: "DropDownEditor", editorOptions: {items: sexData} } ] });

构造函数

名称 说明
DataGrid() 构建 DataGrid 类的新实例。

初始化函数

名称 说明
init()

方法

名称 说明
appendColumn(p_column) DataGridcolumns 集合中添加一个列,并返回表示该列的 DataGridColumn 对象。
appendColumn(p_name, p_caption, [p_width], [p_align]) DataGridcolumns 集合中添加一个列,并返回表示该列的 DataGridColumn 对象。
appendColumns(p_columns) DataGridcolumns 集合中添加一组列。
appendItem(p_item) EntityContainer 请求添加一行数据,成功后再调用 {@link me._appendItem} 方法。
checkAll() 将所有的数据项设为选中状态。
clearCacheAdjust() 清除本地用户的调整缓存。
clearColumns() columns 集合中移除所有列。
clearEditor() 编辑状态下,清除编辑器 {@exculde mx.datacontrols.ScrollLoadGrid}
clearItems() items 集合中移除所有数据项。仅仅操作了当前页的dom对象,EntityContainer数据未变化。 若要从 DataGrid 中移除单个数据项,请使用 removeItem 方法。
contains($p_target) 返回一个 Boolean 值,该值表示控件的容器中是否包含该 JQuery 对象。
deselectAll([p_triggerEvent]) 清除对 DataGrid 当前的选中项的选定。使用该方法后,selection 字段变为空。
deselectItem(p_item, [p_triggerEvent]) 清除对 DataGrid 中指定项的选定。该方法只有当指定项与 selection 字段相同时,才有效。
dispose() 释放对象运行时动态生成的内容(属性、方法、事件)。
exportExcel([p_exportHandler], [p_params]) 将表格数据导出为 Excel 表格。
getCheckedIDs() 获取所有选中项的 ID 的集合。
getCheckedItems() 获取所有选中的数据项集合。
getColumnEditors() 获取表格列上定义的编辑器集合 HashMap
getContext() 获取控件当前所属 Weblet 的上下文信息( WebletContext 类型)。
getEl() 获取控件容器对应的 HTML DOM 元素对象。
getFirstItemIndex() 获取当前页第一条数据的索引值。
getPageCount() 获取当前的总页数。
hasChanged() 提供一个方法,判断表单是否有修改过但未保存的信息。
hide() 隐藏控件,设置控件不可见。
insertColumn(p_position, p_column, p_direction) 在指定位置插入列。
insertColumnAfter(p_position, p_column) 在指定位置后插入列。
insertColumnBefore(p_position, p_column) 在指定位置前插入列。
insertItem(p_row, p_item) 在指定行后插入一个数据项,并返回数据实体。
isEditorLocked() 判断当前激活编辑器是否是锁定的。如果是true则是锁定状态,反之是未锁定 当编辑处于锁定状态,将会一直保持在其对应的单元格上,直到解锁为止
isFirstPage() 获取一个 Boolean 值,表示当前是否是第一页。
isLastPage() 获取一个 Boolean 值,表示当前是否是最后一页。
load([p_data], [p_callback]) EntityContainer 加载数据。
lockEditor() 锁定当前激活的编辑器,如果返回true表示锁定成功,反之锁定失败
markError(p_itemId, p_colName, p_value, p_msg) 提供一个方法,给指定单元格上标记错误。 @param p_itemId 一个字符串,表示单元格所行的 id @param p_colName 一个字符串,表示单元格所在列的列标题。 @param p_value 一个 Boolean 值,true 时标记错误,false 时取消标记。 @param p_msg 一个字符串,表示提示信息,p_value 为 false 时,可以不传值。
moveDown(p_needSelectedTip) 提供下移勾选行的方法,如果没有勾选行,则下移当前选中行。
moveItem(p_item, p_index) 将指定的数据项移动到指定的索引位置。也可以使用 DataGridItemDataGridItem.moveToDataGridItem.moveUpDataGridItem.moveDown 方法。
moveTo(p_left, p_top) 移动控件到指定位置。@param p_left 一个数字,表示 css 样式的 left 属性。 @param p_top 一个数字,表示 css 样式的 top 属性。
moveToFirstPage() 跳转到第一页。
moveToLastPage() 跳转到最后一页。
moveToNextPage() 跳转到下一页。
moveToPage(p_index) 跳转到某一页。@param p_index 一个 Number 值,表示要跳转到第几页。
moveToPreviousPage() 跳转到前一页。
moveUp(p_needSelectedTip) 提供上移勾选行的方法,如果没有勾选行,则上移当前选中行。
printGrid(p_preview) 提供一个方法,打印表格内容。@param p_preview : true | false 一个 Boolean 值,表示是否启用打印预览功能,默认 true true : 表示显示打印预览 false : 表示不显示打印预览,直接打印
removeColumn(p_column) columns 集合中移除指定的 DataGridColumn 对象。 若要从列表中移除所有列,请使用 clearColumns 方法。
removeItem(p_item, [p_callback]) EntityContainer 请求删除一行数据,成功后再调用 removeItem 方法。
removeItems(p_items, [p_callback], [p_isReload]) EntityContainer 请求删除数据,成功后再调用 removeItem 方法。
resizeTo(p_width, p_height) 重设控件的大小。@param p_width 控件的宽度,可以是数字(如 100),也可以是字符串(如 “100%”)。 @param p_height 控件的高度,可以是数字(如 100),也可以是字符串(如 “100%”)。
save([p_data], [p_callback]) EntityContainer 请求保存数据。
selectAll([p_triggerEvent]) 设置选中所有项。
selectItem(p_item, [p_triggerEvent]) 选择 DataGrid 列表中的指定的数据项。
selectNextItem() 选中当前选中项的下一个数据项。如果当前没有选中项,则选中第一个数据项;如果当前的选中项是最后一项,则不做任何改变。
selectPreviousItem() 选中当前选中项的前一个数据项。如果当前没有选中项或选中项是第一个,则不做任何改变。
setAllowEditing(p_editing) 设置是否可编辑 allowEditing
setBorder(p_border) 设置控件的边框样式。@param p_border 一个字符串,表示css样式的 border 属性。
setBottom(p_bottom) 设置 bottom 字段的值。@param p_bottom 控件的下边界与父容器下边界的像素距离,可以是数字(如 50),也可以是字符串(如 50%)。
setColumns(p_columns) 设置 columns 字段的值。该方法首先会清空 columns 集合。
setCss(p_css) 设置 css 字段的值。 @param p_css 一个 JSON 对象,表示控件的 CSS 样式。
setCssClass(p_cssClass) 设置 cssClass 字段的值 @param p_cssClass 一个String 对象,样式classname
setDisplay(p_display) 设置 display 字段的值。@param p_display css 样式的 display 属性。
setDisplayCheckBox(p_displayCheckBox) 设置 displayCheckBox 的字段值。
setDisplayColSplitLine(p_displayColSplitLine) 设置 displayColSplitLine 的字段值。
setDisplayHead(p_displayHead) 设置 displayHead 的字段值。
setDisplayRowNumber(p_displayRowNumber) 设置 displayRowNumber 的字段值。 此方法只在构造参数中高displayRowNumber为true时有效
setDisplayStatisticRow(p_displayStatisticRow) 设置 displayStatisticRow 的字段值。
setEnableCellTip(p_enableCellTip) 设置 enableCellTip 的字段值。
setEnabled(p_enabled) 设置 enabled 字段的值。
setEntityContainer(p_entityContainer) 设置 entityContainer 的字段值。
setFilter(p_filter, [p_override]) 设置 filter 字段的值
setHeight(p_height) 设置 height 字段的值。 注:子类UploadControl上传控件不支持百分比设置高度 @param p_height 控件的高度,可以是数字(如 100),也可以是字符串(如 “100%”)。
setItemEnabled(p_id, p_enabled) 设置 DataGrid 的某一行是否可编辑 p_id DataGridItem 的 id 或是其的索引值 p_enabled 一个布尔值,true 代表可编辑,false 代表不可编辑
setItems(p_items) 设置 items 字段的值。该方法首先会清空 items 集合。
setLeft(p_left) 设置 left 字段的值。 @param p_left 控件的左边界与父容器左边界的像素距离,可以是数字(如 50),也可以是字符串(如 50%)。
setPageSize(p_pageSize) 设置 pageSize 字段的值。同时跳转到第一页。@param p_pageSize 一个 Number 值,表示每页可以显示的记录数。
setPosition(p_position) 设置 position 字段的值。@param p_position 一个字符串,表示 css 样式的 position 属性。
setRight(p_right) 设置 right 字段的值。@param p_right 控件的右边界与父容器右边界的像素距离,可以是数字(如 50),也可以是字符串(如 50%)。
setSearchBox(p_searchBox) 设置DataGrid的DataGridSearchBox控件
setTop(p_top) 设置 top 字段的值。 @param p_top 控件的上边界与父容器上边界的像素距离,可以是数字(如 50),也可以是字符串(如 50%)。
setVisible(p_visible) 设置 visible 字段的值。@param p_visible 一个 Boolean 值,表示控件是否可见。
setWidth(p_width) 设置 width 字段的值。@param p_width 控件的高度,可以是数字(如 500)、字符串(如“500px”或“50%”).
show() 显示控件,设置控件可见。
showImportExcelWizard([p_windowManager], [p_url], [p_callback]) 打开导入 Excel 表格的向导窗口,并返回该向导。
sort(p_column, [p_order]) 将指定列的数据项进行排序。
sorts(p_columns, p_order) 将指定多列的数据项进行排序。
uncheckAll() 将所有的数据项设为未选中状态。
unLockEditor() 解除对当前编辑器的锁定
validate() 不提供默认校验逻辑,允许自定义扩展。 返回值格式为 {successful: true|false, hint: "校验提示信息"}
$(p_expression) 该方法与 me.$e.find(p_expression) 等同。
$wrap([p_obj]) 返回一个 JQuery 对象。
_getEditingNextCell(p_arg, v) 受保护的。

字段

名称 说明
activeEditor 获取当前表格激活的编辑器,如果没有,返回null
alias 获取或设置一个字符串,表示控件的别名。
allowAdjusting 获取或设置一个 Boolean 值,该值表示是否可以调整 DataGrid 控件中列的宽度。如果该值为 true,表示可以调整;反之则不可以。
allowDraggingColumn 获取或设置一个 Boolean 值,该值表示是否可以调整 DataGrid 控件中的列头的顺序。如果该值为 true,表示可以调整;反之则不可以。 allowDraggingColumn在设置false的同时要设置allowDraging为false才可以使列头顺序不能拖动,只要有一个为true,列头的顺序就是可以改变的。
allowDraggingItem 获取或设置一个 Boolean 值,该值表示是否可以拖动 {@link mx.datacontrols.DataGrid.DataGridItem} 项。@default true
allowDraging 获取或设置一个 Boolean 值,该值表示是否可以调整 DataGrid 控件中列的宽度。如果该值为 true,表示可以调整;反之则不可以。 该属性和 allowDraggingColumn 属性意义相同。 allowDraging在设置false的同时要设置me.allowDraggingColumn为false才可以使列头顺序不能拖动,只要有一个为true,列头的顺序就是可以改变的。 @default true
allowEditing 获取一个 Boolean 值,表示表格控件是否允许编辑。
allowInterlacedRow 获取或设置一个 Boolean 值,表示表格是否要隔行变色。
allowMultipleSorting 获取或设置一个 Boolean 值,表示是否允许多列排序。
allowPaging 获取和设置一个 Boolean 值,表示是否可以分页。
allowSorting 获取或设置一个 Boolean 值,表示所有列是否允许排序。
autoSelect 获取或设置一个值,表示当列表中没有选中项的时候,是否自动选择第一个数据项。如果该值为 true,则自动选择;反之则不自动选择。@default false
autoWrap 获取或设置表格数据行是否自动换行。 该属性仅在 DataGridGroupHeaderGrid可用。
baseUrl 请参见 EntityContainer.baseUrl 属性。如果 DataGrid 的 entityContainer 由外界创建,那么该属性不需要设置; 否则只有当entityContainer 属性对应的数据容器对象的type属性值为local时,可以不需要设置该属性,其它情况下必须设置。
border 获取控件的边框样式。如“1px solid red”,表示边框的样式为 1 像素红色的实线。请使用 setBorder 方法设置该字段的值。
bottom 获取控件的下边界与父容器下边界的像素距离。请使用 setBottom 方法设置该字段的值。
cacheAdjust 获取或设置 Boolean 值,表示是否在本地缓存用户对于列宽度、顺序、显示的调整。开启该功能时,请设置cacheAdjustPrefixalias属性值。
cacheAdjustPrefix 获取或设置 一个字符串,表示本地缓存用户对于列宽度、顺序、显示的调整时存储时的key前缀,完整的key由cacheAdjustPrefix与alias拼接而成以确保唯一性。
columns 获取和设置一个集合,用于创建含控件中显示的所有 DataGridColumn
contextMenu 一个 ContextMenu 对象,表示控件的右键菜单。
cssClass 指定css伪类名称,设置控件显示样式
display 获取控件的显示样式值。如“none”,表示隐藏控件; “block”表示强制作为块对象呈递。请使用 setDisplay方法设置该字段的值。
displayCheckBox 获取或设置一个 Boolean 值,该值表示数据项之前是否显示一个选择框。如果该值为 true,则表示显示;反之则不显示。请使用 setDisplayCheckBox 方法设置该字段的值。
displayColSplitLine 获取一个 Boolean 值,表示是否显示列的分割线。
displayHead 获取一个 Boolean 值,表示是否显示列头。请使用 setDisplayHead 方法设置该字段的值。
displayPrimaryKey 获取或设置一个 Boolean 值,该值表示是否显示主键列。
displayRowNumber 获取或设置一个 Boolean 值,该值表示数据项之前是否显示行号。如果该值为 true,则表示显示;反之则不显示。请使用 setDisplayRowNumber 方法设置该字段的值。
displayStatisticRow 获取或设置一个 Boolean 值,该值表示表格是否显示统计行。如果该值为 true,则表示显示;反之则不显示。 请使用 setDisplayStatisticRow 方法设置该字段的值。 如果需要设置某列的统计值,请使用 DataGridColumn.setStatisticValue 方法,或者使用 DataGridColumn.statisticValue 属性设置初始统计值。
editOnSelected 获取或设置一个 Boolean 值,表示表格是否使用选中后编辑。
enableBrowserContextMenu 获取或初始化设置是否允许浏览器默认的上下文菜单。
enableCellTip 获取一个 Boolean 值,表示是否显示titile属性。请使用 setEnableCellTip 方法设置该字段的值。
enabled 获取控件是否可以对用户交互作出响应。如果该值为 true,则表示控件可以对用户交互作出响应;反之则不能。 请使用 setEnabled 方法设置该字段的值。@default true
enableEditingPageSize 设置一个 Boolean 值,在allowPaging添加分页控件情况下,表示是否可编辑分页控件pageSize编辑框。
enableHeadContextMenu 一个布尔值,指示是否启用表头上下文菜单
entityContainer 获取一个 EntityContainer 对象(通常是 GridEntityContainer 类型),表示表格的数据源。 请使用 setEntityContainer 方法设置该字段的值。
eTag 获取控件的标签。
filter 获取或设置表格的过滤条件。请使用 setFilter 方法设置该字段的值。该属性是一个字符串或者是一个 JSON 对象,该属性与 searchParamType 属性有关。 当 searchParamType 属性为 string 时,该属性是字符串或者 JSON 对象,例如:"name='jacky'&age=23" 或者 {name: "jacky", age: 23}, 此时 DataGrid 执行简单查询; 当 searchParamType 属性为 json 时,该属性是 JSON 对象, 该 JSON 对象必须遵循高级查询格式规范, 例如: {criterions: [ {fieldName: "age", value: 18, operator: ">"}, {fieldName: "age", value: 60, operator: "<"} ], junction: "and", columnJunction: "and"} 表示对属性名为 “age” 的列设置过滤条件: 18 < age < 60。
hasPrimaryKey 获取或设置一个属性,用于声明是否有主键,若声明为无主键,则使用appendItem时数据有可能重复添加
headContextMenu 一个 ContextMenu 对象,表示表头的右键菜单。
height 参见 ControlControl.height 属性。
importExcelOptions 获取或设置解析文件的范围。 一个 JSON 对象(如 {horizontalBegin : 1, horizontalEnd : 0, verticalBegin : 1, verticalEnd : 0, sheetNumber : 1, separatorNum : 0}; )

参数说明。

  • horizontalBegin : 开始行,默认值 1
  • horizontalEnd : 结束行,默认值 0,表示不设置结束行
  • verticalBegin : 开始列,默认值 1
  • verticalEnd : 结束列,默认值 0,表示不设置结束列
  • sheetNumber : 解析excel的第几个sheet页,默认值 1
  • separatorNum : 解析真正数据行,默认是为0,即从表头下面一行开始解析。
  • saveByDefault : 一个 boolean 值,默认是 true,表示选择 Excel 后,点击下一步是否直接保存。
  • parseExcelCallBack : 一个函数对象,表示服务端解析 Excel 后,处理返回数据的回调函数。
itemCount 获取一个 Number值,表示当前的总记录数。@default 0
itemMenu 一个 ContextMenu 对象,表示数据项的右键菜单。
items 获取一个集合,包含数据项列表中所有的项(DataGridItem 类型)。请使用 setItems 方法设置该字段的值。
layoutConfigs 获取或者设置一个 JSON 对象,该属性表示控件在父容器中的布局配置参数。该属性只有在控件父容器运用布局器才会生效。
lazyRender 设置表格是否延迟渲染
lazyRenderSize 设置表格延迟渲染时,每次渲染的数据大小,如果同时需要分页,请设置pageSize的值为该属性值得整数倍。
left 获取控件的左边界与父容器左边界的像素距离。请使用 setLeft 方法设置该字段的值。
maxTitleLength 获取单元格title最大字符。
moveByShortcutKey 获取或设置一个 Boolean 值,表示是否使用向上快捷键(ctrl+↑)或向下快捷键(ctrl+↓)移动表格行。@default false
multipleSortColumns 获取或设置一个字符串,表示需要多列排序的列名称(如“age,gender,name”),以逗号分隔,排序顺序为从左向右。
pageIndex 在数据创建中调用,加入这个处理是因为,如果在创建数据的过程中要先清理掉当前表格的编辑状态。 如果清除编辑器出错,则中止新数据的创建过程,如果不清除,由于_editingItem没有切换,可能会造成在调用renderCell时,渲染出错的情况
pageNaviBar 获取一个 PageNaviBar 对象。 表示当前 DataGrid 的分页工具条。
pageSize 获取和设置一个 Number 值,表示当前每页允许显示的记录数。@default 20
pageSizeOptions 获取和设置一个数组值,表示分页记录数可设置的选项。
parent 获取控件所属的父对象。
permissionID 获取或设置一个字符串,表示控件的权限标识。
position 获取控件位置样式值。请使用 setPosition 方法设置该字段的值。

该字段的可选值包括:

  • relative
  • absolute

primaryKey 获取或设置一个属性,该属性对应的值将用作 DataGrid 中数据项的 id 值,表示主键唯一值。 此属性必须在初始化控件时设置
printHideFields 是否打印默认隐藏的字段。@default false
right 获取控件的右边界与父容器右边界的像素距离。请使用 setRight 方法设置该字段的值。
rowNumberColCaption 获取或设置序号列的名称。
rowNumberColWidth 获取或设置序号列的宽度。
saveMessage 获取和设置一个字符串,该属性表示表格数据保存成功后的提示信息。当用户设置为空或者空字符串时,保存动作发生后将不提示信息。
searchBox 获取或设置一个 DataGridSearchBox 对象.
searchParamType 获取或设置表格的查询条件类型。json 表示查询参数filter 的值采用 Json 对象的形式传递。string 表示查询参数 filter 的值采用字符串的形式传递。 该字段必须在初始化前设置。

该字段可选的值包括:

  • json
  • string

selection 获取一个对象,表示 DataGrid 中当前选定的数据项(DataGridItem类型)。 该属性特指背景色选中的行所在的数据项。
selections 获取一个集合,表示 DataGrid 中当前选定的所有数据项(DataGridItem类型)的集合。 注意:该数组不是勾选项的集合。如果需要获取勾选项的集合,请使用 {@link getCheckedItems()} 方法。
sortColumn 获取上一次进行排序的列(DataGridColumn 类型)。
sorter 获取或设置一个字符串,表示请求服务时的排序条件。如“NAME ASC, AGE DESC”。
sortOrder 获取或设置一个 Boolean 值,该值表示是否按升序或降序对 DataGrid 控件中的数据项进行排序。如果该值为 true,表示按升序排序;反之则降序。
toEditCellByTabKey 获取或设置一个boolean值,表示是否通过使用tab键来切换编辑的单元格 该属性仅在 DataGridGroupHeaderGrid可用。
top 获取控件的上边界与父容器上边界的像素距离。请使用 setTop 方法设置该字段的值。
typeName 获取当前类型实例的类的类型。
usePercentage 指示是否使用列宽百分比自适应
visible 获取一个 Boolean 值,表示控件是否可见。如果该值为 true,则表示控件可见;反之则不可见。请使用 setVisible 方法设置该字段的值。@default true
width 参见 ControlControl.width 属性。
$e 获取该控件的占位符,该占位符为一个 JQuery 对象。
_editingNextCell 受保护的。

事件

名称 说明
oncelledited 当数据项进行编辑后,将触发该事件。
oncellediting 当数据项进行编辑时,将触发该事件。此时单元格内编辑器尚未创建。
oneditorcreated 当数据项的某个单元格内编辑器被创建激活后,将触发该事件。
oneditorcreating 当数据项的某个单元格内编辑器被创建前,将触发该事件。
onitemchecked 当数据项的选中状态发生改变后,将触发该事件。
onitemclick 当单击列表中项的时候,将触发该事件。
onitemcountchanged 总记录数改变时触发该事件。
onitemcreated 当列表项被创建后,将触发该事件。
onitemdoubleclick 当双击列表中项的时候,将触发该事件
onitemindexchanged 当数据项索引发生改变的时候,将触发该事件。通常调用 moveItemDataGridItem.moveUpDataGridItem.moveDownDataGridItem.moveTo 方法时会触发该事件。
onitemremoved 当列表项被从DOM中删除后,将触发该事件。
onload 当数据加载完后,将触发该事件。
onloading 当数据容器开始加载数据时,将触发该事件。调用 load 方法时会触发该事件。
onpageindexchanged 当前的页面索引变更时触发该事件。调用 moveToPage 方法是触发该事件。
onselectionchanged 当控件当前的选择项发生改变后,将触发该事件。调用 selectItemremoveItemdeselectItem 等方法后会触发该事件。
onselectionchanging 当控件当前的选择项发生改变的时候,将触发该事件。调用 selectItem 方法时会触发该事件。
onvalidate 当数据校验完后,将触发该事件。

构造函数详细信息

DataGrid() 方法

构建 DataGrid 类的新实例。

初始化函数详细信息

init() 方法


方法详细信息

appendColumn(p_column) 方法

DataGridcolumns 集合中添加一个列,并返回表示该列的 DataGridColumn 对象。

参数

示例 1

以下是为 DataGrid 添加一个列的示例。
JavaScript 代码
dataGrid.appendColumn("gender", "性别", "150", "center"); dataGrid.appendColumn({ name: "gender", caption: "性别" }); dataGrid.appendColumn(column); // column 为一个 DataGridColumn 对象

appendColumn(p_name, p_caption, [p_width], [p_align]) 方法

DataGridcolumns 集合中添加一个列,并返回表示该列的 DataGridColumn 对象。

参数

  • p_name
    一个 JSON 对象(如 { name:"class", text:"类", dataType:"string", width:150, align:"center" }),表示 DataGridColumn 的一组属性值;或一个字符串,表示 DataGridColumn 对象的 DataGridColumn.name 字段的值。
  • p_caption
  • p_width
    可选的。一个数字(如 500)或字符串(如“500px”或“50%”),表示列的宽度。
  • p_align
    可选的。一个字符串,表示列中文本的对齐方式。可以为“left”左对齐、“right”右对齐、“center”居中对齐、“justify”两端对齐。

示例 1

以下是为 DataGrid 添加一个列的示例。
JavaScript 代码
dataGrid.appendColumn("gender", "性别", "150", "center"); dataGrid.appendColumn({ name: "gender", caption: "性别" }); dataGrid.appendColumn(column); // column 为一个 DataGridColumn 对象

appendColumns(p_columns) 方法

DataGridcolumns 集合中添加一组列。

参数

  • p_columns
    一个数组,该数组包含了一组 DataGridColumn 对象。

示例 1

以下是为 DataGrid 添加一组 DataGridColumn 的示例。 dataGrid.appendColumns([ { name: "gender", text: "性别" }, { name: "age", text: "年龄" } ]);

appendItem(p_item) 方法

EntityContainer 请求添加一行数据,成功后再调用 {@link me._appendItem} 方法。

参数


checkAll() 方法

将所有的数据项设为选中状态。

clearCacheAdjust() 方法

清除本地用户的调整缓存。

clearColumns() 方法

columns 集合中移除所有列。

clearEditor() 方法

编辑状态下,清除编辑器 {@exculde mx.datacontrols.ScrollLoadGrid}

clearItems() 方法

items 集合中移除所有数据项。仅仅操作了当前页的dom对象,EntityContainer数据未变化。 若要从 DataGrid 中移除单个数据项,请使用 removeItem 方法。

contains($p_target) 方法

返回一个 Boolean 值,该值表示控件的容器中是否包含该 JQuery 对象。

参数

  • $p_target
    一个 JQuery 对象,或 JQuery 选择器对应的字符串(如“#container”),或 HTML DOM 元素。

继承自


deselectAll([p_triggerEvent]) 方法

清除对 DataGrid 当前的选中项的选定。使用该方法后,selection 字段变为空。

参数

  • p_triggerEvent
    可选的。默认值为“true”。一个 Boolean 值,表示是否要触发 onselectionchanged 事件。如果该值为 true,则触发事件;反之则不触发。

deselectItem(p_item, [p_triggerEvent]) 方法

清除对 DataGrid 中指定项的选定。该方法只有当指定项与 selection 字段相同时,才有效。

参数

  • p_item
    一个 DataGridItem 对象,表示要清除对该项的选定。
  • p_triggerEvent
    可选的。默认值为“true”。一个 Boolean 值,表示是否要触发 onselectionchanged 事件。如果该值为 true,则触发事件;反之则不触发。

dispose() 方法

释放对象运行时动态生成的内容(属性、方法、事件)。

继承自


exportExcel([p_exportHandler], [p_params]) 方法

将表格数据导出为 Excel 表格。

参数

  • p_exportHandler
    可选的。一个 ExcelUtil 对象。
  • p_params
    可选的。一个 JSON 对象,请参见 ExcelUtil.params 属性。

示例 1

以下为使用平台默认的 Handler 执行导出 Excel 的示例。
JavaScript 代码
dataGrid.exportExcel({tableName:"uap_bm", columnNames:"BMMC,BMJL", columnCaptions:"部门名称,部门经理", filter:"BMMC='研发中心'", fileName:"部门人员表格"});

示例 2

以下为使用自定义的 Handler 执行导出 Excel 的示例。
JavaScript 代码
var excelHandler = new mx.utils.ExcelUtil(); excelHandler.setBaseUrl("~/customServlet"); excelHandler.setParams({tableName:"uap_bm", columnNames:"BMMC,BMJL", columnCaptions:"部门名称,部门经理", filter:"BMMC='研发中心'", fileName:"部门人员表格"}); excelHandler.exportExcel();

getCheckedIDs() 方法

获取所有选中项的 ID 的集合。

getCheckedItems() 方法

获取所有选中的数据项集合。

getColumnEditors() 方法

获取表格列上定义的编辑器集合 HashMap

getContext() 方法

获取控件当前所属 Weblet 的上下文信息( WebletContext 类型)。

继承自


getEl() 方法

获取控件容器对应的 HTML DOM 元素对象。

继承自


getFirstItemIndex() 方法

获取当前页第一条数据的索引值。

继承自


getPageCount() 方法

获取当前的总页数。

继承自


hasChanged() 方法

提供一个方法,判断表单是否有修改过但未保存的信息。

hide() 方法

隐藏控件,设置控件不可见。

继承自


insertColumn(p_position, p_column, p_direction) 方法

在指定位置插入列。

参数

  • p_position
    表示插入的位置。通常是 DataGridColumn 对象的索引。
  • p_column
    表示待插入的列,是一个 DataGridColumn 对象 或者 JSON对象。
  • p_direction
    一个 Boolean 值,表示插入的方向,为true表示后插入,为false表示前插入。

insertColumnAfter(p_position, p_column) 方法

在指定位置后插入列。

参数

  • p_position
    表示插入的位置。通常是 DataGridColumn 对象的索引。
  • p_column
    表示待插入的列,是一个 DataGridColumn 对象 或者 JSON对象。

insertColumnBefore(p_position, p_column) 方法

在指定位置前插入列。

参数

  • p_position
    表示插入的位置。通常是 DataGridColumn 对象的索引。
  • p_column
    表示待插入的列,是一个 DataGridColumn 对象 或者 JSON对象。

insertItem(p_row, p_item) 方法

在指定行后插入一个数据项,并返回数据实体。

参数

  • p_row
    一个数字,表示指定行的行号。
  • p_item
    一个 JSON 对象(如 { name:"bruce", value:"lee" },“name”和“value”为列(DataGridColumn 类型)的 DataGridColumn.name 字段值)

isEditorLocked() 方法

判断当前激活编辑器是否是锁定的。如果是true则是锁定状态,反之是未锁定 当编辑处于锁定状态,将会一直保持在其对应的单元格上,直到解锁为止

isFirstPage() 方法

获取一个 Boolean 值,表示当前是否是第一页。

继承自


isLastPage() 方法

获取一个 Boolean 值,表示当前是否是最后一页。

继承自


load([p_data], [p_callback]) 方法

EntityContainer 加载数据。

参数

  • p_data
    可选的。默认值为“null”。一个 JSON 对象,表示用户自定义需要保存的参数。
  • p_callback
    可选的。默认值为“null”。一个回调的函数。

lockEditor() 方法

锁定当前激活的编辑器,如果返回true表示锁定成功,反之锁定失败

markError(p_itemId, p_colName, p_value, p_msg) 方法

提供一个方法,给指定单元格上标记错误。 @param p_itemId 一个字符串,表示单元格所行的 id @param p_colName 一个字符串,表示单元格所在列的列标题。 @param p_value 一个 Boolean 值,true 时标记错误,false 时取消标记。 @param p_msg 一个字符串,表示提示信息,p_value 为 false 时,可以不传值。

参数

  • p_itemId
    一个字符串,表示单元格所行的 id
  • p_colName
    一个字符串,表示单元格所在列的列标题。
  • p_value
    一个 Boolean 值,true 时标记错误,false 时取消标记。
  • p_msg
    一个字符串,表示提示信息,p_value 为 false 时,可以不传值。 {@exclude mx.datacontrols.GroupItemGrid}

moveDown(p_needSelectedTip) 方法

提供下移勾选行的方法,如果没有勾选行,则下移当前选中行。

参数

  • p_needSelectedTip
    一个 Boolean 值,表示下移时如果没有选择行是否给出提示,默认为 false,不给出提示。

moveItem(p_item, p_index) 方法

将指定的数据项移动到指定的索引位置。也可以使用 DataGridItemDataGridItem.moveToDataGridItem.moveUpDataGridItem.moveDown 方法。

参数

  • p_item
    一个 DataGridItem 对象。
  • p_index
    一个数字,表示移动的索引位置。

moveTo(p_left, p_top) 方法

移动控件到指定位置。@param p_left 一个数字,表示 css 样式的 left 属性。 @param p_top 一个数字,表示 css 样式的 top 属性。

参数

  • p_left
    一个数字,表示 css 样式的 left 属性。
  • p_top
    一个数字,表示 css 样式的 top 属性。

继承自


moveToFirstPage() 方法

跳转到第一页。

继承自


moveToLastPage() 方法

跳转到最后一页。

继承自


moveToNextPage() 方法

跳转到下一页。

继承自


moveToPage(p_index) 方法

跳转到某一页。@param p_index 一个 Number 值,表示要跳转到第几页。

参数

  • p_index
    一个 Number 值,表示要跳转到第几页。

继承自


moveToPreviousPage() 方法

跳转到前一页。

继承自


moveUp(p_needSelectedTip) 方法

提供上移勾选行的方法,如果没有勾选行,则上移当前选中行。

参数

  • p_needSelectedTip
    一个 Boolean 值,表示上移时如果没有选择行是否给出提示,默认为 false,不给出提示。

printGrid(p_preview) 方法

提供一个方法,打印表格内容。@param p_preview : true | false 一个 Boolean 值,表示是否启用打印预览功能,默认 true true : 表示显示打印预览 false : 表示不显示打印预览,直接打印

参数

  • p_preview
    : true | false 一个 Boolean 值,表示是否启用打印预览功能,默认 true true : 表示显示打印预览 false : 表示不显示打印预览,直接打印

removeColumn(p_column) 方法

columns 集合中移除指定的 DataGridColumn 对象。 若要从列表中移除所有列,请使用 clearColumns 方法。

参数

  • p_column
    一个数字(如 0),表示 columns 集合中列的序号;或者一个 DataGridColumn 对象。

removeItem(p_item, [p_callback]) 方法

EntityContainer 请求删除一行数据,成功后再调用 removeItem 方法。

参数

  • p_item
    可以是一个字符串主键,或是数字索引,也可以是 DataGridItem 类型的对象,指定要删除的数据对象。
  • p_callback
    可选的。默认值为“null”。一个回调的函数。

示例 1

以下是为 DataGrid 删除一行数据的示例。
JavaScript 代码
//用索引删除数据 dataGrid.removeItem(1); //用主键删除数据 dataGrid.removeItem("id_123"); //用选中的数据项删除数据 dataGrid.removeItem(dataGrid.selection);

removeItems(p_items, [p_callback], [p_isReload]) 方法

EntityContainer 请求删除数据,成功后再调用 removeItem 方法。

参数

  • p_items
    一个数组,指定要删除的数据对象,数组可以由字符串 ID 组成,ID 表示所要删除的数据的主键值。 也可以由 DataGridItem 类型的对象组成,或是由表示数据索引的数字。
  • p_callback
    可选的。默认值为“null”。一个回调的函数。
  • p_isReload
    可选的。默认值为“true”。设置一个 Boolean 值,该参数表示删除成功后是否刷新当前页数据。

示例 1

以下是为 DataGrid 删除一组数据的示例。
JavaScript 代码
//用索引删除数据 dataGrid.removeItems([1,2,3]); //用主键删除数据 var checkedIDs = dataGrid.getCheckedIDs(); dataGrid.removeItems(checkedIDs); //用选中的数据项删除数据 var checkedItems = dataGrid.getCheckedItems(); dataGrid.removeItems(checkedItems);

resizeTo(p_width, p_height) 方法

重设控件的大小。@param p_width 控件的宽度,可以是数字(如 100),也可以是字符串(如 “100%”)。 @param p_height 控件的高度,可以是数字(如 100),也可以是字符串(如 “100%”)。

参数

  • p_width
    控件的宽度,可以是数字(如 100),也可以是字符串(如 “100%”)。
  • p_height
    控件的高度,可以是数字(如 100),也可以是字符串(如 “100%”)。

继承自


save([p_data], [p_callback]) 方法

EntityContainer 请求保存数据。

参数

  • p_data
    可选的。默认值为“null”。一个 JSON 对象,表示用户自定义需要保存的参数。
  • p_callback
    可选的。默认值为“null”。一个回调的函数。 {@exculde mx.datacontrols.ScrollLoadGrid}

selectAll([p_triggerEvent]) 方法

设置选中所有项。

参数

  • p_triggerEvent
    可选的。默认值为“true”。一个 Boolean 值,表示是否要触发 onselectionchanged 事件。如果该值为 true,则触发事件;反之则不触发。

selectItem(p_item, [p_triggerEvent]) 方法

选择 DataGrid 列表中的指定的数据项。

参数

  • p_item
    一个数字(如 0),表示 items 集合中数据项的序号;或者一个 DataGridItem 对象。
  • p_triggerEvent
    可选的。默认值为“true”。一个 Boolean 值,表示是否要触发 onselectionchanged 事件。如果该值为 true,则触发事件;反之则不触发。

selectNextItem() 方法

选中当前选中项的下一个数据项。如果当前没有选中项,则选中第一个数据项;如果当前的选中项是最后一项,则不做任何改变。

selectPreviousItem() 方法

选中当前选中项的前一个数据项。如果当前没有选中项或选中项是第一个,则不做任何改变。

setAllowEditing(p_editing) 方法

设置是否可编辑 allowEditing

参数

  • p_editing
    boolean值,true:可编辑 false 不可编辑

setBorder(p_border) 方法

设置控件的边框样式。@param p_border 一个字符串,表示css样式的 border 属性。

参数

  • p_border
    一个字符串,表示css样式的 border 属性。

继承自


setBottom(p_bottom) 方法

设置 bottom 字段的值。@param p_bottom 控件的下边界与父容器下边界的像素距离,可以是数字(如 50),也可以是字符串(如 50%)。

参数

  • p_bottom
    控件的下边界与父容器下边界的像素距离,可以是数字(如 50),也可以是字符串(如 50%)。

继承自


setColumns(p_columns) 方法

设置 columns 字段的值。该方法首先会清空 columns 集合。

参数

  • p_columns
    一个数组,该数组包含了一组 DataGridColumn 对象。

setCss(p_css) 方法

设置 css 字段的值。 @param p_css 一个 JSON 对象,表示控件的 CSS 样式。

参数

  • p_css
    一个 JSON 对象,表示控件的 CSS 样式。 {@exclude mx.datacontrols.ScrollBar}

继承自


setCssClass(p_cssClass) 方法

设置 cssClass 字段的值 @param p_cssClass 一个String 对象,样式classname

参数

  • p_cssClass
    一个String 对象,样式classname {@exclude mx.datacontrols.ScrollBar}

继承自


setDisplay(p_display) 方法

设置 display 字段的值。@param p_display css 样式的 display 属性。

参数

  • p_display
    css 样式的 display 属性。

继承自


setDisplayCheckBox(p_displayCheckBox) 方法

设置 displayCheckBox 的字段值。

参数

  • p_displayCheckBox
    一个 Boolean 值,表示是否要要在表格第一列显示 CheckBox 控件。

setDisplayColSplitLine(p_displayColSplitLine) 方法

设置 displayColSplitLine 的字段值。

参数

  • p_displayColSplitLine
    一个 Boolean 值,表示是否要显示列的分割线。

setDisplayHead(p_displayHead) 方法

设置 displayHead 的字段值。

参数

  • p_displayHead
    一个 Boolean 值,表示是否要显示表格的列头。

setDisplayRowNumber(p_displayRowNumber) 方法

设置 displayRowNumber 的字段值。 此方法只在构造参数中高displayRowNumber为true时有效

参数

  • p_displayRowNumber
    一个 Boolean 值,表示是否要要在表格第一列显示行号。

setDisplayStatisticRow(p_displayStatisticRow) 方法

设置 displayStatisticRow 的字段值。

参数

  • p_displayStatisticRow
    一个 Boolean 值,表示是否要显示统计行。

setEnableCellTip(p_enableCellTip) 方法

设置 enableCellTip 的字段值。

参数

  • p_enableCellTip
    一个 Boolean 值,表示是否要显示表格cell的title属性。

setEnabled(p_enabled) 方法

设置 enabled 字段的值。

参数

  • p_enabled

继承自


setEntityContainer(p_entityContainer) 方法

设置 entityContainer 的字段值。

参数


setFilter(p_filter, [p_override]) 方法

设置 filter 字段的值

参数

  • p_filter
    一个字符串或 Json 对象,表示查询的参数。
  • p_override
    可选的。默认值为“true”。一个 Boolean 值,表示是否覆盖原先的 filter 字段的值。

setHeight(p_height) 方法

设置 height 字段的值。 注:子类UploadControl上传控件不支持百分比设置高度 @param p_height 控件的高度,可以是数字(如 100),也可以是字符串(如 “100%”)。

参数

  • p_height
    控件的高度,可以是数字(如 100),也可以是字符串(如 “100%”)。

继承自


setItemEnabled(p_id, p_enabled) 方法

设置 DataGrid 的某一行是否可编辑 p_id DataGridItem 的 id 或是其的索引值 p_enabled 一个布尔值,true 代表可编辑,false 代表不可编辑

参数

  • p_id
  • p_enabled

setItems(p_items) 方法

设置 items 字段的值。该方法首先会清空 items 集合。

参数

  • p_items
    一个数组,该数组包含了一组 DataGridItem 对象。

setLeft(p_left) 方法

设置 left 字段的值。 @param p_left 控件的左边界与父容器左边界的像素距离,可以是数字(如 50),也可以是字符串(如 50%)。

参数

  • p_left
    控件的左边界与父容器左边界的像素距离,可以是数字(如 50),也可以是字符串(如 50%)。 {@exclude mx.datacontrols.ComplexForm} {@exclude mx.datacontrols.DataGridSearchBox} {@exclude mx.datacontrols.DynamicForm} {@exclude mx.datacontrols.SkinDataForm}

继承自


setPageSize(p_pageSize) 方法

设置 pageSize 字段的值。同时跳转到第一页。@param p_pageSize 一个 Number 值,表示每页可以显示的记录数。

参数

  • p_pageSize
    一个 Number 值,表示每页可以显示的记录数。

继承自


setPosition(p_position) 方法

设置 position 字段的值。@param p_position 一个字符串,表示 css 样式的 position 属性。

参数

  • p_position
    一个字符串,表示 css 样式的 position 属性。

继承自


setRight(p_right) 方法

设置 right 字段的值。@param p_right 控件的右边界与父容器右边界的像素距离,可以是数字(如 50),也可以是字符串(如 50%)。

参数

  • p_right
    控件的右边界与父容器右边界的像素距离,可以是数字(如 50),也可以是字符串(如 50%)。

继承自


setSearchBox(p_searchBox) 方法

设置DataGrid的DataGridSearchBox控件

参数

  • p_searchBox
    一个 mx.datacontrols.DataGridSearchBox 实例

setTop(p_top) 方法

设置 top 字段的值。 @param p_top 控件的上边界与父容器上边界的像素距离,可以是数字(如 50),也可以是字符串(如 50%)。

参数

  • p_top
    控件的上边界与父容器上边界的像素距离,可以是数字(如 50),也可以是字符串(如 50%)。 {@exclude mx.datacontrols.ComplexForm} {@exclude mx.datacontrols.DataGridSearchBox} {@exclude mx.datacontrols.DynamicForm} {@exclude mx.datacontrols.SkinDataForm}

继承自


setVisible(p_visible) 方法

设置 visible 字段的值。@param p_visible 一个 Boolean 值,表示控件是否可见。

参数

  • p_visible
    一个 Boolean 值,表示控件是否可见。

继承自


setWidth(p_width) 方法

设置 width 字段的值。@param p_width 控件的高度,可以是数字(如 500)、字符串(如“500px”或“50%”).

参数

  • p_width
    控件的高度,可以是数字(如 500)、字符串(如“500px”或“50%”).

继承自


show() 方法

显示控件,设置控件可见。

继承自


showImportExcelWizard([p_windowManager], [p_url], [p_callback]) 方法

打开导入 Excel 表格的向导窗口,并返回该向导。

参数

  • p_windowManager
    可选的。一个 WindowManager 对象。可以根据 WebletWeblet.context 属性获取到该对象。
  • p_url
    可选的。一个字符串,表示处理 Excel 的服务地址。平台默认提供了解析 Excel 文件的服务,但需求不能满足时需要自定义服务。
  • p_callback
    可选的。一个回调函数,当向导完成后执行该方法。

sort(p_column, [p_order]) 方法

将指定列的数据项进行排序。

参数

  • p_column
    一个数字(如 0),表示列在集合中的序号;或一个字符串,表示列的名称;或一个 DataGridColumn 对象。
  • p_order
    可选的。一个 Boolean 值,表示按升序或降序排序。请参见 sortOrder 字段。

sorts(p_columns, p_order) 方法

将指定多列的数据项进行排序。

参数

  • p_columns
    一个数字数组,表示列在集合中的序号;或一个字符串数组,表示列的名称;或一个 DataGridColumn 对象数组。
  • p_order

uncheckAll() 方法

将所有的数据项设为未选中状态。

unLockEditor() 方法

解除对当前编辑器的锁定

validate() 方法

不提供默认校验逻辑,允许自定义扩展。 返回值格式为 {successful: true|false, hint: "校验提示信息"}

$(p_expression) 方法

该方法与 me.$e.find(p_expression) 等同。

参数

  • p_expression

继承自


$wrap([p_obj]) 方法

返回一个 JQuery 对象。

参数

  • p_obj
    可选的。默认值为“me.$e”。一个 JQuery 对象,或继承自 Control 的控件,或字符串,或 HTML DOM 元素。 如果参数为 JQuery 对象,则返回本身; 如果参数为继承自 Control 的控件,则返回控件的 $e 对象; 如果参数为字符串,则返回以字符串为选择器的 JQuery 对象; 如果参数为空,则返回控件本身的 $e 对象。

继承自


_getEditingNextCell(p_arg, v) 方法

受保护的。

参数

  • p_arg
  • v

字段详细信息

activeEditor 字段

获取当前表格激活的编辑器,如果没有,返回null

默认值

null

alias 字段

获取或设置一个字符串,表示控件的别名。

继承自


allowAdjusting 字段

获取或设置一个 Boolean 值,该值表示是否可以调整 DataGrid 控件中列的宽度。如果该值为 true,表示可以调整;反之则不可以。

默认值

true

allowDraggingColumn 字段

获取或设置一个 Boolean 值,该值表示是否可以调整 DataGrid 控件中的列头的顺序。如果该值为 true,表示可以调整;反之则不可以。 allowDraggingColumn在设置false的同时要设置allowDraging为false才可以使列头顺序不能拖动,只要有一个为true,列头的顺序就是可以改变的。

allowDraggingItem 字段

获取或设置一个 Boolean 值,该值表示是否可以拖动 {@link mx.datacontrols.DataGrid.DataGridItem} 项。@default true

默认值

true

allowDraging 字段

获取或设置一个 Boolean 值,该值表示是否可以调整 DataGrid 控件中列的宽度。如果该值为 true,表示可以调整;反之则不可以。 该属性和 allowDraggingColumn 属性意义相同。 allowDraging在设置false的同时要设置me.allowDraggingColumn为false才可以使列头顺序不能拖动,只要有一个为true,列头的顺序就是可以改变的。 @default true

默认值

true

allowEditing 字段

获取一个 Boolean 值,表示表格控件是否允许编辑。

默认值

false

allowInterlacedRow 字段

获取或设置一个 Boolean 值,表示表格是否要隔行变色。

默认值

true

allowMultipleSorting 字段

获取或设置一个 Boolean 值,表示是否允许多列排序。

allowPaging 字段

获取和设置一个 Boolean 值,表示是否可以分页。

继承自


allowSorting 字段

获取或设置一个 Boolean 值,表示所有列是否允许排序。

默认值

false

autoSelect 字段

获取或设置一个值,表示当列表中没有选中项的时候,是否自动选择第一个数据项。如果该值为 true,则自动选择;反之则不自动选择。@default false

默认值

false

autoWrap 字段

获取或设置表格数据行是否自动换行。 该属性仅在 DataGridGroupHeaderGrid可用。

默认值

false

baseUrl 字段

请参见 EntityContainer.baseUrl 属性。如果 DataGrid 的 entityContainer 由外界创建,那么该属性不需要设置; 否则只有当entityContainer 属性对应的数据容器对象的type属性值为local时,可以不需要设置该属性,其它情况下必须设置。

border 字段

获取控件的边框样式。如“1px solid red”,表示边框的样式为 1 像素红色的实线。请使用 setBorder 方法设置该字段的值。

继承自


bottom 字段

获取控件的下边界与父容器下边界的像素距离。请使用 setBottom 方法设置该字段的值。

继承自


cacheAdjust 字段

获取或设置 Boolean 值,表示是否在本地缓存用户对于列宽度、顺序、显示的调整。开启该功能时,请设置cacheAdjustPrefixalias属性值。

cacheAdjustPrefix 字段

获取或设置 一个字符串,表示本地缓存用户对于列宽度、顺序、显示的调整时存储时的key前缀,完整的key由cacheAdjustPrefix与alias拼接而成以确保唯一性。

columns 字段

获取和设置一个集合,用于创建含控件中显示的所有 DataGridColumn

集合

该字段是一个集合数组字段。 集合中成员的类型为 mx.datacontrols.DataGridColumn

集合索引

列的名称(DataGridColumn.name)或列在集合中的序号(从 0 开始计数)。

contextMenu 字段

一个 ContextMenu 对象,表示控件的右键菜单。

cssClass 字段

指定css伪类名称,设置控件显示样式

继承自


display 字段

获取控件的显示样式值。如“none”,表示隐藏控件; “block”表示强制作为块对象呈递。请使用 setDisplay方法设置该字段的值。

继承自


displayCheckBox 字段

获取或设置一个 Boolean 值,该值表示数据项之前是否显示一个选择框。如果该值为 true,则表示显示;反之则不显示。请使用 setDisplayCheckBox 方法设置该字段的值。

默认值

false

displayColSplitLine 字段

获取一个 Boolean 值,表示是否显示列的分割线。

默认值

true

displayHead 字段

获取一个 Boolean 值,表示是否显示列头。请使用 setDisplayHead 方法设置该字段的值。

默认值

true

displayPrimaryKey 字段

获取或设置一个 Boolean 值,该值表示是否显示主键列。

默认值

false

displayRowNumber 字段

获取或设置一个 Boolean 值,该值表示数据项之前是否显示行号。如果该值为 true,则表示显示;反之则不显示。请使用 setDisplayRowNumber 方法设置该字段的值。

默认值

false

displayStatisticRow 字段

获取或设置一个 Boolean 值,该值表示表格是否显示统计行。如果该值为 true,则表示显示;反之则不显示。 请使用 setDisplayStatisticRow 方法设置该字段的值。 如果需要设置某列的统计值,请使用 DataGridColumn.setStatisticValue 方法,或者使用 DataGridColumn.statisticValue 属性设置初始统计值。

默认值

false

editOnSelected 字段

获取或设置一个 Boolean 值,表示表格是否使用选中后编辑。

默认值

false

enableBrowserContextMenu 字段

获取或初始化设置是否允许浏览器默认的上下文菜单。

继承自


enableCellTip 字段

获取一个 Boolean 值,表示是否显示titile属性。请使用 setEnableCellTip 方法设置该字段的值。

默认值

false

enabled 字段

获取控件是否可以对用户交互作出响应。如果该值为 true,则表示控件可以对用户交互作出响应;反之则不能。 请使用 setEnabled 方法设置该字段的值。@default true

继承自

默认值

true

enableEditingPageSize 字段

设置一个 Boolean 值,在allowPaging添加分页控件情况下,表示是否可编辑分页控件pageSize编辑框。

默认值

false

enableHeadContextMenu 字段

一个布尔值,指示是否启用表头上下文菜单

entityContainer 字段

获取一个 EntityContainer 对象(通常是 GridEntityContainer 类型),表示表格的数据源。 请使用 setEntityContainer 方法设置该字段的值。

eTag 字段

获取控件的标签。

继承自

默认值

<div/>

filter 字段

获取或设置表格的过滤条件。请使用 setFilter 方法设置该字段的值。该属性是一个字符串或者是一个 JSON 对象,该属性与 searchParamType 属性有关。 当 searchParamType 属性为 string 时,该属性是字符串或者 JSON 对象,例如:"name='jacky'&age=23" 或者 {name: "jacky", age: 23}, 此时 DataGrid 执行简单查询; 当 searchParamType 属性为 json 时,该属性是 JSON 对象, 该 JSON 对象必须遵循高级查询格式规范, 例如: {criterions: [ {fieldName: "age", value: 18, operator: ">"}, {fieldName: "age", value: 60, operator: "<"} ], junction: "and", columnJunction: "and"} 表示对属性名为 “age” 的列设置过滤条件: 18 < age < 60。

hasPrimaryKey 字段

获取或设置一个属性,用于声明是否有主键,若声明为无主键,则使用appendItem时数据有可能重复添加

默认值

true

headContextMenu 字段

一个 ContextMenu 对象,表示表头的右键菜单。

height 字段

参见 ControlControl.height 属性。

继承自

默认值

100%

importExcelOptions 字段

获取或设置解析文件的范围。 一个 JSON 对象(如 {horizontalBegin : 1, horizontalEnd : 0, verticalBegin : 1, verticalEnd : 0, sheetNumber : 1, separatorNum : 0}; )

参数说明。

  • horizontalBegin : 开始行,默认值 1
  • horizontalEnd : 结束行,默认值 0,表示不设置结束行
  • verticalBegin : 开始列,默认值 1
  • verticalEnd : 结束列,默认值 0,表示不设置结束列
  • sheetNumber : 解析excel的第几个sheet页,默认值 1
  • separatorNum : 解析真正数据行,默认是为0,即从表头下面一行开始解析。
  • saveByDefault : 一个 boolean 值,默认是 true,表示选择 Excel 后,点击下一步是否直接保存。
  • parseExcelCallBack : 一个函数对象,表示服务端解析 Excel 后,处理返回数据的回调函数。

itemCount 字段

获取一个 Number值,表示当前的总记录数。@default 0

继承自

默认值

0

itemMenu 字段

一个 ContextMenu 对象,表示数据项的右键菜单。

items 字段

获取一个集合,包含数据项列表中所有的项(DataGridItem 类型)。请使用 setItems 方法设置该字段的值。

集合

该字段是一个集合数组字段。 集合中成员的类型为 mx.datacontrols.DataGridItem

集合索引

数据项在集合中的序号(从 0 开始计数)。

layoutConfigs 字段

获取或者设置一个 JSON 对象,该属性表示控件在父容器中的布局配置参数。该属性只有在控件父容器运用布局器才会生效。

继承自


lazyRender 字段

设置表格是否延迟渲染

lazyRenderSize 字段

设置表格延迟渲染时,每次渲染的数据大小,如果同时需要分页,请设置pageSize的值为该属性值得整数倍。

left 字段

获取控件的左边界与父容器左边界的像素距离。请使用 setLeft 方法设置该字段的值。

继承自


maxTitleLength 字段

获取单元格title最大字符。

默认值

false

moveByShortcutKey 字段

获取或设置一个 Boolean 值,表示是否使用向上快捷键(ctrl+↑)或向下快捷键(ctrl+↓)移动表格行。@default false

默认值

false

multipleSortColumns 字段

获取或设置一个字符串,表示需要多列排序的列名称(如“age,gender,name”),以逗号分隔,排序顺序为从左向右。

pageIndex 字段

在数据创建中调用,加入这个处理是因为,如果在创建数据的过程中要先清理掉当前表格的编辑状态。 如果清除编辑器出错,则中止新数据的创建过程,如果不清除,由于_editingItem没有切换,可能会造成在调用renderCell时,渲染出错的情况

继承自

默认值

1

pageNaviBar 字段

获取一个 PageNaviBar 对象。 表示当前 DataGrid 的分页工具条。

pageSize 字段

获取和设置一个 Number 值,表示当前每页允许显示的记录数。@default 20

继承自

默认值

20

pageSizeOptions 字段

获取和设置一个数组值,表示分页记录数可设置的选项。

继承自


parent 字段

获取控件所属的父对象。

继承自


permissionID 字段

获取或设置一个字符串,表示控件的权限标识。

继承自


position 字段

获取控件位置样式值。请使用 setPosition 方法设置该字段的值。

该字段的可选值包括:

  • relative
  • absolute

继承自


primaryKey 字段

获取或设置一个属性,该属性对应的值将用作 DataGrid 中数据项的 id 值,表示主键唯一值。 此属性必须在初始化控件时设置

默认值

id

printHideFields 字段

是否打印默认隐藏的字段。@default false

默认值

false

right 字段

获取控件的右边界与父容器右边界的像素距离。请使用 setRight 方法设置该字段的值。

继承自


rowNumberColCaption 字段

获取或设置序号列的名称。

默认值


rowNumberColWidth 字段

获取或设置序号列的宽度。

默认值

25

saveMessage 字段

获取和设置一个字符串,该属性表示表格数据保存成功后的提示信息。当用户设置为空或者空字符串时,保存动作发生后将不提示信息。

默认值

mx.msg("SAVE_SUCCESS")

searchBox 字段

获取或设置一个 DataGridSearchBox 对象.

searchParamType 字段

获取或设置表格的查询条件类型。json 表示查询参数filter 的值采用 Json 对象的形式传递。string 表示查询参数 filter 的值采用字符串的形式传递。 该字段必须在初始化前设置。

该字段可选的值包括:

  • json
  • string


selection 字段

获取一个对象,表示 DataGrid 中当前选定的数据项(DataGridItem类型)。 该属性特指背景色选中的行所在的数据项。

selections 字段

获取一个集合,表示 DataGrid 中当前选定的所有数据项(DataGridItem类型)的集合。 注意:该数组不是勾选项的集合。如果需要获取勾选项的集合,请使用 {@link getCheckedItems()} 方法。

sortColumn 字段

获取上一次进行排序的列(DataGridColumn 类型)。

sorter 字段

获取或设置一个字符串,表示请求服务时的排序条件。如“NAME ASC, AGE DESC”。

sortOrder 字段

获取或设置一个 Boolean 值,该值表示是否按升序或降序对 DataGrid 控件中的数据项进行排序。如果该值为 true,表示按升序排序;反之则降序。

默认值

true

toEditCellByTabKey 字段

获取或设置一个boolean值,表示是否通过使用tab键来切换编辑的单元格 该属性仅在 DataGridGroupHeaderGrid可用。

默认值

false

top 字段

获取控件的上边界与父容器上边界的像素距离。请使用 setTop 方法设置该字段的值。

继承自


typeName 字段

获取当前类型实例的类的类型。

usePercentage 字段

指示是否使用列宽百分比自适应

默认值

false

visible 字段

获取一个 Boolean 值,表示控件是否可见。如果该值为 true,则表示控件可见;反之则不可见。请使用 setVisible 方法设置该字段的值。@default true

继承自

默认值

true

width 字段

参见 ControlControl.width 属性。

继承自

默认值

auto

$e 字段

获取该控件的占位符,该占位符为一个 JQuery 对象。

继承自


_editingNextCell 字段

受保护的。

事件详细信息

oncelledited 事件

当数据项进行编辑后,将触发该事件。

参数

  • column
    一个 DataGridColumn 对象。
  • item
    一个 DataGridItem 对象。
  • cell
    一个 Jquery 对象,表示当前编辑的单元格(TD)。

oncellediting 事件

当数据项进行编辑时,将触发该事件。此时单元格内编辑器尚未创建。

参数

  • cancel
    可通过设置 cancel 参数为 true 来取消当前操作。默认为 false。
  • column
    一个 DataGridColumn 对象。
  • item
    一个 DataGridItem 对象。

oneditorcreated 事件

当数据项的某个单元格内编辑器被创建激活后,将触发该事件。

参数

  • editor
    一个 Editor 对象。

oneditorcreating 事件

当数据项的某个单元格内编辑器被创建前,将触发该事件。

参数

  • column
    一个 DataColumn 对象。
  • editorOptions
    一个 JSON 对象,表示创建编辑器时所需的参数。

onitemchecked 事件

当数据项的选中状态发生改变后,将触发该事件。

参数


onitemclick 事件

当单击列表中项的时候,将触发该事件。

参数


onitemcountchanged 事件

总记录数改变时触发该事件。

继承自


onitemcreated 事件

当列表项被创建后,将触发该事件。

参数


onitemdoubleclick 事件

当双击列表中项的时候,将触发该事件

参数


onitemindexchanged 事件

当数据项索引发生改变的时候,将触发该事件。通常调用 moveItemDataGridItem.moveUpDataGridItem.moveDownDataGridItem.moveTo 方法时会触发该事件。

参数

  • sourceItem
    一个 DataGridItem 对象,即移动的源数据项。
  • targetItems
    一组 DataGridItem 对象集合,即被移动的目标数据项集合。

onitemremoved 事件

当列表项被从DOM中删除后,将触发该事件。

onload 事件

当数据加载完后,将触发该事件。

onloading 事件

当数据容器开始加载数据时,将触发该事件。调用 load 方法时会触发该事件。

参数

  • cancel
    一个 Boolean 值,表示是否中止当前的加载动作。

onpageindexchanged 事件

当前的页面索引变更时触发该事件。调用 moveToPage 方法是触发该事件。

继承自


onselectionchanged 事件

当控件当前的选择项发生改变后,将触发该事件。调用 selectItemremoveItemdeselectItem 等方法后会触发该事件。

onselectionchanging 事件

当控件当前的选择项发生改变的时候,将触发该事件。调用 selectItem 方法时会触发该事件。

参数

  • cancel
    可通过设置 cancel 参数为 true 来取消当前操作。默认为 false。
  • item
    一个 DataGridItem 对象,即将被选择的项。

onvalidate 事件

当数据校验完后,将触发该事件。