# M18 JSF 组件

# inputText

# 属性列表

属性名称 类型 默认值 说明
id String 组件的唯一标识符,同一个父组件下的子组件不能有相同的id,建议页面上的每个组件都设置id。
value String 组件的值。
style String 组件的行内CSS样式。
styleClass String 组件的样式类名,多个类使用空格分开。
rendered boolean true 是否渲染此组件。如果设置为false,那么在生成的html页面上没有对应元素。
visible boolean true 是否隐藏此组件。如果设置为true,那么在生成的html页面上有对应元素,但是不可见,注意与rendered="false"区分。
disabled boolean false 是否禁用输入元素,禁用后不能触发事件。
readOnly boolean false 是否设置输入元素为只读状态,只读状态仍然可触发事件,注意与disabled="true"区分。
required boolean false 是否为必填字段。
label String 组件的前置标签。
labelVisible boolean true 是否渲染组件的标签。
suffixLabel String 组件的后置标签。
tableName String 组件的值对应的数据表名。
columnName String 组件的值对应的数据列名。
info String 组件的描述信息。
infoPos String end 组件描述信息的位置。可选项:startprefixsuffixend
trim boolean false 是否去除首尾的空格。
upperCase boolean false 是否转换为大写字母。
mask String 规定输入字符串的格式。
password boolean false 输入元素是否为密码类型。
regex String 规定输入字符串的正则表达式。
maxlength int 能够输入字符的最大长度。

# 事件列表

事件名称 说明
change 输入元素的值发生变化时触发。
blur 输入元素失去焦点时触发。
focus 输入元素获得焦点时触发。
click 点击输入元素时触发。
dblclick 双击输入元素时触发。
keydown 在输入字段按下任意键时触发。
keypresss 在输入字段按下字符键时触发。非字符键例如ctrl、shift。
keyup 在输入字段按下任意键后松开时触发。
mousedown 在输入字段按钮鼠标时触发。
mouseup 在输入字段松开鼠标时触发。
mousemove 在输入字段移动鼠标时触发。
mouseout 鼠标移除输入字段时触发。

# inputNum

# 属性列表

属性名称 类型 默认值 说明
id String 组件的唯一标识符,同一个父组件下的子组件不能有相同的id,建议页面上的每个组件都设置id。
value Number 组件的值。
style String 组件的行内CSS样式。
styleClass String 组件的样式类名,多个类使用空格分开。
rendered boolean true 是否渲染此组件。如果设置为false,那么在生成的html页面上没有对应元素。
visible boolean true 是否隐藏此组件。如果设置为true,那么在生成的html页面上有对应元素,但是不可见,注意与rendered="false"区分。
disabled boolean false 是否禁用输入元素,禁用后不能触发事件。
readOnly boolean false 是否设置输入元素为只读状态,只读状态仍然可触发事件,注意与disabled="true"区分。
required boolean false 是否为必填字段。
label String 组件的前置标签。
labelVisible boolean true 是否渲染组件的标签。
suffixLabel String 组件的后置标签。
tableName String 组件的值对应的数据表名。
columnName String 组件的值对应的数据列名。
info String 组件的描述信息。
infoPos String end 组件描述信息的位置。可选项:startprefixsuffixend
groupUsed boolean true 整数部分是否分组。
groupSize int 3 整数部分分组的大小。
length int 数字的长度,整数位数与小数位数的和。
decimal int 小数的位数。
decimalSeparator String . 小数的符号。
thousandSeparator String , 分组的符号。
max double 允许输入的最大值。
min double 允许输入的最小值。

# 事件列表

inputNum组件的事件与inputText组件的事件相同。

# inputDate

# 属性列表

属性名称 类型 默认值 说明
id String 组件的唯一标识符,同一个父组件下的子组件不能有相同的id,建议页面上的每个组件都设置id。
value Date 组件的值。
style String 组件的行内CSS样式。
styleClass String 组件的样式类名,多个类使用空格分开。
rendered boolean true 是否渲染此组件。如果设置为false,那么在生成的html页面上没有对应元素。
visible boolean true 是否隐藏此组件。如果设置为true,那么在生成的html页面上有对应元素,但是不可见,注意与rendered="false"区分。
disabled boolean false 是否禁用输入元素,禁用后不能触发事件。
readOnly boolean false 是否设置输入元素为只读状态,只读状态仍然可触发事件,注意与disabled="true"区分。
required boolean false 是否为必填字段。
label String 组件的前置标签。
labelVisible boolean true 是否渲染组件的标签。
suffixLabel String 组件的后置标签。
tableName String 组件的值对应的数据表名。
columnName String 组件的值对应的数据列名。
info String 组件的描述信息。
infoPos String end 组件描述信息的位置。可选项:startprefixsuffixend
clearBtn boolean false 是否在选择面板显示清除按钮。
daysOfWeekDisabled int[] 是否禁用一周内的某几天,范围从0至6,0表示星期天。在xhtml上可用#[0, 1, 3]这种形式来指定。
datesDisabled Date[] 是否禁用特定的某些日期。
defaultViewDate Date 选择面板初始选择的日期,默认是今天。
endDate Date 能够选择的最后一天,超过这一天的日期都会被禁用。
startDate Date 能够选择的第一天,比第一天早的日期都会被禁用。
format String yyyy-mm-dd 日期的格式。
minView String days 最小能够选择到的日期单位,可选项:daysmonthsyeardecadescenturies
startView String days 初始选择的日期单位,可选项:daysmonthsyeardecadescenturies
orientation String auto 选择面板的位置,由横向位置和纵向位置组成,横向包括leftrightauto,纵向包括topbottomauto
weekStart int 0 自然周的第一天,范围从0至6,0表示星期天。
todayBtn boolean true 是否在选择面板显示今天按钮。
todayHighlight boolean true 选择面板今天是否高亮显示。
showOnFocus boolean false 是否在输入元素获得焦点时打开选择面板。

