<checkBox>

checkBox


This checkBox tag is used to show an edit box.

Relationship with other tags

The checkBox tag is child tag of formLayout or panelLayout.

The checkBox tag does not have any child tag.

Example

The following example shows the XML for a checkBox tag.

   <formLayout columns="1";   blockSize="5" fieldWidth="400" >
      <checkBox label="#{workitemmodel.labels.PREFERENCE}" value="#{workitemmodel.values.PREFERENCE}" readOnly="true" 
                valueSet="#{workitemmodel.listItems.PREFERENCE}" >
   </formLayout > 

Attributes

Name Type Supports EL? Description
disabled String no If set to true, the control is in ready only mode.
id String no UI component identifier. There could be multiple checkBox controls and this id attribute is used to uniquely identify the control.
label String yes Localized string shown as the field (or control) label.
maximumLength String no Maximum length of the control in pixels.
pprTargets String no UI component ID that needs to be refreshed after the value of this checkBox field is updated. It can be a single ID or a group of IDs seperated by comma. This is used when configuring dependent fields.
readOnly String no If set to true, no user input is allowed. The control is disabled.
required String yes If set to true, user has to provide approporiate value. It can also take an EL expersion like "#{workitemmodel.required.OWNER}", which will use value from the "required" attribute of the corresponding field defined in the model XML.
value String yes Field value currently selected.
valueSet String yes Defines where to get the values for the checkbox group. Normally it takes a format as "#{workitemmodel.listItems.PREFERENCE}" where listItems specifies that the data to be fetech is for the list.