《htc组件api手册》由会员分享，可在线阅读，更多相关《htc组件api手册（119页珍藏版）》请在金锄头文库上搜索。
1、/用户名称：神州数码（中国）有限公司密级：HTC 组件 API 手册文档编号： 文档名称：编 写： 编写日期：审 核： 审核日期：批 准： 批准日期：修订状况章节编号 章节名称 修订内容简述 修订人 修订日期 修订前版本号 批准人3.5.4.14 Datawindow属性增加此属性，用于实现 dw 分页时每页的序号累积王健 2006-3-143.5.4.12 Datawindow属性 支持多表头及表王健 2006-5-9头的合并3.5.5.13 Datawindow方法支持在任意位置插 入行 赵元凯2006-5-113.18 DocEditorX 增加 word 编辑控件，用于 在 ie内能
2、进 行 word文档的编辑3.3.4.1 List 属性 增加对齐方式属性 align赵元凯 2006-6-193.6.7.1 Datawindow列属性 增加列对齐方式属性 align赵元凯 2006-6-193.6.7.12 Datawindow列属性 增加表头对齐方式属性headeralign赵元凯 2006-6-193.6.4.15 Datawindow属性 增加对列的分组合计汇总的功能王健 2006-6-233.1.3.2 TextArea 增加 maxLength和 minLength 两个属性王健 2006-6-233.2.3.4 TextField 增加 maxLength和
3、minLength 两个属性王健 2006-6-233.7.4.3 Tree 增加 tree 分批加载数据的功能王健 2006-6-233.6.7.13 Datawindow列属性 增加 input 输入法开关 ime赵元凯 2006-6-233.6.7.23 Datawindow列属性增加 input 大小写控制属性ucase赵元凯 2006-6-231.HTC 组件综述1.1.本指南适用范围和人员本手册是为在 SmatFrame 平台上进行应用开发，前端使用 htc 方案的开发人员编写的。阅读人员需了解如下的基础知识：1） activex 控件2） javascript 语言3） xml
4、语言4） j2ee1.2.HTC 架构介绍1.2.1. HTC 概述HTML 组件(HTCsHtml Components)提供一种机制来使用脚本作为动态 HTML(DHTML)行为实现组件功能。以.htc 扩展名保存，一份 HTC 是一份包含脚本和一组用于定义组件的HTC 特殊元素的 HTML 文件。HTC 组件内可包含属性、方法、事件，也可订阅绑定页面的事件，通过这些机制实现功能的封装。可理解成一个功能独立的 javabean 或一个 activex 控件，只是它的封装层次是在页面这一层。Frame 提供的前端 HTC 组件主要是一组前端页面的展示组件和一些前端编程的工具函数。前端展示 H
5、TC 组件内部以封装 activeX 控件的形式提供展示功能，包括自定义文本框、树型列表、单选下拉列表，多选下拉列表，数据网格等组件。前端编程工具函数以 js 文件的形式提供，主要提供 loadXml,XmlToHtml,HtmlToXml,checkValid 等功能。1.2.2. HTC 的组成和调用客户前端WebServer通过XMLHTTP(msxml4.dll)进行前后台消息的请求和响应页面内的js脚本 Service.jsHTC组件脚本ActiveX:Ctais_htc.ocxAutoupdt.dllDcbassrv.dll辅助工具脚本:checkValid.jsservicexm
6、l.jsHtc 的前端由图示的几部分组成，service.js 文件是前后端调用的总控模块，负责调用报文的拼装，操作 xmlhttp 进行报文的发送和接收，并将相应数据返回给调用的页面或js 代码。Htc 组件主要是对 activeX 控件的封装，使可直接使用 html 语言进行定义。Activex控件实现了大多数的界面元素，其中 autoupdt.dll 和 dcbassrv.dll 实现了组件的自动下载和一些基本服务支持。辅助工具脚本是一些有用的辅助开发工具，能够减少代码开发量和规范页面的一致性。checkValid 用于对整个页面元素（主要是 htc 的页面元素）进行统一的有效性验证，s
7、ervicexml 用于统一处理数据从 html 页面的导出，和将 xml 数据导入到 html 页面内。所以对于常规的 htc 前端页面的开发，包含如下步骤：1） 使用 htc 组件进行页面的定义2） 使用 jsp 和 js 脚本进行页面逻辑的开发3） 通过调用 service.js 内提供的方法访问后台的服务进行数据的提交和交换。2. 脚本工具2.1.htcCommon.js2.1.1. 用途负责维护一些常用的前台路径及全局的调试信息，用户在配置完 Frame 的 htc 方案后，可手工修改此文件的变量，完成信息的配置2.1.2. 引用方式2.1.3. 配置变量说明1） var G_DEB
8、UG = false;定义是否在调试状态，如果 G_DEBUG = true，则前后台传输的报文会打印到一个对话框上。2） var HOST = http:/localhost:7001;主机路径3） var URL_SERVICE_ENTRY = /WebTest/entry/EntryServlet;后台 servlet 的入口地址4） var URL_MESSAGE = /WebTest/public/htmComponent/htm/dlg_message.htm;调试信息对话框的地址5） var URL_ALERT = /WebTest/public/htmComponent/htm
9、/dlg_alert.htm;定制了 window.alert 函数6） var URL_CONFIRM = /WebTest/public/htmComponent/htm/dlg_confirm.htm;定制了 window.confirm 函数7） var URL_PROMPT = /WebTest/public/htmComponent/htm/dlg_prompt.htm;定制了 window.prompt 函数2.2.service.js2.2.1. 用途Service.js 是一个核心脚本，负责前后端的通讯，所有服务报文的发送，接收，解析都是通过这个脚本来操作的，另外还提供一些和
10、 xml 数据操作相关的函数和在调试状态下对报文的查看。2.2.2. 引用方式2.2.3. 函数2.2.3.1. createWorkId1 功能描述产生一个随机数，用于和后台的工作区相对应2 语法格式var sid = createWorkId();3 返回值一个随机数字符串4 相关Service doService 2.2.3.2. doService1 功能描述执行一个具体的后台服务调用，并将结果返回。2 语法格式var xmlResult = service.doService();var xmlResult = service.doService(strCondition);3 参数
11、strCondition：xml 格式字符串，对应于后台服务方法调用的传入条件字符串。4 返回值xmlResult：xml 格式字符串，后台服务返回的结果。5 举例下面的示例演示了一个完整的服务方法的调用过程var sid=createWorkId();var service = new Service(“com.dc.class.method”, sid);var oArg = service.doService(“%”);if (getCode(service)= 2000) var oDoc = loadXml(oArg);/将数据映射到对应的 htc 控件内elseshowMessag
12、e(getMessage(service), 0);6 相关Service createWorkId getCode2.2.3.3. getCode1 功能描述得到调用后台服务的返回代码，约定 2000 为正常调用的返回代码，其他代码用户可自定义其含义，前后台根据约定的代码进行相应的处理。2 语法格式var sCode = getCode();var sCode = getCode(service);3 参数service： Service 对象实例4 返回值字符串格式的返回代码5 备注第一种无参数的调用方式返回当前 Service 实例对象对应的返回代码；第二种调用返回指定的 Service
13、 实例对象的返回代码6 相关Service doService getMessage2.2.3.4. getMessage1 功能描述得到调用后台服务的返回代码对应的消息说明，当返回代码不为 2000 时，通常在此处得到详细的异常消息说明。2 语法格式var sMsg = getMessage ();var sMsg = getMessage (service);3 参数service： Service 对象实例4 返回值返回的消息说明字符串5 备注第一种无参数的调用方式返回当前 Service 实例对象对应的消息说明；第二种调用返回指定的 Service 实例对象的消息说明6 相关Servi
14、ce doService getCode2.2.3.5. loadFile1 功能描述装入指定的 xml 文件，以 XmlDocument 对象的形式返回2 语法格式var oDoc loadFile(strFile);3 参数strFile：一个本地的 xml 文件的全路径名4 返回值包含装入的 xml 文件的 XmlDocument 对象5 相关loadXml2.2.3.6. loadXml1 功能描述将给定的 xml 字符串进行解析，以 XmlDocument 对象的形式返回2 语法格式var oDoc loadXml(strXml);3 参数strXml：xml 格式的字符串4 返回值
15、XmlDocument 对象5 相关loadFile2.2.3.7. Service1 功能描述通过 new Service 对象，建立一个前后台的连接机制，将前台的调用映射到后台的一个服务调用上，在 doService()时调用后台的服务，并将结果返回。2 语法格式var service = new Service(serviceName, sid);3 参数1) serviceName：一个后台具体的服务名称字符串2) sid：可选参数，工作区标识号字符串4 返回值Service 对象的引用5 举例具体例子可参阅 doService()。6 相关doService getCode getM
16、essage2.2.3.8. xmlNodeCopy1 功能描述xml 节点之间的数据复制。一般用于把 doservice()返回的数据，映射到页面的相应的数据岛中。2 语法格式void xmlNodeCopy(oSrc, oTarget, targetNodeName)3 参数1) oSrc：原数据的节点，可是 XmlDocument 或 XmlEmlment 对象2) oTarget：一般为页面上的数据岛，也可以是 XmlDocument 或 XmlEmlment 对象3) targetNodeName：目标节点名称字符串。必须写出该节点的完整路径，如:ROOT/ITEMS。4 返回值无5 备注1) oSrc 和 oTarget 可具有相同的 xml 结构，或者 oTarget 是 oSrc 的一个子集。2) 当进行节点之间的拷贝时，如果目