# 事件列表

inputDate组件的事件与inputText组件的事件相同。

# inputTime

# 属性列表

属性名称 类型 默认值 说明
id String 组件的唯一标识符,同一个父组件下的子组件不能有相同的id,建议页面上的每个组件都设置id。
value String 组件的值。
style String 组件的行内CSS样式。
styleClass String 组件的样式类名,多个类使用空格分开。
rendered boolean true 是否渲染此组件。如果设置为false,那么在生成的html页面上没有对应元素。
visible boolean true 是否隐藏此组件。如果设置为true,那么在生成的html页面上有对应元素,但是不可见,注意与rendered="false"区分。
disabled boolean false 是否禁用输入元素,禁用后不能触发事件。
readOnly boolean false 是否设置输入元素为只读状态,只读状态仍然可触发事件,注意与disabled="true"区分。
required boolean false 是否为必填字段。
label String 组件的前置标签。
labelVisible boolean true 是否渲染组件的标签。
suffixLabel String 组件的后置标签。
tableName String 组件的值对应的数据表名。
columnName String 组件的值对应的数据列名。
info String 组件的描述信息。
infoPos String end 组件描述信息的位置。可选项:startprefixsuffixend
maxHours int 24 能够支持的最大小时数。
showSeconds boolean true 是否显示秒数。
defaultTime String 默认的时间。

# 事件列表

事件名称 说明
changeTime 当组件的值发生变化时触发。
show 选择面板显示时触发。
hide 选择面板隐藏时触发。

# inputCombo

# 属性列表

属性名称 类型 默认值 说明
id String 组件的唯一标识符,同一个父组件下的子组件不能有相同的id,建议页面上的每个组件都设置id。
value NumberString 组件的值。
style String 组件的行内CSS样式。
styleClass String 组件的样式类名,多个类使用空格分开。
rendered boolean true 是否渲染此组件。如果设置为false,那么在生成的html页面上没有对应元素。
visible boolean true 是否隐藏此组件。如果设置为true,那么在生成的html页面上有对应元素,但是不可见,注意与rendered="false"区分。
disabled boolean false 是否禁用输入元素,禁用后不能触发事件。
readOnly boolean false 是否设置输入元素为只读状态,只读状态仍然可触发事件,注意与disabled="true"区分。
required boolean false 是否为必填字段。
label String 组件的前置标签。
labelVisible boolean true 是否渲染组件的标签。
suffixLabel String 组件的后置标签。
tableName String 组件的值对应的数据表名。
columnName String 组件的值对应的数据列名。
info String 组件的描述信息。
infoPos String end 组件描述信息的位置。可选项:startprefixsuffixend
multiple boolean false 是否开启多选。
liveSearch boolean false 是否能够搜索。
keepInvalid boolean false 如果组件的值不在可选项中是否还保留此选项。
emptyValue Object "" 用什么代表空值。

# 事件列表

事件名称 说明
change 当选择元素的值改变时触发。
blur 当选择元素失去焦点时触发。
focus 当选择元素获得焦点时触发。
click 点击选择元素时触发。
dblclick 双击选择元素时触发。

# 可接受的子选项

  • selectItem,表示单个选项,属性列表如下。
属性名称 类型 默认值 说明
itemLabel String 选项的标签。
itemValue NumberString 选项的值。
description String 选项的说明。
style String 选项的行内CSS样式。
styleClass String 选项的类名。
disabled boolean false 是否禁用此选项。
rendered boolean true 是否渲染此选项。
  • selectItems,表示多个选项的集合,属性列表如下。
属性名称 类型 默认值 说明
value Object 多个选项的集合。
  • selectItemGroup,表示选项的组合,可包含selectItem、selectItems、selectItemGroup,属性列表如下。
属性名称 类型 默认值 说明
itemLabel String 组合的名称。

# inputColor

# 属性列表

属性名称 类型 默认值 说明
id String 组件的唯一标识符,同一个父组件下的子组件不能有相同的id,建议页面上的每个组件都设置id。
value String 组件的值。
style String 组件的行内CSS样式。
styleClass String 组件的样式类名,多个类使用空格分开。
rendered boolean true 是否渲染此组件。如果设置为false,那么在生成的html页面上没有对应元素。
visible boolean true 是否隐藏此组件。如果设置为true,那么在生成的html页面上有对应元素,但是不可见,注意与rendered="false"区分。
disabled boolean false 是否禁用输入元素,禁用后不能触发事件。
readOnly boolean false 是否设置输入元素为只读状态,只读状态仍然可触发事件,注意与disabled="true"区分。
required boolean false 是否为必填字段。
label String 组件的前置标签。
labelVisible boolean true 是否渲染组件的标签。
suffixLabel String 组件的后置标签。
tableName String 组件的值对应的数据表名。
columnName String 组件的值对应的数据列名。
info String 组件的描述信息。
infoPos String end 组件描述信息的位置。可选项:startprefixsuffixend
withInput boolean true 是否显示输入元素。
format String rgba 颜色的格式,可选项:hexrgbrgba
horizontal boolean false 设置颜色和透明度控制条是否为纵向。
defaultColors String[] 设置几种默认的颜色备选。

# 事件列表

inputColor组件的事件与inputText组件的事件相同。

# inputCheck

# 属性列表

