TreeGrid开发手册.doc

TreeGrid开发手册1. XML说明1.1 TreeGrid配置MetaXml格式var metaXml = new ActiveXObject(Microsoft.XMLDOM);var rootElement = metaXml.createElement(TreeGrid)metaXml.appendChild(rootElement);var tbElement = metaXml.createElement(TableMeta)/初始化设置rootElement.appendChild(tbElement);/数据库表名tbElement.setAttribute(tableName,CM_DEPART); /主键 tbElement.setAttribute(id,DEPT_NO); /父字段名称tbElement.setAttribute(parentId,PARENT_DEPT_NO);/父字段的值 tbElement.setAttribute(parentIdValue,0);/数据的排序字段名tbElement.setAttribute(orderBy,SEQ_NUM); /数据的查询条件tbElement.setAttribute(where,); /展开第几层 默认为0，只显示根节点 -1为全部展开 tbElement.setAttribute(expandLevel,0); /加载到几层,-1为全部加载 受展开第几层影响，要是比值比展开到几层小就自动设为展开第几层的值,没设默认为0层只加载根节点tbElement.setAttribute(loadLevel,-1); /得到源数据XML的路径，扩展用tbElement.setAttribute(loadXmlPath,treeDataXml.jsp); /图片路径tbElement.setAttribute(imagePath,/super/app/TreeGrid/images/);/展开的图片名称tbElement.setAttribute(expandImage,folder.gif);/关闭的图片路径tbElement.setAttribute(closeImage,folder1.gif); /是否显示表头 默认显示(true)tbElement.setAttribute(isDisplayHead,true); /是否画节点连线 默认显示(true)tbElement.setAttribute(isLine,true); /是否生成边框线 默认不生成(为空)tbElement.setAttribute(tdBorder,1px solid #eeeeee); /层的背景色levelBackgroundColor + 0(层)tbElement.setAttribute(levelBackgroundColor0,#0000FF); /列的设置var fieldElement = metaXml.createElement(Field);tbElement.appendChild(fieldElement);/字段的页面显示宽度fieldElement.setAttribute(width,300); /字段的页面显示居中方式fieldElement.setAttribute(align,left); /字段的中文名称fieldElement.setAttribute(cName,编 号); /字段数据库的名称fieldElement.setAttribute(eName,DEPT_CODE); /是否显示 默认不隐藏(false)fieldElement.setAttribute(isHide,false); /是否是树 默认不是(false)fieldElement.setAttribute(isTree,true); /是否拖动 默认是(true)fieldElement.setAttribute(isDrag,true); /字段自定义内容fieldElement.setAttribute(innerHTML,); /是否解析 默认是(true)fieldElement.setAttribute(isParse,true); /设置树的mataXMl TreeGrid_setTGMetaXml(metaXml); 1.2 TreeGrid Dataxml格式注意：XML节点名称一定要以R_开头，并不能重复，多表则在R_后面在加可以区分数据的字符节点属性除了数据字段以外还必须有固定属性hasChildNodes ：表示该节点是否包含子节点，主要是源XML不是全部加载的情况使用 还可以有expandImage和closeImage 表示当前节点的展天节点的图片和关闭节点的图片2. 常用API说明2.1 TreeGrid_IsNull(Object)功能：判断对象是否为null类：TreeGrid方法: TreeGrid_IsNull(pram)参数: pram 对象返回值: Boolean true=not null/false=null示例： 判断name是否为nullIf(TreeGrid_IsNull(name)2.2 TreeGrid_IsNullStr(string)功能：判断字符串是否为空类：TreeGrid方法: TreeGrid_IsNullStr(pram)参数: pram 字符串返回值: Boolean true=not null/false=null示例：判断name是否为空 Var name=;If(TreeGrid_ IsNullStr(name)2.3 TreeGrid_Load()功能：TreeGird初始化，得到源数据(生成TrggGrid)类：TreeGrid方法: TreeGrid_Load()参数: 无返回值: 无示例：加载TreeGrid2.4 TreeGrid_GetFiledInfo(Object)功能：把xml节点生成TGNode(对象/HTML)类：TreeGrid方法: TreeGrid_GetFiledInfo(node)参数: node 将要生成TGNode的一个XML节点返回值: Object 包含TGNode节点的DIV对象示例：2.5 TreeGrid_IsExpand (Object)功能：得到当前节点状态类：TreeGrid方法: TreeGrid_ IsNullStr (TGNode)参数: TGNode当前页面的一行记录(table对象)返回值: number 0=没有子节点;1=展开;2=关闭示例：Var stats = TreeGrid_IsNullStr(TGNode);If(stats = 0/没有子节Else if(stats = 1)/ 展开Else if(stats = 2)/ 关闭2.6 TreeGrid_GetNodeId (Object)功能：根据对象节点得到数据对应的ID类：TreeGrid方法: TreeGrid_GetNodeId(Node| TGNode)参数: TGNode当前页面的一行记录(table对象)|node 源dataXml中的节点记录返回值: String示例：2.7 TreeGrid_ExpandNodeState (Object)功能：设打开节点的的样式（包含换线/换图片/调用外部事件）类：TreeGrid方法: TreeGrid_ExpandNodeState(TGNode)参数: TGNode当前页面的一行记录(table对象)返回值: 无示例：2.8 TreeGrid_CloseNodeState(Object)功能：设打开节点的的样式（包含换线/换图片/调用外部事件）类：TreeGrid方法: TreeGrid_CloseNodeState(TGNode)参数: TGNode当前页面的一行记录(table对象)返回值: 无示例：2.9 TreeGrid_ExpandNode (Object)功能：TreeGrid打开或关闭节点类：TreeGrid方法: TreeGrid_ExpandNode (TGNode)参数: TGNode当前页面的一行记录(table对象)返回值: 无示例：2.10 TreeGrid_getLNextLevelNode (Object)功能：得到一条TGNode节点的子节点类：TreeGrid方法: TreeGrid_getLNextLevelNode(TGNode)参数: TGNode当前页面的一行记录(table对象)返回值: Boolean true=not null/false=null示例：无2.11 TreeGrid_ExpandAll (Object)功能：展开选中的节点的所有子节点类：TreeGrid方法: TreeGrid_CloseNodeState(TGNode)参数: TGNode当前页面的一行记录(table对象)返回值: 无示例：2.12 TreeGrid_ExpandNodePath (string)功能：按节点路径选中指定的节点或打开节点类：TreeGrid方法: TreeGrid_ExpandNodePath(nodePath)参数: nodePath string 例：(R_266,R_267,R_268)返回值: 无示例：TreeGrid_ExpandNodePath(R_266,R_267,R_268);2.13 TreeGrid_SetSelectNodePath (string)功能：按节点路径打开并选中指定的节点类：TreeGrid方法: TreeGrid_SetSelectNodePath(nodePath) 参数: nodePath string 例：(R_266,R_267,R_268)返回值: 无示例：TreeGrid_SetSelectNodePath(R_266,R_267,R_268);2.14 TreeGrid_DeleteRowNode (Object)功能：删除指事定的节点类：TreeGrid方法: TreeGrid_DeleteRowNode(TGNode)参数: TGNode当前页面的一行记录(table对象)返回值: 无示例：2.15 TreeGrid_RowUpMove ()功能：当前选中的TGNode上移一行类：TreeGrid方法: TreeGrid_RowUpMove参数:无返回值: 无示例：2.16 TreeGrid_RowDownMove()功能：当前选中的TGNode下移一行类：TreeGrid方法: TreeGrid_RowDownMove()参数: 无返回值: 无示例：TreeGrid_RowLeftMove()功能： 类：TreeGrid方法: TreeGrid_RowLeftMove()参数: 无返回值: 无示例：TreeGrid_RowRightMove()功能：当前选中的TGNode右移_移到本节点上面一个节点作子节点类：TreeGrid方法: TreeGrid_RowRightMove()参数:无返回值: 无示例：2.17 TreeGrid_GetParamXml ()功能：得到调用dataXML的参数,初始化TreeGrid变量类：TreeGrid方法: TreeGrid_GetParamXml()参数: 无返回值: 生成去后台取参数的XML示例：2.18 TreeGrid_GetDataXml (string)功能：根据参数XML从后台加载dataXml数据类：TreeGrid方法: TreeGrid_GetDataXml(parmXml)参数: parmXml返回值: 无示例：2.19 TreeGrid_GetObject (Object|string)功能：根据参数得到对象类：TreeGrid方法: TreeGrid_GetObject(pram)参数: pram 根据字符串生找到对象（html）返回值: object(html对象)示例：得到当前页面为AAAA的对象Var obj = TreeGrid_GetObject(“AAAA”)2.20 TreeGrid_Scroll ()功能： TreeGrid头和数据层同时拖动类：TreeGrid方法: TreeGrid_Scroll ()参数: 无返回值: 无示例：2.21 TreeGrid_GetHead ()功能：根据配置XML得到TreeGrid的头文件类：TreeGrid方法: TreeGrid_GetHead()参数: 无返回值: stirng (table/html)示例：TreeGrid_getNodeAttribute(Object,string)功能：得到节点属性信息类：TreeGrid方法: TreeGrid_getNodeAttribute(node,attributeName)参数: node xml的一个节点attributeName 属性名称返回值: string 属性的值示例：var id = TreeGrid_ getNodeAttribute (node,id);2.22 TreeGrid_getFieldValue (Object,string)功能：得到一条记录里的字段值类：TreeGrid方法: TreeGrid_getFieldValue(TGNode,fieldName)参数: TGNode当前页面的一行记录(table对象)fieldname 字段名（可以为id和parentId取值）返回值: string 字段对应的值示例：得定指定TGNode的idvar id = TreeGrid_getFieldValue(TGNode,id);2.23 TreeGrid_GetNodeImage (Object)功能：得到一个节点的图片类：TreeGrid方法: TreeGrid_GetNodeImage(TGNode)参数: TGNode当前页面的一行记录(table对象)返回值: object (image.expandImage|image.closeImage|image.path);示例：var image = TreeGrid_getFieldValue(TGNode);alert(image.expandImage);alert(image. closeImage);alert(image. path);2.24 TreeGrid_SetNodeImage (Object,object|string)功能：设置节点的图片类：TreeGrid方法: TreeGrid_CloseNodeState(TGNode)参数: TGNode当前页面的一行记录(table对象)返回值: String 图片名称，默认展开和关闭一样objectimage.expandImage|image.closeImage|image.path 图片对象示例：var image = new Object(); image.expandImage = folder.gif;image.closeImage = folder1.gif;TreeGrid_SetNodeImage(TGNode,image)2.25 TreeGrid_GetNodeClassName (Object)功能：返回节点的样式类：TreeGrid方法: TreeGrid_GetNodeClassName (TGNode)参数: TGNode当前页面的一行记录(table对象)返回值: stirng ep_1|ep_2|ep_3|ep_4|er_1|er_2|er_3|er_4|pp_1|pp_2|pp_3|pp_4示例：2.26 TreeGrid_SetNodeState(Object,string)功能：设置节点的样式类：TreeGrid方法: TreeGrid_SetNodeState(TGNode,state)参数: TGNode当前页面的一行记录(table对象)State : ep_1|ep_2|ep_3|ep_4|er_1|er_2|er_3|er_4|pp_1|pp_2|pp_3|pp_4返回值: 无示例：2.27 TreeGrid_setTGDocument (Object)功能：设置当前TreeGrid所在页面的document,用于在其它页面调用当前页面的方法类：TreeGrid方法: TreeGrid_setTGDocument(param)参数:树所在的document对象返回值: 无示例：在另一个页面控制TwoFrame框加里的树Var doc = parent.TwoFrame.document;/TreeGrid_setTGDocument(doc)2.28 TreeGrid_setTGMetaXml (Object)功能：设置树的mata信息类：TreeGrid方法: TreeGrid_setTGMetaXml(mataXml)参数: mataXml (xml对象)返回值: 无示例：var metaXml = new ActiveXObject(Microsoft.XMLDOM);var rootElement = metaXml.createElement(TreeGrid)metaXml.appendChild(rootElement);var tbElement = metaXml.createElement(TableMeta)rootElement.appendChild(tbElement);tbElement.setAttribute(loadXmlPath,treeDataXml.jsp); var fieldElement = metaXml.createElement(Field);tbElement.appendChild(fieldElement);fieldElement.setAttribute(cName,编 号); fieldElement.setAttribute(eName,DEPT_CODE); fieldElement.setAttribute(isTree,true);TreeGrid_setTGMetaXml(metaXml);/设置树的mataXMl2.29 TreeGrid_GetTGNodeByCNode (Object)功能： 通过自定义的对象得到当前对象所在的TGNode类：TreeGrid方法: TreeGrid_GetTGNodeByCNode(param)参数: param当前TGNode 的一个HTML子对象返回值: 无示例：3. 常用接口说明3.1 TreeGrid_SetParseNode(Object)功能：TreeGrid解悉节点前调用的方法类：TreeGrid.方法: TreeGrid_SetParseNode(node)参数: node 正要解悉的xml节点返回值: 无实现方法示例：把当前节点的Name列的值改成Afunction TreeGrid_SetParseNode(node)Node.setAttribute(Name,A); return node;3.2 TreeGrid_SetParseNodeImage(Object)功能：解悉节点时调用的方法，设置节点的图片类：TreeGrid.方法: TreeGrid_SetParseNodeImage(node)参数: node 正要解悉的xml节点返回值: string|objectimage.expandImage|image.closeImage|image.path 1、 如果返回值为string则打开和关闭图片一样,2、 如果返回值为object对象，则要有expandImage或closeImage属性值实现方法例：把SEQ_NUM字小于300的节点图片改成role.giffunction TreeGrid_SetParseNodeImage(node) var value = TreeGrid_getNodeAttribute(node,SEQ_NUM); /取行里的字段值if(value 300)return role.gif;3.3 TreeGrid_SetParseNodeBackgColor (Object)功能：解悉节点时调用的方法，设置节点的背景色类：TreeGrid.方法: TreeGrid_SetParseNodeBackgColor(node)参数: node 正要解悉的xml节点返回值: string 表示颜色的字符串 实现方法例：把SEQ_NUM字小于300的节点设背景色为#84FF84function TreeGrid_SetParseNodeBackgColor(node) var value = TreeGrid_getNodeAttribute(node,SEQ_NUM); /取行里的字段值 if(value 300) return #84FF84;3.4 TreeGrid_selectRow(Object)功能： TreeGrid选中一行的事件类：TreeGrid.方法: TreeGrid_selectRow(TGNode) 参数: TGNode :当前选中的行(table对象)返回值: 无 例：得到选中行的idfunction TreeGrid_selectRow(TGNode) var id = TreeGrid_getFieldValue(TGNode,id); alert(id)3.5 TreeGrid_DeleteSelectRow(Object) 功能：TreeGrid判断是否删除选中行的事件类：TreeGrid.方法: TreeGrid_DeleteSelectRow(TGNode) 参数: TGNode :当前选中的行(table对象)返回值: Boolean true(删除)/false(不删除) 例：默认都是同意删除的function TreeGrid_selectRow(TGNode) Return true;3.6 TreeGrid_GetExpandNode (Object)功能：TreeGrid点击展开节点的事件类：TreeGrid.方法: TreeGrid_GetExpandNode (TGNode) 参数: TGNode :当前选中的行(table对象)返回值: 无 例：保持两个页面的树打开一样function TreeGrid_GetExpandNode(TGNode)Var id = TreeGrid_getFieldValue(TGNode,id);/另一个被调用的方法3.7 TreeGrid_DblClickImage(Object)功能：TreeGrid双击图片事件 类：TreeGrid.方法: TreeGrid_DblClickImage(TGNode)参数: TGNode :当前选中的行(table对象)返回值: 无 例：双击图片改变当前图片function TreeGrid_DblClickImage(TGNode)var image = new Object(); image.expandImage = folder.gif;image.closeImage = folder1.gif;TreeGrid_SetNodeImage(TGNode,image)3.8 TreeGrid_DblClickRow(Object )功能：TreeGrid双击一条记录事件 类：TreeGrid.方法: TreeGrid_DblClickRow(TGNode)参数: TGNode :当前选中的行(table对象)返回值: 无例：双击行改变当前图片function TreeGrid_ DblClickRow(TGNode)var image = new Object(); image.expandImage = folder.gif;image.closeImage = folder1.gif;TreeGrid_SetNodeImage(TGNode,image)3.9 TreeGrid_GetLastSelectNodePath(string )功能： TreeGrid得到当前页面最后选中那一个节点的路径，用于记忆上一次最后打开选中的节点类：TreeGrid.方法: TreeGrid_GetLastSelectNodePath(FullNode)参数: FullNode : String 例：R_1,R_2,R_3返回值: 无 例：把最后选中那一个节点保存到session中function TreeGrid_GetLastSelectNodePath(TGNodePath)Page_Session(TreeGrid_SelectNodePath,TGNodePath);/把路径写到session中3.10 TreeGrid_GetLastExpandNodePath(stirng )功能： TreeGrid得到当前页面最后展开或关闭节点的路径,用于记忆上一次最后打开的节点类：TreeGrid.方法: TreeGrid_GetLastExpandNodePath(FullNode)参数: FullNode : String 例：R_1,R_2,R_3返回值: 无 例：把最后展开的节点保存到session中function TreeGrid_GetLastExpandNodePath(TGNodePath)Page_Session(TreeGrid_ExpandNodePath,TGNodePath);/把路径写到session中4. 编码规范4.1 Eclipse格式化CTRL+SHIFT+F设置路径：Java/代码样式/格式化程序/代码格式设置：空行设置：行最大长度设置：注释设置：提示：Alt+/Ctrl+1Ctrl+链接对象生成Set和Get方法重构：altshiftR4.2 层次结构4.2.1 Java Source4.3 命名规范4.3.1 方法以TreeGrid_打头举例说明：TreeGrid_IsNull()4.3.2 全局变量以TG_打头例:var TG_Document = document; /记录是否发生行的单击事件var TG_HiedDiv = null; /用于加载过程中的隐藏层var TG_ExpandLevelTime = 100; /用于加载过程中展开子层的时间var TG_IsLine = true; /是否节点之间画连接线注：4.3.3 注释/*TreeGrid双击图片事件*TGNode : (Object) 当前选中的行*return : 无*/function TreeGrid_DblClickImage(TGNode)注释说明：1、方法实现的功能2、参数类型3、返回说明5. 示例5.1.1 web页面例：tree.jspTreeGrid!-var metaXml = new ActiveXObject(Microsoft.XMLDOM);var rootElement = metaXml.createElement(TreeGrid)metaXml.appendChild(rootElement);var tbElement = metaXml.createElement(TableMeta)rootElement.appendChild(tbElement);tbElement.setAttribute(tableName,CM_DEPART); /数据库表名tbElement.setAttribute(id,DEPT_NO); /主键tbElement.setAttribute(parentId,PARENT_DEPT_NO); /父字段名称tbElement.setAttribute(parentIdValue,0); /父字段的值tbElement.setAttribute(orderBy,SEQ_NUM); /数据的排序字段名tbElement.setAttribute(where,); /数据的查询条件tbElement.setAttribute(expandLevel,0); /展开第几层 默认为0，只显示根节点 -1为全部展开tbElement.setAttribute(loadLevel,-1); /加载到几层,-1为全部加载 受展开第几层影响，要是比值比展开到几层小就自动设为展开第几层的值,没设默认为0层 只加载根节点tbElement.setAttribute(loadXmlPath,treeDataXml.jsp); /得到源数据XML的路径，扩展用tbElement.setAttribute(imagePath,/super/app/TreeGrid/images/);/图片路径tbElement.setAttribute(expandImage,folder.gif); /展开的图片名称tbElement.setAttribute(closeImage,folder1.gif); /关闭的图片路径tbElement.setAttribute(isDisplayHead,true); /是否显示表头 默认显示(true)tbElement.setAttribute(isLine,true); /是否画节点连线 默认显示(true)tbElement.setAttribute(tdBorder,1px solid #eeeeee); /是否生成边框线 默认不生成(为空) 例：1px solid #eeeeee/*tbElement.setAttribute(levelBackgroundColor0,#0000FF); /层的背景色levelBackgroundColor + 0(层)tbElement.setAttribute(levelBackgroundColor1,#84FF84); /层的背景色levelBackgroundColor + 1(层)tbElement.setAttribute(levelBackgroundColor2,#FFFF00); /层的背景色levelBackgroundColor + 2(层)tbElement.setAttribute(levelBackgroundColor3,#0000FF); /层的背景色levelBackgroundColor + 3(层)tbElement.setAttribute(levelBackgroundColor4,#FF0000); /层的背景色levelBackgroundColor + 4(层)tbElement.setAttribute(levelBackgroundColor5,#0000FF); /层的背景色levelBackgroundColor + 5(层)tbElement.setAttribute(levelBackgroundColor6,#84FF84); /层的背景色levelBackgroundColor + 6(层)tbElement.setAttribute(levelBackgroundColor7,#FFFF00); /层的背景色levelBackgroundColor + 7(层)tbElement.setAttribute(levelBackgroundColor8,#0000FF); /层的背景色levelBackgroundColor + 8(层)tbElement.setAttribute(levelBackgroundColor9,#FF0000); /层的背景色levelBackgroundColor + 9(层)*/var fieldElement = metaXml.createElement(Field);tbElement.appendChild(fieldElement);fieldElement.setAttribute(width,300); /字段的页面显示宽度fieldElement.setAttribute(align,left); /字段的页面显示居中方式fieldElement.setAttribute(cName,编 号); /字段的中文名称fieldElement.setAttribute(eName,DEPT_CODE); /字段数据库的名称fieldElement.setAttribute(isHide,false); /是否显示 默认不隐藏(false)fieldElement.setAttribute(isTree,true); /是否是树 默认不是(false)fieldElement.setAttribute(isDrag,true); /是否拖动 默认是(true)fieldElement.setAttribute(innerHTML,); /字段自定义内容 fieldElement.setAttribute(isParse,true); /是