XulPlanet.com - Toolbarbutton Reference

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

ツールバーに表示されるボタン。描画のされ方を除けば標準の button と同じである。通例、画像を含むことが想定されている。

toolbarbutton の追加情報

toolbarbutton 要素は以下のインタフェースを実装している。

nsIAccessibleProvider nsIDOMXULButtonElement

属性:

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

プロパティとメソッド:

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

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.

型 : character

ショートカットキーとして使う文字に設定する。この文字は、toolbarbutton のラベルテキストに現れる文字の一つである必要がある。この文字は一般に下線付きで表示される。一方、その振る舞いはプロットフォームやテーマに依存する。ユーザが ALT (またはプラットフォームによる同様のキー) とアクセスキーを押すと、ウィンドウのどこからでも toolbarbutton は起動される。この値は文字の大小には関しないが、ラベルに両方がある場合には、 accesskey 属性にマッチする方の文字が使用される。

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.

型 : boolean

この属性が true のとき、あるいはこの属性がないときには、ボタンが押されるたびにボタンのチェック状態が切り替わる。この属性が false のときは、手動でチェック状態を調整する必要がある。

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. Constants for the possible values for this attribute are in the nsIDOMXULButtonElement interface.

型 : integer: 0, 1 or 2

この属性は 3 つの状態ボタン、番号 0、1、2 を作り出すのに使うことができる。状態 0 または 1 のときは、ボタンを押すと反対の状態に切り替わる。状態 2 のときには、ボタンを押すと状態 0 に切り替わる。これは、このボタンはチェックボックスのように動作することを意味している。チェック状態を調節するためには、存在する 3 つの状態を手動で設定する必要があることを除いて。状態をどのように調節するかについて異なる振る舞いを持ちたい場合には、autoCheck 属性を false に設定し、スクリプトで状態を調節する。チェック状態を持つボタンでは、type 属性を 'checkbox' に設定する必要がある。この属性に使用可能な値の定数は nsIDOMXULButtonElement インタフェースにある。

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.

型 : boolean

ボタンがチェックされているかどうかを表す。この機能はツールバーのトグルボタンで用いられる。トグルされているボタンの外観を表すため、通常のときと押されたときの 2 つの画像をツールバーボタンに関連づけることができる。スタイルシートには、 checked 属性をチェックするスタイル規則がある。

command

Type: element id

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

型 : element id

要素が監視している command 要素の id を設定。

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 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 on both sides.
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.

型 : 以下の値の一つ

与えられたスペースが小さくて toolbarbutton のラベルがその場所に合わないとき、crop 属性で指定した側にテキストは切り取られる。切り取られたテキストの位置には、省略記号が用いられる。ボックスの方向が逆のときは、切り取りも逆になる。

start: テキストの左側が切り取られる。
end: テキストの右側が切り取られる。
left: (非推奨) テキストの左側が切り取られる。
right: (非推奨) テキストの右側が切り取られる。
center: テキストの両側が切り取られる。
none: テキストの切り取りに省略記号が用いられない。テキストが非常に大きいときには、単に切られるだけである。側は CSS のテキスト配置 (alignment) に依存する。

dir

Type: one of the values below

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

normal: The elements are placed left to right or top to bottom in the order they appear in the XUL code.
reverse: The elements are placed right to left or bottom to top. This is reverse of the order in which they appear in the XUL code.

型 : 以下の値の一つ

toolbarbutton 要素の子要素を置く方向。

normal: XUL コードに現れる順序で、要素は左から右へまたは上から下へ置かれる。
reverse: XUL コードに現れる順序で、要素は右から左へまたは下から上へ置かれる。

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.

型 : boolean

toolbarbutton が無効か有効かを表す。この属性を true に設定すると、toolbarbutton は無効になる。通常、テキストが灰色で表示される。toolbarbutton が無効の場合には、ユーザアクションに応答しない。要素にフォーカスできず、またコマンドイベントは起きない。マウスイベントにはまだ応答する。 toolbarbutton を有効にするには、値を 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 that is not in a dialog box has no effect. The following values can be used as the dialog type:

accept: The OK button, which will accept the changes when pressed.
cancel: The cancel button which will cancel the operation.
help: A help button for displaying help about the dialog.
disclosure: A button to show more information. This might be a button or a disclosure triangle.