属性名称 类型 默认值 说明
id String 组件的唯一标识符,同一个父组件下的子组件不能有相同的id,建议页面上的每个组件都设置id。
value boolean 组件的值。
style String 组件的行内CSS样式。
styleClass String 组件的样式类名,多个类使用空格分开。
rendered boolean true 是否渲染此组件。如果设置为false,那么在生成的html页面上没有对应元素。
visible boolean true 是否隐藏此组件。如果设置为true,那么在生成的html页面上有对应元素,但是不可见,注意与rendered="false"区分。
disabled boolean false 是否禁用输入元素,禁用后不能触发事件。
readOnly boolean false 是否设置输入元素为只读状态,只读状态仍然可触发事件,注意与disabled="true"区分。
required boolean false 是否为必填字段。
label String 组件的前置标签。
labelVisible boolean true 是否渲染组件的标签。
suffixLabel String 组件的后置标签。
tableName String 组件的值对应的数据表名。
columnName String 组件的值对应的数据列名。
info String 组件的描述信息。
infoPos String end 组件描述信息的位置。可选项:startprefixsuffixend
textPos String right 标签的位置,可选项:leftright

# 事件列表

事件名称 说明
change 当组件的值发生变化时触发。

# inputRadio

# 属性列表

属性名称 类型 默认值 说明
id String 组件的唯一标识符,同一个父组件下的子组件不能有相同的id,建议页面上的每个组件都设置id。
value StringNumberboolean 组件的值。
style String 组件的行内CSS样式。
styleClass String 组件的样式类名,多个类使用空格分开。
rendered boolean true 是否渲染此组件。如果设置为false,那么在生成的html页面上没有对应元素。
visible boolean true 是否隐藏此组件。如果设置为true,那么在生成的html页面上有对应元素,但是不可见,注意与rendered="false"区分。
disabled boolean false 是否禁用输入元素,禁用后不能触发事件。
readOnly boolean false 是否设置输入元素为只读状态,只读状态仍然可触发事件,注意与disabled="true"区分。
required boolean false 是否为必填字段。
label String 组件的前置标签。
labelVisible boolean true 是否渲染组件的标签。
suffixLabel String 组件的后置标签。
tableName String 组件的值对应的数据表名。
columnName String 组件的值对应的数据列名。
info String 组件的描述信息。
infoPos String end 组件描述信息的位置。可选项:startprefixsuffixend
textPos String right 标签的位置,可选项:leftright

# 事件列表

事件名称 说明
change 当组件的值发生变化时触发。

# inputSpinner

# 属性列表

属性名称 类型 默认值 说明
id String 组件的唯一标识符,同一个父组件下的子组件不能有相同的id,建议页面上的每个组件都设置id。
value Number 组件的值。
style String 组件的行内CSS样式。
styleClass String 组件的样式类名,多个类使用空格分开。
rendered boolean true 是否渲染此组件。如果设置为false,那么在生成的html页面上没有对应元素。
visible boolean true 是否隐藏此组件。如果设置为true,那么在生成的html页面上有对应元素,但是不可见,注意与rendered="false"区分。
disabled boolean false 是否禁用输入元素,禁用后不能触发事件。
readOnly boolean false 是否设置输入元素为只读状态,只读状态仍然可触发事件,注意与disabled="true"区分。
required boolean false 是否为必填字段。
label String 组件的前置标签。
labelVisible boolean true 是否渲染组件的标签。
suffixLabel String 组件的后置标签。
tableName String 组件的值对应的数据表名。
columnName String 组件的值对应的数据列名。
info String 组件的描述信息。
infoPos String end 组件描述信息的位置。可选项:startprefixsuffixend
min doube 0 最小值。
max double 100 最大值。
step double 100 每一步的大小。
decimal int 0 小数位数。
verticalButton boolean false 增加按钮和减少按钮是否在一起纵向排列。

# 事件列表

inputSpinner组件的事件与inputText组件的事件相同。

# inputSwitch

# 属性列表

属性名称 类型 默认值 说明
id String 组件的唯一标识符,同一个父组件下的子组件不能有相同的id,建议页面上的每个组件都设置id。
value boolean 组件的值。
style String 组件的行内CSS样式。
styleClass String 组件的样式类名,多个类使用空格分开。
rendered boolean true 是否渲染此组件。如果设置为false,那么在生成的html页面上没有对应元素。
visible boolean true 是否隐藏此组件。如果设置为true,那么在生成的html页面上有对应元素,但是不可见,注意与rendered="false"区分。
disabled boolean false 是否禁用输入元素,禁用后不能触发事件。
readOnly boolean false 是否设置输入元素为只读状态,只读状态仍然可触发事件,注意与disabled="true"区分。
required boolean false 是否为必填字段。
label String 组件的前置标签。
labelVisible boolean true 是否渲染组件的标签。
suffixLabel String 组件的后置标签。
tableName String 组件的值对应的数据表名。
columnName String 组件的值对应的数据列名。
info String 组件的描述信息。
infoPos String end 组件描述信息的位置。可选项:startprefixsuffixend
onColor String primary 打开状态的颜色,可选项:primarysuccessdangerwarninginfo
offColor String primary 关闭状态的颜色,可选项:primarysuccessdangerwarninginfo
onText String ON 打开状态的标签。
offText String OFF 关闭状态的标签。
handleWidth int 开关的宽度。
labelWidth int 开关标签的宽度。

# 事件列表

事件名称 说明
change 当组件的值发生变化时触发。

# inputSlider

# 属性列表

属性名称 类型 默认值 说明
id String 组件的唯一标识符,同一个父组件下的子组件不能有相同的id,建议页面上的每个组件都设置id。
value Number 组件的值。
style String 组件的行内CSS样式。
styleClass String 组件的样式类名,多个类使用空格分开。
rendered boolean true 是否渲染此组件。如果设置为false,那么在生成的html页面上没有对应元素。
visible boolean true 是否隐藏此组件。如果设置为true,那么在生成的html页面上有对应元素,但是不可见,注意与rendered="false"区分。
disabled boolean false 是否禁用输入元素,禁用后不能触发事件。
readOnly boolean false 是否设置输入元素为只读状态,只读状态仍然可触发事件,注意与disabled="true"区分。
required boolean false 是否为必填字段。
label String 组件的前置标签。
labelVisible boolean true 是否渲染组件的标签。
suffixLabel String 组件的后置标签。
tableName String 组件的值对应的数据表名。
columnName String 组件的值对应的数据列名。
info String 组件的描述信息。
infoPos String end 组件描述信息的位置。可选项:startprefixsuffixend
min double 0 最小值。
max double 10 最大值。
step double 1 每一步增长量。

