facesdoc.HTML_BASIC.javax.faces.SelectBooleanjavax.faces.Checkbox.html Maven / Gradle / Ivy
Show all versions of javax.faces-api Show documentation
component-family: javax.faces.SelectBoolean renderer-type: javax.faces.Checkbox
HTML_BASIC render-kit
component-family: javax.faces.SelectBoolean renderer-type: javax.faces.Checkbox
Renders an HTML "input" element of type "checkbox".
Decode Behavior
Obtain the Map
from the "requestParameterMap"
property of the ExternalContext
. If there is no
entry in the Map
for the "clientId" of this
component, pass "false" to the setSubmittedValue()
method of the component, which must be an instance of
EditableValueHolder
. If there is an entry, and its
value is equal, ignoring case and without quotes, to any of the
Strings: "on", "yes" or "true" pass true to the
setSubmittedValue()
method of the component.
Encode Behavior
Render the clientId of the component as the value of the "name"
attribute. If the current value of the component is "true",
output the "checked" attribute (must be rendered as checked="checked").
If the "styleClass" attribute is specified, render its value as the value
of the "class" attribute.
This renderer is responsible for rendering its children.
Note:
Attributes with a pass-through
value of
true
are not interpreted by the renderer and are passed
straight through to the rendered markup, without checking for validity. Attributes with a
pass-through
value of false
are interpreted
by the renderer, and may or may not be checked for validity by the renderer.
Attributes
attribute-name
pass-through
attribute-class
description
default-value
accesskey
true
java.lang.String
Access key that, when pressed, transfers focus
to this element.
undefined
dir
true
java.lang.String
Direction indication for text that does not inherit directionality.
Valid values are "LTR" (left-to-right) and "RTL" (right-to-left).
undefined
disabled
false
boolean
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".
undefined
lang
true
java.lang.String
Code describing the language used in the generated markup
for this component.
undefined
onblur
true
java.lang.String
Javascript code executed when this element loses focus.
undefined
onchange
false
java.lang.String
Javascript code executed when this element loses focus
and its value has been modified since gaining focus.
undefined
onclick
true
java.lang.String
Javascript code executed when a pointer button is
clicked over this element.
undefined
ondblclick
true
java.lang.String
Javascript code executed when a pointer button is
double clicked over this element.
undefined
onfocus
true
java.lang.String
Javascript code executed when this element receives focus.
undefined
onkeydown
true
java.lang.String
Javascript code executed when a key is
pressed down over this element.
undefined
onkeypress
true
java.lang.String
Javascript code executed when a key is
pressed and released over this element.
undefined
onkeyup
true
java.lang.String
Javascript code executed when a key is
released over this element.
undefined
onmousedown
true
java.lang.String
Javascript code executed when a pointer button is
pressed down over this element.
undefined
onmousemove
true
java.lang.String
Javascript code executed when a pointer button is
moved within this element.
undefined
onmouseout
true
java.lang.String
Javascript code executed when a pointer button is
moved away from this element.
undefined
onmouseover
true
java.lang.String
Javascript code executed when a pointer button is
moved onto this element.
undefined
onmouseup
true
java.lang.String
Javascript code executed when a pointer button is
released over this element.
undefined
onselect
true
java.lang.String
Javascript code executed when text within this
element is selected by the user.
undefined
readonly
false
boolean
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".
undefined
style
true
java.lang.String
CSS style(s) to be applied when this component is rendered.
undefined
styleClass
false
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.
undefined
tabindex
true
java.lang.String
Position of this element in the tabbing order
for the current document. This value must be
an integer between 0 and 32767.
undefined
title
true
java.lang.String
Advisory title information about markup elements generated
for this component.
undefined
Copyright (c) 2003-2010 Oracle America, Inc. All Rights Reserved.