XUL:checkbox

From MDC

« XUL Reference home    [ Examples | Attributes | Properties | Methods | Related ]

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.

More information is available in the XUL tutorial.

Attributes

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

Properties

accessKey, accessibleType, checked, command, crop, disabled, image, label, tabIndex

[edit] Examples

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

[edit] 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, querytype, 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 element.

checked

Type: boolean

Indicates whether the element is checked or not.

Use hasAttribute() to determine whether this attribute is set instead of getAttribute().

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 element is too big 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 in the middle, showing both the start and end of the text normally.
• 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 element is disabled or not. If this element is set to true the element is disabled. Disabled elements are usually drawn with grayed-out text. If the element is disabled, it does not respond to user actions, it cannot be focused, and the command event will not fire.

image

Type: image URL

The URL of the image to appear on the element. If this attribute is empty or 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 on the element. If this is left out, no text appears.

preference

Type: element id

Connects the element to a corresponding preference. This attribute only has any effect when used inside a prefwindow. The value of the preference will be updated to match the value property of the element.

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 sequence.

[edit] Properties

Inherited from XUL element align, allowEvents, boxObject, builder, className, collapsed, contextMenu, controllers, currentItem, database, datasources, dir, flex, height, hidden, id, left, listBoxObject, maxHeight, maxWidth, menu, minHeight, minWidth, observes, ordinal, orient, pack, persist, ref, resource, statusText, style, tooltip, tooltipText, top, value, width Inherited from DOM element attributes, childNodes, cloneNode, firstChild, lastChild, localName, namespaceURI, nextSibling, nodeName, nodeType, nodeValue, ownerDocument, parentNode, prefix, previousSibling, tagName

accessKey

Type: character

Gets and sets the value of the accesskey attribute.

accessibleType

Type: integer

A value indicating the type of accessibility object for the element.

checked

Type: boolean

Gets and sets the value of the checked attribute.

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

Type: integer

Gets and sets the value of the tabindex attribute.

[edit] Methods

Inherited from XUL element blur, click, doCommand, focus, getElementsByAttribute Inherited from DOM element addEventListener, appendChild, dispatchEvent, getAttribute, getAttributeNode, getAttributeNodeNS, getAttributeNS, getElementsByTagName, getElementsByTagNameNS, hasAttribute, hasAttributeNS, hasAttributes, hasChildNodes, insertBefore, isSupported, normalize, removeAttribute, removeAttributeNode, removeAttributeNS, removeChild, removeEventListener, replaceChild, setAttribute, setAttributeNode, setAttributeNodeNS, setAttributeNS

[edit] Related

Interfaces

nsIAccessibleProvider, nsIDOMXULCheckboxElement