TRSWCM5二次开发-02接口API文档

修订记录1基本类、常用基本方法常用方法该节的方法需要依赖的JS引入情况如下：〈scriptsrc=〃../../app/js/easyversion/lightbase.js〃></script>〈scriptsrc=〃../../app/js/source/wcmlib/WCMConstants.js〃></script><scriptsrc=〃../../app/js/easyversion/extrender.js〃></script><scriptsrc=〃../../app/js/easyversion/elementmore.js〃></script>判断数据类型的方法判断数据是否是数组Ext.isArray(o)和Array.isArray(o)方法说明：通过这个方法，可以判断当前参数o的数据类型是否是数组，返回true或false；参数说明：参数o是要判断的数据；使用示例：例如要判断rels是否是数组；varrels=[];Array.isArray(rels);判断数据是否是布尔型数据Ext.isBoolean(o)方法说明：判断数据的类型是否是布尔型，返回true或false；参数说明：参数o是要判断的数据；使用示例：例如要判断o是否是布尔型数据；varo=true;Ext.isBoolean(o);判断数据类型是否是函数Ext.isFunction(o)方法说明：判断数据的类型是否是函数，返回true或false；参数说明：参数o是要判断的数据；使用示例：例如要判断参数o是否是函数；varo=function(){};Ext.isFunction(o);判断数据类型是否是字符串Ext.isString(o)方法说明：判断数据的类型是否是字符串型，返回true或false；参数说明：参数o是要判断的数据；使用示例：例如要判断定义的o是否是字符串类型；varo=aaa;Ext.isString(o);判断数据类型是否是数字Ext.isNumber(o)方法说明：判断数据的类型是否是number型，返回true或false；参数说明：参数o是要判断的数据；使用示例：例如要判断参数o是否是数字类型；varo=3;Ext.isNumber(o);判断数据类型是否是为空Ext.isEmpty(onotAllowBlank)方法说明：判断数据的类型是否是空类型，包括null、undefined、以及notAllowBlank参数不传或者传false，空串也返回true，返回true或false；参数说明：参数o是要判断的数据，参数notAllowBlank是是否允许空串也为空;使用示例：例如要o是否为空；varo= ;Ext.isEmpty(o);判断数据是否是基本数据类型(数字、字符串、布尔型)Ext.isSimpType(o)方法说明：判断数据的类型是否是基本数据类型，包括数字类型、字符串类型、布尔型，返回true或false；参数说明：参数o是要判断的数据；使用示例：例如要判断o是否是基本数据类型；varo=true;Ext.isSimpType(o);判断数据是否是object的方法Ext.isObject(o)方法说明：判断数据的类型是否是object型，返回true或false；参数说明：参数o是要判断的数据；使用示例：例如要判断数据o是否是一个object类型；varo=newObject();Ext.isObject(o);判断数据是否是dom元素的方法Ext.isDom(o)方法说明：判断数据的类型是否是dom元素类型，返回true或false；参数说明：参数o是要判断的数据；使用示例：例如要判断o是否是dom元素；〃te是一个元素的idvaro=$('te');Ext.isDom(o);字符串String的扩展方法判断字符串是否以某串字符结束endsWith(sEnd)方法说明：判断字符串是否是以某指定的字符串sEnd结束，返回true或false；参数说明：参数sEnd是字符串；使用示例：例如要判断字符串s是否是以‘efg'结束；〃判断字符串s是否是以‘efg'结束vars='abcdefg';alert(s.endsWith('efg'));判断字符串是否以某串字符开始startsWith(sStart)方法说明：判断字符串是否是以某指定的字符串sStart开始，返回true或false；参数说明：参数sStart是字符串；使用示例：例如要判断字符串s是否是以'abc开始；〃判断字符串s是否是以'abc'开始vars='abcdefg';alert(s.startsWith('abc'));去除字符串两头的空格trim()方法说明：去除字符串两头的空格，返回新的字符串;参数说明：无；使用示例：例如要将字符串s中两头的空格去掉；〃将字符串s中两头的空格去掉vars='aaaa';alert(s.trim());获取字符串的字符长度byteLength()方法说明：获取字符串的字符长度，一个汉字占2个字符；参数说明：无；使用示例：例如要获取字符串s的字符长度，一个汉字占2个字符;〃获取字符串的字符长度，一个汉字占2个字符vars='汉字'；alert(s.byteLength());字符串比较，忽略大小写equalsI(sc)方法说明：忽略大小写比较2个字符串是否相等，返回true或者false；参数说明：参数sc是源字符串；使用示例：例如要比较2个字符串是否相等，忽略大小写；〃比较2个字符串是否相等，忽略大小写vars='AAA';alert(s.equalsI('aaa'));将链接参数串转成json对象parseQuery()方法说明：将链接参数串转化成json对象，返回一个json对象;参数说明：无；使用示例：例如要将链接的参数串s转化成json对象；〃将链接的参数串s转化成json对象vars=?aaa=1&bbb=2&ccc=3;varqueryA=s.parseQuery();alert(queryA['aaa']);Array数组扩展方法获取数组的最后一个元素last()方法说明：获取数组中的最后的一个元素，并返回;参数说明：无；使用示例：例如要取数组a中的最后一个元素；〃取数组a中的最后一个元素vara=[3,4,5,6];alert(a.last());获取数组中某个元素的索引位indexOf(o)方法说明：获取元素o在数组中的位置，返回整数，没有找到元素0,返回-1；参数说明：参数0是要在数组中查找的元素；使用示例：例如要获取元素4在数组a中的位置；〃获取元素4在数组a中的位置vara=[3,4,5,6];alert(a.indexOf⑷)；移除数组中的指定的元素remove(o)方法说明：将数组中的元素o移除，返回移除后的数组;参数说明：参数0是要移除的元素；使用示例：例如要将取元素4从数组a中移除；〃将取元素4从数组a中移除vara=[3,4,5,6];alert(a.remove(4));移除数组中的空元素compact()方法说明：移除数组中的null元素，返回移除后的数组;参数说明：无；使用示例：例如要将数组中的null元素移除；〃将数组中的null元素移除vara=[3,4,null,5,null,6];alert(pact());判断指定数组是否包含某个指定的元素include(o)方法说明：判断指定数组是否包含某个元素，返回true或者false；参数说明：参数o是要判断是否包含的元素；使用示例：例如要判断数组a是否包含元素4；〃判断数组a是否包含元素4vara=[3,4,5,6];alert(a.include(4));循环遍历数组的每个元素，对每个元素进行相应处理each(function(item,index){})方法说明：循环遍历数组，参数是一个处理函数，对每个元素按处理函数处理；参数说明：参数是一个处理函数，处理函数的第一个参数是当前遍历到的元素，第二个参数是当前遍历到了数组的第几个元素；使用示例：例如循环遍历数组a，对每个元素进行相应输出；〃循环遍历数组，对每个元素进行相应处理vara=[3,4,5,6];a.each(function(item){alert(item);));Dom元素扩展的方法根据某个dom对象递归向父元素找具有某个属性或者某个样式的元素Element.find(t,attr,cls,aPAttr)方法说明：通过这个方法，可以根据指定的元素递归向上在自己和父元素中找具有某个属性或者样式的元素；参数说明：t是要从这个元素开始找得元素，attr参数是查找是否含有的属性名称，cls参数是查找是否含有的样式名称，aPAttr参数是属性数组，用于查找是否含有该属性数组里面的属性的元素；使用示例：例如根据指定的dom元素，查看dom元素及其父元素中是否能找到含有“trs_layout”样式的元素；Element.find(dom,null,'trs_layout');切换某个元素的显示/隐藏Element.toggle(el)方法说明：通过这个方法，可以切换某个元素的显示隐藏，如果该元素原来是显示的，执行了该方法，该元素将隐藏，反之亦然。参数说明：el是要切换的元素的id或者是该元素对象；使用示例：例如要切换id为test的元素显示/隐藏；Element.toggle('test');显示某个元素Element.show(el)方法说明：通过这个方法，可以使某个元素的显示，如果该元素原来是隐藏的，执行了该方法，该元素将显示。参数说明：el是要切换的元素的id或者是该元素对象；使用示例：例如要显示id为test的元素；Element.show('test');隐藏某个元素Element.hide(el)方法说明：通过这个方法，可以使某个元素的显示，如果该元素原来是显示的，执行了该方法，该元素将隐藏。参数说明：el是要切换的元素的id或者是该元素对象；使用示例：例如要隐藏id为test的元素；Element.hide('test');判断某个元素是否有某个样式Element.hasClassName(el,cs)方法说明：通过这个方法，可以判断指定元素是否有指定的样式class。参数说明：el是要切换的元素的id或者是该元素对象；使用示例：例如要判断一个id为test的元素是否具有样式名为box的样式；Element.hasClassName('test',‘box');给某个元素添加某个样式 Element.addClassName(el,cs)方法说明：通过这个方法，可以为指定元素添加指定的样式class。参数说明：el是要切换的元素的id或者是该元素对象；使用示例：例如要给一个id为test的元素添加样式名为box的样式；Element.addClassName('test',’box');给某个元素去掉某个样式Element.removeClassName(el,cs)方法说明：通过这个方法，可以为指定元素去掉指定的样式class。参数说明：el是要切换的元素的id或者是该元素对象；使用示例：例如要给一个id为test的元素去掉样式名为box的样式；Element.removeClassName('test',"box');取指定元素的后一个兄弟节点Element.next(dom)方法说明：通过这个方法，可以获取到指定的dom元素的后一个兄弟节点。参数说明：参数dom是dom元素对象；使用示例：例如要获取id为test的dom元素的下一个兄弟节点；Element.next($('test'));取指定元素的前一个兄弟节点Element.previous(dom)方法说明：通过这个方法，可以获取到指定的dom元素的前一个兄弟节点。参数说明：参数dom是dom元素对象；使用示例：例如要获取id为test的dom元素的前一个兄弟节点；Element.previous($('test'));取指定元素的第一个子节点Element.first(dom)方法说明：通过这个方法，可以获取到指定的dom元素的第一个子节点。参数说明：参数dom是dom元素对象；使用示例：例如要获取id为test的dom元素的第一个子节点；Element.first($('test'));取指定元素的最后一个子节点Element.last(dom)方法说明：通过这个方法，可以获取到指定的dom元素的最后一个子节点。参数说明：参数dom是dom元素对象；使用示例：例如要获取id为test的dom元素的最后一个子节点；Element.last($('test'));移除某个元素Element.remove(dom)方法说明：移除指定的dom元素。参数说明：参数dom是dom元素对象；使用示例：例如要移除id为test的dom元素；Element.remove($('test'));Json对象的相应方法获取json对象指定属性的值Ext.Json.value(json,xp,bCase)和$v(json,xp,bCase),两者等价方法说明：获取json对象指定属性的值;参数说明：参数json是json对象，xp是属性名称，bCase是控制属性是否不转为大写；使用示例：例如要获取json对象a的aaa属性值，bCase不传，默认为转为大写；〃获取json对象a的aaa属性值，bCase不传，默认为转为大写vara={AAA:1,BBB:2,CCC:3);alert($v(a,'aaa'));获取json对象指定属性的数组Ext.Json.array(json,xp,bCase)和$a(json,xp,bCase)，两者等价方法说明：获取json对象指定属性的值得数组，即指定的属性是一个数组；参数说明：参数json是json对象，xp是属性名称(可以用”.”分隔)，bCase是控制属性是否不转为大写；使用示例：例如要获取json对象a的doc数组，即多个doc的集合；〃获取json对象a的doc数组，即多个doc的集合vara={docs:{doc:[{title:'aaa',content:'bbb'},{title:'aaa1',content:'bbb1'},{title:'aaa2',content:'bbb3'}]));alert($a(a,'docs.doc',true));将xmlDocument对象解析成json对象Ext.Json.parseXml(xml)方法说明：将xmlDocument对象解析成json对象;参数说明：参数xml是xmlDocument对象；使用示例：将xmlDocument对象转化为json对象;Ext.Json.parseXml(xml)浏览器event的方法添加监听事件的方法Event.observe(el,name,fn)方法说明：通过这个方法，可以给某个对象绑定对某个事件的监听，并做相应的事情；参数说明：el是监听对象的id或者name串，name参数是监听的事件名串，fn是监听所要触发的事件；使用示例：例如要给一个id为olpt的input元素绑定一个监听click事件，单击后input框清空；Event.observe('oIpt','click',function(){//执行清空操作$('oIpt').value="”;));取消监听某事件的方法Event.stopObserving(el,name,fn)方法说明：取消对某个对象的某个事件的监听，并做相应的事情；参数说明：el是监听对象的id或者name串，name参数是监听的事件名串，fn是监听所要触发的事件；使用示例：例如要对上面那个id为olpt的input元素取消监听click事件；Event.stopObserving('oIpt','click',function(){});向Json追加参数的方法Ext.apply(o1,o2),Ext.applyIf(o1,o2)方法说明：Ext.apply和Ext.applylf都是向Json中追加参数的方法，applylf所不同的是只追加没有的，有就不追加了，而apply如果是有的话就覆盖了。参数说明：o1是被追加的Json对象，是返回的对象，o2是要追加的参数；使用示例：比如要向一个Json--oparams中追加一个siteid属性；//定义构造oParamsvaroParams={objectId:$('objId').value,docName:$('docName').value)//向oParams中追力口siteid参数，siteid以一个json对象的形式加入//applyIf与apply使用方法类似，使用需根据需要而定Ext.apply(oParams,{SiteId:obj.getId()));转成数组的方法$人(北6现公6)方法说明：这个方法是把对象集合转成对象数组，让其具有数组的属性；参数说明：参数iterable是个对象集；使用示例：把当前页面的所有input元素的集合转成数组varinputArray=$A(document.getElementsByTagName("INPUT"));客户端转义方法$transHtml(_sContent)和$trans2Html(_sContent,_bChangeBlank)方法说明：$transHtml和$trans2Html都是对内容中的特殊字符进行转义，$transHtml主要是对“<”，">"，“〃”进行转义，而$trans2Html是根据参数_bChangeBlank来决定是否对空格进行转义。参数说明：参数_sContent需要转义的内容，是字符串，_bChangeBlank为boolean型，决定是否对空格转义；使用示例：//获取对象obj上的value属性值，并进行转义varvalue=$transHtml(obj.getProperty('value'));//需要把空格也做转义varvalue=$trans2Html(obj.getProperty('value'),true);获取form中某个元素的值：$F(_id)方法说明：获取form表单中某个子节点(id为_id的元素)的值参数说明：参数_id是元素的id使用示例：获取id为startTimeHour的元素的值//获取id为startTimeHour的节点的值varaStartTimeHour=$F('startTimeHour');将json对象转化成用‘&’连接的链接参数键值串$toQueryStr(p0,up,encode)，方法$toQueryStr2(p0,up)功能类似，只是不做字符的编码方法说明：将json对象转化成链接后面所带参数的形式，返回的是以‘&’拼接的参数键值串；参数说明：参数p0是需要转化的json对象，参数up是控制是否要转为大写，参数encode是控制是否要对字符编码；使用示例：将参数json对象a转化为链接参数串；〃将参数json对象a转化为链接参数串vara={aaa:1,bbb:2,ccc:3);alert($toQueryStr(a,true,true));1.1.12获取链接参数值的方法getParameter(_sName,_sQuery)✓方法说明：获取链接上某个参数的参数值;✓参数说明：参数_sName是参数名，_sQuery是参数串，可以不传，默认取当前页面的；✓使用示例：获取参数名为’aaa’的参数值；〃将获取当前页面上参数名为’aaa’的参数值alert(getParameter("aaa"));WCMevent对象的常用方法该节的方法需要依赖的JS引入情况如下：〈scriptsrc=〃../../app/js/easyversion/lightbase.js〃></script>〈scriptsrc=〃../../app/js/source/wcmlib/WCMConstants.js〃></script><scriptsrc=〃../../app/js/easyversion/extrender.js〃></script><scriptsrc=〃../../app/js/easyversion/elementmore.js〃></script><scriptsrc=〃../../app/js/source/wcmlib/core/MsgCenter.js〃></script><scriptsrc=〃../../app/js/source/wcmlib/core/CMSObj.js〃></script>获取选中的第一个对象event.getobj()方法说明：在实现操作的时候，可能我们要得到一个选中的实体对象，如果是选中了多个，将会取第一个，可以通过这个方法获得；参数说明：不需要参数；使用示例：需要得到对象上面的docid属性varobj=event.getObj();varnDocId=obj.getProperty("docid");获取选中的对象集event.getObjs()方法说明：在实现操作的时候，可能我们要得到列表上选中的实体对象集，可以通过这个方法获得；参数说明：不需要参数；使用示例：需要得到选中的对象集中的第一个对象varobjs=event.getObjs();varobj=objs.getAt(O);获取选中的对象集的Id序列event.getIds()方法说明：在实现操作的时候，我们需要获取列表上选中的对象的id序列，可以用这个方法得到，返回的是一个id序列串；参数说明：不需要参数；使用示例：获取选中的对象集的id序列varsIds=event.getIds();获取当前列表所属对象event.getHost();方法说明：获取当前列表的所属对象，一般为栏目、站点，这个在我们需要获取当前列表所属的对象的相关信息如id，类型时经常用到；参数说明：不需要参数；使用示例：需要得到当前列表所属对象的类型和idvarhost=event.getHost();//得到所属对象的idvarhostId=event.getHost().getId();//得到所属对象的类型，返回的是描述，如website、channelvarsHostType=event.getHost().getType();//得到所属对象的类型，返回的是类型编号，如103、101varnHostType=event.getHost().getIntType();获取当前列表所属对象Idevent.getHost().getId()方法说明：得到所属对象的id，如过是站点，则返回站点的id，如果是栏目，则返回栏目的id；参数说明：不需要参数；使用示例：在实现操作的时候，需要构造请求的参数里需要站点或者栏目的id，可以这样得到；varhost=event.getHost();//得到所属对象的idvarhostId=event.getHost().getId();获取当前列表所属对象的类型event.getHost().getType() 和event.getHost().getIntType()方法说明：由于列表的所属对象分为站点和栏目，所以经常会需要判断所属对象的类型，可以通过这2个方法得到，getType()方法的到的是类型的描述，如website、channel；而getIntType()方法得到的是类型的编号，如101，103；参数说明：不需要参数；使用示例：在实现操作构造请求参数的时候，可能需要判断所属对象的类型，来决定是把所属对象的id赋给SiteId参数还是channelId参数；varhost=event.getHost();//得到所属对象的idvarhostId=event.getHost().getId();//得到所属对象的类型，返回的是类型编号，如103、101varsHostType=event.getHost().getType();varoparams={}//WCMConstants.OBJ_TYPE_WEBSITE即是定义的常量'website'if(nHostType==WCMConstants.OBJ_TYPE_WEBSITE){oparams={ChannelId:0,siteId:hostId};//WCMConstants.OBJ_TYPE_CHANNEL即是定义的常量'channel'}elseif(nHostType==WCMConstants.OBJ_TYPE_CHANNEL){oparams={ChannelId:hostId,siteId:0};}CMSObj该节的方法需要依赖的JS引入情况如下：〈scriptsrc=〃../../app/js/easyversion/lightbase.js〃></script>〈scriptsrc=〃../../app/js/source/wcmlib/WCMConstants.js〃></script>〈scriptsrc=〃../../app/js/easyversion/extrender.js〃></script>〈scriptsrc=〃../../app/js/easyversion/elementmore.js〃></script><scriptsrc=〃../../app/js/source/wcmlib/core/MsgCenter.js〃></script><scriptsrc=〃../../app/js/source/wcmlib/core/CMSObj.js〃></script>创建一个CMSObj实例createFrom(info,_context)方法说明：根据对象的基本信息(对象id和type)创建wcm基础对象CMSObj参数说明：参数info是包含对象id和type等的json对象，_context是包含创建对象后需要执行动作所需的相应参数的json对象；使用示例：例如栏目移动后，需要执行刷新操作，移动后发出消息；varinfo={objId:srcObjId,objType:WCMConstants.OBJ_TYPE_CHANNEL};varcontext={dstObjectId:dstObjId,isSite:isSite);CMSObj.createFrom(info,context).aftermove();创建一个CMSObjs实例createEnumsFrom(info,_context)方法说明：根据对象的type,创建wcm基础集合对象CMSObjs参数说明：参数info是包含对象type的json对象，_context是包含创建对象后需要执行动作所需的相应参数的json对象；使用示例：在做某些对象(如栏目)的移动的以后，通知其他页面刷新，构造这些对象集合CMSObjs发出消息；〃在做某些对象(如栏目)的移动的以后，通知其他页面刷新varobjsOrHost=event.getObjsOrHost();varitems=口；for(vari=0;i<objsOrHost.length();i++){items.push({objId:objsOrHost.getAt(i).getId()));)varcontext={dstObjectId:_nTargetId,isSite:_bIsSite);varoCmsObjs=CMSObj.createEnumsFrom({objType:objsOrHost.getType()),context);oCmsObjs.addElement(items);oCmsObjs.aftermove();

1.3.3创建WCMevent1.3.3创建WCMevent的方法createEvent(info,_context)方法说明：根据对象的基本信息(对象id和type)创建wcm基础对象CMSObj参数说明：参数info是包含对象id和type等的json对象，_context一般是当前上下文信息，见PageContext.getContext()使用示例：例如根据当前操作的对象获取对象信息，然后创建WCMevent；〃根据当前操作的对象获取对象信息，然后创建WCMeventvarinfo=item.getItemInfo();vareventObj=CMSObj.createEvent(info,PageContext.getContext());CMSObjs平时很少用到，略MsgCenter该节的方法需要依赖的JS引入情况如下：〈scriptsrc=〃../../app/js/easyversion/lightbase.js〃></script><scriptsrc=〃../../app/js/source/wcmlib/WCMConstants.js〃></script><scriptsrc=〃../../app/js/easyversion/extrender.js〃></script><scriptsrc=〃../../app/js/easyversion/elementmore.js〃></script><scriptsrc=〃../../app/js/source/wcmlib/core/MsgCenter.js〃></script><scriptsrc=〃../../app/js/source/wcmlib/core/CMSObj.js〃></script>新建后要触发的事件CMSObj.afteradd(event)方法说明：在做添加一条记录的时候，当请求执行结束后，列表需要刷新，达到所见即所得的效果，只要调用一下这个方法就会发出消息，执行相应的刷新；参数说明：参数为event,详细请参考文档《TRSWCM6.5二次开发实体对象》使用示例：新建一条记录后，发个消息刷新列表；CMSObj.afteradd(event)修改后要触发的事件afteredit(event)方法说明：修改的情况同新建类似参数说明：参数为event，详细请参考文档《TRSWCM6.5二次开发-实体对象》使用示例：CMSObj.afteredit(event)删除后要触发的事件afterdelete()方法说明：对删除的对象调用这个方法，就会发出消息，执行相应的刷新；参数说明：没有参数使用示例：请求发送完后，回调函数中主动调用afterdelete方法执行刷新;m_oMgr.getHelper().call(m_oMgr.serviceId,'delete',oPostData,true,function(){event.getObjs().afterdelete();));PageContext该节的方法需要依赖的JS引入情况如下:〈script〃src=../../app/js/easyversion/lightbase.js"></script>〈script一〃src=../../app/js/source/wcmlib/WCMConstants.js"></script>〈script一〃src=../../app/js/easyversion/extrender.js"></script><script一〃src=../../app/js/easyversion/elementmore.js"></script><script一〃src=../../app/js/source/wcmlib/core/MsgCenter.js"></script><script一〃src=../../app/js/source/wcmlib/core/CMSObj.js"></script><script一〃src=../../app/js/source/wcmlib/core/AuthServer.js"></script><script一〃src=../../app/js/source/wcmlib/pagecontext/AbsList.js"></script>列表页面刷新PageContext