GIT_REF_JSF标签使用参考手册.doc

EasyUDA平台JSF标签使用参考手册高伟达软件技术有限公司2007年2月高伟达软件科技2008年5月第4页高伟达信贷管理信息系统文档信息标题JSF标签使用参考手册版本号1.91版本日期2008-12-16打印日期/文件名GIT_REF_JSF标签使用参考手册.doc存放目录所有者项目组作者向炜、邹明修订记录日期 描述作者版本号2007-2-25文档建立向炜1.02007-3-22增加codeTable、oneSelect、commandLink、outputText自定义组件向炜1.12007-4-51、标签中增加“number”属性2、修改校验标签中关于币种和白分比转换后的校验3、删除标签中“useClose”、“useWindow”、“dialogWidth”、“dialogHeight”属性4、新增标签5、新增标签向炜1.22007-4-131、标签中增加selectName属性2、增加限制文本框输入说明3、增加BackingBean中方法说明向炜1.32007-4-191、修改keyPressNumber，增加输入的长度控制2、补充BackingBean中的方法说明3、修改标签中的百分比显示向炜1.42007-5-281、标签中增加defaultValue属性向炜1.52007-6-71、标签中增加validate和confirm属性向炜1.62007-6-121、新增标签向炜1.72007-6-141、标签中增加rowspan属性2、标签中增加lock属性向炜1.82008-1-16增加分页功能邹明1.92008/12/16增加ajax相关的若干标签的内容邹明1.91文档审核/审批（此文档需如下审核）姓名公司/部门职务/职称文档分发（此文档将分发至如下各人）姓名公司/部门职务/职称本文档中所包含的信息属于机密信息，如无高伟达软件技术有限公司的书面许可，任何人都无权复制或利用。Copy Right 2007 Great Info Tech China信贷管理信息系统高伟达软件科技第4页 共67页 2008高伟达软件科技版权所有高伟达软件科技2007年2月第 3 页高伟达信贷管理信息系统目 录1前言41.1文档目的41.2文档范围41.3目标读者42基础标签52.462.572.682.792.892.9122.10142.11152.12162.13172.14192.15192.16212.17222.18232.19242.20252.21262.22262.23272.24282.25293自定义标签313.1313.2323.3343.4353.5353.6363.7373.8393.9403.10413.11423.12433.13433.14443.15453.16464客户端验证标签484.1484.2494.3494.4504.5504.6514.7524.8524.9534.10545表格分页555.1数据555.2页面566限制文本框输入587BackingBean中方法说明59高伟达软件科技第 63 页 共 67 页 2007高伟达软件科技版权所有高伟达软件科技2007年2月第 63 页高伟达信贷管理信息系统1 前言1.1 文档目的该文档旨在为界面开发工作组提供一套完整的JSF控件使用说明书。1.2 文档范围本文档列出在开发过程中需要使用的基本JSF控件，包括：l 控件描述l 控件使用的语法l 各控件标签及常用属性在JSP文件中的使用范例l 标签风格l 使用说明1.3 目标读者本文的主要读者为界面开发小组成员或其他对JSF感兴趣的开发人员。2 基础标签2.1 2.1.1 控件描述JSP页面中所有标签和组件必须在这中间使用才能够在输出网页中正常显示2.1.2 例子代码2.2 2.2.1 控件描述在jsf页面内，所有HTML代码必须放在 中间才能够正常显示2.2.2 例子代码HTML代码2.3 2.3.1 控件描述这个控件邦定一个参数文件，它获取 ResourceBundle 并将其装载到 Map 中，然后将其存储到请求领域的命名空间中，这样使得用同一机制在模型层中访问数据所得到的信息是有效的。2.3.2 例子代码2.3.3 属性列表属性数据类型描述是否必须basenameString表示资源包的路径，这里并不需要指明具体的Locale，而只需要给出默认属性文件的路径。 此例邦定的文件位于myfaces-examplesWEB-INF resources .properties是valueString表示在页面中引用资源包时用的变量是2.4 2.4.1 控件描述显示错误提示，当监控的内容提交时前端检查是否符合要求2.4.2 截图2.4.3 例子代码2.4.4 属性列表属性数据类型描述是否必须idString此属性是组件标识符。此属性的值在当前JSP页面中要求是唯一的。是styleClassString对应的样式文件的样式名称否forString监控那个值的变动是2.5 2.5.1 控件描述显示错误提示，和messages类似，但是它是一个全局错误信息，整个网页任何地方不符合要求都将出错。它是没有for属性的。2.5.2 截图2.5.3 例子代码2.5.4 属性列表属性数据类型描述是否必须idString此属性是组件标识符。此属性的值在当前JSP页面中要求是唯一的。是styleClassString对应的样式文件的样式名称否2.6 2.6.1 控件描述显示一个图片2.6.2 例子代码 2.6.3 属性列表属性数据类型描述是否必须idString此属性是组件标识符。此属性的值在当前JSP页面中要求是唯一的。是styleClassString对应的样式文件的样式名称否urlString图片地址是ValueString当图片无法显示时显示的文字是2.7 2.7.1 控件描述显示一个输出文本，可以从bean中获取变量。2.7.2 截图2.7.3 例子代码2.7.4 属性列表属性数据类型描述是否必须idString此属性是组件标识符。此属性的值在当前JSP页面中要求是唯一的。否styleClassString对应的样式文件的样式名称否valueString显示BEAN中的值是2.8 2.8.1 控件描述显示一个数据表格。2.8.2 截图2.8.3 例子代码2.8.4 属性列表属性数据类型描述是否必须idString此属性是组件标识符。此属性的值在当前JSP页面中要求是唯一的。否styleClassString对应的样式文件的样式名称否VarString数据集名称，用于显示行内容的时候使用否valueString数据集来源是注：是否必须是说明此值在JSP页面中是否必须，视具体情况具体分析，下同。2.8.5 使用说明每一个列的数据邦定，需要修改中邦定的值，以及栏名称 /这一栏的名称是“Name” /这一栏绑定的内容2.9 2.9.1 控件描述这是myfaces的控件。主要是用来控制数据集的导航，需要配合其它数据显示使用。这里是为for=”data”的控制服务。2.9.2 截图2.9.3 例子代码 2.9.4 属性列表属性数据类型描述是否必须idString此属性是组件标识符。此属性的值在当前JSP页面中要求是唯一的。是forString对应的数据显示集，也就是这个导航为那个集合服务是fastStepString每次向下滚动行数是pageCountVarString当前数据集的总页数否pageIndexVarString当前页面否paginatorString是否显示快捷页码，ture或者false否paginatorMaxPagesString每页最多显示快捷页码的数目否firstRowIndexVarString本页第一行在整个数据集中的序号否lastRowIndexVarString本页第一行在整个数据集中的序号否2.9.5 使用说明这是一个数据控制组件，所以它必须与一个数据表格对应（例如dataTable）2.10 2.10.1 控件描述显示一个输入框，用于接收用户输入的数据，并可以绑定到bean的变量中2.10.2 截图2.10.3 例子代码2.10.4 属性列表属性数据类型描述是否必须idString此属性是组件标识符。此属性的值在当前JSP页面中要求是唯一的。否styleClassString对应的样式文件的样式名称否maxlengthString最大长度，超过限定长度就无法输入否valueString邦定到BEAN中的值否requiredString是否必须输入内容，只要ture和false两种属性，需要配合message使用否sizeString输入框显示宽度否2.11 2.11.1 控件描述显示一个文本输入域，用于接收用户的输入，和inputText不同的是它可以输入多行，而inputText只能够输入一行。2.11.2 截图2.11.3 例子代码2.11.4 属性列表属性数据类型描述是否必须idString此属性是组件标识符。此属性的值在当前JSP页面中要求是唯一的。否styleClassString对应的样式文件的样式名称否requiredString是否必须输入内容，只要ture和false两种属性，需要配合message使用否valueString邦定的数据集是rowsString文本输入域最大行数否2.12 2.12.1 控件描述提供一个密码输入框，当输入数据的时候显示“*”，并可以把内容传递到bean中的变量。一些属性可以参考INPUTTEXT。2.12.2 截图2.12.3 例子代码2.12.4 属性列表属性数据类型描述是否必须idString此属性是组件标识符。此属性的值在当前JSP页面中要求是唯一的。是requiredString是否必须输入内容，只要ture和false两种属性，需要配合message使用否maxlengthString最大长度，超过限定长度就无法输入否styleClassString对应的样式文件的样式名称否valueString邦定bean的变量是2.13 2.13.1 控件描述这是myfaces的日历控件。2.13.2 截图2.13.3 例子代码2.13.4 属性列表属性数据类型描述必需idString此属性是组件标识符。此属性的值在当前JSP页面中要求是唯一的。是monthYearRowClassString月份选项样式否weekRowClassString周份选项样式否currentDayCellClassString当前日期选项样式否renderAsPopupString是否显示上面截图的日历菜单选项否popupTodayStringString如果显示日历菜单，今天日期的提示否popupWeekStringString如果显示日历菜单，周的提示否popupDateFormatString显示的日期样式，这里有bug，所以不建议大家修改，定为“yyyy-MM-dd”否2.13.5 使用说明因为需要自动把javascript导入到前台页面，所以必须在web.xml文件前增加下面： extensionsFilter /faces/*2.14 2.14.1 控件描述提供一个隐藏输入框，主要用于一些参数传递，但是又不需要给客户看到。2.14.2 截图它是一个隐藏输入框，在前台只有HTML代码，但是没有显示。2.14.3 例子代码2.14.4 属性列表属性数据类型描述是否必须idString此属性是组件标识符。此属性的值在当前JSP页面中要求是唯一的。否valueString绑定bean的变量是2.15 2.15.1 控件描述这个控件是从下拉菜单中选择一个选项。数据来源可以是一项一项的，也可以是数据集。2.15.2 截图2.15.3 例子代码 2.15.4 属性列表属性数据类型描述是否必须idString此属性是组件标识符。此属性的值在当前JSP页面中要求是唯一的。否valueString这是selectOneMenu的value，下拉菜单的提示语言，比如“请选择年龄”等是itemValueString每一项下拉菜单的值是itemLabelString每一项下拉显示出来给用户看的内容是ValueString这是selectItems的value，这是一个数据集是2.15.5 使用说明selectItem表示是一项，selectItems表示数量来源是value，这个SelectItem是List 或者 array数据类型。2.16 2.16.1 控件描述您可以使用 SelectOneRadio 来显示一个单选按钮选择集合。您可以包含一组单选选项和嵌套的选项组。2.16.2 截图2.16.3 例子代码2.16.4 属性列表属性数据类型描述是否必须idString此属性是组件标识符。此属性的值在当前JSP页面中要求是唯一的。是styleClassString对应的样式文件的样式名称否LayoutString排列方式，此处是垂直排列否itemValueString每一项菜单的值是itemLabelString每一项显示出来给用户看的内容是ValueString这是selectItems的value，这是一个数据集是2.16.5 使用说明selectItem表示是一项，selectItems表示数量来源是value，这个SelectItem是List 或者 array数据类型。2.17 2.17.1 控件描述您可以使用 selectOneListbox来显示多项下拉菜单。但是只能够选择一项。2.17.2 截图2.17.3 例子代码 2.17.4 属性列表属性数据类型描述是否必须idString此属性是组件标识符。此属性的值在当前JSP页面中要求是唯一的。是styleClassString对应的样式文件的样式名称否itemValueString每一项菜单的值是itemLabelString每一项显示出来给用户看的内容是ValueString这是selectItems的value，这是一个数据集是2.17.5 使用说明selectItem表示是一项，selectItems表示数量来源是value，这个SelectItem是List 或者 array数据类型。2.18 2.18.1 控件描述您可以使用 selectManyListbox来同时显示多个选项表格框。并可以选择多项。2.18.2 截图2.18.3 例子代码 2.18.4 属性列表属性数据类型描述是否必须idString此属性是组件标识符。此属性的值在当前JSP页面中要求是唯一的。是styleClassString对应的样式文件的样式名称否itemValueString每一项菜单的值否itemLabelString每一项显示出来给用户看的内容否selectItemsString数据集来源，参考selectItems否ValueString这是selectItems的value，这是一个数据集否2.18.5 使用说明selectItem表示是一项，selectItems表示数量来源是value，这个SelectItem是List 或者 array数据类型。2.19 2.19.1 控件描述显示一个选择。它只有两个返回值false和true。2.19.2 截图2.19.3 例子代码2.19.4 属性列表属性数据类型描述是否必须idString此属性是组件标识符。此属性的值在当前JSP页面中要求是唯一的。否ValueString邦定到bean中的变量是2.20 2.20.1 控件描述从一个list或者arraylist中导入选项数据。需要配合selectOneMenu或者selectOneListbox等使用。2.20.2 例子代码 2.20.3 属性列表属性数据类型描述是否必须valuelist邦定backingbean的数据集是2.20.4 使用说明需要配合selectOneMenu或者selectOneListbox等使用。2.21 2.21.1 控件描述显示一个链接控件，显示文本需要适用outputText2.21.2 截图2.21.3 例子代码2.21.4 属性列表属性数据类型描述是否必须idString此属性是组件标识符。此属性的值在当前JSP页面中要求是唯一的。否TargetString打开链接的目标窗口否valueString需要链接到的地址是2.22 2.22.1 控件描述显示一个提交按钮，可以直接提交到bean的方法中2.22.2 截图2.22.3 例子代码2.22.4 属性列表属性数据类型描述是否必须idString此属性是组件标识符。此属性的值在当前JSP页面中要求是唯一的。是styleClassString对应的样式文件的样式名称否valueString显示出来的按钮名称是actionString是一个动作，提交到bean中的方法是2.23 2.23.1 控件描述显示一个提交标签，这个标签和commandButton不同，它可以是一个文本框，需要结合actionListener使用。actionListener用于监听提交，并不是一定需要的。2.23.2 截图2.23.3 例子代码 2.23.4 属性列表属性数据类型描述是否必须idString此属性是组件标识符。此属性的值在当前JSP页面中要求是唯一的。否actionString是一个动作，提交到bean中的方法是2.24 2.24.1 控件描述提供一个隐藏输入框，主要用于一些参数传递，但是又不需要给客户看到。2.24.2 截图一个事件监听标签，也是用于参数传递。这个标签的特点是传递到的地方和来源是不一样的属性。2.24.3 例子代码2.24.4 属性列表属性数据类型描述是否必须propertyString要传递到后台bean的变量是valueString数据来源。是2.25 2.25.1 控件描述jscookMenu作用是显示一个menu导航菜单，它是myfaces的一个控件，数据可以在bean中配置2.25.2 截图2.25.3 例子代码 2.25.4 属性列表属性数据类型描述是否必须idString此属性是组件标识符。此属性的值在当前JSP页面中要求是唯一的。是themeString对应的样式名称，可选项为ThemeIEThemeMiniBlackThemeOfficeThemePanel是navigationMenuItemsString数据集来源，参考selectItems是ValueString这是selectItems的value，这是一个数据集是layoutString相当于menu的别名否2.25.5 使用说明navigationMenuItem表示是一项，navigationMenuItems表示数量来源是value，这个navigationMenuItems是List 或者 ArrayList数据类型。3 自定义标签3.1 3.1.1 控件描述Ajax链接。 3.1.2 截图无3.1.3 例子代码3.1.4 属性列表属性数据类型描述必需idString此属性是组件标识符。此属性的值在当前JSP页面中要求是唯一的。是targetString页面中的区域标识(dimension)，即链接的目标页面将要显示的区域是valueString链接名称是actionString链接地址是paramString指定随链接传递的参数，参数名指向页面中要作为参数的元素ID，多个参数使用”,”分隔否3.1.5 使用说明Ajaxlink基于URL跳转，而不是通过表单提交。表单提交形式的ajax链接请参考gc:commandLink标签。3.2 3.2.1 控件描述Ajax对话框。 主窗口显示为链接，点击链接后主窗口冻结，同时显示对话框窗口3.2.2 截图3.2.3 例子代码3.2.4 属性列表属性数据类型描述必需idString此属性是组件标识符。此属性的值在当前JSP页面中要求是唯一的。是valueString对话框链接名称是actionString对话框页面地址是widthInteger对话框宽度是heightInteger对话框高度是modalBoolean是否为模态窗口否postactionString决定对话框操作结束并被关闭后是否需要触发某个事件，该值对应主窗口目标事件的提交按钮否3.2.5 使用说明1. 关闭对话框将关闭按钮绑定js事件onclick=tb_remove()2. 执行操作并关闭对话框在BackingBean事件中调用DialogService.closeAjaxDialog(map)，在没有参数传递的情况下，该方法参数传入null即可。3. 参数传递该对话框通过js实现，对话框和主窗口实际上为同一页面，所以在对话框中可以直接对主窗口的元素取值。对话框的返回值需要通过参数标签指定，指定的参数名称对应主窗口中的元素ID。3.3 3.3