References > " . "Element Reference"; $pagetitle="Toolbarbutton"; $customsidebar = "elemref-sidebar.php"; include "header.php"; ?>

Toolbarbutton

A button that appears on a toolbar. It is equivalent to a regular button except that it may be rendered differently. Typically, it is expected to have an image.

More information about toolbarbutton

The toolbarbutton element implements the following interfaces:

nsIAccessibleProvider   nsIDOMXULButtonElement  

Attributes:

accesskey autoCheck checkState checked command
crop dir disabled dlgType group
image label open orient tabindex
type validate

Properties and Methods:

accessKey accessible autoCheck checkState checked
command crop dir disabled dlgType
group image label open orient
type

Attributes:

Inherited from XUL Element:

align
allowevents
allownegativeassertions
class
coalesceduplicatearcs
collapsed
container
containment
context
contextmenu
datasources
debug
dir
empty
equalsize
flags
flex
height
hidden
id
insertafter
insertbefore
left
maxheight
maxwidth
menu
minheight
minwidth
observes
ordinal
orient
pack
persist
popup
position
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 toolbarbutton. 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 toolbarbutton 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.

autoCheck

Type: boolean

If this attribute is true, or left out, the checked state of the button will be switched each time the button is pressed. If this attribute is false, the checked state must be adjusted manually.

checkState

Type: integer: 0, 1 or 2

This attribute may be used to create three state buttons, numbered 0, 1 and 2. When in state 0 or 1, pressing the button will switch to the opposite state. When in state 2, pressing the button will switch to state 0. This means that the button acts like a checkbox except that there is a third state which must be set manually by adjusting the check state. If you wish to have different behavior for how the states are adjusted, set the autoCheck attribute to false and adjust the state with a script. The type attribute must be set to 'checkbox' for buttons with a check state.

checked

Type: boolean

Indicates whether the button is checked or not. This feature is used for toggle buttons on a toolbar. You can associate two images, a normal image and a depressed image, to a toolbar button to create the apperance of the button being toggled. In the stylesheet, just have a style rule that checks for the checked attribute.

command

Type: element id

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

crop

Type: one of the values below

If the label of the toolbarbutton 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 right to left (rtl), the cropping is reversed.

dir

Type: one of the values below

The direction in which the child elements of the toolbarbutton are placed.

disabled

Type: boolean

Indicates whether the toolbarbutton is disabled or not. If this attribute is set to true, the toolbarbutton is disabled. This is usually drawn with the text in grey. If the toolbarbutton 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 toolbarbutton, leave the attribute out entirely as opposed to setting the value to false.

dlgType

Type: one of the values below

The dialog type of the button, used only when the button is in a dialog box. You can use this feature to replace the standard dialog box buttons with custom buttons, yet the dialog event methods will still function. For example, if the dlgType is set to 'accept', the button will replace the dialog box's accept button, which is usually labeled OK. Using this attribute on a button not a dialog box has no effect. The following values can be used as the dialog type:

group

Type: string group name

Buttons with 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 radio buttons, the others in the group are unchecked.

image

Type: image URL

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

open

Type: boolean

For the menu type buttons, the open attribute is set to true when the menu is open. The open attribute is not present if the menu is closed.

orient

Type: one of the values below

Used to specify whether the children of the toolbarbutton are oriented horizontally or vertically. The default value depends on the element. You can also use the '-moz-box-orient' style property.

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.

type

Type: string

The type of button. If this attribute is not present, a normal button is created. You can set the type attribute to the value 'menu' to create a button with a menu popup. This will typically cause the button to be displayed differently.

validate

Type: one of the values below

This attribute indicates whether to load the image from the cache or not. This would be useful if the images are stored remotely or you plan on swapping the image frequently. The following values are accepted, or leave out the attribute entirely for default handling:


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

autoCheck

Type: boolean

Gets and sets the value of the autoCheck attribute.

checkState

Type: integer: 0, 1 or 2

Gets and sets the value of the checkState attribute.

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.

dir

Type: string

Gets and sets the value of the dir attribute.

disabled

Type: boolean

Gets and sets the value of the disabled attribute.

dlgType

Type: string

Gets and sets the value of the dlgType attribute.

group

Type: string group name

Gets and sets the value of the group 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.

open

Type: boolean

Gets and sets the value of the open attribute.

orient

Type: string

Gets and sets the value of the orient attribute.

type

Type: string

Gets and sets the value of the type attribute.