# 事件列表

事件名称 说明
change 当组件的值发生变化时触发。

# inputTexearea

# 属性列表

属性名称 类型 默认值 说明
id String 组件的唯一标识符,同一个父组件下的子组件不能有相同的id,建议页面上的每个组件都设置id。
value String 组件的值。
style String 组件的行内CSS样式。
styleClass String 组件的样式类名,多个类使用空格分开。
rendered boolean true 是否渲染此组件。如果设置为false,那么在生成的html页面上没有对应元素。
visible boolean true 是否隐藏此组件。如果设置为true,那么在生成的html页面上有对应元素,但是不可见,注意与rendered="false"区分。
disabled boolean false 是否禁用输入元素,禁用后不能触发事件。
readOnly boolean false 是否设置输入元素为只读状态,只读状态仍然可触发事件,注意与disabled="true"区分。
required boolean false 是否为必填字段。
label String 组件的前置标签。
labelVisible boolean true 是否渲染组件的标签。
suffixLabel String 组件的后置标签。
tableName String 组件的值对应的数据表名。
columnName String 组件的值对应的数据列名。
info String 组件的描述信息。
infoPos String end 组件描述信息的位置。可选项:startprefixsuffixend
rows int 输入元素的行数。
cols int 输入元素的列数。
maxlength int 能够输入字符的最大长度。
trim boolean false 是否去除首尾的空格。
upperCase boolean false 是否转换为大写字母。

# 事件列表

inputTextarea组件的事件与inputText组件的事件相同。

# inputFile

# 属性列表

属性名称 类型 默认值 说明
id String 组件的唯一标识符,同一个父组件下的子组件不能有相同的id,建议页面上的每个组件都设置id。
multiple boolean false 是否支持多个文件
briefStyle boolean false 是否已简洁模式显示(所有按钮,显示图标,不显示文本)
download boolean true 是否允许下载“已上传”文件
reloadable boolean false 是否支持重复读取本地文件
styleClass String 组件的样式类名,多个类使用空格分开。
style String 组件的行内CSS样式。
disabled boolean false 是否禁用输入元素,禁用后不能触发事件。
readonly boolean false 是否设置输入元素为只读状态,只读状态仍然可触发事件,注意与disabled="true"区分。
instantUpload boolean false 是否在文件读取后,立即自动上传到服务器
dropZone boolean false 是否显示文件“拖放区”
caption boolean true 是否显示标题区
keepData boolean false 是否在组件中显示绑定文件信息(默认情况下,只作为文件上传工具)
uploadListener EL expression 当文件上传后,触发事件。通过EL表达式来执行动作。
maxCount int 能够选择的最大文件数
maxFileSize long 能够选择的文件最大大小
removeable boolean true 是否可以移除选择文件
fileType string 接受的文件类型。可选image, html,text,video,audio,flash,pdf,object,other。可以多选,以,分割。
fileExtension string 接受的文件扩展名。可以多选,以,分割。

# lookup

# 属性列表

属性名称 类型 默认值 说明
id String 组件的唯一标识符,同一个父组件下的子组件不能有相同的id,建议页面上的每个组件都设置id。
value String 组件的值。
style String 组件的行内CSS样式。
styleClass String 组件的样式类名,多个类使用空格分开。
rendered boolean true 是否渲染此组件。如果设置为false,那么在生成的html页面上没有对应元素。
visible boolean true 是否隐藏此组件。如果设置为true,那么在生成的html页面上有对应元素,但是不可见,注意与rendered="false"区分。
disabled boolean false 是否禁用输入元素,禁用后不能触发事件。
readOnly boolean false 是否设置输入元素为只读状态,只读状态仍然可触发事件,注意与disabled="true"区分。
required boolean false 是否为必填字段。
label String 组件的前置标签。
labelVisible boolean true 是否渲染组件的标签。
suffixLabel String 组件的后置标签。
tableName String 组件的值对应的数据表名。
columnName String 组件的值对应的数据列名。
info String 组件的描述信息。
infoPos String end 组件描述信息的位置。可选项:startprefixsuffixend
lookupType String lookup对应的searchType, 定义于stSearch.xml
checkAccess boolean true 是否在查询数据时检查用户访问权限。
lookupDto StLookupDto 指定lookup组件显示信息。(不指定的情况下,系统会自行读取)

# treeCombo

# 属性列表

属性名称 类型 默认值 说明
id String 组件的唯一标识符,同一个父组件下的子组件不能有相同的id,建议页面上的每个组件都设置id。
value NumberString 组件的值。
style String 组件的行内CSS样式。
styleClass String 组件的样式类名,多个类使用空格分开。
rendered boolean true 是否渲染此组件。如果设置为false,那么在生成的html页面上没有对应元素。
visible boolean true 是否隐藏此组件。如果设置为true,那么在生成的html页面上有对应元素,但是不可见,注意与rendered="false"区分。
disabled boolean false 是否禁用输入元素,禁用后不能触发事件。
readOnly boolean false 是否设置输入元素为只读状态,只读状态仍然可触发事件,注意与disabled="true"区分。
required boolean false 是否为必填字段。
label String 组件的前置标签。
labelVisible boolean true 是否渲染组件的标签。
suffixLabel String 组件的后置标签。
tableName String 组件的值对应的数据表名。
columnName String 组件的值对应的数据列名。
info String 组件的描述信息。
infoPos String end 组件描述信息的位置。可选项:startprefixsuffixend
items Object 可选的树节点,可以是TreeComboData类型,也可以是TreeComboNode的集合。
liveSearch boolean false 是否能够搜索。
emptyValue Object null 用什么代表空值。

