Controls Documentation

Controls  Complex Types  Show Hierarchies  Show Full Hierarchies 

Control: xp:checkBox

Description

A control that can be selected or cleared. Check boxes can be grouped together.

Properties

• <xp:checkBox
• accessibility
• accesskey
• role
• tabindex
• title
• basics
• binding
• dir
• disabled
• id
• immediate
• lang
• loaded
• readonly
• rendered
• rendererType
• required
• text
• data
• checkedValue
• converter
• defaultChecked
• disableModifiedFlag
• uncheckedValue
• validator
• validators
• value
• valueChangeListener
• valueChangeListeners
• dojo
• dojoAttributes
• dojoType
• events
• onblur
• onchange
• onclick
• ondblclick
• onfocus
• onkeydown
• onkeypress
• onkeyup
• onmousedown
• onmousemove
• onmouseout
• onmouseover
• onmouseup
• styling
• disableTheme
• style
• styleClass
• themeId
• />

Java

Java Class: com.ibm.xsp.component.xp.XspInputCheckbox

accessibility

title, string Advisory Title Provides title information for controls. Required Attribute false Localizable true Allow Runtime Binding true Allow Load Time Binding true Allow Non Binding true

tabindex, string Tab Index Indicates where this control is located in the tab order of the page. Value must be an integer between 0 and 32,767. If the value is left blank, the tab order will inherit the browser's default order. Required Attribute false Localizable false Allow Runtime Binding false Allow Load Time Binding true Allow Non Binding true

accesskey, string Access Key Transfers focus to the control when pressed Required Attribute false Localizable true Allow Runtime Binding false Allow Load Time Binding true Allow Non Binding true

role, string Control Identifier Describes the role of the current UI element/area. It can be used by assistive technologies to determine its purpose. Required Attribute false Localizable false Allow Runtime Binding true Allow Load Time Binding true Allow Non Binding true

basics

binding, object - javax.faces.component.UIComponent  [Inherited] Control Binding Specifies an expression that binds the control to a particular control property. Required Attribute false Localizable false Allow Runtime Binding true Allow Load Time Binding true Allow Non Binding false

loaded, boolean  [Inherited] Loaded Specifies whether or not the control should be created when the page is loaded. Value defaults to 'true'. Required Attribute false Localizable false Allow Runtime Binding false Allow Load Time Binding true Allow Non Binding true

id, string  [Inherited] Control Identifier Specifies the name identifier for the control. No two controls can have the same name identifier in a single page. Required Attribute false Localizable false Allow Runtime Binding false Allow Load Time Binding true Allow Non Binding true

rendered, boolean  [Inherited] Rendered Flag Indicates whether or not the control should be displayed or processed on any subsequent form submission. Required Attribute false Localizable false Allow Runtime Binding true Allow Load Time Binding true Allow Non Binding true

rendererType, string  [Inherited] Renderer Type Identifies (with the "family" defined by the control) an appropriate renderer to encode and decode this control Required Attribute false Localizable false Allow Runtime Binding false Allow Load Time Binding true Allow Non Binding true

required, boolean  [Inherited] Required Flag Indicates that users must input a value for the control. Required Attribute false Localizable false Allow Runtime Binding true Allow Load Time Binding true Allow Non Binding true

immediate, boolean  [Inherited] Immediate Action Indicates that the value of the control must be converted and validated immediately during the Apply Request Values phase, not the Process Validation phase. Required Attribute false Localizable false Allow Runtime Binding true Allow Load Time Binding true Allow Non Binding true

dir, string Direction Specifies the direction for text that does not inherit a direction. Valid values are 'LTR' (left to right) and 'RTL' (right to left). Required Attribute false Localizable false Allow Runtime Binding true Allow Load Time Binding true Allow Non Binding true

lang, string Language Code Describes the language used in the generated markup of the control. Required Attribute false Localizable true Allow Runtime Binding true Allow Load Time Binding true Allow Non Binding true

disabled, boolean Disabled Flag Determines whether or not the page can receive focus or be included in page submissions. Required Attribute false Localizable false Allow Runtime Binding true Allow Load Time Binding true Allow Non Binding true

readonly, boolean Read Only Flag Flag indicating that this control will prohibit changes by the user. The control may receive focus unless it has also been disabled. Required Attribute false Localizable false Allow Runtime Binding true Allow Load Time Binding true Allow Non Binding true

text, string Text The label text for this control Required Attribute false Localizable true Allow Runtime Binding true Allow Load Time Binding true Allow Non Binding true

data

value, generic  [Inherited] Value Contains the current value of the control Required Attribute false Localizable false Allow Runtime Binding true Allow Load Time Binding true Allow Non Binding true

converter, f:converterInterface - javax.faces.convert.Converter  [Inherited] Converter Converter instance registered with this control Required Attribute false Localizable false Allow Runtime Binding true Allow Load Time Binding true Allow Non Binding true

validator,   [Inherited] Validator MethodBinding representing a validator method that will be called during Process Validations to perform correctness checks on the value of this control. The expression must evaluate to a public method that takes FacesContext, UIComponent, and Object parameters, with a return type of void. Required Attribute false

validators, Collection of f:validatorInterface - javax.faces.validator.Validator  [Inherited] Validators List An array of Validators associated with this control Required Attribute false

