XUL:toolbarbutton

出典: MDC

« XUL リファレンス HOME    [ 例 | 属性 | プロパティ | メソッド | 関連項目 ]

toolbar 上に表示されるボタン。これは、描画が異なることを除き、通常の button と同等です。一般的には、この要素は画像を持ちます。

詳しい情報が XUL チュートリアルにあります。

関連性のあるアクセシビリティ・ガイドライン All toolbar functionality should be duplicated elsewhere in the application Where possible, provide keyboard alternatives. Where possible, duplicate functionality in a menu item or context menu. Where not possible, make all toolbarbuttons focusable by -moz-user-focus: normal.

属性

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

プロパティ

accessKey, accessibleType, autoCheck, checkState, checked, command, crop, dir, disabled, dlgType, group, image, label, open, orient, tabIndex, type

[編集] 例

  <toolbar id="test-toolbar">
    <toolbarbutton accesskey="P" label="Plain"/>
    <toolbarbutton accesskey="C" label="Checkbox" type="checkbox"/>
    <toolbarbutton accesskey="b" label="Menu-button" type="menu-button">
      <menupopup>
        <menuitem label="Menu item 1"/>
        <menuitem label="Menu item 2"/>
      </menupopup>
    </toolbarbutton>
    <toolbarbutton accesskey="M" label="Menu" type="menu">
      <menupopup>
        <menuitem label="Menu item 1"/>
        <menuitem label="Menu item 2"/>
      </menupopup>
    </toolbarbutton>
  </toolbar>
  <toolbar id="radio-toolbar">
    <toolbarbutton accesskey="1" label="Radio 1" type="radio" group="RadioGroup"/>
    <toolbarbutton accesskey="2" label="Radio 2" type="radio" group="RadioGroup"/>
    <toolbarbutton accesskey="3" label="Radio 3" type="radio" group="RadioGroup"/>
  </toolbar>

[編集] 属性

XUL 要素からの継承 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

型: character

ショートカットキーとして使用される文字を設定します。この文字はその要素の label 属性のテキストに現れる文字の一つでなければいけません。

autoCheck

型: boolean

この属性が true に設定されているか、この属性が無いとき、button が押下される度にボタンのチェック状態が切り替わります。false のときは、チェック状態を手動で調整しなければなりません。この属性が true の場合、button の種類は "checkbox" または "radio" でなければなりません。

checkState

型: integer, 値は 0 または 1, 2

この属性は、0 および 1, 2 の button の三つの状態を作成するために使用します。状態が 0 または 1 の場合、button を押下すると反対の状態に切り替わります。状態が 2 の場合、button を押下すると状態 0 に切り替わります。これは、チェック状態を手動で調整するための三番目の状態を除き、checkbox のように動作する button を意味します。異なる方法で状態を調整したいときは、autoCheck 属性を false に設定し、状態をスクリプトで調整してください。チェック状態を持つ button は type 属性が checkbox に設定されていなければなりません。この属性に設定可能な定数は nsIDOMXULButtonElement インタフェース内にあります。

checked

型: boolean

要素にチェックが入っているかどうかを示します。

この属性が設定されているかどうかを確認するには、getAttribute() ではなく hasAttribute() を使用してください。

command

型: 要素 id

要素に監視された command 要素の id をセットします。

crop

型: 下記の値のいずれか一つ

要素の label に与えられた空間が小さ過ぎるときは、crop 属性によって指定された側のテキストが切り取られます。テキストが切り取られた場所には省略記号 (ellipsis) が使用されます。ボックスの方向が反対の場合は、切り取られる場所も反対側になります。

• start: テキストは先頭から切り取られます。
• end: テキストは末尾から切り取られます。
• left: 非推奨 テキストは左側から切り取られます。
• right: 非推奨 テキストは右側から切り取られます。
• center: テキストの中央が切り取られ、通常、テキストの先頭と末尾が表示されます。
• none: テキストは省略記号を使用して切り取られません。しかし、テキストがあまりに長い場合は単純に削除されます。削除する側は CSS の行揃え (text alignment) に依存します。

dir

型: 下記の値のいずれか一つ

要素の子要素が配置される方向。

• normal: 要素は左から右へ、または上から下へ、XUL コード内に現れる順に配置されます。
• reverse: 要素は右から左へ、または下から上へ、XUL コード内に現れる順と逆に配置されます。

disabled

型: 真偽値

要素が無効化されているかどうかを示します。ある要素が true に設定されていたら、その要素は無効化されています。無効化された要素は通常グレイ表示のテキストで描画されます。要素が無効化されていると、ユーザのアクションには応答せず、フォーカスもあてられず、command イベントも発生しません。

dlgtype

型: 下記の値のいずれか一つ

button がダイアログボックス内にある場合のみ使用される、button の dialog 形式。この機能は、標準のダイアログボックスボタンをカスタムボタンで置き換えるために使用します。dialog イベントメソッドはそのまま機能します。例えば、dlgType が accept に設定されているときは、この button がダイアログボックスの (普通は OK ラベルが付いた) 同意ボタンと置き換えられます。この属性をダイアログボックス内ではない button に使用しても効果はありません。ダイアログの形式として次の値を使用することができます:

• accept: OK ボタン。押下された場合、変更に同意します。
• cancel: キャンセルボタン。操作を中止します。
• help: ヘルプボタン。ダイアログについてのヘルプを表示します。
• disclosure: 詳細を表示するボタン。これは、ボタンか詳細表示の三角形になります。

group

型: グループ名の string

group 属性に同じ値を持つ、type="radio" のボタンは同じグループ内に置かれます。各グループでは一度に一つのボタンのみにチェックを入れることができます。ユーザが一つのボタンを選択すると、グループ内の他のボタンのチェックが外れます。

image

型: 画像の URL

要素上に表示する画像の URL。この属性が空または除外された場合、画像は表示されません。画像の位置は dir 属性および orient 属性によって決定されます。

label

型: string

要素上に表示するlabel。 省略された場合、テキストは表示されない。

oncommand

型: script code

このイベントハンドラは command が活性化した時、呼び出されます。これは、ユーザがメニュー項目を選択したり command に割り当てられたキーボードショートカットが押したりした場合に起こります。

open

型: boolean

menu の type ボタンについて、メニューが開かれたとき、open 属性が true に設定されます。メニューが閉じられると open 属性は提供されません。

orient

型: 下記の要素のいずれか一つ

ある要素の子要素の並びが水平方向なのか、垂直方向なのかを指定するのに使われる。デフォルト値はその要素に依存する。-moz-box-orient スタイルプロパティを使用することもできます。

• horizontal: ある要素の子要素それぞれが、XUL のソース中で現れる順に、水平に一行に並んでいる。
• vertical: ある要素の子要素それぞれが、XUL のソース中で現れる順に、垂直に一列に並んでいる。

tabindex

型: 整数

要素のタブの順番。タブの順番は tab キーが押下されたときにフォーカスが移動する順番です。より大きな tabindex の値をもつ要素は、タブの遷移が後になります。

type

型: string

button の形式。この属性が提供されていない場合、通常のボタンが作成されます。この属性の値を menu に設定すると menu popup を持つボタンを作成することができます。これは、一般的には異なる表示の button になります。

• menu: メニューポップアップを持つボタンを作成するには、type 属性の値を menu に設定します。この場合は button 内に menupopup 要素を置きます。ユーザがメニューを開閉するには button 上のどこかをクリックします。
• menu-button: メニューを持つボタンを作成するには、値を menu-button に設定します。menu 型とは異なり、この形式はユーザが矢印を押してメニューを開く必要があります。ボタンのメイン部分が押されると別のコマンドが発生します。このボタンの形式はブラウザの戻るボタンや進むボタンに使用されています。
• checkbox: チェック状態を切り替えるトグルボタンを作成するには、この値を使用してください。押されるたびに checkState の値が切り替わります。
• radio: ラジオボタンを作成するには、この値を使用してください。この形式と group 属性を使用して toolbarbutton のグループを作成することもできます。

validate

型: 下記の値のいずれか一つ

この属性は、キャッシュから image を読み込むかどうかを指示します。image がリモートに格納されるときや、image を頻繁に差し替えようとしているとき、役立つでしょう。次の値はデフォルトで扱われる属性全体を許可、または除外します:

• always: image を読み込むべきかどうか、常に確認されます。
• never: 可能であれば、キャッシュから image が読み込まれます。

[編集] プロパティ

XUL 要素からの継承 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 DOM 要素からの継承 attributes, childNodes, cloneNode, firstChild, lastChild, localName, namespaceURI, nextSibling, nodeName, nodeType, nodeValue, ownerDocument, parentNode, prefix, previousSibling, tagName

accessKey

型: character

accesskey 属性の値の取得と設定。

accessibleType

型: integer

要素の accessibility オブジェクトの種類を示す値。

autoCheck

型: boolean

autoCheck 属性の値の取得と設定。

checkState

型: integer, 値は 0 または 1, 2

checkState 属性の値の取得と設定。

checked

型: boolean

checked 属性の値の取得と設定。

command

型: 要素の id

command 属性の値の取得と設定。

crop

型: string

crop 属性の値の取得と設定。

dir

型: string

dir 属性の値の取得と設定。

disabled

型: 真偽値

disabled 属性の値の取得と設定。

dlgType

型'string

dlgType 属性の値の取得と設定。

group

型: string group name

group 属性の値の取得と設定。

image

型: image URL

image 属性の値の取得と設定。

label

型: string

label 属性の値の取得と設定。

open

型: boolean

open 属性の値の取得と設定。

orient

型: string

orient 属性の値の取得と設定。

tabIndex

型: 整数

tabindex 属性の値の取得と設定。

type

型: string

type 属性の値の取得と設定。

[編集] メソッド

XUL 要素からの継承 blur, click, doCommand, focus, getElementsByAttribute DOM 要素からの継承 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

[編集] 関連項目

要素

toolbar, toolbargrippy, toolbaritem, toolbarpalette, toolbarseparator, toolbarset, toolbarspacer, toolbarspring, toolbox

インタフェース

nsIAccessibleProvider, nsIDOMXULButtonElement