# 事件列表

事件名称 说明
change 当组件的值发生变化时触发。

# fluidPannel

# 属性列表

属性名称 类型 默认值 说明
id String 组件的唯一标识符,同一个父组件下的子组件不能有相同的id,建议页面上的每个组件都设置id。
style String 组件的行内CSS样式。
styleClass String 组件的样式类名,多个类使用空格分开。
rendered boolean true 是否渲染此组件。
column int 2 为当前布局指定垂直分栏数量。由于fluidPanel基于12栅格系统,因此分栏数量必须是12的约数:1、2、3、4、6、12,推荐使用1、2、3、4。
wide boolean true 控制布局的最大宽度,如果为true,那么能够占满父元素的宽度,如果为false那么就有最大宽度的限制。
title String 布局的标题。
bordered boolean false 是否有边框,标题在边框下方。
groupBorder boolean false 是否有边框,标题嵌入在边框中。
collapsible boolean false 是否支持收起展开。
status String normal 初始状态,可选项:normalcollapsed
titleAlign String left 标题的对齐方式,可选项:leftcenterright
actionAlign String left 展开、收缩按钮的对齐方式,可选项:leftcenterright
collapseText String 收缩按钮的提示信息。
expandText String 展开按钮的提示信息。

# codeEditor

# 属性列表

属性名称 类型 默认值 说明
id String 组件的唯一标识符,同一个父组件下的子组件不能有相同的id,建议页面上的每个组件都设置id。
value String 组件的值。
style String 组件的行内CSS样式。
styleClass String 组件的样式类名,多个类使用空格分开。
rendered boolean true 是否渲染此组件。如果设置为false,那么在生成的html页面上没有对应元素。
visible boolean true 是否隐藏此组件。如果设置为true,那么在生成的html页面上有对应元素,但是不可见,注意与rendered="false"区分。
disabled boolean false 是否禁用输入元素,禁用后不能触发事件。
readOnly boolean false 是否设置输入元素为只读状态,只读状态仍然可触发事件,注意与disabled="true"区分。
required boolean false 是否为必填字段。
label String 组件的前置标签。
labelVisible boolean true 是否渲染组件的标签。
suffixLabel String 组件的后置标签。
tableName String 组件的值对应的数据表名。
columnName String 组件的值对应的数据列名。
info String 组件的描述信息。
infoPos String end 组件描述信息的位置。可选项:startprefixsuffixend
lineNumbers boolean true 是否显示行号。
language String javascript 代码编辑器的程序语言。可选项:javascriptformulaplaintplthtmlhtmltpltsqlsqltplt
lineWrapping boolean true 是否开启自动换行。

# 事件列表

事件名称 说明
change 当组件的值发生变化时触发。

# jqGrid

# 属性列表

属性名称 类型 默认值 说明
id String 组件的唯一标识符,同一个父组件下的子组件不能有相同的id,建议页面上的每个组件都设置id。
style String 组件的行内CSS样式。
styleClass String 组件的样式类名,多个类使用空格分开。
rendered boolean true 是否渲染此组件。
visible boolean true 是否隐藏此组件。
searchable boolean true 是否支持搜索。
columns List<JqGridCol> 设置表格的列。
sortable boolean true 是否支持排序。
supportPage boolean true 是否支持分页。
multiselect boolean false 是否支持多选。
height int 250 设置内部的表格高度。
rowNum int 每页显示数量。
rownumbers boolean false 是否显示行号。
rowList int[] 分页信息。
sortname String 初始排序的栏位。
sortorder String asc 初始排序的顺序,可选项:ascdesc
treeGrid boolean false 是否以树的形式来呈现。
ExpandColumn String 指定以哪列来展开树。
autoencode boolean true 是否格式化html标签。
rownumWidth int 35 行号的宽度。

# 事件列表

事件名称 说明
onClickRow 在点击某一行数据时触发。
onDblClickRow 在双击某一行数据时触发。

# 可接受的子选项

  • tableColumn,表格的列,属性列表如下。
属性名称 类型 默认值 说明
name String 列的唯一标识符。
label String 列的名称。
align String left 列的对齐方式。可选项:leftcenterright
formatter String javascript函数名称,用于格式化单元格的内容。内置的formatter:checkboximage。也可自行定义格式化函数。
classes String 列的样式类名。
width int 150 列的宽度。
sortable boolean true 是否支持排序。
hidden boolean false 是否隐藏此列。
resizable boolean true 是否支持改变宽度。
sorttype String text 排序类型,可以是固定类型或者javascript函数。固定类型:intfloatdatetext
cellattr String javascript函数名称,可以给单元格增加额外的属性。

# checkGroup & radioGroup

# 属性列表

属性名称 类型 默认值 说明
id String 组件的唯一标识符,同一个父组件下的子组件不能有相同的id,建议页面上的每个组件都设置id。
value String 组件的值。
style String 组件的行内CSS样式。
styleClass String 组件的样式类名,多个类使用空格分开。
rendered boolean true 是否渲染此组件。如果设置为false,那么在生成的html页面上没有对应元素。
visible boolean true 是否隐藏此组件。如果设置为true,那么在生成的html页面上有对应元素,但是不可见,注意与rendered="false"区分。
disabled boolean false 是否禁用输入元素,禁用后不能触发事件。
readOnly boolean false 是否设置输入元素为只读状态,只读状态仍然可触发事件,注意与disabled="true"区分。
required boolean false 是否为必填字段。
label String 组件的前置标签。
labelVisible boolean true 是否渲染组件的标签。
suffixLabel String 组件的后置标签。
info String 组件的描述信息。
infoPos String end 组件描述信息的位置。可选项:startprefixsuffixend
column int 2 指定垂直分栏数量。由于组件布局基于12栅格系统,因此分栏数量必须是12的约数:1、2、3、4、6、12,推荐使用1、2、3、4。
groupTitle String 为组件增加一个Title
type String type="border"时,会增加边框。
nativeCheck boolean false 是否显示原生checkBox。 默认显示Bootstrap风格的checkbox。
textPos String left left,right。 Checkbox文本位置。
dataOption Collection<OptionItem> Checkbox的数据项
onchange 当checkbox的值发生变化时触发事件。