valueChangeListener,   [Inherited] Value Change Listener MethodBinding representing a value change listener method that will be notified when a new value has been set for this input control. The expression must evaluate to a public method that takes a ValueChangeEvent parameter, with a return type of void. Required Attribute false

valueChangeListeners, Collection of xp:valueChangeListenerInterface - javax.faces.event.ValueChangeListener  [Inherited] Value Change Listeners A collection of value change listeners that will be notified when a new value has been set for this input control Required Attribute false

disableModifiedFlag, boolean  [Inherited] Disable Modified Flag Disables this control from participating in modified notifications for the current XPage. Required Attribute false Localizable false Allow Runtime Binding true Allow Load Time Binding true Allow Non Binding true

defaultChecked, boolean  [Inherited] Default Checked Specifies the default checked state for the check box Required Attribute false Localizable false Allow Runtime Binding true Allow Load Time Binding true Allow Non Binding true

checkedValue, string  [Inherited] Checked value Specifies the checked value of the check box Required Attribute false Localizable false Allow Runtime Binding true Allow Load Time Binding true Allow Non Binding true

uncheckedValue, string  [Inherited] Unchecked value Specifies the unchecked value of the check box Required Attribute false Localizable false Allow Runtime Binding true Allow Load Time Binding true Allow Non Binding true

dojo

dojoType, string  [Inherited] Dojo Type Sets the default Dojo Type used to create this control in the browser. Required Attribute false Localizable false Allow Runtime Binding true Allow Load Time Binding true Allow Non Binding true

dojoAttributes, Collection of xp:dojoAttribute - com.ibm.xsp.dojo.DojoAttribute  [Inherited] Dojo Attributes Specifies a list of Dojo attributes. Required Attribute false

events

onclick, string Click Script JavaScript code executed when a pointer control is clicked over this control Required Attribute false Localizable false Allow Runtime Binding true Allow Load Time Binding true Allow Non Binding true

ondblclick, string Double Click Script JavaScript code executed when a pointer control is double clicked over this control Required Attribute false Localizable false Allow Runtime Binding true Allow Load Time Binding true Allow Non Binding true

onmousedown, string Mouse Down Script JavaScript code executed when a pointer control is pressed down over this control Required Attribute false Localizable false Allow Runtime Binding true Allow Load Time Binding true Allow Non Binding true

onmouseup, string Mouse Up Script JavaScript code executed when a pointer control is released over this control Required Attribute false Localizable false Allow Runtime Binding true Allow Load Time Binding true Allow Non Binding true

onmouseover, string Mouse Over Script JavaScript code executed when a pointer control is moved onto this control Required Attribute false Localizable false Allow Runtime Binding true Allow Load Time Binding true Allow Non Binding true

onmousemove, string Mouse Move Script JavaScript code executed when a pointer control is moved within this control Required Attribute false Localizable false Allow Runtime Binding true Allow Load Time Binding true Allow Non Binding true

onmouseout, string Mouse Out Script JavaScript code executed when a pointer control is moved away from this control Required Attribute false Localizable false Allow Runtime Binding true Allow Load Time Binding true Allow Non Binding true

onkeypress, string Key Press Script JavaScript code executed when a key is pressed and released over this control. Required Attribute false Localizable false Allow Runtime Binding true Allow Load Time Binding true Allow Non Binding true

onkeydown, string Key Down Script JavaScript code executed when a key is pressed down over this control Required Attribute false Localizable false Allow Runtime Binding true Allow Load Time Binding true Allow Non Binding true

onkeyup, string Key Up Script JavaScript code executed when a key is released over this control Required Attribute false Localizable false Allow Runtime Binding true Allow Load Time Binding true Allow Non Binding true

onblur, string Focus Off Script JavaScript code executed when this control loses focus Required Attribute false Localizable false Allow Runtime Binding true Allow Load Time Binding true Allow Non Binding true

onfocus, string Focus On Script JavaScript code executed when this control receives focus Required Attribute false Localizable false Allow Runtime Binding true Allow Load Time Binding true Allow Non Binding true

onchange, string Input Change Script JavaScript code executed when this control loses focus and its value has been modified since gaining focus Required Attribute false Localizable false Allow Runtime Binding true Allow Load Time Binding true Allow Non Binding true

styling

disableTheme, boolean  [Inherited] Disable Theme A flag used to determine if the theme should be applied to this control. Required Attribute false Localizable false Allow Runtime Binding false Allow Load Time Binding true Allow Non Binding true

themeId, string  [Inherited] Theme Id The theme id that should be used to set the component properties when a theme is applied Required Attribute false Localizable false Allow Runtime Binding false Allow Load Time Binding true Allow Non Binding true

style, string CSS Styles Specifies CSS style(s) to be applied when this control is rendered. Required Attribute false Localizable false Allow Runtime Binding true Allow Load Time Binding true Allow Non Binding true

styleClass, string CSS Style Classes Specifies the space-separated list of CSS style class(es) to be applied when this control is rendered. This value must be passed through as the "class" attribute on generated markup. Required Attribute false Localizable false Allow Runtime Binding true Allow Load Time Binding true Allow Non Binding true