CyberPlat_参考手册.doc

需求规格说明书CyberPlatform参考手册版本号修改日期修改内容修改人批准人0.12011-9-23首次发布林家乐1. 组件1.1 内置变量1.1.1 模板变量l stack：当前Struts OGNL值栈l action：当前执行的控制器l owner：组件对象1.1.2 值栈变量l #ns：当前模板命名空间变量，以Map形式提供，可以对其进行put与get操作l #local：当前模板本地变量，以Map形式提供，可以对其进行put与get操作1.2 内置函数1.2.1 case 描述提供IF ELSEIF ELSE功能。 参数名称描述值类型默认值condiition条件BooleantrueVal当condition为真时的返回值ObjectfalseVal当condition为假时的返回值Object1.3 组件列表1.3.1 p.button.o.copy 描述表示一个复制对象按钮。 参数名称描述值类型默认值clientId组件元素客户端IDString自动生成model要复制的对象数据实体text显示的按钮文本String复制1.3.2 p.button.o.create 描述表示一个新建对象按钮。 参数名称描述值类型默认值clientId组件元素客户端IDString自动生成entityName新建的数据实体名Stringtext在按钮上显示的文本String新建popop是否在使用弹出窗口方式BooleanfalsepopupCallback弹出窗口关闭时的回调函数String1.3.3 p.button.o.delete 描述表示一个删除对象按钮 参数名称描述值类型默认值clientId组件元素客户端IDString自动生成text在按钮上显示的文本String删除model要删除的对象数据实体1.3.4 p.button.o.deleteSelected 描述表示一个批量删除按钮。 参数名称描述值类型默认值clientId组件元素客户端IDString自动生成text在按钮上显示的文本String删除entityName要删除的数据实体名String1.3.5 p.button.o.edit 描述表示一个编辑对象按钮。 参数名称描述值类型默认值clientId组件元素客户端IDString自动生成text要显示在按钮上的文本String编辑model要编辑的对象数据实体1.3.6 p.button.o.listView 描述表示一个添转到列表视图的按钮。 参数名称描述值类型默认值clientId组件元素客户端IDString自动生成text要显示在按钮上的文本String列表视图entityName数据实体名Stringaction控制器的动作名Stringlist1.3.7 p.button.o.lookupOk 描述表示一个在查找页面中的确定选择项按钮。 参数名称描述值类型默认值clientId组件元素客户端IDString自动生成text要显示在按钮上的文本String列表视图entityName数据实体名String1.3.8 p.button.o.save 描述表示一个保存按钮。 参数名称描述值类型默认值clientId组件元素客户端IDString自动生成text要显示在按钮上的文本String保存model要保存的数据实体数据实体1.3.9 p.button.o.saveAndNew 描述表示一个保存并新建对象按钮。 参数名称描述值类型默认值clientId组件元素客户端IDString自动生成model要保存的对象数据实体text要显示在按钮上的文本String保存1.3.10 p.button.o.treeView 描述表示一个添转到列表视图的按钮。 参数名称描述值类型默认值clientId组件元素客户端IDString自动生成text要显示在按钮上的文本String树形视图entityName数据实体名Stringaction控制器的动作名Stringlist1.3.11 p.button.o.view 描述表示一个显示对象详细信息按钮。 参数名称描述值类型默认值clientId组件元素客户端IDString自动生成model要显示的对象数据实体text要显示在按钮上的文本String查看1.3.12 p.button.close 描述关闭当前窗口。 参数名称描述值类型默认值clientId组件元素客户端IDString自动生成text要显示在按钮上的文本String查看1.3.13 p.button.cancel 描述返回上一页。 参数名称描述值类型默认值clientId组件元素客户端IDString自动生成text要显示在按钮上的文本String取消1.3.14 p.buttonSet.o.edit 描述编辑对象时的按钮集。 参数名称描述值类型默认值model正在编辑的数据实体数据实体supportCancel是否显示取消按钮BooleantruesupportClose是否显示关闭按钮Booleanfalse1.3.15 p.buttonSet.o.list 描述对象列表时的按钮集。 参数名称描述值类型默认值entityName数据实体名称StringactiveView当前的视图类型Stringlist:列表视图tree:树形视图listsupportTreeView该对象是否支持树形视图BooleanfalsesupportListView该对象是否支持列表视图Booleantrue1.3.16 p.buttonSet.o.lookup 描述在查找对象时的按钮集。 参数名称描述值类型默认值entityName数据实体名称StringactiveView当前的视图类型Stringlist:列表视图tree:树形视图listsupportTreeView该对象是否支持树形视图BooleanfalsesupportListView该对象是否支持列表视图Booleantrue1.3.17 p.buttonSet.o.view 描述查看对象时的按钮集。 参数名称描述值类型默认值model正在查看的数据实体数据实体1.3.18 p.form.checkbox 描述表示一个复制框。 参数请参数struts2的checkbox标签。1.3.19 p.form.dateField 描述表示一个日期输入。 参数名称描述值类型默认值clientId组件元素客户端IDStringname提交的参数名Stringformat日期格式String当前用户的日期格式timePicker是否需要选择时间Booleanfalsevalue日期值Date根据name自动求值inputSize日期框的字符数Int根据format自动计算mode显示模式Stringinput：输入模式display:显示模式input1.3.20 p.form.formValidator 描述验证信息反馈。 参数名称描述值类型默认值1.3.21 p.form.select 描述表示一个选择框。 参数请参数struts2的select标签。1.3.22 boBox 描述表示一个组合框（选择框的可编辑版本）。 参数请参数struts2的select标签。1.3.23 p.form.stateForm 描述表示一个表单。 参数名称描述值类型默认值clientId组件元素客户端IDStringstate表示保存在表单中的数Mapinclude表示要保持的参数名List“ami”, “retURL”exclude表示要排除的参数名ListformAction提交的路径StringenctypeHTML的enctypeString1.3.24 p.form.file 描述表示一个文件上传字段，提交到后台的为一个字符串，该字符串表示上传的文件的虚拟路径。 参数名称描述值类型默认值name表示字段的名称String1.3.25 p.form.textfield 描述表示一个单行文本框。 参数请参数struts2的textfield标签。1.3.26 p.form.textarea 描述表示一个多行文本框。 参数请参数struts2的textarea标签。1.3.27 p.form.o.lookupField 描述表示一个对象选择框。 参数名称描述值类型默认值clientId组件元素客户端IDStringname要提交的参数名StringentityName对象数据名StringentityNameField对象名称字段Stringmultiple是否能够选择多条记录BooleanfalselistRow当作显示模式为listbox时，列表的显示项目数Int8mode显示模式Stringinput：输入display：显示inputinputMode输入模式Stringtextfield:输入框listBox:列表textfield1.3.28 p.grid.dataGrid 描述表示一个数据表格。 参数名称描述值类型默认值clientId组件元素与JS组件客户端IDStringmodel列表模型PagedCollectionListmodelURL列表模型数据地址StringdateFields要显示的字段ListpagingAble是否支持分页BooleantruepageSize每页显示的记录数Int15pageIndex当前的页码Int1groupField以该字段分组StringgroupTextTpl分组行的文本显示模板String1.3.29 p.grid.dataGrid.checkboxColumn 描述表示一个勾选框列，主要用来表示“是”与“否”。 参数名称描述值类型默认值header表头标题String与dataField相同dataField数据字段Stringsortable是否可排序Booleanfalseresizable是否可调整大小Booleanfalsetooltip鼠标移到表头是显示的提示信息Stringalign对齐方式 Stringleft:左对齐center:居中right:右对齐left1.3.30 p.grid.dataGrid.checkboxSelectionColumn 描述表示一个以checkbox作为选择的列。 参数名称描述值类型默认值inputName提交的参数名Stringheader表头标题String与dataField相同dataField数据字段Stringsortable是否可排序Booleanfalseresizable是否可调整大小Booleanfalsetooltip鼠标移到表头是显示的提示信息Stringalign对齐方式 Stringleft:左对齐center:居中right:右对齐left1.3.31 p.grid.dataGrid.column 描述表示一个列，该列中的值以文本形式显示。 参数名称描述值类型默认值header表头标题String与dataField相同dataField数据字段Stringsortable是否可排序Booleanfalseresizable是否可调整大小Booleanfalsetooltip鼠标移到表头是显示的提示信息Stringalign对齐方式 Stringleft:左对齐center:居中right:右对齐leftwidth宽度，以像素为单位Int1.3.32 p.grid.dataGrid.textColumn 描述表示一个显示多数据量文本的列。 参数名称描述值类型默认值header表头标题String与dataField相同dataField数据字段Stringsortable是否可排序Booleanfalseresizable是否可调整大小Booleanfalsetooltip鼠标移到表头是显示的提示信息Stringalign对齐方式 Stringleft:左对齐center:居中right:右对齐leftwidth宽度，以像素为单位Int1.3.33 p.grid.dataGrid.serialNoColumn 描述显示当前记录的序号 参数名称描述值类型默认值header表头标题String与dataField相同resizable是否可调整大小Booleanfalsetooltip鼠标移到表头是显示的提示信息Stringwidth宽度，以像素为单位Intalign对齐方式 Stringleft:左对齐center:居中right:右对齐left1.3.34 p.grid.dataGrid.dateColumn 描述表示一个日期时间列。 参数名称描述值类型默认值format日期格式String当前用户的日期格式header表头标题String与dataField相同dataField数据字段Stringsortable是否可排序Booleanfalseresizable是否可调整大小Booleanfalsetooltip鼠标移到表头是显示的提示信息Stringwidth宽度，以像素为单位Intalign对齐方式 Stringleft:左对齐center:居中right:右对齐left1.3.35 p.grid.dataGrid.rendererColumn 描述表示一个自己定义显示函数的列，列组件的内容为显示函数的内容。请参考EXT的column中的renderer属性。 参数名称描述值类型默认值header表头标题String与dataField相同dataField数据字段Stringsortable是否可排序Booleanfalseresizable是否可调整大小Booleanfalsetooltip鼠标移到表头是显示的提示信息Stringwidth宽度，以像素为单位Intalign对齐方式 Stringleft:左对齐center:居中right:右对齐left1.3.36 p.grid.dataGrid.templateColumn 描述表示一个自己定义显示模板的列，列组件的内容为模板内容。请参考EXT的中模板写法。 参数名称描述值类型默认值header表头标题String与dataField相同dataField数据字段Stringsortable是否可排序Booleanfalseresizable是否可调整大小Booleanfalsetooltip鼠标移到表头是显示的提示信息Stringwidth宽度，以像素为单位Intalign对齐方式 Stringleft:左对齐center:居中right:右对齐left1.3.37 p.grid.dataGrid.treeColumn 描述表示一个树形结构的列。 参数名称描述值类型默认值header表头标题String与dataField相同dataField数据字段Stringsortable是否可排序Booleanfalseresizable是否可调整大小Booleanfalsetooltip鼠标移到表头是显示的提示信息Stringwidth宽度，以像素为单位Intalign对齐方式 Stringleft:左对齐center:居中right:右对齐leftdataURL下级数据的数据采集URLString当前Request的ServletPathparentField上级字段名Stringparentloader自定义的数据采集函数String1.3.38 p.grid.o.dataGrid 描述表示一个以对象为基础的数据网络，主要能自动提供多选列、操作列、工具条的功能。 参数说明名称描述值类型默认值clientId组件元素/JS组件客户端IDStringmodel列表模型PagedCollectionListmodelURL列表模型数据地址StringdateFields要显示的字段ListpagingAble是否支持分页BooleantruepageSize每页显示的记录数Int15pageIndex当前的页码Int1groupField以该字段分组StringgroupTextTpl分组的模板StringselectionAble是否提供选择列BooleantruemultipleSelection是否为能够多选BooleantrueitemOperationAble是否提供操作列BooleantrueitemEditAble是否能够编辑记录BooleantrueitemViewAble是否能够查看记录BooleantrueitemDeleteAble是否能够删除记录Booleantrue1.3.39 p.grid.o.dataGrid.referenceColumn 描述表示一个对象链接列。 参数名称描述值类型默认值header表头标题String与dataField相同dataField显示的字段StringidentityField对象编号字段String自动根据dataField求值sortable是否可排序Booleanfalseresizable是否可调整大小Booleanfalsetooltip鼠标移到表头是显示的提示信息Stringwidth宽度，以像素为单位Intalign对齐方式 Stringleft:左对齐center:居中right:右对齐left1.3.40 p.layout.detailPanel 描述详细信息面板。 参数名称描述值类型默认值clientId组件元素客户端IDStringtitle标题Stringmode显示模式Stringinput:编辑模式display:查看模式input 子组件.1.1 buttonBar.1.1.1 描述按钮栏。.1.2 section.1.2.1 描述表示详细视图中的一个片段区块。.1.2.2 参数名称描述值类型默认值title标题String1.3.41 p.layout.detailTable 描述表格组件，以字段为基出，提供自动布局功能。 参数名称描述值类型默认值clientId组件元素客户端IDStringitemsPerRow每行显示多少个字段Int1accessOrderTAB的切换顺序StringleftToRight:从左到右topToBottom:从上到下leftToRight 子组件.1.1 field.1.1.1 描述表示表格中的一个字段，字段的内容为字段的输入组件。.1.1.2 参数名称描述值类型默认值label字段标签Int1span字段跨度（表示该字段的宽度跨越多少个字段）Int1requiredMask必填标识Booleanfalse1.3.42 p.layout.form 描述表示一个表单支持的布局，通过该布局，自动支持保持“ami”与“retURL”参数。 参数名称描述值类型默认值state表示保存在表单中的数Mapinclude表示要保持的参数名List“ami”, “retURL”frame是否显示页面框架BooleantrueadditionalBodyCls添加到HTML BODY加的CSSStringenctypeHTML的enctypeString 子组件.1.1 detailBlock.1.1.1 描述表单的内容。1.3.43 p.layout.listPanel 描述列表面板。 参数名称描述值类型默认值clientId组件元素客户端IDStringtitle标题String.1 子组件.1.1 buttonBar.1.1.1 描述按钮栏。.1.2 listBlock.1.2.1 描述表示列表视图中的一个数据网格区块。1.3.44 p.layout.master 描述表示一个页面主框架组件。 参数名称描述值类型默认值additionalBodyCls表示附加在body元素中的CSS ClassString 子组件.1.1 leftSide.1.1.1 描述左边的内容。.1.2 rightSide.1.2.1 描述右边的内容。1.3.45 p.layout.panel 描述表示一个页面块。 参数名称描述值类型默认值clientId组件元素客户端IDStringtitle标题StringadditionalBodyCls附在页面块中的CSS ClassString 子组件.1.1 buttonBar.1.1.1 描述按钮栏，显示在页面块的右上角。.1.2 body.1.2.1 描述页面块中的内容。1.3.46 p.layout.o.detailPage 描述表示一个编辑页面布局组件。 参数名称描述值类型默认值additionalBodyCls表示附加在body元素中的CSS ClassStringframe是否显示页面架框BooleantruesupportBreadcrumb是否显示当前位置导航条Booleantrue 子组件.1.1 detailBlock.1.1.1 描述编辑页面的内容区。1.3.47 p.layout.o.listPage 描述表示一个列表页面布局组件。 参数名称描述值类型默认值additionalBodyCls表示附加在body元素中的CSS ClassStringframe是否显示页面架框BooleantruesupportBreadcrumb是否显示当前位置导航条Booleantrue 子组件.1.1 detailBlock.1.1.1 描述列表页面的内容区。1.3.48 p.menu. breadcrumb 描述表示当前位置导航组件。 参数名称描述值类型默认值clientId组件元素客户端IDString1.3.49 p.menu. downDownMenu 描述表示下拉菜单组件。 参数名称描述值类型默认值clientId组件元素客户端IDString1.3.50 p.menu. menuPanel 描述表示菜单导航面板。 参数名称描述值类型默认值clientId组件元素客户端IDString1.3.51 p.tip. message 描述表示一个信息显示组件，以高亮的方式显示提示信息在页面中。 参数名称描述值类型默认值clientId组件元素客户端IDString1.3.52 p.tip. toolTip 描述表示一个冒泡提示信息显示组件。 参数名称描述值类型默认值clientId组件元素/JS组件客户端IDString1.3.53 p.tree.o.treePanel 描述表示一个对象树。 参数名称描述值类型默认值clientId组件元素客户端IDString自动生成entityName数据实体名StringentityIdField数据实体编号字段StringidentityNameField数据实体名称字段StringnameentityParentField数据实体上级字段StringparentrootNodes要显示的节点对象Listchecked要选中的节点对象ListcheckAble节点是否可选BooleantruecheckboxInputName复选框的输入名StringselectedmultipleSelection是否允许多选Booleantrue1.3.54 p.widget.attachment.listPanel 描述对象附件相关列表组件。 参数名称描述值类型默认值title标题StringrelatedObject相关对象数据实体supportFilePathColumn是否显示文件路径列BooleantruesupportDescriptionColumn是否显示附件描述列Booleanfalse1.3.55 p.widget.checkIcon 描述表示一个复选框（以显片方式显示，用户不能对其进行编辑）。 参数名称描述值类型默认值clientId组件元素客户端IDStringchecked是否已选Booleanfalse1.3.56 p.widget.security.hasPermission 描述判断指定的权限拥有者是否具有指定的权限，如果有则显示组件内容。 参数名称描述值类型默认值owner权限拥有者MemberUserUserRole当前登录用户operator对资源的操作符StringAccessresFullName资源全称StringresObjectId资源对象IDStringresCode自定义资源代码号StringresURL功能资源或菜单资源的URLStringcheckDefault是否检查默认权限Booleantruenegate如果为FALSE，则有权限时显示内容如果为TRUE，有没权限时显示内容Booleanfalse1.3.57 p.widget.tabPanel 描述选项卡面板组件。 参数名称描述值类型默认值clientId客户端/JS组件IDString自动生成 子组件.1.1 tab.1.1.1 参数说明名称描述值类型默认值title选项卡标题String1.3.58 p.widget.tabPanel.tab 描述选项卡组件。 参数名称描述值类型默认值clientId客户端/JS组件IDString自动生成title标题String.1.1.1 描述选项卡内容。1.3.59 p.multiView 描述通过view属性值显示子组件。 参数名称描述值类型默认值view要显示的子组件编号String2. 表单验证2.1.1 类型验证平台内置的转换验证类都在com.cyberway.modules.framework.validation.translators下类型描述ArrayTranslator使用JSON的方式转换成数据并把每个元素转换成指定的类型DateTranslator根据定义的日期格式转换成日期对象DoubleTranslator转换成Double对象EnumTranslator转换成指定的枚举对象FloatTranslator转换成Float对象IntegerTranslator转换成Integer对象JSONArrayTranslator转换成JSON数组JSONObjectTranslator转换成JSON对象LocaleTranslator转换成本地化对象LongTranslator转换成Long对象StringTranslator无转换TimeZoneTranslator转换成TimeZone对象TypeTranslator输入指定的类型转换器与目标类型进行转换2.1.2 逻辑验证平台内置的转换验证类都在com.cyberway.modules.framework.validation.validators下类型描述Capitalize首字目必须大写Email合法的邮件地址格式Equal指定的值进行相等判断Max最大值MaxLength传入字符串的最大长度Min最小值MinLength传入字符串的最小长度Regexp正则表达式匹配Required必填Uncapitalize首字母小写UniqueEntity指定数据实体的属性，根据该属性判断唯一性3. 事件列表类型描述com.cyberway.platform.support.event.StartupEvent系统启动com.cyberway.modules.framework.orm.event.PreInsertEvent新建数据前com.cyberway.modules.framework.orm.event.PostInsertEvent成功新建数据后com.cyberway.modules.framework.orm.event.PreUpdateEvent数据更新前com.cyberway.modules.framework.orm.event.PostUpdateEvent数据成功更新后com.cyberway.modules.framework.orm.event.PreDeleteEvent数据删除前com.cyberway.modules.framework.orm.event.PostDeleteEvent数据成功删除后com.cyberway.modules.framework.orm.event.PostLoadEvent数据对象成功加载后com.cyberway.modules.framework.struts2.event.ActionPreExecuteEvent控制器动作执行前com.cyberway.modules.framework.struts2.event.ActionPostExecuteEvent控制器动作执行后4. 自定义查询4.1 格式 items : field : , valueType : , op : , value : , boolFilter : 以上的items是以字段为基础的条件而boolFilter则是条件的逻辑组合，支持 and 与 or 与括号。l boolFilter示例：(1 or 2) and 3以上示例中的1,2,3等数字，是条件的索引号。4.1.1 字段值类型值描述Constant常量值Field字段值Null空值4.1.2 操作符值描述Eq相等NotEq不相等StartsWith字符起始匹配Contains字符包含匹配NotContains字符不包含匹配LessThen小于GreaterThen大于LessThenEq小于等于GreaterThenEq大于等于Include暂不支持NotInclude暂不支持5. 服务对象表5.1 组件对象5.1.1 缓存BEAN描述platform.support.cache.cacheManager缓存管理器5.1.2 配置BEAN描述platform.support.config.configuration系统配置对象5.1.3 数据源BEAN描述platform.support.dataSource数据源5.1.4 类型转换BEAN描述platform.support.conversion.typeConverter系统类型转换器5.1.5 邮件BEAN描述platform.support.email.htmlEmailFactoryHTML邮件工厂platform.support.email.textEmailFactory文本邮件工厂5.1.6 数据实体BEAN描述platform.support.entity.identifierGenerator数据实体标识生成器platform.support.entity.aliasManager数据实体别名管理器monEntityManager低级的公共数据实体管理服务platform.support.entity.entityManager基础数据实体服务服务platform.support.entity.entityManagerProxyFactory基础数据实体管理服务代理工厂platform.support.entity.entityAction实体控制器platform.support.entity.entityActionProxy基础数据实体控制器代理工厂5.1.7 异常处理BEAN描述platform.exceptionHandling.exceptionManager异常管理5.1.8 HibernateBEAN描述platform.support.hibernate.sessionFactoryHibernate SessionFactoryplatform.support.hibernat