# 可接受的子选项

  • selectItem,表示单个选项,属性列表如下。
属性名称 类型 默认值 说明
itemLabel String 选项的标签。
itemValue NumberString 选项的值。
description String 选项的说明。
style String 选项的行内CSS样式。
styleClass String 选项的类名。
disabled boolean false 是否禁用此选项。
rendered boolean true 是否渲染此选项。
  • selectItems,表示多个选项的集合,属性列表如下。
属性名称 类型 默认值 说明
value Object 多个选项的集合。

# toolbar

# 属性列表

属性名称 类型 默认值 说明
id String 组件的唯一标识符,同一个父组件下的子组件不能有相同的id,建议页面上的每个组件都设置id。
style String 组件的行内CSS样式。
styleClass String 组件的样式类名,多个类使用空格分开。
rendered boolean true 是否渲染此组件。如果设置为false,那么在生成的html页面上没有对应元素。
visible boolean true 是否隐藏此组件。如果设置为true,那么在生成的html页面上有对应元素,但是不可见,注意与rendered="false"区分。
disabled boolean false 是否禁用输入元素,禁用后不能触发事件。
labelVisible boolean true 是否渲染组件的标签。
iconStyle String small 工具栏图标样式:small,large,hide
toolStyle String 工具栏样式选项,可选noborder,nospace
moreStyle String secondary more按钮的样式,仅当autoFit="true"时有效。可选primary,secondary,success,warning,danger
autoFit boolean false 工具栏是否根据空间大小自动调整布局。

# 可接受的子选项

  • actionItem

    工具栏基本动作单元。属性如下:

属性名称 类型 默认值 说明
action String 动作的唯一标识。
onstart String 在动作请求发起时调用的Javascript代码
oncomplete String 在动作请求完成后调用的Javascript代码
onsuccess String 在动作请求成功完成后调用的Javascript代码
onerror String 在动作请求发生错误后调用的Javascript代码
async boolean false 动作请求是否异步发送。
partialSubmit boolean true 动作请求是否只提交部分数据
process String 动作请求发起时提要的数据组件
actionListener EL expression 动作请求服务器端的响应方法
update String 动作请求完成后,需要更新的组件id
style String 动作元素的行内CSS样式。
styleClass String 组件的样式类名,多个类使用空格分开。
colorStyle String 按钮的样式,可选primary,secondary,success,warning,danger

可通过<caw:icon>来为actionItem指定图片。

  • actionGroup

    将一组actionItem作为一个整体显示(并列显示)。

  • actionStack

    将一组actionItem作为一个下拉菜单显示,其中第一个actionItem直接以按钮显示,其余actionItem在下拉菜单中显示。

  • actionMenu

    将一组actionItem全部作为下拉菜单显示。需要通过label来指定下拉菜单按钮的文本。

  • actionFacet

    将其他组件放置在toolbar上面。

<caw:toolbar id="toolbar">
  <caw:actionItem action="action1" onstart="" oncomplete="" 
                  process="@this" update="#{caw:webIDs('id1 id2')}"
                  actionListener="#{xxxBean.action1}"
                  disabled="false" rendered="true"
                  mess-label="actionMess" title="#{caw:mess('actionMess')}">
    <caw:icon name="cicon-panel" library="font/cawIcon"></caw:icon
  </caw:actionItem>
  <caw:actionGroup>
    <caw:actionItem ...></caw:actionItem>
    <caw:actionItem ...></caw:actionItem>
  </caw:actionGroup>
  <caw:actionStack>
     <caw:actionItem ...></caw:actionItem>
     <caw:actionItem ...></caw:actionItem>
  </caw:actionStack>
  <caw:actionMenu label="Dropdown">
     <caw:actionItem ...></caw:actionItem>
     <caw:actionItem ...></caw:actionItem>
  </caw:actionMenu>
  <caw:actionFacet name="udfaction">
    <caw:inputText></caw:inputText>
  </caw:actionFacet>
</caw:toolbar>

# tabView

# 属性列表

属性名称 类型 默认值 说明
id String 组件的唯一标识符,同一个父组件下的子组件不能有相同的id,建议页面上的每个组件都设置id。
style String 组件的行内CSS样式。
styleClass String 组件的样式类名,多个类使用空格分开。
rendered boolean true 是否渲染此组件。如果设置为false,那么在生成的html页面上没有对应元素。
visible boolean true 是否隐藏此组件。如果设置为true,那么在生成的html页面上有对应元素,但是不可见,注意与rendered="false"区分。
tabStyle String card 组件标签样式。可选tab,pill,card
colorStyle boolea 标签颜色样式:primary,info,success,warning,danger
colorful boolean 标签以不同颜色展示
tabPosition String above 标签位置,可选above,right,below,left
tabAlign String left 标签水平位置,可选left,center,right
bordered boolean false 是否显示边框
activeTab String 指定当前显示的标签页,对应<caw:tab>的属性id
syncActive boolean false 是否将标签页状态同步到后台

# 可接受的子选项

  • tab

    定义标签页内容,属性如下