型 : 以下の値の一つ

ボタンのダイアログタイプ。ボタンがダイアログボックスのボタンのときにのみ使われる。標準のダイアログボックスボタンをカスタムボタンで置きかえることに、この機能が使える。こうすると、ダイアログのイベントメソッドが働く。例えば、dlgType を 'accept' に設定した場合、ボタンはダイアログボックスの accept ボタン (通常は OK というラベルになっている) を置きかえます。ダイアログボックスにないボタンでこの属性を使っても、何の効果もありません。以下の値がダイアログタイプとして使用できる。

accept: OK ボタン。押されたときに変更を受け入れる。
cancel: キャンセルボタン。操作をキャンセルする。
help: ヘルプボタン。ダイアログについてのヘルプを表示する。
disclosure: 詳細情報を表示するボタン。ボタンかまたは穴の空いた三角形で表示される。

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.

型 : string group name

group 属性に同じ値を持つボタンは、同じグループに入れられる。各グループでは 1 つのボタンのみが一時にチェックされる。ユーザがラジオボタンの一つを選択したとき、そのグループの他のボタンはチェックを解除される。

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.

型 : image URL

toolbarbutton に表示す画像の URL。この属性がないと、画像は表示されない。画像の位置は dir 属性と orient 属性で決定される。

label

Type: string

The label that will appear on the toolbarbutton. If this is left out, no text appears.

型 : string

toolbarbutton に表示するラベル。この属性がないと、テキストは表示されない。

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.

型 : boolean

メニュータイプのボタンのとき、メニューが開いていると open 属性は true に設定される。メニューが閉じているときは、open 属性は存在しない。

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.

horizontal: Child elements of the toolbarbutton are placed next to each other in a row in the order that they appear in the XUL source.
vertical: Child elements of the toolbarbutton are placed under each other in a column in the order that they appear in the XUL source.

型 : 以下の値の一つ

toolbarbutton の子要素を横並びにするか縦並びにするかを指定するのに使用する。デフォルト値は要素に依存する。 '-moz-box-orient' スタイルプロパティを用いて指定することもできる。

horizontal: toolbarbutton の子要素は、 XUL ソースに現れる順に前の要素の隣に一行に並んで配置される。
vertical: toolbarbutton の子要素は、 XUL ソースに現れる順に前の要素の下に一列に並んで配置される。

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.

型 : integer

要素のタブ順序。タブ順序とは、ユーザが Tab キーを押したときにフォーカスが移動する順番のこと。高い tabindex を持つ要素が、タブ順序のシーケンスで後になる。

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.

menu: Set the type attribute to the value 'menu' to create a button with a menu popup. Place a menupopup element inside the button in this case. The user may click anywhere on the button to open and close the menu.
menu-button: You can also use the value 'menu-button' to create a button with a menu. Unlike the 'menu' type, this type requires the user to press the arrow to open the menu, but a different command may be invoked when the main part of the button is pressed. This type of button would be used for browser's back and forward buttons.

型 : string

ボタンのタイプ。この属性がない場合は、普通のボタンが作成される。type 属性の値を 'menu' にすると、メニューポップアップを持つボタンを作ることができる。この場合は一般に、表示の仕方が異なるボタンとなる。

menu: type 属性を 'menu' に設定すると、メニューポップアップを持つボタンを作成する。この場合にはボタン内に menupopup 要素を置くことができる。ボタンのどこをクリックしても、メニューを開いたり閉じたりできる。
menu-button: 'menu-button' 値を使うと、メニューを持つボタンを作成できる。'menu' 型とは違い、この型ではメニューを開くにはユーザが矢印を押す必要があり、ボタンの主部が押された場合は異なるコマンドが実行される。このタイプのボタンは、ブラウザの「戻る」「進む」ボタンに用いられている。

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:

always: The image is always checked to see whether it should be reloaded.
never: The image will be loaded from the cache if possible.

型 : 以下の値の一つ

この属性は、キャッシュから画像を読み込むかどうかを指定する。画像がリモートに保存されていたり、頻繁に画像を変えたりするとき、この属性は役立つ。以下の値が受け入れられる。属性を完全に消すと、デフォルトの処理になる。