Home > Element Reference : Checkbox

Contents

### Checkbox

An element that can be turned on and off. This is most commonly rendered as a box when the element is off and a box with a check when the element is on. The user can switch the state of the check box by selecting it with the mouse. A label, specified with the label attribute may be added beside the check box to indicate to the user as to its function.

More information about Checkbox

Example:

        <checkbox label="Enable JavaScript" checked="false"/>

#### Attributes:

Attributes inherited from XUL Element

accesskey

This should be set to a letter that is used as a shortcut key. This letter should be one of the characters that appears in the label text for the checkbox. This letter will typically be drawn underlined, although this behavior will be platform and skin specific. When the user presses ALT (or a similar key that varies on each platform) and the access key, the checkbox will be activated from anywhere in the window.

checked

Indicates whether the checkbox is checked or not.

command

Set to an id of a command element that is being observed by the element.

crop

If the label of the checkbox is too small to fit in its given space, the text will be cropped on the side specified by the crop attribute. An ellipsis will be placed in place of the cropped text. If the box direction is right to left (rtl), the cropping is reversed.

- start: The text will be cropped on its left side.
- end: The text will be cropped on its right side.
- left: (Deprecated) The text will be cropped on its left side.
- right: (Deprecated) The text will be cropped on its right side.
- center: The text will be cropped on both sides.
- none: The text will be not be cropped using an ellipsis. However, the text will simply be cut off if it is too large. The side depends on the CSS text alignment.

disabled

If this attribute is set to true, the checkbox is disabled. This is usually drawn with the text in grey. If the checkbox is disabled, the function of the button cannot be performed. Leave the attribute out entirely for a regular enabled button.

image

The URL of the image to appear on the checkbox. If this is attribute is left out, no image appears. The position of the image is determined by the dir and orient attributes.

label

The label that will appear on the checkbox. If this is left out, no text appears.

tabindex
value

A value associated with the checkbox. You may use it in a script for your own purposes.

#### Properties and Methods:

Properties and Methods inherited from XUL Element

accesskey

This should be set to a letter that is used as a shortcut key. This letter should be one of the characters that appears in the label text for the checkbox. This letter will typically be drawn underlined, although this behavior will be platform and skin specific. When the user presses ALT (or a similar key that varies on each platform) and the access key, the checkbox will be activated from anywhere in the window.

blur ( )

If the focus is on the element, it is removed. The focus is not automatically placed on any other element. Essentially, this is used to call the onblur handler.

checked

Gets and sets the value of the checked attribute.

command

Set to an id of a command element that is being observed by the element.

controllers
crop

If the label of the checkbox is too small to fit in its given space, the text will be cropped on the side specified by the crop attribute. An ellipsis will be placed in place of the cropped text. If the box direction is right to left (rtl), the cropping is reversed.

- start: The text will be cropped on its left side.
- end: The text will be cropped on its right side.
- left: (Deprecated) The text will be cropped on its left side.
- right: (Deprecated) The text will be cropped on its right side.
- center: The text will be cropped on both sides.
- none: The text will be not be cropped using an ellipsis. However, the text will simply be cut off if it is too large. The side depends on the CSS text alignment.

doCommand ( )

Executes the associated command.

focus ( )

Assigns the focus to the element, if it can accept the focus. The onfocus handler is called.

image

The URL of the image to appear on the checkbox. If this is attribute is left out, no image appears. The position of the image is determined by the dir and orient attributes.

label

The label that will appear on the checkbox. If this is left out, no text appears.

value

A value associated with the checkbox. You may use it in a script for your own purposes.

Copyright (C) 1999 - 2002 XULPlanet.com