属性名称 类型 默认值 说明
id String 组件的唯一标识符,同一个父组件下的子组件不能有相同的id,建议页面上的每个组件都设置id。
style String 组件的行内CSS样式。
styleClass String 组件的样式类名,多个类使用空格分开。
rendered boolean true 是否渲染此组件。如果设置为false,那么在生成的html页面上没有对应元素。
disabled boolean false 是否禁用当前标签页
ajaxLoad boolean false 当前标签是否在选中时加载(即当标签页第一次激活时,加载内容)
onAjaxLoad ELExpression 在加载内容前响应事件
onActive ELExpression 在标签页被激活时,响应事件

# 事件列表

事件名称 说明
shown 在标签页激活显示时触发
hidden 在标签页隐藏时触发
beforeShow 在标签页激活显示前触发
beforeHide 在标签页隐藏动作开始时触发

# waterMark

# 属性列表

属性名称 类型 默认值 说明
id String 组件的唯一标识符,同一个父组件下的子组件不能有相同的id,建议页面上的每个组件都设置id。
style String 组件的行内CSS样式。
styleClass String 组件的样式类名,多个类使用空格分开。
rendered boolean true 是否渲染此组件。如果设置为false,那么在生成的html页面上没有对应元素。
visible boolean true 是否隐藏此组件。如果设置为true,那么在生成的html页面上有对应元素,但是不可见,注意与rendered="false"区分。
name String 水印图片名称
library String 水印图片资源库
opacity float 1 水印透明度, 0~1之间, 1是不透明,0是全透明
zIndex int 0 水印显示层级。在多水印情况下,可以通过这个参数调整显示层级。
position String 水印显示的位置,可选topleft , topright , bottomleft , bottomright , bottom , top , left , right , center
positionX String 水印在X轴的定位,可选left,center,right,也可以是其他定位信息,比如10px, 与属性position互斥
positionY String 水印在Y轴的定位,可选top,center,bottom,也可以是其他定位信息,比如10%, 与属性position互斥
size String 水印大小,可选cover , containcover表示把水印扩展至足够大,以使水印完全覆盖背景区域。contain表示把水印扩展至最大尺寸,以使其宽度和高度完全适应内容区域。 也可以通过具体设定size: 100px 200px
width String auto 水印宽度, 如100px, 50%.与size互斥
height String auto 水印高度, 如100px, 50%.与size互斥

# EditTable

# 表格属性列表

属性名称 类型 必需 默认值 说明
model String 实际上Model是一个接口,这个接口默认是由EditTableModel实现,TableData(SqlTable模型)继承自EditTableModel
tableName String Y 表格的名称
primarykey String 表格的主要栏位,用于判定空白行。如果有多个栏位,中间使用";"隔开
caption String 表格的标题。若设置,表格会有收起|展开的功能按钮
style String 表格的CSS样式。
styleClass String 表格的样式类名,多个类使用空格分开。
gridComplete String 自定义组件数据加载后的js数据处理方法
loadBeforeSend String 自定义组件数据加载前的js处理方法
serializeGridData String 自定义组件异步加载数据的ajax参数处理方法
serializeCellData String 自定义表格单元格数据变动时的ajax参数处理方法
resizeStop String 自定义组件或界面大小变动后js处理方法
expandColumn String Tree模式下的必须属性;指定用那一列展开树。
height int 200 组件的高度
rownumWidth int 40 行号的宽度
readonly boolean false 表格是否为只读。
editable boolean true 表格是否可编辑
sortable boolean true 表格是否支持排序
paging boolean false 表格是否支持分页(若未设置,取edittable的非值)
changeOrder boolean false 表格是否显示向上向下的功能按键(行级操作)
showDefAction boolean true 表格是否显示插入行删除行的功能按键(行级操作); editable 为true时才有效
showAddDeforeIcon boolean true 表格是否显示在上面增加一行的功能按键(行级操作);editable 为true时才有效
dupRowAction boolean true 表格是否显示复制一行的功能按键(行级操作);editable 为true时才有效
rownumbers boolean true 表格是否显示行号
treeGrid boolean false 表格是否以的形式来呈现
batchUpdate boolean false 表格是否支持批量更新(若启用,会自动增加一列checkbox的列配合此功能,勾选了checkbox的行才会更新)
showFooterRow boolean false 表格是否显示汇总行(默认显示为表格下方)
showTopSummary boolean false 表格汇总行显示在表格的上方
showYScrollBar boolean true 表格是否显示Y轴的滚动条
supportFormat boolean true 表格是否支持栏位设定
supportModifyChange boolean true 表格单元格内值变动时是否触发页面显示“*”标记
supportUDFValid boolean true 表格是否支持UDF Layout的自定义必填验证
supportArrowKeyPageTurning boolean false 表格支持分页时,是否支持方向键翻页
supportSrollPageTurning boolean false 表格支持分页时,是否支持鼠标滚动翻页
needDefRow boolean true 表格是否需要一行空白行
copyExcelData boolean false 表格是否支持从Excel复制数据功能
addRowWhenChanged boolean true 表格是否支持最后一行的栏位值变动时,自动再增加一行
needRowSelectEvent boolean false 表格行选中时是否在JSF BeanActionPerformed方法中响应rowSelectEvent事件
showLeftIcon boolean true 是否在列标题的功能区显示左移的功能图标
showRightIcon boolean true 是否在列标题的功能区显示右移的功能图标
showDeleteIcon boolean true 是否在列标题的功能区显示删除的功能图标(仅适用于非必填栏位)
showFrozenIcon boolean true 是否在列标题的功能区显示冻结列的功能图标
showDupColIcon boolean false 是否在列标题的功能区显示列复制的功能图标(若启用,会自动增加一列checkbox的列配合此功能,鼠标选择的单元格数据复制到勾选了checkbox的行对应栏位)
showAddRowIcon boolean true 是否在表格的功能区现在增加行的功能图标(增加到最后一行)

