构建 GridEntityContainer 类的新实例。
全称 | mx.datacontainers.GridEntityContainer |
命名空间 | mx.datacontainers |
类 | GridEntityContainer |
继承层次结构 | GridEntityContainerEntityContainer |
源文件 | ~\mx\scripts\datacontainers\GridEntityContainer.js |
JavaScript 代码 |
var container = new mx.datacontainers.GridEntityContainer(
{
"baseUrl" : "~/rest/getData"
});
container.on("load", function()
{
alert("onload");//触发 onload 事件。
});
container.load(paras);//根据指定的参数加载数据。 |
JavaScript 代码 |
var dc = new mx.datacontainers.GridEntityContainer(
{
"type" : "local", //声明容器类型为本地数据。
"meta" :
[
{
"name" : "id",
"caption" : "主键"
},
{
"name" : "name",
"caption" : "姓名"
} ], //本地元数据信息。
"data" :
[
{
"id" : "local_1",
"name" : "local_1_name"
},
{
"id" : "local_2",
"name" : "local_2_name"
},
{
"id" : "local_3",
"name" : "local_3_name"
} ] //本地数据信息。
});
container.on("load", function()
{
alert("onload");//触发 onload 事件。
});
container.load(); |
名称 | 说明 |
GridEntityContainer() | 构建 GridEntityContainer 类的新实例。 |
名称 | 说明 |
init() |
名称 | 说明 |
bind(p_target) | 提供一个方法,用于跟另外一个数据容器绑定,达到数据同步的效果。 |
checkSaved(p_id) | 提供一个方法,检查指定数据是否保存过。true 表示数据为修改状态;false表示数据为新增状态,尚未保存。 |
clearChanges() | 提供一个方法,清除容器中记录的数据改变信息。 |
create([p_entity]) | 添加一个数据对象。 |
create([p_entity], p_options) | 添加一个数据对象。 |
getChanges() | 提供一个方法,获取数据容器中已改变但未保存的内容。 |
getEntity(p_entity) | 提供一个方法,返回一条数据,这条数据的主键与参数对象的主键值相同。 |
getEntityByIndex(p_index) | 提供一个方法,根据数据在数组中的位置获取对象。 |
getEntityByKey(p_key) | 提供一个方法,根据主键获取对应的数据对象。 |
hasChanged(p_changed) | 获取或者设置 EntityContainer.changed 字段的值。 |
load([p_data]) | 为数据容器加载数据对象。 此方法主要供数据控件调用,一般情况下,不推荐开发人员在业务代码中调用此方法; 特殊情况如多个数据控件绑定同一个数据源时除外。 |
load([p_path]) | 为数据容器加载数据对象。 此方法主要供数据控件调用,一般情况下,不推荐开发人员在业务代码中调用此方法; 特殊情况如多个数据控件绑定同一个数据源时除外。 |
load([p_path], [p_data]) | 为数据容器加载数据对象。 此方法主要供数据控件调用,一般情况下,不推荐开发人员在业务代码中调用此方法; 特殊情况如多个数据控件绑定同一个数据源时除外。 |
load([p_path], [p_data], [p_callBack]) | 为数据容器加载数据对象。 此方法主要供数据控件调用,一般情况下,不推荐开发人员在业务代码中调用此方法; 特殊情况如多个数据控件绑定同一个数据源时除外。 |
remove(p_ID) | 根据主键删除数据对象。 |
remove(p_ID, [p_path]) | 根据主键删除数据对象。 |
remove(p_IDs, p_para, [p_path]) | 根据主键删除数据对象。 |
removeAll() | 删除所有的数据。 |
removeByIndexes(p_index) | 根据位置删除数据对象。 |
removeByIndexes(p_index, [p_path]) | 根据位置删除数据对象。 |
removeByIndexes(p_indexes, [p_path]) | 根据位置删除数据对象。 |
save([p_path]) | 调用后台服务,将新增和修改的内容保存到数据库。 保存前会调用 validate 方法检查数据值是否合法。 |
setBaseUrl(p_url) | 设置 baseUrl 字段的值。 |
setValue(p_entity, p_col, p_value) | 提供一个方法,修改表单中某个字段的值。 |
setValue(p_entity, p_col, p_value, [p_triggerEvent]) | 提供一个方法,修改表单中某个字段的值。 |
startEdit(p_key) | 提供一个方法,使指定数据进入编辑状态。 |
_getJsonFlatter() | 受保护的。 |
_parseArgs(p_args) | 受保护的。 |
_parseData(p_result) | 受保护的。 |
_parseMeta(p_result) | 受保护的。 |
_prepareLocalData(p_data, p_meta, p_para) | 受保护的。 |
_resetNewData(p_result) | 受保护的。 |
_setLoadArgs(p_result) | 受保护的。 |
_setLoadingArgs() | 受保护的。 |
_showError(p_msgKey, p_context) | 受保护的。 |
名称 | 说明 |
actionOverideBaseUrl | 设置或者获取是否使用action中相应的值作为baseUrl覆盖原有的baseUrl |
actions | 获取或设置一个 JSON 对象,表示数据容器中各种操作的 path 集合。该字段的字段名表示操作类型,值表示操作路径。
用户可以根据需要改变改变相应的操作路径。
该字段的字段名包括:
|
baseUrl | 获取数据容器的资源 URL。请参见 RESTClient.baseUrl。 |
canCreate | 获取一个 boolean 值,表示当前数据容器是否允许创建。 |
canDelete | 获取一个 boolean 值,表示当前数据容器是否允许删除。 |
canModify | 获取一个 boolean 值,表示当前数据容器是否允许编辑。 |
changed | 获取一个 Boolean 值,表示数据容器中是否存在修改过但未保存的数据。 当 insertEntity 和 updateEntity 方法被调用时,该字段被置为true;当 save 方法被调用时,该字段被还原为false。 |
client | 获取数据容器的 REST 服务客户端 RESTClient,数据容器通过此客户端调用后台服务。 |
data | 获取一个对象数组,表示数据容器中的数据值。 |
dicts | 获取一个数组,表示数据容器中的数据字典。通过字段名称可以获取该字段对应的所有数据字典。 |
editingItem | 获取一个对象,表示数据容器中正在编辑的一行数据 |
iscID | 获取或设置一个字符串,表示当前容器的操作权限,请求加载请求元数据是传给服务。 |
itemCount | 获取一个数字,表示当前数据容器中的数据条数。 |
loadDicts | 设置或获取一个 boolean 值,表示默认是否获取字典信息。 开发时确定字典信息由前端指定,不需要调用服务时,也可以设置为 false。 |
loadMeta | 一个 boolean 值,表示当前数据容器是否有元数据信息。 少数控件比如树没有元数据信息时,子类重写成 false。 开发时确定元数据信息由前端指定,不需要调用服务时,也可以设置为 false。 |
mdaParams | 获取或设置一个 JSON 对象,用于保存模型驱动所需要的参数。 |
meta | 获取一个数组,表示数据容器中的元数据信息,通常包含各个字段的类型及校验信息等内容。 |
primaryKey | 获取一个字符串,表示数据的主键(或唯一标识)所在列名。 |
type | 获取数据容器的类型。必须在创建数据容器时设定该属性。
该字段可选的值包括:
|
_changedItems | 受保护的。 |
_changingType | 受保护的。 |
_deleteIDs | 受保护的。 |
_lastLoad | 受保护的。 |
_loadCallBack | 受保护的。 |
_loadData | 受保护的。 |
_loadDataPara | 受保护的。 |
_loadMetaPara | 受保护的。 |
_oldData | 受保护的。 |
_saveCallBack | 受保护的。 |
_submitting | 受保护的。 |
_tempLoadResult | 受保护的。 |
名称 | 说明 |
onchanged | 当数据容器中的数据值发生改变后,将触发该事件。 |
onchanging | 当数据容器中的数据值发生改变的时候,将触发该事件。 |
oncreated | 当数据容器中新增数据对象后,将触发该事件。 |
oncreating | 当数据容器中新增数据对象时,将触发该事件。 |
ondeleted | 当数据容器中有数据对象被删除后,将触发该事件。 |
ondeleting | 当数据容器中有数据对象被删除时,将触发该事件。 |
onerror | 当出现错误时,将触发该事件。主要用于取消等待蒙板。 |
onload | 容器加载完数据后,将触发该事件。以下参数说明仅包含当前子类的扩展参数,基础参数和其他信息请参照 EntityContainer.onload 事件。 |
onloading | 当数据容器开始加载数据时,将触发该事件。调用 load 方法时会触发该事件。 |
onsaved | 当数据容器中的数据对象保存成功后,将触发该事件。调用 save 方法会触发该事件。 |
onsaving | 当数据容器中的数据对象保存时,将触发该事件。调用 save 方法会触发该事件。 |
onvalidate | 当数据容器中的数据对象保存时,如果服务端校验不通过,将触发该事件。 要求服务端在保存失败的时候返回的数据格式如下所示。 {successful: false, resultValue: [[ {"error":true,"errors":["最后使用时间格式不正确!"],"errorsToDefaulFormatString":"最后使用时间格式不正确!\n","fieldName":"lastTime","messages":[],"msgToDefaulFormatString":""}, {"error":true,"errors":["必须为整数,介于0-10000之间"],"errorsToDefaulFormatString":"必须为整数,介于0-10000之间\n","fieldName":"pointCount","messages":[],"msgToDefaulFormatString":""} ]] ,resultHint: ""} ,其中嵌套数组表示一条记录的校验结果,数组内的 JSON 表示一个字段的检验结果。 |
该字段的字段名包括:
该字段可选的值包括: