ITE接口文档.docx

ITE接口文档.docx

《ITE接口文档.docx》由会员分享，可在线阅读，更多相关《ITE接口文档.docx（46页珍藏版）》请在冰点文库上搜索。

ITE接口文档

ITE接口文档

1IteForm接口

Form操作接口。

主要包括操作页面、执行功能等接口。

每个Form页面，都会包含一个全局对象gIteForm。

通过该对象，调用IteForm接口方法，可操作当前Form页面对象。

如取一个控件的值，可这样调用：

gIteForm.wg.getWidgetVal（“pageid”）;

根据处理的对象不同，IteForm接口包含如下几个包：

●fn功能

●svc服务

●pn面板

●wg控件

●grid表格

●formForm公共方法和属性

1.1全局属性

●ctxpathURL根路径

●skin使用的皮肤

●titleform标题

●formid当前页面的panelid

●tabbar本form所在tab页的tabbar。

●tabid本form所在tab页的tabid

●toolbar本form的toolbar。

●panels页面中所有panel的基本信息。

其key值为panelid，value为该panel的基本信息，包括：

layout、pid（父panelid）、chgflag（记录非GridPanel的修改标记）

●widgets页面中所有widget的基本信息。

其key值为pageid，value为该pageid所属widget的基本信息，包括：

panelid、label、wgtype、readonly、defaultValue、wgJsType、format、wgprop、realStatOp

●fns页面中所有使用到的功能对象。

key=fnid,value=功能对象，包含id,name,beforecode,aftercode,showwaitbox,isauth,types,showresult,svcs

1.2Fn

1.2.1doFunctions（fnobjs,eRowid,resetPageno,extraData）

/*执行功能序列

参数对象：

fnobjs{Array}需要执行的功能。

可能为功能对象ID数组或者功能函数数组。

功能对象需要属性：

id,showwaitbox,showresult,beforecode,aftercode,svcs{id,params,paramfilter,refreshs,resetchgflags}

eRowidGrid中发生事件行的rowid。

如果非Grid内单元格的事件，该值应传入null。

resetPageno是否需要重置页号到第一页。

默认为true。

一般来说，仅在Grid的换页和排序事件中需要设置为false。

extraData额外数据。

任意对象，可在功能的前后置代码中使用。

*/

1.2.2genFnParam（fnid,eRowid,resetPageno）

/**

*生成功能所有服务的参数

*参数：

fnid功能ID

eRowidGrid中发生事件行的rowid。

如果非Grid内单元格的事件，该值应传入null。

resetPageno是否需要重置页号到第一页。

默认为true。

一般来说，仅在Grid的换页和排序事件中需要设置为false。

返回：

Map{key="svc_{svcid}",vlaue=[{服务定义参数组成的对象}]}。

取参数失败或校验失败时，返回false。

*/

1.2.3viewReport（fnid,eRowid,reportAtxPageid,reportid,isAutoPrint,isViewPrintDlg,nCopies）

/**

*显示报表

*参数：

fnid查询报表数据的功能ID

*eRowid如果是从Grid中的行事件中执行本功能，传入事件行的rowid

*reportAtxPageid报表控件在页面上的ID

*reportid报表ID

*isAutoPrint是否自动打印（Y/N）。

为Y时，显示报表后，直接执行打印功能

*isViewPrintDlg是否显示打印对话框（Y/N）。

*nCopies打印份数。

默认为1

*返回：

失败时返回false。

其他未定义。

*/

1.2.4doFnNew（resetPageids,excludePageids）

/**

*执行“新增”功能。

主要功能是重置功能相关的panel。

*参数：

resetPageids{Array}需要重置的panelid内的任意widgetid列表

*resetPanelids{Array}需要重置的panelid列表

*excludePageids{Array}重置时需要排除的控件ID列表。

可选。

不指定时重置panel内除button、link外的所有控件。

*返回：

成功新增时返回true，否则返回false

*/

1.2.5doFnNewAndKeepValue（resetPageids,showtips）

/**

*执行“新增并保留当前值”功能。

主要功能是重置功能相关panel的主键ID。

*参数：

resetPageids{Array}需要重置的widgetid列表

*showtips复制成功后，显示提示信息。

Y提示默认消息，N不提示，其他字符串为提示消息。

默认为Y。

*返回：

成功时返回true，否则返回false

*/

1.3Svc

1.3.1svcRefresh（svcs,data）

/*刷新一个功能的执行结果到页面中

参数：

svcs服务对象数组

data服务执行结果

*/

1.3.2genSvcParam（svc,paramfilter,eRowid,targetWin,resetPageno,isGridSaveCell）

/*生成服务使用的参数

参数：

svc服务定义信息

paramfilter取参数的过滤条件

eRowid如果执行预定义功能的操作是由Grid内部事件触发的，eRowid为该事件的事件源所在行的rowid

targetWin目标窗体。

为空时表示目标窗体为当前窗体。

resetPageno是否需要重置页号到第一页。

默认为true。

一般来说，仅在Grid的换页和排序事件中需要设置为false。

isGridSaveCell{boolean}如果有参数处于Grid中，Grid是否要退出编辑状态。

默认为true。

返回：

参数对象组成的数组。

格式：

[{"参数名":

"参数值",...},...]。

如果没有任何参数在Grid中，则数组中仅会有一条记录。

*/

1.3.3confirmDelete（svcid,params,selMsg,confirmMsg）

1.3.4putParamRule（fnid,svcid,pageid,ruleName,ruleParam）

/**

*确认删除。

本函数主要用于删除Grid中行的功能前置代码中。

*一般来说，执行删除功能时，服务的参数中应该包含参数值。

*该函数首先检查参数中是否有值（相当于判断Grid中是否选择了行），没有值时提示用户选择需删除数据。

已选择行时，提示用户确认删除。

*参数：

svcid执行删除服务的ID

*params需要上传到服务的参数。

（一般是在doFunction中生成的）

*selMsg提示选择数据的消息。

空串时不提示。

有内容时提示指定消息，否则提示默认消息。

*confirmMsg确认删除消息。

空串时不提示。

有内容时提示指定消息，否则提示默认消息。

*返回值：

参数中没有数据时或用户选择不删除时，返回false。

其他返回true。

*/

/**

*增加或更改服务控件的校验规则

*@paramfnid功能ID。

服务所在功能的ID。

*@paramsvcid服务ID。

控件所在服务的ID。

*@parampageid控件pageid。

需设置校验规则的服务控件pageid。

*@paramruleName规则名。

*@paramruleParam规则参数对象。

参数为null时，删除规则。

*/

1.4pn

1.4.1getPanelIdByPageid（pageid,widgetMustExists）

/**

*通过控件页面ID列表查找包含这些控件的面板ID列表

*参数：

pageid{String}一个控件的pageid或{Array}多个控件的pageid

*widgetMustExists控件是否都必须存在。

默认为false。

设置为true时，如果pageid中有不包含在当前页面中的控件，则提示错误并返回false。

*返回：

{String或Array}包含指定控件的一个面板ID或多个面板ID列表。

注意：

*如果pageid为null，则返回null。

*如果pageid为Array，则返回Array。

*如果pageid为String，则返回String。

*如果widgetMustExists设置为true，并且pageid中有不包含在当前页面中的控件，则提示错误并返回false

*/

1.4.2checkPanelsChangeReminder（pageids）

/**

*检查panel是否需要提醒改变。

*参数：

pageids{Array}控件页面ID列表

*panelids{Array}panelid列表。

如果为null，则检查pn._changeReminderPanels中的所有panel

*返回：

如果panelids中有panel包含在pn._changeReminderPanels并且panel内数据已变更时，返回已变更的第一个panelid。

否则返回null。

*/

1.4.3this.pn.changeReminder（pageids）

/**

*变更提醒。

*如果指定的panel包含在pn._changeReminderPanels并且panel内数据已变更时，提醒用户确认。

*参数：

pageids{Array}控件页面ID列表

*panelids{Array}panelid列表。

如果为null，则检查pn._changeReminderPanels中的所有panel

*返回：

如果panel没有变更，或panel没有包含在pn._changeReminderPanels，或者用户确认继续操作时返回true。

否则返回false。

*/

1.4.4setPanelChgFlag（pageid,chgFlag）

/**

*设置panel的修改标记

*参数：

pageidpanel内任一控件的pageid

*chgFlag标记值（Y/N）

*/

