Tooltip

This element is used for the tooltip popups. For text only tooltips, this element doesn't need to be used; instead you may just add a tooltiptext attribute to an element.

More information about tooltip

この要素はツールチップポップアップに利用される。テキストのみのツールチップは、この要素を必要としない。代わりに、 tooltiptext 属性を要素に指定すれば済む。

tooltip の追加情報

プロパティとメソッド:

hidePopup label moveTo popupBoxObject position
showPopup sizeTo

属性:

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
mousethrough
observes
ordinal
orient
pack
persist
popup
position
ref
removeelement
sortDirection
sortResource
sortResource2
statustext
style
template
tooltip
tooltiptext
top
uri
wait-cursor
width

crop

Type: one of the values below

If the label of the tooltip 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.

型 : 以下の値の一つ

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

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

Type: boolean

If true, the tooltip is used as the default popup for displaying tooltips in the window.

型 : boolean

true の場合は、ウィンドウでツールチップを表示するためのポップアップのデフォルトとして、 tooltip 要素が使用される。

label

Type: string

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

型 : string

ツールチップに表示するラベル。この属性がないときには、テキストは表示されない。

noautohide

Type: boolean

If this attribute is set to false or omitted, the tooltip will automatically disappear after a few seconds. If this attribute is set to true, this will not happen and the tooltip will only hide when the user moves the mouse to another element.

型 : boolean

この属性を false に設定するかまたは削除すると、ツールチップは数秒後に自動的に隠れるようになる。この属性を true に設定すると、ツールチップは自動的に消えたりはせずに、ユーザが他の要素にマウスを移動した場合にのみ隠る。

onpopuphidden

Type: script code

This event is sent to a popup after it has been hidden.

型 : script code

ポップアップが隠された後、そのポップアップにこのイベントが送信される。

onpopuphiding

Type: script code

This event is sent to a popup when it is about to be hidden.

型 : script code

ポップアップが隠されている最中に、そのポップアップにこのイベントが送信される。

onpopupshowing

Type: script code

This event is sent to a popup just before it is popped open. This handler is usually used to dynamically set the contents when the user requests to display it. Returning false from this event handler prevents the popup from appearing.

型 : script code

ポップアップが開かれる直前に、このイベントはそのポップアップに送信される。このハンドラは通常、ユーザがポップアップを表示するよう要求したときに動的に内容を設定するために使用される。このイベントハンドラが false を返すと、ポップアップの表示が取りやめられる。

onpopupshown

Type: script code

This is event is sent to a popup after it has been opened, much like the onload event is sent to a window when it is opened.

型 : script code

ウィンドウが開かれたときに onload イベントがそのウィンドウに送信されるのと同様に、このイベントはポップアップが開かれた後、そのポップアップに送信される。

position

Type: one of the values below

The position attribute determines where the popup appears relative to the element the user clicked to invoke the popup. This allows you to place the menu on one side on a button.

  • after_start: The popup appears underneath the element with the popup's upper-left corner aligned with the lower-left corner of the element. The left edges of the element and the popup are aligned. This is typically used for drop-down menus.
  • after_end: The popup appears underneath the element with the popup's upper-right corner aligned with the lower-right corner of the element. The right edges of the element and the popup are aligned.
  • before_start: The popup appears above the element with the popup's lower-left corner aligned with the upper-left corner of the element. The left edges of the element and the popup are aligned.
  • before_end: The popup appears above the element with the popup's lower-right corner aligned with the upper-right corner of the element. The right edges of the element and the popup are aligned.
  • end_after: The popup appears to the right of the element with the popup's lower-left corner aligned with the lower-right corner of the element. The bottom edges of the element and the popup are aligned.
  • end_before: The popup appears to the right of the element with the popup's upper-left corner aligned with the upper-right corner of the element. The top edges of the element and the popup are aligned.
  • start_after: The popup appears to the left of the element with the popup's lower-right corner aligned with the lower-left corner of the element. The bottom edges of the element and the popup are aligned.
  • start_before: The popup appears to the left of the element with the popup's upper-right corner aligned with the upper-left corner of the element. The top edges of the element and the popup are aligned.
  • overlap: The popup appears over top of the element with the upper-left corners aligned.
  • at_pointer: The popup appears at the same position as the mouse pointer.
  • after_pointer: The popup appears at the same horizontal position as the mouse pointer, but vertically, it is placed just below the element.

