API
Class

Data ($UI/wxsys/comps/tableData/data)

使用范围：WX

Contents

class Data ($UI/wxsys/comps/tableData/data) extends Component

数据基类

Constructor Top

  Data ()
  Data ( config)

Static Properties & Enumerations Top

DataState STATE

data的状态常量

Properties Top

boolean autoNew = false

自动新增数据，默认：false，当自动新增为false时，会自动加载
boolean confirmDelete

删除确认提示
string confirmDeleteText

删除确认提示文本
boolean confirmRefresh

数据修改后未保存刷新时的确认提示
string confirmRefreshText

未保存数据刷新确认提示文本

Attributes Top

boolean autoNew = false

自动新增数据，默认：false，当自动新增为false时，会自动加载

Methods Top

void applyUpdates ()
Boolean check ()
void clear ()
void colValid (Row | string row, string col)
void colValidInfo (Row | string row, string col)
void deleteAllData (DeleteDataParam options)
boolean deleteData (Any value, DeleteDataParam options)
void disableRecordChange ()
void enabledRecordChange ()
boolean getReadonly ()
Any getValueByPath (String path)
boolean isChanged ()
void loadAllPageData (Any parent, Any options)
void loadData1 (JSON data, Boolean append, Integer index)
void loadFromStorage (String key)
void loadNextPageData (Any parent, Any options)
void loadPageData (Any parent, Integer pageIndex, Any options)
Any newData (JSON options)
void refreshData (RefreshDataParam options)
void remove (Any value, Any parent)
void removeStorage (String key)
void saveData ()
void saveToStorage (String key)
JSON toJSON ()
void valid ()
void validInfo ()

Events Top

void afterDelete (AfterDeleteEvent event)
void afterNew (AfterNewEvent event)
void afterRefresh (AfterRefreshEvent event)
void afterSave (AfterSaveEvent event)
void beforeDelete (BeforeDeleteEvent event)
void beforeNew (BeforeNewEvent event)
void beforeRefresh (BeforeRefreshEvent event)
void beforeSave (BeforeSaveEvent event)
void customDelete (DeleteEvent event)
void customNew (CustomNewEvent event)
void customRefresh (CustomRefreshEvent event)
void customSave (CustomSaveEvent event)
void saveBatchReady (SaveBatchReadyEvent event)

Constructor details Top

public Data ()

数据基类

public Data ( config)

构造函数

Inherited from Operational

Parameters

config

操作配置

Static Properties & Enumerations Detail Top

static public DataState STATE

data的状态常量

Properties Detail Top

public boolean autoNew = false

自动新增数据，默认：false，当自动新增为false时，会自动加载

public boolean confirmDelete

删除确认提示

See ConfirmDeleteText

public string confirmDeleteText

删除确认提示文本

See ConfirmDelete

public boolean confirmRefresh

数据修改后未保存刷新时的确认提示

See ConfirmRefreshText

public string confirmRefreshText

未保存数据刷新确认提示文本

See ConfirmRefresh

Attributes Detail Top

public boolean autoNew = false

自动新增数据，默认：false，当自动新增为false时，会自动加载

Methods Detail Top

public void applyUpdates ()

进行数据状态的更新，设置data的数据行状态，如：清除删除行，清除编辑状态，版本号维护；通常在数据提交服务端成功后调用

Return Value

void

public Boolean check ()

检查数据合法性

Return Value

Boolean

public void clear ()

清除数据，前端数据清除不影响数据库中数据

Return Value

void

public void colValid (Row | string row, string col)

数据列是否满足约束

Parameters

Row | string row

行或者行ID
string col

[required]列名

扩展类型：COLUMN

Return Value

void

public void colValidInfo (Row | string row, string col)

数据列不满足约束提示

Parameters

Row | string row

行或者行ID
string col

[required]列名

扩展类型：COLUMN

Return Value

void

public void deleteAllData (DeleteDataParam options)

删除所有数据，感知directDeleteMode和confirmDelete属性设置
参数格式：

{ "confirm" : {boolean} - 删除确认提示，缺省使用属性confirmDelete }

Parameters

DeleteDataParam options

100 删除参数 (Optional)

Return Value

void

public boolean deleteData (Any value, DeleteDataParam options)

删除数据，当directDeleteMode=true时直接提交后台删除，当confirmDelete=true时会弹出删除确认框
参数格式：

