构建 ComplexGrid 类的新实例。
| 全称 | mx.datacontrols.ComplexGrid |
| 命名空间 | mx.datacontrols |
| 类 | ComplexGrid |
| 继承层次结构 | ComplexGridDataGridPagedControlControl |
| 源文件 | ~\mx\scripts\datacontrols\ComplexGrid.js |
提供一个集成工具栏和表格的复合组件。
示例 1
以下为 ComplexGrid 的示例。
| JavaScript 代码 |
var grid = new mx.datacontrols.ComplexGrid({
baseUrl: "http://bruce-pc:8892/mx/rest/getData",
create:_grid_create, // 如果点击“新建”按钮不使用默认的逻辑，可重写
saveData:_grid_save, // 如果点击“保存”按钮不使用默认的逻辑，可重写
remove:_grid_remove // 如果点击“删除”按钮不使用默认的逻辑，可重写
});
// 向工具栏添加自定义按钮
grid.appendToolBarItems([{
name:"exportExcel",
text:"导出 Excel",
onclick:_grid_exportExcel
},
{
name:"importExcel",
text:"导入 Excel",
onclick:_grid_importExcel
}
]);
function _grid_create()
{
}
function _grid_save()
{
}
function _grid_remove()
{
}
function _grid_exportExcel()
{
}
function _grid_importExcel()
{
} |
构造函数
| 名称 | 说明 |
| ComplexGrid() | 构建 ComplexGrid 类的新实例。 |
初始化函数
| 名称 | 说明 |
| init() |
方法
字段
| 名称 | 说明 |
| activeEditor | 获取当前表格激活的编辑器,如果没有，返回null |
| alias | 获取或设置一个字符串，表示控件的别名。 |
| allowAdjusting | 获取或设置一个 Boolean 值，该值表示是否可以调整 DataGrid 控件中列的宽度。如果该值为 true，表示可以调整；反之则不可以。 |
| allowDraggingColumn | 获取或设置一个 Boolean 值，该值表示是否可以调整 DataGrid 控件中的列头的顺序。如果该值为 true，表示可以调整；反之则不可以。 |
| allowDraggingItem | 获取或设置一个 Boolean 值，该值表示是否可以拖动 {@link mx.datacontrols.DataGrid.DataGridItem} 项。 |
| allowDraging | 获取或设置一个 Boolean 值，该值表示是否可以调整 DataGrid 控件中列的宽度。如果该值为 true，表示可以调整；反之则不可以。 该属性和 allowDraggingColumn 属性意义相同。 |
| allowEditing | 获取一个 Boolean 值，表示表格控件是否允许编辑。 |
| allowInterlacedRow | 获取或设置一个 Boolean 值，表示表格是否要隔行变色。 |
| allowMultipleSorting | 获取或设置一个 Boolean 值，表示是否允许多列排序。 |
| allowPaging | 获取和设置一个 Boolean 值，表示是否可以分页。 |
| allowSorting | 获取或设置一个 Boolean 值，表示所有列是否允许排序。 |
| autoSelect | 获取或设置一个值，表示当列表中没有选中项的时候，是否自动选择第一个数据项。如果该值为 true，则自动选择；反之则不自动选择。 |
| autoWrap | 获取或设置表格数据行是否自动换行。 |
| baseUrl | 请参见 EntityContainer.baseUrl 属性。如果 DataGrid 的 entityContainer 由外界创建，那么该属性不需要设置； 否则需要设置该属性的值。 |
| border | 获取控件的边框样式。如“1px solid red”，表示边框的样式为 1 像素红色的实线。请使用 setBorder 方法设置该字段的值。 |
| bottom | 获取控件的下边界与父容器下边界的像素距离。请使用 setBottom 方法设置该字段的值。 |
| columns | 获取和设置一个集合，用于创建含控件中显示的所有 DataGridColumn。 |
| contextMenu | 一个 ContextMenu 对象，表示控件的右键菜单。 |
| cssClass | 指定css伪类名称，设置控件显示样式 |
| display | 获取控件的显示样式值。如“none”，表示隐藏控件； “block”表示强制作为块对象呈递。请使用 setDisplay。注：该"block"值不能在ComplexGrid控件中使用。 方法设置该字段的值。 |
| displayCheckBox | 获取或设置一个 Boolean 值，该值表示数据项之前是否显示一个选择框。如果该值为 true，则表示显示；反之则不显示。请使用 setDisplayCheckBox 方法设置该字段的值。 |
| displayColSplitLine | 设置 displayColSplitLine 的字段值。 |
| displayHead | 获取一个 Boolean 值，表示是否显示列头。请使用 setDisplayHead 方法设置该字段的值。 |
| displayPrimaryKey | 获取或设置一个 Boolean 值，该值表示是否显示主键列。 |
| displayRowNumber | 获取或设置一个 Boolean 值，该值表示数据项之前是否显示行号。如果该值为 true，则表示显示；反之则不显示。请使用 setDisplayRowNumber 方法设置该字段的值。 |
| displayStatisticRow | 获取或设置一个 Boolean 值，该值表示表格是否显示统计行。如果该值为 true，则表示显示；反之则不显示。 请使用 setDisplayStatisticRow 方法设置该字段的值。 如果需要设置某列的统计值，请使用 DataGridColumn.setStatisticValue 方法，或者使用 DataGridColumn.statisticValue 属性设置初始统计值。 |
| displayToolBar | 获取或设置一个 Boolean 值，表示是否显示工具栏。 |
| editOnSelected | 获取或设置一个 Boolean 值，表示表格是否使用选中后编辑。 |
| enabled | 获取控件是否可以对用户交互作出响应。如果该值为 true，则表示控件可以对用户交互作出响应；反之则不能。 请使用 setEnabled 方法设置该字段的值。 |
| enableHeadContextMenu | 一个布尔值，指示是否启用表头上下文菜单 |
| entityContainer | 获取一个 EntityContainer 对象（通常是 GridEntityContainer 类型），表示表格的数据源。 请使用 setEntityContainer 方法设置该字段的值。 |
| eTag | 获取控件的标签。 |
| filter | 获取或设置表格的过滤条件。请使用 setFilter 方法设置该字段的值。 |
| headContextMenu | 一个 ContextMenu 对象，表示表头的右键菜单。 |
| height | 参见 Control 的 Control.height 属性。 |
| imagePosition | |
| importExcelOptions | 获取或设置解析文件的范围。
一个 JSON 对象（如 {horizontalBegin : 1, horizontalEnd : 0, verticalBegin : 1, verticalEnd : 0, sheetNumber : 1, separatorNum : 0}; ）
参数说明。
|
| itemCount | 获取和设置一个 Number 值，表示当前的总记录数。 |
| itemDefaultData | 表格记录的默认值 |
| itemMenu | 一个 ContextMenu 对象，表示数据项的右键菜单。 |
| items | 获取一个集合，包含数据项列表中所有的项（DataGridItem 类型）。请使用 setItems 方法设置该字段的值。 |
| layoutConfigs | 获取或者设置一个 JSON 对象，该属性表示控件在父容器中的布局配置参数。该属性只有在控件父容器运用布局器才会生效。 |
| left | 获取控件的左边界与父容器左边界的像素距离。请使用 setLeft 方法设置该字段的值。 |
| moveByShortcutKey | 获取或设置一个 Boolean 值，表示是否使用向上快捷键（ctrl+↑）或向下快捷键（ctrl+↓）移动表格行。 |
| multipleSortColumns | 获取或设置一个字符串，表示需要多列排序的列名称（如“age,gender,name”），以逗号分隔，排序顺序为从左向右。 |
| padding | 获取控件的内边距。如“4px”表示上下左右的内边距均为 4 像素； “4px 2px 3px 1px”则表示上边距为 4 像素，右边距为 2 像素，下边距为 3 像素，左边距为 1 像素。请使用 setPadding 方法设置该字段的值。 |
| pageIndex | 在数据创建中调用，加入这个处理是因为，如果在创建数据的过程中要先清理掉当前表格的编辑状态。 如果清除编辑器出错，则中止新数据的创建过程，如果不清除，由于_editingItem没有切换，可能会造成在调用renderCell时，渲染出错的情况 |
| pageNaviBar | 获取一个 PageNaviBar 对象。 表示当前 DataGrid 的分页工具条。 |
| pageSize | 获取和设置一个 Number 值，表示当前每页允许显示的记录数。 |
| pageSizeOptions | 获取和设置一个数组值，表示分页记录数可设置的选项。 |
| parent | 获取控件所属的父对象。 |
| permissionID | 获取或设置一个字符串，表示控件的权限标识。 |
| position | 获取控件位置样式值。如“static”，表示无特殊定位，对象遵循 HTML 定位规则。请使用 setPosition
方法设置该字段的值。
该字段的可选值包括:
|
| primaryKey | 获取或设置一个属性，该属性对应的值将用作 DataGrid 中数据项的 id 值，表示主键唯一值。 |
| printHideFields | 是否打印默认隐藏的字段。 |
| right | 获取控件的右边界与父容器右边界的像素距离。请使用 setRight 方法设置该字段的值。 |
| rowNumberColWidth | 获取或设置序号列的宽度。 |
| saveMessage | 获取和设置一个字符串，该属性表示表格数据保存成功后的提示信息。当用户设置为空或者空字符串时，保存动作发生后将不提示信息。 |
| searchBox | 获取或设置一个 DataGridSearchBox 对象. |
| searchParamType | 获取或设置表格的查询条件类型。json 表示查询参数filter 的值采用 Json 对象的形式传递。string 表示查询参数 filter 的值采用字符串的形式传递。
该字段必须在初始化前设置。
该字段可选的值包括：
|
| selection | 获取一个对象，表示 DataGrid 中当前选定的数据项（DataGridItem类型）。 该属性特指背景色选中的行所在的数据项。 |
| selections | 获取一个集合，表示 DataGrid 中当前选定的所有数据项（DataGridItem类型）的集合。 注意：该数组不是勾选项的集合。如果需要获取勾选项的集合，请使用 {@link getCheckedItems()} 方法。 |
| sortColumn | 获取上一次进行排序的列（DataGridColumn 类型）。 |
| sorter | 获取或设置一个字符串，表示请求服务时的排序条件。如“NAME ASC, AGE DESC”。 |
| sortOrder | 获取或设置一个 Boolean 值，该值表示是否按升序或降序对 DataGrid 控件中的数据项进行排序。如果该值为 true，表示按升序排序；反之则降序。 |
| toolBar | 获取或设置一个 ToolBar 对象。 |
| toolBarHeight | 获取或设置一个内置 toolBar toolBar 对象的默认高度。 |
| top | 获取控件的上边界与父容器上边界的像素距离。请使用 setTop 方法设置该字段的值。 |
| usePercentage | 指示是否使用列宽百分比自适应 |
| validateOnSaving | 一个布尔值，指示数据在保存之前是否校验空值 |
| visible | 获取一个 Boolean 值，表示控件是否可见。如果该值为 true，则表示控件可见；反之则不可见。请使用 setVisible 方法设置该字段的值。 |
| width | 参见 Control 的 Control.width 属性。 |
| $e | 获取该控件的占位符，该占位符为一个 JQuery 对象。 |
| _columns | 受保护的。原始的元数据列头信息 |
| _hasOverrideRenderCell | 受保护的。获取一个 Boolean 值，表示是否有重写 renderCell 方法的列。 |
| _tempColumnName | 受保护的。 |
事件
| 名称 | 说明 |
| oncelledited | 当数据项进行编辑后，将触发该事件。 |
| oncellediting | 当数据项进行编辑时，将触发该事件。此时单元格内编辑器尚未创建。 |
| oneditorcreated | 当数据项的某个单元格内编辑器被创建激活后，将触发该事件。 |
| oneditorcreating | 当数据项的某个单元格内编辑器被创建前，将触发该事件。 |
| onitemchecked | 当数据项的选中状态发生改变后，将触发该事件。 |
| onitemclick | 当单击列表中项的时候，将触发该事件。 |
| onitemcountchanged | 总记录数改变时触发该事件。 |
| onitemcreated | 当列表项被创建后，将触发该事件。 |
| onitemdoubleclick | 当双击列表中项的时候，将触发该事件 |
| onitemindexchanged | 当数据项索引发生改变的时候，将触发该事件。通常调用 moveItem、DataGridItem.moveUp、DataGridItem.moveDown、DataGridItem.moveTo 方法时会触发该事件。 |
| onload | 当数据加载完后，将触发该事件。 |
| onloading | 当数据容器开始加载数据时，将触发该事件。调用 load 方法时会触发该事件。 |
| onpageindexchanged | 当前的页面索引变更时触发该事件。调用 moveToPage 方法是触发该事件。 |
| onselectionchanged | 当控件当前的选择项发生改变后，将触发该事件。调用 selectItem、 removeItem、 deselectItem 等方法后会触发该事件。 |
| onselectionchanging | 当控件当前的选择项发生改变的时候，将触发该事件。调用 selectItem 方法时会触发该事件。 |
| onvalidate | 当数据校验完后，将触发该事件。 |
方法详细信息
appendColumn(p_column) 方法
参数
- p_column一个 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]) 方法
参数
- 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) 方法
参数
- p_columns一个数组，该数组包含了一组 DataGridColumn 对象。
继承自
示例 1
以下是为 DataGrid 添加一组
DataGridColumn 的示例。
dataGrid.appendColumns([
{ name: "gender", text: "性别" },
{ name: "age", text: "年龄" }
]);
appendItem(p_item) 方法
向 EntityContainer 请求添加一行数据，成功后再调用 {@link me._appendItem} 方法。
参数
- p_item一个 JSON 对象（如 { name:"bruce", value:"lee" }，“name”和“value”为列（DataGridColumn 类型）的 DataGridColumn.name 字段值）。
继承自
clearItems() 方法
contains($p_target) 方法
返回一个 Boolean 值，该值表示控件的容器中是否包含该 JQuery 对象。
参数
- $p_target一个 JQuery 对象，或 JQuery 选择器对应的字符串（如“#container”），或 HTML DOM 元素。
继承自
create() 方法
工具栏“新建”按钮对应的默认方法。可重写。
deselectAll([p_triggerEvent]) 方法
参数
- p_triggerEvent可选的。默认值为“true”。一个 Boolean 值，表示是否要触发 onselectionchanged 事件。如果该值为 true，则触发事件；反之则不触发。
继承自
deselectItem(p_item, [p_triggerEvent]) 方法
参数
- p_item一个 DataGridItem 对象，表示要清除对该项的选定。
- p_triggerEvent可选的。默认值为“true”。一个 Boolean 值，表示是否要触发 onselectionchanged 事件。如果该值为 true，则触发事件；反之则不触发。
继承自
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(); |
getItemDefaultData() 方法
获取一行记录的的默认值
返回一个 JSON 对象（如 { name:"bruce", value:"lee" }，“name”和“value”为列（DataGridColumn
类型）的 DataGridColumn.name 字段值）。
继承自
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则是锁定状态，反之是未锁定
当编辑处于锁定状态，将会一直保持在其对应的单元格上，直到解锁为止
继承自
load([p_data], [p_callback]) 方法
向 EntityContainer 加载数据。
参数
- p_data可选的。默认值为“null”。一个 JSON 对象，表示用户自定义需要保存的参数。
- p_callback可选的。默认值为“null”。一个回调的函数。
继承自
markError(p_itemId, p_colName, p_value, p_msg) 方法
提供一个方法，给指定单元格上标记错误。
参数
- p_itemId一个字符串，表示单元格所行的 id
- p_colName一个字符串，表示单元格所在列的列标题。
- p_value一个 Boolean 值，true 时标记错误，false 时取消标记。
- p_msg一个字符串，表示提示信息，p_value 为 false 时，可以不传值。
继承自
moveDown(p_needSelectedTip) 方法
提供下移勾选行的方法，如果没有勾选行，则下移当前选中行。
参数
- p_needSelectedTip一个 Boolean 值，表示下移时如果没有选择行是否给出提示，默认为 false，不给出提示。
继承自
moveItem(p_item, p_index) 方法
将指定的数据项移动到指定的索引位置。也可以使用 DataGridItem 的 DataGridItem.moveTo 和
DataGridItem.moveUp、DataGridItem.moveDown 方法。
参数
- p_item一个 DataGridItem 对象。
- p_index一个数字，表示移动的索引位置。
继承自
moveTo(p_left, p_top) 方法
移动控件到指定位置。
参数
- p_left一个数字，表示 css 样式的 left 属性。
- p_top一个数字，表示 css 样式的 top 属性。
继承自
moveToPage(p_index) 方法
printGrid(p_preview) 方法
提供一个方法，打印表格内容。
参数
- p_preview: true | false 一个 Boolean 值，表示是否启用打印预览功能，默认 true true : 表示显示打印预览 false : 表示不显示打印预览，直接打印
继承自
remove() 方法
工具栏“删除”按钮对应的默认方法。可重写。
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) 方法
重设控件的大小。
参数
- p_width控件的宽度，可以是数字（如 100），也可以是字符串（如 “100%”）。
- p_height控件的高度，可以是数字（如 100），也可以是字符串（如 “100%”）。
继承自
save([p_data], [p_callback]) 方法
向 EntityContainer 请求保存数据。
参数
- p_data可选的。默认值为“null”。一个 JSON 对象，表示用户自定义需要保存的参数。
- p_callback可选的。默认值为“null”。一个回调的函数。
继承自
saveData() 方法
工具栏“保存”按钮对应的默认方法。可重写。
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() 方法
setBorder(p_border) 方法
setBottom(p_bottom) 方法
setCssClass(p_cssClass) 方法
setDisplay(p_display) 方法
setDisplayCheckBox(p_displayCheckBox) 方法
setDisplayColSplitLine(p_displayColSplitLine) 方法
setDisplayHead(p_displayHead) 方法
setDisplayRowNumber(p_displayRowNumber) 方法
设置 displayRowNumber 的字段值。
此方法只在构造参数中高displayRowNumber为true时有效
参数
- p_displayRowNumber一个 Boolean 值，表示是否要要在表格第一列显示行号。
继承自
setDisplayStatisticRow(p_displayStatisticRow) 方法
setDisplayToolBar(p_displayToolBar) 方法
setEntityContainer(p_entityContainer) 方法
setFilter(p_filter, [p_override]) 方法
设置 filter 字段的值
参数
- p_filter一个字符串或 Json 对象，表示查询的参数。
- p_override可选的。默认值为“true”。一个 Boolean 值，表示是否覆盖原先的 filter 字段的值。
继承自
setHeight(p_height) 方法
setItemEnabled(p_id, p_enabled) 方法
设置 DataGrid 的某一行是否可编辑
p_id DataGridItem 的 id 或是其的索引值
p_enabled 一个布尔值，true 代表可编辑，false 代表不可编辑
参数
- p_id
- p_enabled
继承自
setPadding(p_padding) 方法
setPosition(p_position) 方法
setSearchBox(p_searchBox) 方法
设置DataGrid的DataGridSearchBox控件
参数
- p_searchBox一个 mx.datacontrols.DataGridSearchBox 实例
继承自
setTop(p_top) 方法
setVisible(p_visible) 方法
setWidth(p_width) 方法
showImportExcelWizard([p_windowManager], [p_url], [p_callback]) 方法
打开导入 Excel 表格的向导窗口，并返回该向导。
参数
- p_windowManager
- p_url可选的。一个字符串，表示处理 Excel 的服务地址。平台默认提供了解析 Excel 文件的服务，但需求不能满足时需要自定义服务。
- p_callback可选的。一个回调函数，当向导完成后执行该方法。
继承自
sort(p_column, p_order) 方法
将指定列的数据项进行排序。
参数
- p_column一个数字（如 0），表示列在集合中的序号；或一个字符串，表示列的名称；或一个 DataGridColumn 对象。
- p_order一个 Boolean 值，表示按升序或降序排序。请参见 sortOrder 字段。
继承自
validate() 方法
不提供默认校验逻辑，允许自定义扩展。
返回值格式为 {successful: true|false, hint: "校验提示信息"}
继承自
$wrap([p_obj]) 方法
返回一个 JQuery 对象。
参数
- p_obj可选的。默认值为“me.$e”。一个 JQuery 对象，或继承自 Control 的控件，或字符串，或 HTML DOM 元素。如果参数为 JQuery 对象，则返回本身；如果参数为继承自 Control 的控件，则返回控件的 $e 对象；如果参数为字符串，则返回以字符串为选择器的 JQuery 对象；如果参数为空，则返回控件本身的 $e 对象。
继承自
_appendItem(p_item) 方法
参数
- p_item一个 JSON 对象（如 { name:"bruce", value:"lee" }，“name”和“value”为列（DataGridColumn 类型）的 DataGridColumn.name 字段值）或一个 DataGridItem 对象。
继承自
_changeEditorToText(p_fieldName) 方法
_compareItems(p_item1, p_item2) 方法
受保护的。返回一个值，指出在当前的区域设置中两个对象（DataGridItem 类型）是否相同。 如果
p_item1 排序在 p_item2 之前，那么返回 –1；如果 p_item1 排序在 p_item2 之后，则返回 +1。如果返回值为
0，那就说明这两个对象是相同的。
参数
- p_item1一个 DataGridItem 对象。
- p_item2将与 p_item1 进行比较的 DataGridItem 对象。
继承自
_createColumnEditor(p_column) 方法
_hasTempColumn(p_columns) 方法
受保护的。判断p_columns是否包含名为me._tempColumnName的列，
这里只找顶级的列，不进行递归查找。因为_tempColumnName只能出现在顶级列中
参数
- p_columns
继承自
_initColumnsPercentage() 方法
_markCellNotNull(p_error_row) 方法
_mergerColumns(p_clientColumn, p_serverColumn, p_keyField) 方法
参数
- p_clientColumn一个数组，表示客户端的 columns 信息。
- p_serverColumn一个数组，表示服务端的 columns 信息。
- p_keyField一个字符串，表示用于标识是否是相同列的字段名称。
继承自
字段详细信息
allowAdjusting 字段
allowDraggingColumn 字段
allowDraggingItem 字段
获取或设置一个 Boolean 值，该值表示是否可以拖动 {@link mx.datacontrols.DataGrid.DataGridItem} 项。
继承自
默认值
true
allowDraging 字段
获取或设置一个 Boolean 值，该值表示是否可以调整 DataGrid 控件中列的宽度。如果该值为 true，表示可以调整；反之则不可以。
该属性和 allowDraggingColumn 属性意义相同。
继承自
默认值
true
allowInterlacedRow 字段
allowMultipleSorting 字段
autoSelect 字段
获取或设置一个值，表示当列表中没有选中项的时候，是否自动选择第一个数据项。如果该值为 true，则自动选择；反之则不自动选择。
继承自
默认值
false
baseUrl 字段
请参见 EntityContainer.baseUrl 属性。如果 DataGrid 的 entityContainer 由外界创建，那么该属性不需要设置；
否则需要设置该属性的值。
继承自
columns 字段
获取和设置一个集合，用于创建含控件中显示的所有 DataGridColumn。
继承自
集合
该字段是一个集合数组字段。
集合中成员的类型为
mx.datacontrols.DataGridColumn。
集合索引
列的名称（DataGridColumn.name）或列在集合中的序号（从 0
开始计数）。
display 字段
获取控件的显示样式值。如“none”，表示隐藏控件；
“block”表示强制作为块对象呈递。请使用 setDisplay。注：该"block"值不能在ComplexGrid控件中使用。
方法设置该字段的值。
继承自
displayCheckBox 字段
获取或设置一个 Boolean 值，该值表示数据项之前是否显示一个选择框。如果该值为 true，则表示显示；反之则不显示。请使用
setDisplayCheckBox 方法设置该字段的值。
继承自
默认值
false
displayColSplitLine 字段
displayPrimaryKey 字段
displayRowNumber 字段
获取或设置一个 Boolean 值，该值表示数据项之前是否显示行号。如果该值为 true，则表示显示；反之则不显示。请使用
setDisplayRowNumber 方法设置该字段的值。
继承自
默认值
false
displayStatisticRow 字段
获取或设置一个 Boolean 值，该值表示表格是否显示统计行。如果该值为 true，则表示显示；反之则不显示。
请使用 setDisplayStatisticRow 方法设置该字段的值。
如果需要设置某列的统计值，请使用 DataGridColumn.setStatisticValue 方法，或者使用
DataGridColumn.statisticValue 属性设置初始统计值。
继承自
默认值
false
editOnSelected 字段
enabled 字段
entityContainer 字段
继承自
imagePosition 字段
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 后，处理返回数据的回调函数。
继承自
items 字段
获取一个集合，包含数据项列表中所有的项（DataGridItem 类型）。请使用
setItems 方法设置该字段的值。
继承自
集合
该字段是一个集合数组字段。
集合中成员的类型为
mx.datacontrols.DataGridItem。
集合索引
数据项在集合中的序号（从 0 开始计数）。
layoutConfigs 字段
moveByShortcutKey 字段
获取或设置一个 Boolean 值，表示是否使用向上快捷键（ctrl+↑）或向下快捷键（ctrl+↓）移动表格行。
继承自
默认值
false
multipleSortColumns 字段
获取或设置一个字符串，表示需要多列排序的列名称（如“age,gender,name”），以逗号分隔，排序顺序为从左向右。
继承自
padding 字段
获取控件的内边距。如“4px”表示上下左右的内边距均为 4 像素； “4px 2px 3px 1px”则表示上边距为 4 像素，右边距为 2
像素，下边距为 3 像素，左边距为 1 像素。请使用 setPadding 方法设置该字段的值。
继承自
pageIndex 字段
在数据创建中调用，加入这个处理是因为，如果在创建数据的过程中要先清理掉当前表格的编辑状态。
如果清除编辑器出错，则中止新数据的创建过程，如果不清除，由于_editingItem没有切换，可能会造成在调用renderCell时，渲染出错的情况
继承自
默认值
1
position 字段
获取控件位置样式值。如“static”，表示无特殊定位，对象遵循 HTML 定位规则。请使用 setPosition
方法设置该字段的值。
该字段的可选值包括:
- static
- relative
- absolute
- fixed
继承自
primaryKey 字段
saveMessage 字段
获取和设置一个字符串，该属性表示表格数据保存成功后的提示信息。当用户设置为空或者空字符串时，保存动作发生后将不提示信息。
继承自
默认值
mx.msg("SAVE_SUCCESS")
searchParamType 字段
获取或设置表格的查询条件类型。json 表示查询参数filter 的值采用 Json 对象的形式传递。string 表示查询参数 filter 的值采用字符串的形式传递。
该字段必须在初始化前设置。
该字段可选的值包括：
- json
- string
继承自
selections 字段
获取一个集合，表示 DataGrid 中当前选定的所有数据项（DataGridItem类型）的集合。
注意：该数组不是勾选项的集合。如果需要获取勾选项的集合，请使用 {@link getCheckedItems()} 方法。
继承自
sortOrder 字段
_hasOverrideRenderCell 字段
事件详细信息
oncelledited 事件
当数据项进行编辑后，将触发该事件。
参数
- column一个 DataGridColumn 对象。
- item一个 DataGridItem 对象。
- cell一个 Jquery 对象，表示当前编辑的单元格（TD）。
继承自
oncellediting 事件
当数据项进行编辑时，将触发该事件。此时单元格内编辑器尚未创建。
参数
- cancel可通过设置 cancel 参数为 true 来取消当前操作。默认为 false。
- column一个 DataGridColumn 对象。
- item一个 DataGridItem 对象。
继承自
oneditorcreated 事件
oneditorcreating 事件
onitemchecked 事件
onitemclick 事件
onitemcreated 事件
onitemdoubleclick 事件
onitemindexchanged 事件
当数据项索引发生改变的时候，将触发该事件。通常调用 moveItem、DataGridItem.moveUp、DataGridItem.moveDown、DataGridItem.moveTo 方法时会触发该事件。
参数
- sourceItem一个 DataGridItem 对象，即移动的源数据项。
- targetItems一组 DataGridItem 对象集合，即被移动的目标数据项集合。
继承自
onpageindexchanged 事件
onselectionchanged 事件
继承自
onselectionchanging 事件
当控件当前的选择项发生改变的时候，将触发该事件。调用 selectItem 方法时会触发该事件。
参数
- cancel可通过设置 cancel 参数为 true 来取消当前操作。默认为 false。
- item一个 DataGridItem 对象，即将被选择的项。