CLASS: _CheckBoxEditor

SUPER CLASS: _Base Editor

Subclasses

_Radio Button Editor

Synopsis

The checkbox editor represents the checkbox control within the checkbox type of Editor widget.

Note that the Check Box Editor class contains a Label control and an edit control. The _CheckBoxEditor classes represent that edit control.

Full Description

Use the checkBox display type to create a checkbox. When you set displayType to CheckBox, the following properties are important to understand:

• checkedValue: the value returned by this editor when the checkbox is checked
• emptyValue: the value returned by this editor when the checkbox is not checked
• dataValue: the checkedValue and the empty value

Checkboxes should have some checked value set if they are going to be used as boolean values. It's usually optional but recommended to set the editor's dataType (see below) to boolean and the emptyValue to false.

The following editor properties are available for the checkBox Editor:

• dataType: the data type for the checkBox selection value. The data type for this value can be a string, a boolean, or a number.
• required: if checked (true) the value cannot be null.
• showMessages: if checked (true) this Editor widget diplays the promp and invalidMessage messages.
• startChecked: if checked (true) the default value of this checkbox is "true" (the exact value would depend on the dataType you selected for the checkbox).

Properties

_CheckBoxEditor.dataType

Determines the type of value that is accepted within the checkedValue property (see the main properties for the editor widget rather than the checkbox-specific properties to find the checkedValue). Possible values are

• String: anything you type into checkedValue is the string returned when the checkbox is checked and someone calls getDataValue() on this widget.
• Boolean: Ignores checkedValue and simply returns true or false based on whether its checked or not checked.
• Number: checkedValue field now only accepts numerical data.

_CheckBoxEditor.editorBorder

described in _Base Editor

If checked, puts a border around the input area. Not all editors have the capability to have a border around the input editor, such as slider and lookup editors.

_CheckBoxEditor.showMessage

Does nothing.

_CheckBoxEditor.startChecked

Select this in order to start your checkbox off with a checkmark in it.