# 可接受的子选项

  • tableColumn:表格的列,通用属性

    属性名称 类型 默认值 说明
    columnName String 列名,必填属性且必须是唯一
    width int 150 列的宽度
    editType String cawText 列的类型
    label String 列标题
    pattern String 列的规则约束,对应到pattern.xml
    required boolean false 列是否必填
    editable boolean 列是否可以编辑,未设置时默认取组件的editable属性值
    sortable boolean true 列是否支持排序
    frozen boolean false 列是否冻结
    hidden boolean false 列是否默认隐藏
    resizable boolean true 列是否可以通过鼠标拖拉调整宽度

  • 目前支持以下列(editType属性值):

    • cawText:

      • trim:是否移除空格;默认为false

      • upperCase:是否大写;默认为false

      • maxLength:最大长度

      • mask:规则验证(如:mask="alias(email)")

        • <caw:tableColumn columnName="email" edittype="cawText" mask="alias(email)"/>
          
    • cawLookup:

      • multiSelect:列的Lookup Dialog是否支持多选;默认为false
      • lookupType:列的Lookup 数据的类别,对应stsearch.xml
      • allowAnyValue:列是否支持输入任意值。默认为false(也就是cawText栏位有Lookup功能)
      • showCode:栏位没有focus时,栏位内显示lookup的code,默认为true。(若设为false,则显示为lookup的desc)
    • cawMemo:

      • readonly|editable:memo的内容是否可以编辑
    • cawNum:

      • length: 数字(包括小数位)的长度
      • decimal: 小数位数
      • max:允许输入的最大值
      • min: 允许输入的最小值
    • cawButton:

      • showValueAsTitle: 对应一个真实的数据列,将数据显示为按钮的标题;默认为false
      • useBtnClass: 按钮被按下时,是否显示“尖角”;默认为true
    • cawCheckbox:

      • allowSelectAll:列标题上是否显示【全选】的checkbox;默认为false
    • cawLabel:

    • cawHtml:

    • cawDate:

    • cawTime:

      • showSeconds:是否显示秒;默认为true
    • cawMess:

    • cawSelect:

      • selectType:
        • input\mess\lookup;
        • 若是input,需要提供InputSelectInfo
        • 若是mess,自动查找messcode
        • 若是lookup,自动查找Pattern
    • cawTreeCombo:

      • treeOption: 对应TreeComboData类型的combo数据
    • cawCombo:

      • comboOption:对应OptionItem类型的List数据(或使用pattern属性)
      • showBlankOption:显示空白的“--”选项;默认为false
      • keepInvalid:如果组件的值不在可选项中是否还保留此选项;默认为false
    • cawFile:

    • cawPhoto:

    • cawColor:

# 预留接口

  • TableActionListener
    • 支持无限多个Listener;执行顺序按照Listener的添加顺序
  • beforeAction(TableAction action)
    • Table事件操作之前预留的接口方法
  • afterAction(TableAction action)
    • Table事件操作之后预留的接口方法
  • afterDupCol(String tableName, int orgIndex, int tarIndex, String columnName)
    • 复制列后预留的接口方法
  • beforeBatchUpdate(String tableName, int rowIndex, List<UpdateColumn> columnList)
    • 批量更新列之前预留的接口方法
  • afterBatchUpdate(String tableName, int rowIndex, List<UpdateColumn> columnList)
    • 批量更新列之后预留的接口方法
  • isCellEditable(String tableName, int rowIndex, String columnName)
    • 单元格是否可以编辑
  • isShowLookupIcon(String tableName, int rowIndex, String columnName)
    • Lookup栏位是否显示lookup的Icon
  • isActionEnable(String tableName, int rowIndex, String columnName, String action)
    • "操作"列中对应的action是否显示
  • isCellVisible(String tableName, String columnName)
    • 列是否显示
  • isCellRequired(String tableName, String columnName)
    • 列是否为必填
  • getCellStyle(String tableName, int rowIndex, String columnName)
    • 列自定义的html样式
  • getCellStyleClass(String tableName, int rowIndex, String columnName)
    • 列自定义的css样式
  • getRowStyleClass(String tableName, int rowIndex)
    • 行自定义的css样式
  • getRowStyle(String tableName, int rowIndex)
    • 行自定义的html样式
  • getLookupSearchType(String tableName, int rowIndex, String columnName)
    • 用于Lookup Dialog中查询UDF Lookup配置
  • getLookupType(String tableName, int rowIndex, String columnName)
    • 用于Lookup栏位自定义配置Lookup Type
  • getComboOption(String tableName, int rowIndex, String columnName)
    • 用于Combo栏位自定义配置下拉选项
  • getNumberDecimal(String tableName, int rowIndex, String columnName)
    • 用于数字栏位自定义小数位
  • getTreeOption(String tableName, int rowIndex, String columnName)
    • 用于Tree栏位自定义配置下拉选项
  • getInputSelectInfo(String tableName, int rowIndex, String columnName)
    • 用于selectType=input的select栏位自定义InputSelectInfo
  • assignedLookupData(String tableName, int tarIndex, SqlTable lookupResult, int rowIndex)
    • 用于Lookup选择数据后调用Listener赋值

# 快捷键

  • Ctrl + I :add row
  • Ctrl + K :delete row
  • Ctrl + 向上的方向键 : 上一个EditTable
  • Ctrl + 向下的方向键 : 下一个EditTable
  • Ctrl + Shift + E : export Excel
  • Ctrl + Shift + F : auto fit
  • Ctrl + Shift + S : Table format Setting
  • Page Up: 翻上页(分页模式下可用)
  • Page Down: 翻下页(分页模式下可用)