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"/>

The checkbox element implements the following interfaces:

nsIAccessibleProvider nsIDOMXULCheckboxElement

Attributes:

accesskey | checked | command | crop | disabled
image | label | preference | tabindex

Properties and Methods:

accessKey | accessible | checked | command | crop
disabled | image | label | tabIndex

#### Attributes:

Inherited from XUL Element:

align
allowevents
allownegativeassertions
class
coalesceduplicatearcs
collapsed
container
containment
context
contextmenu
datasources
dir
empty
equalsize
flags
flex
height
hidden
id
insertafter
insertbefore
left
maxheight
maxwidth
menu
minheight
minwidth
mousethrough
observes
ordinal
orient
pack
persist
popup
position
preference-editable
ref
removeelement
sortDirection
sortResource
sortResource2
statustext
style
template
tooltip
tooltiptext
top
uri
wait-cursor
width

##### accesskey

Type: character

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 theme 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. Although the value is case insensitive, a letter with the case matching the accesskey attribute will used if both cases exist in the label.

##### checked

Type: boolean

Indicates whether the checkbox is checked or not.

##### command

Type: element id

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

##### crop

Type: one of the values below

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 used in place of the cropped text. If the box direction is reversed, 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

Type: boolean

Indicates whether the checkbox is disabled or not. 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, it does not respond to user actions. The element cannot be focused and the command event will not fire. The element will still respond to mouse events. To enable the checkbox, leave the attribute out entirely as opposed to setting the value to false.

##### image

Type: image URL

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

Type: string

The label that will appear beside the checkbox. If this is left out, no text appears. The labels on checkboxes will wrap if there is not enough space.

##### preference Mozilla 1.8

Type: element id

Connects the checkbox to a corresponding preference. This attribute only has any effect when used inside a prefwindow. The preference should be a boolean type.

##### tabindex

Type: integer

The tab order of the element. The tab order is the order in which the focus is moved when the user presses the Tab key. Elements with a higher tabindex are later in the tab order sequence.

#### Properties and Methods:

Inherited from XUL Element:

align
allowEvents
blur
boxObject
boxObject.element
boxObject.getLookAndFeelMetric
boxObject.height
boxObject.screenX
boxObject.screenY
boxObject.width
boxObject.x
boxObject.y
builder
className
click
collapsed
contextMenu
controllers
database
datasources
dir
doCommand
flex
focus
getElementsByAttribute
height
hidden
id
left
maxHeight
maxWidth
menu
minHeight
minWidth
observes
ordinal
orient
pack
persist
ref
resource
statusText
style
tooltip
tooltipText
top
width

Inherited from Element:

addEventListener
appendChild
attributes
childNodes
cloneNode
dispatchEvent
firstChild
getAttribute
getAttributeNS
getAttributeNode
getAttributeNodeNS
getElementsByTagName
getElementsByTagNameNS
hasAttribute
hasAttributeNS
hasAttributes
hasChildNodes
insertBefore
isSupported
lastChild
localName
namespaceURI
nextSibling
nodeName
nodeType
nodeValue
normalize
ownerDocument
parentNode
prefix
previousSibling
removeAttribute
removeAttributeNS
removeAttributeNode
removeChild
removeEventListener
replaceChild
setAttribute
setAttributeNS
setAttributeNode
setAttributeNodeNS
tagName

##### accessKey

Type: character

Gets and sets the value of the accesskey attribute.

##### accessible

Type: nsIAccessible

Returns the accessibility object for the checkbox.

##### checked

Type: boolean

Indicates whether the checkbox is checked or not. You can change the checked property to change the state of the checkbox. A CheckboxStateChange event will be sent to the element when the checkbox is changed either via the checked property or changed by the user.

##### command

Type: element id

Gets and sets the value of the command attribute.

##### crop

Type: string

Gets and sets the value of the crop attribute.

##### disabled

Type: boolean

Gets and sets the value of the disabled attribute.

##### image

Type: image URL

Gets and sets the value of the image attribute.

##### label

Type: string

Gets and sets the value of the label attribute.

##### tabIndex Mozilla 1.8

Type: integer

Gets and sets the value of the tabindex attribute.

Copyright (C) 1999 - 2004 XulPlanet.com