XUL:radio

From MDC

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

An element that can be turned on and off. Radio buttons are almost always grouped together in groups. Only one radio button within the same radiogroup may be selected at a time. The user can switch which radio button is turned on by selecting it with the mouse or keyboard. Other radio buttons in the same group are turned off. A label, specified with the label attribute may be added beside the radio button.

More information is available in the XUL tutorial.

Attributes: accesskey, command, crop, disabled, focused, group, image, label, selected, tabindex, value

Properties: accessKey, accessibleType, control, crop, disabled, image, label, radioGroup, selected, tabIndex, value

[edit] Examples

<radiogroup>
  <radio id="orange" label="Red" accesskey="R"/>
  <radio id="violet" label="Green"  accesskey="G" selected="true"/>
  <radio id="yellow" label="Blue"  accesskey="B" disabled="true"/>
</radiogroup>

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

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.

focused: Type: boolean; This attribute is true if the element is focused.

group: Type: string group name New in Firefox 3; Buttons with type="radio" and the same value for their group attribute are put into the same group. Only one button from each group can be checked at a time. If the user selects one the buttons, the others in the group are unchecked.

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.

selected: Type: boolean; Indicates whether the element is selected or not. This value is read-only. To change the selection, set either the selectedIndex or selectedItem property of the containing 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.

value: Type: string; The string attribute allows you to associate a data value with an element. It is not used for any specific purpose, but you can access it with a script for your own use.

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

control: Type: radiogroup element; Returns the enclosing radiogroup that the radio element is contained within, which may or may not be its direct parent.