| |||||||
FRAMES NO FRAMES |
Render an HTML checkbox list.
See the "Decode Behavior for UISelectMany Components" section.
Encode Behavior
Render a "table" element. If the "styleClass" is specified,
render the value of the "styleClass" attribute as the value of the "class"
attribute on the "table" element. If the "style", "border" attributes are
specified, pass them thru. If the "layout" attribute is specified, and its value
is "pageDirection", render the children elements vertically, otherwise
horizontally, in the table. If any of the children are an instance of
SelectItemGroup, render them as a nested table. Each of the children are
ultimately rendererd as follows. Render an "input" element of "type" "checkbox"
for each child component. Render the "name" attribute on the "input" element
with the value of the clientId
of the component. Render an "id"
attribute on the "input" element. Each "id" value must be unique. If the current
SelectItem.isDisabled() returns true, render "disabled" as the value of the
"disabled" attribute. Close out the "input" element. Render a "label" element.
Render the "for" attribute of the "label" element whose value is the
corresponding "input" element's "id" value. Render any "style" as the "class"
attribute on the "label" element. Close out the starting "label" element and
render the label value from SelectItem.getLabel(). Close out the "label"
element. As an exception to the general rules about how to handle the "id"
attribute, render it as an attribute on the outer "table" element, the value of
which is the clientId
of the component per the rules at the
beginning of this specification. The value of the current SelectItem is rendered
as the value of the "value" attribute. If the value of the enclosing
UISelectMany matches the current value, render "checked" as the value of the
"checked" attribute. See the "Rendering
the option elements" specification for ListboxRenderer
for
more detail on how to render the "option" elements in this renderer.
Tag Information | |
Tag Class | com.sun.faces.taglib.html_basic.SelectManyCheckboxTag |
TagExtraInfo Class | com.sun.faces.taglib.FacesTagExtraInfo |
Body Content | JSP |
Display Name | None |
Attributes | ||||
Name | Required | Request-time | T ype | Description |
converter | false | false | javax.el.ValueExpression
(must evaluate to javax.faces.convert.Converter )
| Converter instance registered with this component. |
converterMessage | false | false | javax.el.ValueExp
ression
(must evaluate to java.lang.String )
| A ValueExpression enabled attribute that, if present, will be used as the text of the converter message, replacing any message that comes from the converter. |
id | false | true | java.lang.String | The component identifier for this component. This value must be unique within the closest parent component that is a naming container. |
immediate | false | false | javax.el.ValueExpression
(must evaluate to boolean )
| Flag indicating that this component's value must be converted and validated immediately (that is, during Apply Request Values phase), rather than waiting until Process Validations phase. |
rendered | false | false | javax.el.ValueExpression<
/code>
| Flag indicating whether or not this component should be rendered (during Render Response Phase), or processed on any subsequent form submit. The default value for this property is true. |
required | false | false | javax.el.ValueExpression<
/code>
| Flag indicating that the user is required to provide a submitted value for this input component. |
requiredMessage | false | false | javax.el.ValueExpr
ession
(must evaluate to java.lang.String )
| A ValueExpression enabled attribute that, if present, will be used as the text of the validation message for the "required" facility, if the "required" facility is used. |
validator | false | false | javax.el.MethodExpressio
n
(signature must match void
validate(javax.faces.context.FacesContext, javax.faces.component.UIComponent,
java.lang.Object) )
| MethodBinding representing a validator method that will be called during Process Validations to perform correctness checks on the value of this component. The expression must evaluate to a public method that takes FacesContext, UIComponent, and Object parameters, with a return type of void. |
validatorMessage | false | false | javax.el.ValueExp
ression
(must evaluate to java.lang.String )
| A ValueExpression enabled attribute that, if present, will be used as the text of the validator message, replacing any message that comes from the validator. |
value | false | false | javax.el.ValueExpression
| The current value of this component. |
valueChangeListener | false | false | javax.el.Metho
dExpression
(signature must match void
valueChange(javax.faces.event.ValueChangeEvent) )
| MethodBinding representing a value change listener method that will be notified when a new value has been set for this input component. The expression must evaluate to a public method that takes a ValueChangeEvent parameter, with a return type of void. |
accesskey | false | false | javax.el.ValueExpression
(must evaluate to java.lang.String )
| Access key that, when pressed, transfers focus to this element. |
border | false | false | javax.el.ValueExpression
| Width (in pixels) of the border to be drawn around the table containing the options list. |
dir | false | false | javax.el.ValueExpression
(must evaluate to java.lang.String )
| Direction indication for text that does not inherit directionality. Valid values are "LTR" (left-to-right) and "RTL" (right-to-left). |
disabled | false | false | javax.el.ValueExpression<
/code>
| Flag indicating that this element must never receive focus or be included in a subsequent submit. A value of false causes no attribute to be rendered, while a value of true causes the attribute to be rendered as disabled="disabled". |
disabledClass | false | false | javax.el.ValueExpres
sion
(must evaluate to java.lang.String )
| CSS style class to apply to the rendered label on disabled options. |
enabledClass | false | false | javax.el.ValueExpress
ion
(must evaluate to java.lang.String )
| CSS style class to apply to the rendered label on enabled options. |
label | false | false | javax.el.ValueExpression
| A localized user presentable name for this component. |
lang | false | false | javax.el.ValueExpression
| Code describing the language used in the generated markup for this component. |
layout | false | false | javax.el.ValueExpression
| Orientation of the options list to be created. Valid values are "pageDirection" (list is laid out vertically), or "lineDirection" (list is laid out horizontally). If not specified, the default value is "lineDirection". |
onblur | false | false | javax.el.ValueExpression
| Javascript code executed when this element loses focus. |
onchange | false | false | javax.el.ValueExpression<
/code>
| Javascript code executed when this element loses focus and its value has been modified since gaining focus. |
onclick | false | false | javax.el.ValueExpression
code>
| Javascript code executed when a pointer button is clicked over this element. |
ondblclick | false | false | javax.el.ValueExpressio
n
(must evaluate to java.lang.String )
| Javascript code executed when a pointer button is double clicked over this element. |
onfocus | false | false | javax.el.ValueExpression
code>
| Javascript code executed when this element receives focus. |
onkeydown | false | false | javax.el.ValueExpression
(must evaluate to java.lang.String )
| Javascript code executed when a key is pressed down over this element. |
onkeypress | false | false | javax.el.ValueExpressio
n
(must evaluate to java.lang.String )
| Javascript code executed when a key is pressed and released over this element. |
onkeyup | false | false | javax.el.ValueExpression
code>
| Javascript code executed when a key is released over this element. |
onmousedown | false | false | javax.el.ValueExpressi
on
(must evaluate to java.lang.String )
| Javascript code executed when a pointer button is pressed down over this element. |
onmousemove | false | false | javax.el.ValueExpressi
on
(must evaluate to java.lang.String )
| Javascript code executed when a pointer button is moved within this element. |
onmouseout | false | false | javax.el.ValueExpressio
n
(must evaluate to java.lang.String )
| Javascript code executed when a pointer button is moved away from this element. |
onmouseover | false | false | javax.el.ValueExpressi
on
(must evaluate to java.lang.String )
| Javascript code executed when a pointer button is moved onto this element. |
onmouseup | false | false | javax.el.ValueExpression
(must evaluate to java.lang.String )
| Javascript code executed when a pointer button is released over this element. |
onselect | false | false | javax.el.ValueExpression<
/code>
| Javascript code executed when text within this element is selected by the user. |
readonly | false | false | javax.el.ValueExpression<
/code>
| Flag indicating that this component will prohibit changes by the user. The element may receive focus unless it has also been disabled. A value of false causes no attribute to be rendered, while a value of true causes the attribute to be rendered as readonly="readonly". |
style | false | false | javax.el.ValueExpression
| CSS style(s) to be applied when this component is rendered. |
styleClass | false | false | javax.el.ValueExpressio
n
(must evaluate to java.lang.String )
| Space-separated list of CSS style class(es) to be applied when this element is rendered. This value must be passed through as the "class" attribute on generated markup. |
tabindex | false | false | javax.el.ValueExpression<
/code>
| Position of this element in the tabbing order for the current document. This value must be an integer between 0 and 32767. |
title | false | false | javax.el.ValueExpression
| Advisory title information about markup elements generated for this component. |
binding | false | false | javax.el.ValueExpression
code>
| The ValueExpression linking this component to a property in a backing bean |
Variables | No Variables Defined. |
| |||||||
FRAMES NO FRAMES |