FisherGrid使用说明.doc

FisherGrid使用说明 刘辉 2008年8月 V2.8 目 录 1. 背景 3 2. 显示效果 3 3. 功能介绍 3 4. 设计思路 4 5. 依赖组件 5 6. 详细使用步骤 6 7. FisherGrid系统配置文件perties详解 9 8. Grid的Xml配置文件结构详解 11 8.1 元素参考 11 8.2 Id元素属性参考 12 8.3 checkbox元素属性参考 12 8.4 position元素属性参考 12 8.5 column元素属性参考 12 9. 常用javascript函数接口规范 13 9.1 Renderer函数 13 9.2 Button的onclick函数 14 10. 常用javascript函数一览 14 11. 常用Jsp自定义tag详解 14 11.1 Tag参考 14 11.2 grid属性参考 15 11.3 select属性参考 17 11.4 separator属性参考 17 11.5 button属性参考 17 11.6 query属性参考 17 11.7 export属性参考 17 11.8 head属性参考 18 12. 系统扩展点 18 13. 附录 18 13.1 如何在eclipse中注册xsd文件实现编写xml文件时有代码提示 18 13.2 XML配置文件生成工具 19 13.3 如何修改枚举值的选择值方式 20 13.4 Column中的name、field、display的区别 20 13.5 如何支持单一系统多数据库 21 13.5.1 方式一： 21 13.5.2 方式二： 22 13.6 如何扩展主题 22 背景 列表页面几乎是所有信息化系统都会使用的页面，然而公司没有一套统一的列表页面显示规范，并且制作一个列表页面也是比较复杂、耗时、功能不全面的工作。此组件就是为了提供一个统一的列表样式、功能丰富、制作简单的列表而设计、开发而成。 显示效果 在线演示地址：10:8080/FisherGrid/ (如果服务器没有启动，请通知我！) 功能介绍 支持服务器端排序； 支持数据库和游标服务器端分页； 可动态选择分页大小； 支持ajax的数据加载(翻页、刷新数据不刷新页面)； 动态显示列； 拖拉列位置； 动态调整表格的长宽； 动态调整列的宽度； 表格可以收缩； 可以设置各个列的查询条件； 上下滚动可以固定表格标题； 支持全选按钮； 支持单选每列； 支持多种事件接口； 转换任意的table为Grid； ajax的数据加载支持常用的几种数据类型：xml/json； 很酷的主题； 支持导出excel等； 支持SQL和HQL； 支持合计； 多主题支持(换皮肤)； 多数据库动态切换支持； … 设计思路 本Grid是基于flexigrid(Jquery的一个插件)进行后台扩展而成，总体设计思路是开发人员配置要显示的列和查询的SQL语句，通过使用jsp自定义Tag来创建Grid。 FisherGrid架构图 FisherGrid总体设计结构图 类/资源 功能描述 Tag 页面开发人员的入口，通过自定义的tag生成Grid Model Grid的模型对象 Grid模板文件 Grid的模板文件(目前采用freemarker作为Grid的模板) Data.jsp 服务端JSON格式的查询结果生成入口 FisherService 组件对外提供的服务的总入口 Formatter 不同类型的字段格式化器，在返回结果给Grid之前格式化内容 Parser 配置资源解析器，目前默认实现的是根据xml配置文件 ConnectionProvider 数据库连接提供者，提供数据库连接信息，目前默认的提供是配置jdbc链接信息获取连接 ColumnFilter 字段过滤条件，不同的字段类型对应不同的过滤条件 Condition 字段过滤条件项目，对应过滤条件中的某一个条件项目 SQLBuilder SQL构造器，目前默认的是解析from、where、order部分然后替换组装的，所以不支持复杂的查询，例如嵌套查询、union查询等 Query 查询器，执行分页查询 依赖组件 Jquery Flexigrid Digester Freemarker Sojo Log4j Beanutils Collections Chardet SkyCommon Hsqldb(可选，运行示例需要) Hibernate3.*(可选，如果使用HQL需要) 详细使用步骤 将${WebRoot}/WEB-INF/lib下面的jar包复制到工程的${WebRoot}/WEB-INF/lib中； 将${WebRoot}下的fisher文件夹复制到工程的${WebRoot}根目录下(注意文