1.4.5getPanelChgFlag（pageid）

/**

*取panel的修改标记。

*参数：

panelid面板ID

*返回：

如果panel为Grid，则Grid中有任意一行修改了，返回Y，否则返回N。

如果panel不是Grid，则直接返回chgflag的值

*/

1.4.6resetPanel（pageid,excludePageids）

/**

*重置panel。

如果panel为Grid，则清除Grid中的数据。

如果panel不是Grid，则重置panel中的widgets到初始值。

*参数：

pageidpanel内任一控件的pageid

*panelid需重置的panelid。

*excludePageids{Array}重置时需要排除的控件ID列表。

可选。

不指定时重置panel内除button、link外的所有控件。

*/

1.4.7showPanel（panelid,isvisible,pageid）

/**

*显示或隐臧panel

*参数：

panelidpanel的ID。

无效时根据pageid查找包含控件的panel

*isvisible面板是否可见，默认为true

*pageid（可选）面板内任意一控件的pageid。

panelid无效时，将根据该pageid查找panel。

*/

1.4.8showPanelByWidgetVal（panelid,wgPageid）

/*

根据widget的值，控制panel的显示或隐藏。

widget值有效时，显示panel；无效时，隐藏panel

参数：

panelidpanel的ID

wgPageidwidgetpageid

*/

1.4.9enableToolbarItemByWidgetVal（toobarPanelId,toolbarItemId,wgPageid）

/*

根据widget的值，控制toolbar项是否有效

参数：

toobarPanelIdtoolbar所在panel的ID值。

注意不是toolbarpanel的id值，是其父panel的id值。

（该参数已废弃）

toolbarItemIdtoolbar项在sys_paneltoolbar中的pageid值

wgPageid控件pageid

*/

1.5Wg

1.5.1getWidgetDataText（pageid,dataInfo）

/*根据combo、tree、ddgrid控件的数据信息，组合显示文本

参数：

pageidwidget在页面上的ID

dataInfo控件的数据信息。

可选，未设置时从控件中取。

返回：

控件的显示文本

*/

1.5.2getWidgetDataValue（pageid,dataInfo）

/*根据combo、tree、ddgrid控件的数据信息，组合值

参数：

pageidwidget在页面上的ID

dataInfo控件的数据信息

返回：

控件的显示文本

*/

1.5.3getDataInfoFromValText（pageid,val,text）

/**

*根据控件的值和文本，得到控件需要的DataInfo格式的数据。

*只能用于得到一个值的情况，如单选下拉框、单选树等的datainfo数据。

*参数：

pageid控件ID

*val值

*text文本

*返回：

{"{pageid}_dispdata__":

{"{val}":

"{text}"}}

*/

1.5.4getDataInfoFromWidget（pageid）

/*从widget中取出dataInfo信息（combo、tree、ddgrid、file）

参数：

pageidwidget在页面上的ID

返回：

控件的数据信息

*/

1.5.5formatWidgetNumberVal（wgPageid,value）

/**

*格式化控件数值。

如果控件的数据类型是数值型，并且设置了格式，则格式化数值。

否则不作处理。

*参数：

wgPageid控件pageid

*value需要设置到控件的原始值

*返回：

格式化值

*/

1.5.6unformatWidgetNumberVal（wgPageid,value）

/**

*反格式化控件数值。

如果控件的数据类型是数值型，并且设置了千分位分隔符，则取值时需要去掉这个分隔符。

*参数：

wgPageid控件pageid

*value控件的原始值（可能带有千分位分隔符）

*返回：

反格式化后的值

*/

1.5.7getWidgetVal（wgPageid）

/*取页面上widget的值。

不同类型的widget取值方式不同。

参数：

wgPageidwidget在页面上的ID

返回：

widget的值

*/

1.5.8setWidgetVal（wgPageid,value,rowData）

/*设置页面上widget的内容。

这里要做些特殊处理

参数：

wgPageidwidget在页面上的ID

valuewidget值

rowData一行的完整数据。

用于combo、tree、file、ddgrid这类分为显示值与实际值的widget

*/

1.5.9resetWidgets（widgets）