{ "confirm" : {boolean} - 删除确认提示，缺省使用属性confirmDelete }

Parameters

Any value

行对象 缺省当前行 (Optional)
DeleteDataParam options

删除参数 (Optional)

Return Value

boolean

public void disableRecordChange ()

禁止data数据修改状态变化

Return Value

void

public void enabledRecordChange ()

启用data数据修改状态变化

Return Value

void

public boolean getReadonly ()

返回只读状态

Return Value

boolean

public Any getValueByPath (String path)

根据路径获取数据项

Parameters

String path

数据项路径

Return Value

Any

public boolean isChanged ()

判断data是否修改

Return Value

boolean

public void loadAllPageData (Any parent, Any options)

在分页状态加载所有数据
参数格式：

{ }

Parameters

Any parent

父节点, 如果是根时，parent为空
Any options

刷新参数

Return Value

void

public void loadData1 (JSON data, Boolean append, Integer index)

加载数据

Parameters

JSON data

要加载的数据
Boolean append

数据增加模式 true/false
Integer index

插入位置

Return Value

void

public void loadFromStorage (String key)

从localStorage加载数据

Parameters

String key

键值 缺省page.id@data.id

Return Value

void

public void loadNextPageData (Any parent, Any options)

加载下一页的数据，受offset、limit影响
参数格式：

{ }

Parameters

Any parent

父节点, 如果是根时，parent为空
Any options

刷新参数

Return Value

void

public void loadPageData (Any parent, Integer pageIndex, Any options)

分页模式下加载第N页数据
参数格式：

{ "async" : {boolean} - 异步执行，默认：false， "confirm" : {boolean} - 刷新提示，缺省使用属性confirmRefresh }

Parameters

Any parent

父节点, 如果是根时，parent为空
Integer pageIndex

页索引
Any options

刷新参数

Return Value

void

public Any newData (JSON options)

新增数据
参数格式：

{ "parent" : {Any} - 树形数据的父（非树形不需要）, "index" : integer - 新增数据的位置，缺省新增到最后, "defaultValues" : array - 新增行的默认值数组 ，数组的长度决定新增行数，数组中的对象是列的默认值 defaultValues格式： [ {列名:默认值,...}, {列名:默认值,...}, ... ] } 

 
 
 	var data = this.comp('mainData');
 	var options = {
 		defaultValues : [
 			{sName:'a1',sCode:'b1'},
 			{sName:'a2',sCode:'b2'}
 		]
 	};	
 	data.newData(options);

Parameters

JSON options

新增参数 ，支持多行新增

Return Value

Any

返回新增数据

public void refreshData (RefreshDataParam options)

数据刷新，当confirmRefresh=true并且数据是编辑或者新增状态时刷新数据时显示刷新确认提示框
参数格式：

{ "append" : {boolean} - 增量刷新，不清除原有数据，默认：false， "confirm" : {boolean} - 刷新提示，缺省使用属性confirmRefresh } 

 
	
 	//强制刷新data
 	var data = this.comp('mainData');
 	var confirmRefresh = data.confirmRefresh;
 	try{
		data.confirmRefresh = false;
	 	data.refreshData();
 	}finally{
 		data.confirmRefresh = confirmRefresh;
 	}

Parameters

RefreshDataParam options

刷新参数

Return Value

void

public void remove (Any value, Any parent)

移除指定的数据，只在前端移除不影响数据库

Parameters

Any value

被删除的数据
Any parent

被删除的数据的父节点

Return Value

void

public void removeStorage (String key)

删除localStorage中data的数据

Parameters

String key

键值 缺省page.id@data.id

Return Value

void

public void saveData ()

保存数据，向后端提交修改的数据

 
 
 	//保存成功后刷新data
 	this.comp('mainData').saveData();

Return Value

void

public void saveToStorage (String key)

data数据存储到localStorage

Parameters

String key

键值 缺省page.id@data.id

Return Value

void

public JSON toJSON ()

获取data的json格式序列化对象

Return Value

JSON

public void valid ()

数据是否满足约束

Return Value

void

public void validInfo ()

数据不满足约束提示

Return Value

void

Events Detail Top

public void afterDelete (AfterDeleteEvent event)

[回调型事件]业务数据删除后

Parameters

AfterDeleteEvent event


结构如下：