型 : 以下の値の一つ

position 属性は、ポップアップを起動するためにユーザがクリックした要素と相対した、ポップアップが表示される位置を決定する。これにより、ボタンのどの側にメニューを表示させるかを指定することができる。

  • after_start: 要素の左下端にポップアップの左上端が合うように、ポップアップは要素の下に表示される。要素の左端とポップアップの左端は一直線になる。これは一般的には、ドロップダウンメニューに使用される。
  • after_end: 要素の右下端にポップアップの右上端が合うように、ポップアップは要素の下に表示される。要素の右端とポップアップの右端は一直線になる。
  • before_start: 要素の左上端にポップアップの左下端が合うように、ポップアップは要素の上に表示される。要素の左端とポップアップの左端は一直線になる。
  • before_end: 要素の右上端にポップアップの右下端が合うように、ポップアップは要素の上に表示される。要素の右端とポップアップの右端は一直線になる。
  • end_after: 要素の右下端にポップアップの左下端が合うように、ポップアップは要素の右側に表示される。要素の下端とポップアップの下端は一直線になる。
  • end_before: 要素の右上端にポップアップの左上端が合うように、ポップアップは要素の右側に表示される。要素の上端とポップアップの上端は一直線になる。
  • start_after: 要素の左下端にポップアップの右下端が合うように、ポップアップは要素の左側に表示される。要素の下端とポップアップの下端は一直線になる。
  • start_before: 要素の左上端にポップアップの右上端が合うように、ポップアップは要素の左側に表示される。要素の上端とポップアップの上端は一直線になる。
  • overlap: ポップアップは要素の前面に、左上端が整列するように表示される。
  • at_pointer: ポップアップはマウスポインタと同じ位置に表示される。
  • after_pointer: ポップアップは、水平位置はマウスポインタと同じ位置に表示されるが、垂直位置は要素の直下に表示される。

プロパティとメソッド:

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

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

hidePopup ( )

Return Type: no return value

Closes the tooltip window immediately.

戻り値の型 : 戻り値なし

ポップアップメニューをすぐに閉じる。

label

Type: string

Gets and sets the value of the label attribute.

型 : string

label 属性の値を取得・設定する。

moveTo ( x , y )

Return Type: no return value

Moves the popup to a new location.

戻り値の型 : 戻り値なし

ポップアップを新しい位置に移動する。

popupBoxObject

Type: nsIPopupBoxObject

This read-only property holds the nsIPopupBoxObject that implements the tooltip. You wouldn't normally need to use this property as all of its functions are available via the tooltip itself.

型 : nsIPopupBoxObject

この読み込み専用プロパティは、ツールチップを実装している nsIPopupBoxObject を持つ。その関数は全てツールチップ自身から利用できるため、通常はこのプロパティを使用する必要はない。

position

Type: one of the values below

The position attribute determines where the popup appears relative to the element the user clicked to invoke the popup. This allows you to place the menu on one side on a button.

  • after_start: The popup appears underneath the element with the popup's upper-left corner aligned with the lower-left corner of the element. The left edges of the element and the popup are aligned. This is typically used for drop-down menus.
  • after_end: The popup appears underneath the element with the popup's upper-right corner aligned with the lower-right corner of the element. The right edges of the element and the popup are aligned.
  • before_start: The popup appears above the element with the popup's lower-left corner aligned with the upper-left corner of the element. The left edges of the element and the popup are aligned.
  • before_end: The popup appears above the element with the popup's lower-right corner aligned with the upper-right corner of the element. The right edges of the element and the popup are aligned.
  • end_after: The popup appears to the right of the element with the popup's lower-left corner aligned with the lower-right corner of the element. The bottom edges of the element and the popup are aligned.
  • end_before: The popup appears to the right of the element with the popup's upper-left corner aligned with the upper-right corner of the element. The top edges of the element and the popup are aligned.
  • start_after: The popup appears to the left of the element with the popup's lower-right corner aligned with the lower-left corner of the element. The bottom edges of the element and the popup are aligned.
  • start_before: The popup appears to the left of the element with the popup's upper-right corner aligned with the upper-left corner of the element. The top edges of the element and the popup are aligned.
  • overlap: The popup appears over top of the element with the upper-left corners aligned.
  • at_pointer: The popup appears at the same position as the mouse pointer.
  • after_pointer: The popup appears at the same horizontal position as the mouse pointer, but vertically, it is placed just below the element.

