| |||||||
| FRAMES NO FRAMES | |||||||
This is presented as a table with one cell per available option; each cell contains a checkbox and the option's label. The "layout" attribute determines whether the checkboxes are laid out horizontally or vertically.
The set of available options is defined by adding child f:selectItem or f:selectItems components to this component.
The value attribute must be a value-binding expression to a property of type List, Object array or primitive array. That "collection" is expected to contain objects of the same type as SelectItem.getValue() returns for the child SelectItem objects. On rendering, any child whose value is in the list will be selected initially. During the update phase, the property setter is called to replace the original collection with a completely new collection object of the appropriate type. The new collection object contains the value of each child SelectItem object that is currently selected.
| Tag Information | |
| Tag Class | org.apache.myfaces.taglib.html.HtmlSelectManyCheckboxTag |
| TagExtraInfo Class | None |
| Body Content | JSP |
| Display Name | None |
| Attributes | ||||
| Name | Required | Request-time | Type | Description |
| border | false | false | javax.el.ValueExpression
(must evaluate to int)
| HTML: Specifies the width of the border of this element, in pixels. Deprecated in HTML 4.01. |
| layout | false | false | javax.el.ValueExpression
(must evaluate to java.lang.String)
| Controls the layout direction of the child elements. Values include: lineDirection (vertical) and pageDirection (horzontal). |
| selectedClass | false | false | javax.el.ValueExpression
(must evaluate to java.lang.String)
| CSS class to be applied to selected items |
| unselectedClass | false | false | javax.el.ValueExpression
(must evaluate to java.lang.String)
| CSS class to be applied to unselected items |
| accesskey | false | false | javax.el.ValueExpression
(must evaluate to java.lang.String)
| HTML: Sets the access key for this element. |
| onselect | false | false | javax.el.ValueExpression
(must evaluate to java.lang.String)
| HTML: Specifies a script to be invoked when the element is selected. |
| onclick | false | false | javax.el.ValueExpression
(must evaluate to java.lang.String)
| HTML: Script to be invoked when the element is clicked. |
| ondblclick | false | false | javax.el.ValueExpression
(must evaluate to java.lang.String)
| HTML: Script to be invoked when the element is double-clicked. |
| onkeydown | false | false | javax.el.ValueExpression
(must evaluate to java.lang.String)
| HTML: Script to be invoked when a key is pressed down over this element. |
| onkeypress | false | false | javax.el.ValueExpression
(must evaluate to java.lang.String)
| HTML: Script to be invoked when a key is pressed over this element. |
| onkeyup | false | false | javax.el.ValueExpression
(must evaluate to java.lang.String)
| HTML: Script to be invoked when a key is released over this element. |
| onmousedown | false | false | javax.el.ValueExpression
(must evaluate to java.lang.String)
| HTML: Script to be invoked when the pointing device is pressed over this element. |
| onmousemove | false | false | javax.el.ValueExpression
(must evaluate to java.lang.String)
| HTML: Script to be invoked when the pointing device is moved while it is in this element. |
| onmouseout | false | false | javax.el.ValueExpression
(must evaluate to java.lang.String)
| HTML: Script to be invoked when the pointing device is moves out of this element. |
| onmouseover | false | false | javax.el.ValueExpression
(must evaluate to java.lang.String)
| HTML: Script to be invoked when the pointing device is moved into this element. |
| onmouseup | false | false | javax.el.ValueExpression
(must evaluate to java.lang.String)
| HTML: Script to be invoked when the pointing device is released over this element. |
| style | false | false | javax.el.ValueExpression
(must evaluate to java.lang.String)
| HTML: CSS styling instructions. |
| styleClass | false | false | javax.el.ValueExpression
(must evaluate to java.lang.String)
| The CSS class for this element. Corresponds to the HTML 'class' attribute. |
| disabled | false | false | javax.el.ValueExpression
(must evaluate to boolean)
| HTML: When true, this element cannot receive focus. |
| readonly | false | false | javax.el.ValueExpression
(must evaluate to boolean)
| HTML: When true, indicates that this component cannot be modified by the user. The element may receive focus unless it has also been disabled. |
| role | false | false | javax.el.ValueExpression
(must evaluate to java.lang.String)
| HTML: An advisory title for this element. Often used by the user agent as a tooltip. |
| label | false | false | javax.el.ValueExpression
(must evaluate to java.lang.String)
| A display name for this component. |
| dir | false | false | javax.el.ValueExpression
(must evaluate to java.lang.String)
| HTML: The direction of text display, either 'ltr' (left-to-right) or 'rtl' (right-to-left). |
| lang | false | false | javax.el.ValueExpression
(must evaluate to java.lang.String)
| HTML: The base language of this document. |
| title | false | false | javax.el.ValueExpression
(must evaluate to java.lang.String)
| HTML: An advisory title for this element. Often used by the user agent as a tooltip. |
| onblur | false | false | javax.el.ValueExpression
(must evaluate to java.lang.String)
| HTML: Specifies a script to be invoked when the element loses focus. |
| onfocus | false | false | javax.el.ValueExpression
(must evaluate to java.lang.String)
| HTML: Specifies a script to be invoked when the element receives focus. |
| tabindex | false | false | javax.el.ValueExpression
(must evaluate to java.lang.String)
| HTML: Specifies the position of this element within the tab order of the document. |
| disabledClass | false | false | javax.el.ValueExpression
(must evaluate to java.lang.String)
| The CSS class assigned to the label element for enabled choices. |
| enabledClass | false | false | javax.el.ValueExpression
(must evaluate to java.lang.String)
| The CSS class assigned to the label element for enabled choices. |
| onchange | false | false | javax.el.ValueExpression
(must evaluate to java.lang.String)
| HTML: Specifies a script to be invoked when the element is modified. |
| hideNoSelectionOption | false | false | javax.el.ValueExpression
(must evaluate to boolean)
| No Description |
| collectionType | false | false | javax.el.ValueExpression
(must evaluate to java.lang.String)
| No Description |
| immediate | false | false | javax.el.ValueExpression
(must evaluate to boolean)
| A boolean value that identifies the phase during which action events should fire.
During normal event processing, action methods and action listener methods are fired during the "invoke application" phase of request processing. If this attribute is set to "true", these methods are fired instead at the end of the "apply request values" phase. |
| required | false | false | javax.el.ValueExpression
(must evaluate to boolean)
| A boolean value that indicates whether an input value is required.
If this value is true and no input value is provided by a postback operation, then the "requiredMessage" text is registered as a FacesMessage for the request, and validation fails. Default value: false. |
| converterMessage | false | false | javax.el.ValueExpression
(must evaluate to java.lang.String)
| Text to be displayed to the user as an error message when conversion of a submitted value to the target type
fails.
|
| requiredMessage | false | false | javax.el.ValueExpression
(must evaluate to java.lang.String)
| Text to be displayed to the user as an error message when this component is marked as "required" but no input data is present during a postback (ie the user left the required field blank). |
| validator | false | false | javax.el.MethodExpression
(signature must match void myMethod( javax.faces.context.FacesContext, javax.faces.component.UIComponent, java.lang.Object ))
| A method-binding EL expression which is invoked during the validation phase for this component.
The invoked method is expected to check the submitted value for this component, and if not acceptable then report a validation error for the component. The method is expected to have the prototype public void aMethod(FacesContext, UIComponent,Object) |
| validatorMessage | false | false | javax.el.ValueExpression
(must evaluate to java.lang.String)
| Text which will be shown if validation fails. |
| valueChangeListener | false | false | javax.el.MethodExpression
(signature must match void myMethod( javax.faces.event.ValueChangeEvent ))
| A method which is invoked during postback processing for the current view if the submitted value for this
component is not equal to the value which the "value" expression for this component returns.
The phase in which this method is invoked can be controlled via the immediate attribute. |
| value | false | false | javax.el.ValueExpression
(must evaluate to java.lang.Object)
| Gets The initial value of this component. |
| converter | false | false | javax.el.ValueExpression
(must evaluate to javax.faces.convert.Converter)
| An expression that specifies the Converter for this component.
The value can either be a static value (ID) or an EL expression. When a static id is specified, an instance of the converter type registered with that id is used. When this is an EL expression, the result of evaluating the expression must be an object that implements the Converter interface. |
| id | false | true | java.lang.String | Get a string which uniquely identifies this UIComponent within the scope of the nearest ancestor NamingContainer component. The id is not necessarily unique across all components in the current view. |
| rendered | false | false | javax.el.ValueExpression
(must evaluate to boolean)
| A boolean value that indicates whether this component should be rendered. Default value: true. |
| binding | false | false | javax.el.ValueExpression
(must evaluate to javax.faces.component.UIComponent)
| Identifies a backing bean property (of type UIComponent or appropriate subclass) to bind " + "to this component instance. This value must be an EL expression. |
| Variables | No Variables Defined. |
| |||||||
| FRAMES NO FRAMES | |||||||