{ "source" : 组件的js对象, "deleteValue" : 被删除的数据 }

Return Value

void

public void afterNew (AfterNewEvent event)

[回调型事件]数据新增后

Parameters

AfterNewEvent event


结构如下：

{ "source" : 组件的js对象, "options" : 新增时传入的option参数，包括：parent,defaultValues "data" : 新增的数据 }

Return Value

void

public void afterRefresh (AfterRefreshEvent event)

[回调型事件]数据刷新后

Parameters

AfterRefreshEvent event


结构如下：

{ "source" : 组件的js对象 "limit" : 页大小, "offset" : 偏移, "options" : 刷新给入的参数 "success" : 是否成功刷新 }

Return Value

void

public void afterSave (AfterSaveEvent event)

[回调型事件]数据保存前

Parameters

AfterSaveEvent event


结构如下：

{ "source" : 组件的js对象, "cancel" : 可修改，设置为true后中断当前保存动作 "options" : 保存时给入的参数 }

Return Value

void

public void beforeDelete (BeforeDeleteEvent event)

[回调型事件]业务数据删除前

Parameters

BeforeDeleteEvent event


结构如下：

{ "source" : 组件的js对象, "cancel" : 可修改，设置为true后中断当前delete动作, "options": 数据删除的可选参数 "deleteValue" : 被删除的数据 }

Return Value

void

public void beforeNew (BeforeNewEvent event)

[回调型事件]数据新增前

Parameters

BeforeNewEvent event


结构如下：

{ "source" : 组件的js对象, "options" : 新增时传入的options参数，包括：parent,defaultValues "cancel" : 可修改，设置为true后中断当前new动作 }

Return Value

void

public void beforeRefresh (BeforeRefreshEvent event)

[回调型事件]数据刷新前

Parameters

BeforeRefreshEvent event


结构如下：

{ "source" : 组件的js对象, "options" : 刷新给入的参数 "cancel" : 可修改，设置为true后中断当前刷新动作 }

Return Value

void

public void beforeSave (BeforeSaveEvent event)

[回调型事件]数据保存前

Parameters

BeforeSaveEvent event


结构如下：

{ "source" : 组件的js对象, "cancel" : 可修改，设置为true后中断当前保存动作 "options" : 保存时给入的参数 }

Return Value

void

public void customDelete (DeleteEvent event)

[回调型事件]数据删除接管，完全接管删除动作

Parameters

DeleteEvent event


结构如下：

{ "source" : 组件的js对象, "cancel" : 可修改，设置为true后中断当前删除动作, "promise": 返回删除操作后的promise，根据返回promise自动完成doDeleteAfter "options": 删除参数 "deleteValue" : 删除的行对象, }

Return Value

void

public void customNew (CustomNewEvent event)

[回调型事件]业务数据新增接管，完全接管new动作，需要接管此事件完成data的newData逻辑

Parameters

CustomNewEvent event


结构如下：

{ "source" : 组件的js对象, "options" : 新增时传入的option参数，包括：parent,defaultValues "data" : 行数据对象数组[{sName:'LiMing',sAge:18},...]，数组的length决定新增的行数 data格式： [ { "列名" : 默认值, "列名" : 默认值, ... }, ... ] }

Return Value

void

public void customRefresh (CustomRefreshEvent event)

[回调型事件]数据刷新，完全接管刷新动作

Parameters

CustomRefreshEvent event


结构如下：

{ "source" : 组件的js对象, "cancel" : 可修改，设置为true后中断当前刷新动作, "limit" : 页大小, "offset" : 偏移, "promise": 返回刷新操作后的promise，根据返回promise自动完成doRefreshAfter "options" : 刷新给入的参数 }

Return Value

void

public void customSave (CustomSaveEvent event)

[回调型事件]数据保存接管，完全接管保存动作

Parameters

CustomSaveEvent event


结构如下：

{ "source" : 组件的js对象, "cancel" : 可修改，设置为true后中断当前保存动作 "promise": 返回保存操作后的promise，根据返回promise自动完成doSaveAfter "options" : 保存时给入的参数 }

Return Value

void

public void saveBatchReady (SaveBatchReadyEvent event)

[回调型事件]批保存准备

Parameters

SaveBatchReadyEvent event


结构如下：

{ "source" : 组件的js对象, "usePatch" : 使用批提交 "options" : 保存时给入的参数 }

Return Value

void