型 : 以下の値の一つ

position 属性は、ポップアップを起動するためにユーザがクリックした要素と相対した、ポップアップが表示される位置を決定する。これにより、ボタンのどの側にメニューを表示させるかを指定することができる。

  • after_start: 要素の左下端にポップアップの左上端が合うように、ポップアップは要素の下に表示される。要素の左端とポップアップの左端は一直線になる。これは一般的には、ドロップダウンメニューに使用される。
  • after_end: 要素の右下端にポップアップの右上端が合うように、ポップアップは要素の下に表示される。要素の右端とポップアップの右端は一直線になる。
  • before_start: 要素の左上端にポップアップの左下端が合うように、ポップアップは要素の上に表示される。要素の左端とポップアップの左端は一直線になる。
  • before_end: 要素の右上端にポップアップの右下端が合うように、ポップアップは要素の上に表示される。要素の右端とポップアップの右端は一直線になる。
  • end_after: 要素の右下端にポップアップの左下端が合うように、ポップアップは要素の右側に表示される。要素の下端とポップアップの下端は一直線になる。
  • end_before: 要素の右上端にポップアップの左上端が合うように、ポップアップは要素の右側に表示される。要素の上端とポップアップの上端は一直線になる。
  • start_after: 要素の左下端にポップアップの右下端が合うように、ポップアップは要素の左側に表示される。要素の下端とポップアップの下端は一直線になる。
  • start_before: 要素の左上端にポップアップの右上端が合うように、ポップアップは要素の左側に表示される。要素の上端とポップアップの上端は一直線になる。
  • overlap: ポップアップは要素の前面に、左上端が整列するように表示される。
  • at_pointer: ポップアップはマウスポインタと同じ位置に表示される。
  • after_pointer: ポップアップは、水平位置はマウスポインタと同じ位置に表示されるが、垂直位置は要素の直下に表示される。
showPopup ( element, x , y , popupType, anchor, align )

Return Type: no return value

Opens the tooltip. There are two ways of specifying where the tooltip appears, either at a specific screen position, or relative to some element in the window. If either x and y are set to values, the tooltip will appear at the screen coordinate (x,y). If x and y are -1, the tooltip will be positioned relative to the element specified as the first argument. This is the likely case for having a tooltip appear over an element. In this latter case, the anchor and align arguments may be used to further control where the tooltip appears relative to the element. The anchor argument corresponds to the popupanchor attribute on the element. The align argument corresponds to the popupalign attribute on the element. The anchor and align attributes are ignored if either x or y are not -1.

To have a tooltip appear relative to another element yet still be offset by some number of pixels, determine the actual screen position of the element using the boxObject.screenX and boxObject.screenY properties of the element and use those as the x and y arguments offset by the desired values.

Type should be either the string "popup", "context" or "tooltip".

戻り値の型 : 戻り値なし

ツールチップを開く。ツールチップをどこに表示するかを指定するには、2 通りの方法がある。特定のスクリーン位置か、またはウィンドウのある要素に相対した位置か、である。x と y がともに値を設定されたときは、ツールチップはスクリーン座標 (x,y) に表示される。 x と y がともに -1 のときは、ツールチップは最初の引数で指定した要素に相対した位置になる。これは、ツールチップが要素上に表示されるような場合である。この後者の場合では anchor と align 引数で、ツールチップを要素に相対してどの位置に表示するかをさらにコントロールするのに使用できる。 anchor 引数は、要素の popupanchor 属性に対応する。 align 引数は、要素の popupalign 属性に対応する。 x か y のどちらかが -1 でないときは、 anchor 属性と align 属性は無視される。

指定数ピクセル分、別の要素に相対的にオフセットしてツールチップを表示するには、要素の the boxObject.screenX プロパティと boxObject.screenY プロパティを使って要素の実際のスクリーン位置を決め、引数 x と y が欲しい値のオフセットとなるように、それらを使います。

型は文字列 "popup"、 "context"、 "tooltip" のどれかである必要がある。

sizeTo ( width , height )

Return Type: no return value

Changes the current size of the popup to a new width and height.

戻り値の型 : 戻り値なし

ポップアップの現在のサイズを、新しい幅と高さに変更する。


Copyright (C) 1999 - 2004 XulPlanet.com