mozilla
Your Search Results

    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.

    More information is available in the XUL tutorial.

    Attributes
    accesskey, checked, command, crop, disabled, src, label, preference, tabindex
    Properties
    accessKey, accessibleType, checked, command, crop, disabled, src, label, tabIndex

    Examples

    Image:XUL_ref_checkbox.png
    <checkbox label="Enable JavaScript" checked="true"/>
    <checkbox label="Enable Java" checked="false"/>
    

    Attributes

    accesskey
    Type: character
    This should be set to a character that is used as a shortcut key. This should be one of the characters that appears in the label label 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().
    For buttons, the type attribute must be set to checkbox or radio for this attribute to have any effect.
    command
    Type: 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 in left-to-right text locales, and the right side in right-to-left locales.
    end
    The text will be cropped on its right side in left-to-right text locales, and the right side in right-to-left locales.
    left
    The text will be cropped on its left side.
    right
    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.
    Depending on the platform and theme being used, some elements will have set a maximum width so they will always appear cropped. If you wish to use the value none and the displayed text is larger than this maximum width, you may be able to use the max-width CSS property (or the maxwidth attribute) to override this size. For example, for a menuitem in a menu you can add the following CSS rule when you want to use the value none:
    menupopup > menuitem, menupopup > menu { max-width: none; }
    
    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.
    Visible controls have a disabled property which, except for menus and menuitems, is normally preferred to use of the attribute, as it may need to update additional state.
    src
    Type: URI
    Set this to an URI pointing to an image to appear in the checkbox. If this attribute is left out, no image appears. You can have both an image and a label.
    label
    Type: string
    The label that will appear on the element. If this is left out, no text appears. For an editable menuitem element the value of this attribute is copied to the menulist.value property upon user selection of the menuitem.

     

    preference
    Type: id
    Connects the element to a corresponding preference. This attribute only has any effect when used inside a prefwindow. More information is available in the Preferences System article.
    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.

    Properties

    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.
    src
    Type: URL
    Gets and sets the value of the src 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.

    Methods

    Inherited Methods
    addEventListener(), appendChild(), blur, click, cloneNode(), compareDocumentPosition, dispatchEvent(), doCommand, focus, getAttribute(), getAttributeNode(), getAttributeNodeNS(), getAttributeNS(), getBoundingClientRect(), getClientRects(), getElementsByAttribute, getElementsByAttributeNS, getElementsByClassName(), getElementsByTagName(), getElementsByTagNameNS(), getFeature, getUserData, hasAttribute(), hasAttributeNS(), hasAttributes(), hasChildNodes(), insertBefore(), isDefaultNamespace(), isEqualNode, isSameNode, isSupported(), lookupNamespaceURI, lookupPrefix, normalize(), querySelector(), querySelectorAll(), removeAttribute(), removeAttributeNode(), removeAttributeNS(), removeChild(), removeEventListener(), replaceChild(), setAttribute(), setAttributeNode(), setAttributeNodeNS(), setAttributeNS(), setUserData

    Interfaces
    nsIAccessibleProvider, nsIDOMXULCheckboxElement

     

    Document Tags and Contributors

    Contributors to this page: Sheppy, trevorh, Callek, Enn, Ptak82, Mgjbot, Dria, Taken, Pmash
    Last updated by: Sheppy,