/*重置widgets到初始值。

如果widget在Grid中，则重置整列数据。

参数：

widgets{Array}需重置的widgetpageid数组。

如果widget定义有缺省值，则将widget置为缺省值，否则置为空值。

*/

1.5.10widgetValidate（wgPageid,wgValue,paramRules）

/*校验用户输入的值

参数：

wgPageid字段在页面上的pageid

wgValue字段的值

paramRules参数设置的校验规则

返回：

校验成功时，返回true，失败时返回false

*/

1.5.11comboIsSelectedValue（wgPageid,combo）

/*判断combo里的值是否是通过选择项得到的值。

注意：

必须调用过combo的confirmValue或移开焦点后才正确。

参数：

wgPageid{wgPageid、combo可二选一，combo优先}widget在页面上的ID

combo{wgPageid、combo可二选一，combo优先}combo对象

返回：

combo里的值是通过从list中选择得到的值时返回true，否则返回false

*/

1.5.12comboSelectOptionByIndex（wgPageid,combo,index）

/*通过index选择combo项。

由于在页面中同时调用多个combo控件的selectOption方法时，有时会出现问题，所以定义这个函数。

参数：

wgPageidwidget在页面上的ID

combocombo对象

index从0开始的combo项索引值

*/

1.5.13comboReloadDataHandler（pageid）

/**

*combo重新载入数据处理函数。

*如果combo需要重新载入数据（如关联参数值变更时），需调用该函数。

以便combo可在合适时机重新载入下拉项。

*@parampageid控件页面ID

*/

1.5.14comboSetKeepInput（pageid,keepinput,inputro,combo）

/**

*combo设置是否保留输入框的值。

并设置下拉按钮样式。

*@parampageid控件页面ID

*@paramkeepinput是否保留输入框的值。

可取值：

Y/N。

*@paraminputro（可选）是否只读。

可取值：

Y/N，默认为N。

当设置为Y时，下拉按钮设置为只读样式。

*@paramcombo（可选）combo对象。

没有指定时，从data中取。

*/

1.5.15treeSetCheck（pageid,itemid,state）

/*设置tree项的check状态

参数：

pageidwidget在页面上的ID

itemidtree项的ID

statetrue/false

*/

1.5.16setWidgetReadonly（pageid,readonly）

/**

*设置控件的只读属性

参数：

pageidwidget在页面上的ID

readonly{boolean}是否只读

*/

1.5.17setFileWidgetAttachData（pageid,val）

/**

*设置文件控件的附加数据。

该数据内容上传文件时会一起上传到服务器。

*@parampageidwidget在页面上的ID

val附加数据内容

*/

1.5.18gridRowToWidgetValue（pageid,rowid,widgets,widgetsWin）

/*将Grid中数据设置到widget中。

在Grid所在页面调用。

*参数：

pageidpanel内任一控件的pageid

*gridpanelidGridpanelid

*rowid所在行的Rowid

*widgets{MIX}需要设置的widget列表。

默认为所有与Grid列名相同且存在的控件。

如果传入数组，则与数组中同名的控件。

如果为Map对象，则key为Grid中控件的pageid，value为目标控件的pageid。

*widgetsWinwidget所在window。

默认为当前window。

*/

1.5.19widgetValueToGridRow（pageid,rowid,widgets,gridWin）

/*将widget数据设置到Grid中。

在Widgets所在页面调用。

*参数：

pageidGrid内任一控件的pageid

*gridpanelidGridpanelid

*rowid所在行的Rowid

*widgets{MIX}需要设置的widget列表。

默认为所有与Grid列名相同且存在的控件。

如果传入数组，则与数组中同名的控件。

如果为Map对象，则key为Grid中控件的pageid，value为目标控件的pageid。

*gridWinGrid所在window。

默认为当前window。

*/

1.5.20setWidgetLabel（pageid,label）

/**

*设置控件的显示label

参数：

pageidwidget在页面上的ID

label文本

*/

1.5.21getWidgetPanelLayout（pageid）

/**

*取控件所在面板Layout

*参数：

pageidwidget在页面上的ID

*返回：

页面中存在控件时，返回控件所在panel的layout。

否则返回空串。

*/

1.5.22setWidgetDefVal（pageid,defaultValue,resetVal）

/**

*设置控件缺省值

*参数：

pageidwidget在页面上的ID

*defaultValue