モジュール javafx.graphics

パッケージ javafx.scene.input

クラスMouseEvent

java.lang.Object

java.util.EventObject

javafx.event.Event

javafx.scene.input.InputEvent

javafx.scene.input.MouseEvent

すべての実装されたインタフェース:

Serializable, Cloneable

直系の既知のサブクラス:

MouseDragEvent

public class MouseEvent
extends InputEvent

マウス・イベントが発生すると、カーソル下の最上位ノードが選択され、「EventDispatcher」で説明したキャプチャ・フェーズとバブリング・フェーズを介してこのノードにイベントが配信されます。

マウス(ポインタ)の場所は複数の座標系に対して相対的に取得できます。x,yの場合、MouseEventのノードの原点が基準となり、sceneX,sceneYの場合、ノードが含まれているSceneの原点が基準となり、screenX,screenYの場合、マウス・ポインタが含まれている画面の原点が基準となります。

ドラッグ・ジェスチャ

ドラッグ・ジェスチャには3つのタイプがあります。 これらはすべてマウス押下イベントによって開始され、マウス解放イベントによって終了します。発生するジェスチャはソース・ノードによって決定されます。

単純な押下、ドラッグ、解放ジェスチャがデフォルトです。 これは、図形のサイズを変更したり、図形を周辺にドラッグする場合などに適しています。 押下、ドラッグ、解放のジェスチャ全体が1つのノードに配信されます。 マウス・ボタンが押下されると、最上位ノードが選択され、ボタンが解放されるまで、後続のすべてのマウス・イベントが同じノードに配信されます。 これらのイベントによってマウス・クリック・イベントが生成された場合、そのイベントも同じノードに配信されます。

単純な押下、ドラッグ、解放ジェスチャでは、その他のノードは関与せず、イベントも受け取りません。 これらのノードがジェスチャに関与する必要がある場合は、完全な押下、ドラッグ、解放ジェスチャをアクティブ化する必要があります。 このジェスチャは、ノード間を接続したり、ノードを他のノードにドラッグする場合などに適しています。このジェスチャ・タイプについては、ジェスチャ・ターゲットに配信されるイベントを含め、MouseDragEventでより詳しく説明しています。

3つ目のジェスチャ・タイプは、プラットフォームでサポートされているドラッグ・アンド・ドロップ・ジェスチャです。 これは、データの転送に最適で、(必ずしもFXでない)アプリケーション間での処理にも対応しています。 このジェスチャ・タイプについては、DragEventでより詳しく説明しています。

簡潔にまとめると、マウス・ボタンが押下されたときに、単純な押下、ドラッグ、解放ジェスチャが自動的にアクティブ化され、すべてのMouseEventがジェスチャ・ソースに配信されます。 ドラッグを開始すると、少し後にDRAG_DETECTEDイベントが発生します。 そのハンドラで、ノードまたはシーンに対してstartFullDragメソッドを呼び出すことによって、完全な押下、ドラッグ、解放ジェスチャを開始できます(この場合、ジェスチャ・ターゲットへのMouseDragEventの配信が開始されます)。また、ノードまたはシーンに対してstartDragAndDropメソッドを呼び出すことによって、ドラッグ・アンド・ドロップ・ジェスチャを開始できます(この場合、システムがドラッグ・アンド・ドロップ・モードに切り替わり、MouseEventのかわりにDragEventの配信が開始されます)。 これらのメソッドのいずれも呼び出さなかった場合は、単純な押下、ドラッグ、解放ジェスチャが続行されます。

タッチ画面上で指をドラッグすると、マウス・ドラッグ・イベントだけでなく、スクロール・ジェスチャ・イベントも生成されることに注意してください。 それがアプリケーション内の競合を意味する場合(物理的なドラッグ・アクションが2つの異なるハンドラによって処理される場合)、isSynthesized()メソッドを使用して問題を検出し、それに従ってドラッグ・ハンドラの動作を調整できます。

マウス入出処理

マウスがノードに入ると、ノードはMOUSE_ENTEREDイベントを受け取り、マウスがノードから出ると、ノードはMOUSE_EXITEDイベントを受け取ります。 これらのイベントは入出の対象ノードにのみ配信され、キャプチャ/バブリング・フェーズを経由しないように見えます。 これが最も一般的なユースケースです。

キャプチャまたはバブリングが必要な場合は、MOUSE_ENTERED_TARGET/MOUSE_EXITED_TARGETイベントが使用されます。 通常、これらのイベントはキャプチャ/バブリング・フェーズを経由します。 つまり、マウスが親自体またはその子に入ったときに親がMOUSE_ENTERED_TARGETイベントを受け取る場合があります。 これらの2つのケースを区別するために、ノードと同様にイベント・ターゲットをテストできます。

これらの2つのタイプは密接に関係しています。MOUSE_ENTERED/MOUSE_EXITEDは、MOUSE_ENTERED_TARGET/MOUSE_EXITED_TARGETのサブタイプです。 キャプチャ・フェーズでは、MOUSE_ENTERED_TARGETが親に配信されます。 イベントがイベント・ターゲット(マウスが実際に入ったノード)に配信されると、そのタイプがMOUSE_ENTEREDに切り替わります。 その後、バブリング・フェーズでタイプがMOUSE_ENTERED_TARGETに戻されます。 ただし、1つのイベントのタイプを切り替えたのみであるため、フィルタ処理したり、使用すると、両方のイベント・バリアントに影響します。 MOUSE_ENTERED_TARGETイベント・ハンドラは、サブタイプ関係に従って、ターゲット上のMOUSE_ENTEREDイベントを受け取ります。

注意

• コンテキスト・メニューのトリガーについては、ContextMenuEventを参照してください。

導入されたバージョン:

JavaFX 2.0

関連項目:

直列化された形式

フィールドのサマリー

フィールド

修飾子と型	フィールド	説明
static EventType<MouseEvent>	ANY	すべてのマウス・イベント・タイプに共通のスーパータイプ。
static EventType<MouseEvent>	DRAG_DETECTED	このイベントは、ドラッグ・ジェスチャのソースとして識別されたノードに配信されます。
static EventType<MouseEvent>	MOUSE_CLICKED	このイベントは、マウス・ボタンがクリックされた(同じノード上で押されて放された)ときに発生します。
static EventType<MouseEvent>	MOUSE_DRAGGED	このイベントは、ボタンを押した状態でマウスが移動されたときに発生します。
static EventType<MouseEvent>	MOUSE_ENTERED	このイベントは、マウスがノードに入ったときに発生します。
static EventType<MouseEvent>	MOUSE_ENTERED_TARGET	このイベントは、マウスがノードに入ったときに発生します。
static EventType<MouseEvent>	MOUSE_EXITED	このイベントは、マウスがノードから出たときに発生します。
static EventType<MouseEvent>	MOUSE_EXITED_TARGET	このイベントは、マウスがノードから出たときに発生します。
static EventType<MouseEvent>	MOUSE_MOVED	このイベントは、ボタンを押さずにノード内でマウスが移動されたときに発生します。
static EventType<MouseEvent>	MOUSE_PRESSED	このイベントは、マウス・ボタンが押されたときに発生します。
static EventType<MouseEvent>	MOUSE_RELEASED	このイベントは、マウス・ボタンが放されたときに発生します。

クラス javafx.event.Eventから継承されたフィールド

consumed、eventType、NULL_SOURCE_TARGET、target

クラス java.util.EventObjectから継承されたフィールド

source

コンストラクタのサマリー

コンストラクタ

コンストラクタ	説明
MouseEvent(Object source, EventTarget target, EventType<? extends MouseEvent> eventType, double x, double y, double screenX, double screenY, MouseButton button, int clickCount, boolean shiftDown, boolean controlDown, boolean altDown, boolean metaDown, boolean primaryButtonDown, boolean middleButtonDown, boolean secondaryButtonDown, boolean synthesized, boolean popupTrigger, boolean stillSincePress, PickResult pickResult)	新しいMouseEventイベントを構築します。
MouseEvent(EventType<? extends MouseEvent> eventType, double x, double y, double screenX, double screenY, MouseButton button, int clickCount, boolean shiftDown, boolean controlDown, boolean altDown, boolean metaDown, boolean primaryButtonDown, boolean middleButtonDown, boolean secondaryButtonDown, boolean synthesized, boolean popupTrigger, boolean stillSincePress, PickResult pickResult)	nullのソースとターゲットを使用した新しいMouseEventイベントを構築します。

メソッドのサマリー

修飾子と型	メソッド	説明
MouseEvent	copyFor(Object newSource, EventTarget newTarget)	該当するイベントを別のソースおよびターゲット用にコピーします。
MouseEvent	copyFor(Object newSource, EventTarget newTarget, EventType<? extends MouseEvent> eventType)	指定のフィールドが置換された特定のイベントのコピーを作成します。
static MouseDragEvent	copyForMouseDragEvent(MouseEvent e, Object source, EventTarget target, EventType<MouseDragEvent> type, Object gestureSource, PickResult pickResult)	MouseDragEventタイプのマウス・イベントのコピーを作成します。
MouseButton	getButton()	このイベントの原因となったマウス・ボタン(ある場合)。
int	getClickCount()	このイベントに関連付けられたマウス・クリック数を返します。
EventType<? extends MouseEvent>	getEventType()	このイベントのイベント・タイプを取得します。
PickResult	getPickResult()	選択内容に関する情報を返します。
double	getSceneX()	MouseEventのソースが含まれているSceneの原点に対するイベントの相対水平位置を返します。
double	getSceneY()	MouseEventのソースが含まれているSceneの原点に対するイベントの相対垂直位置を返します。
double	getScreenX()	イベントの水平方向の絶対位置を返します。
double	getScreenY()	イベントの垂直方向の絶対位置を返します。
double	getX()	MouseEventのソースの原点に対するイベントの相対水平位置。
double	getY()	MouseEventのソースの原点に対するイベントの相対垂直位置。
double	getZ()	MouseEventのソースの原点に対して相対的なイベントの深度位置。
boolean	isAltDown()	このイベントでAlt修飾子が押されたかどうか。
boolean	isControlDown()	このイベントでCtrl修飾子が押されたかどうか。
boolean	isDragDetect()	このイベントに続いてDRAG_DETECTEDイベントが発生するかどうかを判断します。
boolean	isMetaDown()	このイベントでMeta修飾子が押されたかどうか。
boolean	isMiddleButtonDown()	中央ボタン(ボタン2)が現在押下されている場合はtrueを返します。
boolean	isPopupTrigger()	このマウス・イベントがプラットフォームのポップアップ・メニュー・トリガー・イベントである場合はtrueを返します。
boolean	isPrimaryButtonDown()	プライマリ・ボタン(ボタン1、通常左側)が現在押下されている場合はtrueを返します。
boolean	isSecondaryButtonDown()	セカンダリ・ボタン(ボタン1、通常右側)が現在押下されている場合はtrueを返します。
boolean	isShiftDown()	このイベントでShift修飾子が押されたかどうか。
boolean	isShortcutDown()	このイベントでホスト・プラットフォームの一般的なShortcut修飾子が押されたかどうかを返します。
boolean	isStillSincePress()	このイベントの直前に発生した押下イベント以降、システム提供のヒステリシス領域にマウス・カーソルが残っているかどうかを示します。
boolean	isSynthesized()	マウスやトラック・パッドのような通常のマウス・イベント・ソース・デバイスではなく、タッチ画面を使用したことによりこのイベントが合成されたかどうかを示します。
void	setDragDetect(boolean dragDetect)	ドラッグ検出動作を強化します。
String	toString()	このMouseEventオブジェクトの文字列表現を返します。

クラス javafx.event.Eventから継承されたメソッド

clone、consume、fireEvent、getTarget、isConsumed

クラス java.util.EventObjectから継承されたメソッド

getSource

クラス java.lang.Objectから継承されたメソッド

equals、finalize、getClass、hashCode、notify、notifyAll、wait、wait、wait

フィールドの詳細

ANY

public static final EventType<MouseEvent> ANY

すべてのマウス・イベント・タイプに共通のスーパータイプ。

MOUSE_PRESSED

public static final EventType<MouseEvent> MOUSE_PRESSED

このイベントは、マウス・ボタンが押されたときに発生します。 これにより、押下、ドラッグ、解放ジェスチャがアクティブ化され、ボタンが解放されるまで、後続のすべてのマウス・イベントが同じノードに配信されます。

MOUSE_RELEASED

public static final EventType<MouseEvent> MOUSE_RELEASED

このイベントは、マウス・ボタンが放されたときに発生します。 同じノード、つまりボタンが押下されて、押下、ドラッグ、解放ジェスチャがアクティブ化されたノードに配信されます。

MOUSE_CLICKED

public static final EventType<MouseEvent> MOUSE_CLICKED

このイベントは、マウス・ボタンがクリックされた(同じノード上で押されて放された)ときに発生します。 このイベントは、あらゆるノードに対してボタンと同じように動作します。 長いドラッグでもクリック・イベントを生成できることに注意してください(このイベントはマウスの押下と解放の両方を行った最上位ノードに配信されます)。

MOUSE_ENTERED_TARGET

public static final EventType<MouseEvent> MOUSE_ENTERED_TARGET

このイベントは、マウスがノードに入ったときに発生します。 これはバブリング・バリアントで、入ったノードのすべての親にも配信されます(消費済である場合を除きます)。 ノードのいずれかの子にマウスが入ったことを通知する必要がない場合は、MOUSE_ENTEREDイベント・ハンドラを使用する必要があります。

関連項目:

マウス入出処理の詳細はMouseEvent

MOUSE_ENTERED

public static final EventType<MouseEvent> MOUSE_ENTERED

このイベントは、マウスがノードに入ったときに発生します。 このイベント・タイプは、入ったノードにのみ配信されます。親がそのフィルタ処理を行ったり、バブリング・イベントを取得する場合は、MOUSE_ENTERED_TARGETを使用する必要があります。

関連項目:

マウス入出処理の詳細はMouseEvent

MOUSE_EXITED_TARGET

public static final EventType<MouseEvent> MOUSE_EXITED_TARGET

このイベントは、マウスがノードから出たときに発生します。 使用されている場合を除き、出たノードのすべての親にも配信されるバブリング・バリアントです。 ノードのいずれかの子からマウスが出たことを通知する必要がない場合は、MOUSE_EXITEDイベント・ハンドラを使用する必要があります。

関連項目:

マウス入出処理の詳細はMouseEvent

MOUSE_EXITED

public static final EventType<MouseEvent> MOUSE_EXITED

このイベントは、マウスがノードから出たときに発生します。 このイベント・タイプは、出たノードにのみ配信されます。親がそのフィルタ処理を行ったり、バブリング・イベントを取得する場合は、MOUSE_EXITED_TARGETを使用する必要があります。

関連項目:

マウス入出処理の詳細はMouseEvent

MOUSE_MOVED

public static final EventType<MouseEvent> MOUSE_MOVED

このイベントは、ボタンを押さずにノード内でマウスが移動されたときに発生します。 いずれかのマウス・ボタンが押下されると、かわりにMOUSE_DRAGGEDイベントが発生します。

MOUSE_DRAGGED

public static final EventType<MouseEvent> MOUSE_DRAGGED

このイベントは、ボタンを押した状態でマウスが移動されたときに発生します。 同じノード、つまりボタンが押下されて、押下、ドラッグ、解放ジェスチャがアクティブ化されたノードに配信されます。 これは、マウスがノードの境界内にあるかどうかに関係なく配信されます。

DRAG_DETECTED

public static final EventType<MouseEvent> DRAG_DETECTED

このイベントは、ドラッグ・ジェスチャのソースとして識別されたノードに配信されます。 このイベントのハンドラは、(startDragAndDrop()メソッドのstartFullDrag()を呼び出すことによって)完全な押下、ドラッグ、解放ジェスチャまたはドラッグ・アンド・ドロップ・ジェスチャを開始できる唯一の場所です。 いずれも呼び出さなかった場合は、単純な押下、ドラッグ、解放ジェスチャが続行されます。

プラットフォーム固有の距離しきい値を超えてマウスをドラッグすると、このイベントが生成されます。 MOUSE_PRESSEDまたはMOUSE_DRAGGEDイベントに対してsetDragDetectメソッドを呼び出すことによって、この動作を変更できます。

関連項目:

単純な押下、ドラッグ、解放ジェスチャの詳細はMouseEvent、完全な押下、ドラッグ、解放ジェスチャの詳細はMouseDragEvent、ドラッグ・アンド・ドロップ・ジェスチャの詳細はDragEvent

コンストラクタの詳細

MouseEvent

public MouseEvent(EventType<? extends MouseEvent> eventType,
                  double x,
                  double y,
                  double screenX,
                  double screenY,
                  MouseButton button,
                  int clickCount,
                  boolean shiftDown,
                  boolean controlDown,
                  boolean altDown,
                  boolean metaDown,
                  boolean primaryButtonDown,
                  boolean middleButtonDown,
                  boolean secondaryButtonDown,
                  boolean synthesized,
                  boolean popupTrigger,
                  boolean stillSincePress,
                  PickResult pickResult)

nullのソースとターゲットを使用した新しいMouseEventイベントを構築します。

パラメータ:

eventType - イベントのタイプ。

x - シーンに関連するx。

y - シーンに関連するy。

screenX - 画面に対して相対的なx座標。

screenY - 画面に対して相対的なy座標。

button - 使用されたマウス・ボタン

clickCount - クリック・カウント数

shiftDown - Shift修飾子が押された場合はtrueです。

controlDown - Ctrl修飾子が押された場合はtrueです。

altDown - Alt修飾子が押された場合はtrueです。

metaDown - Meta修飾子が押された場合はtrueです。

primaryButtonDown - プライマリ・ボタンが押下された場合はtrue。

middleButtonDown - 中央ボタンが押下された場合はtrue。

secondaryButtonDown - セカンダリ・ボタンが押下された場合はtrue。

synthesized - このイベントが合成された場合

popupTrigger - このイベントが現在のプラットフォームのポップアップ・トリガーを示すかどうか

stillSincePress - isStillSincePress()を参照

pickResult - 選択結果。 nullに設定でき、その場合は、シーン座標に基づいて、追加の値のない2D選択結果が構築されます。

導入されたバージョン:

JavaFX 8.0

MouseEvent

public MouseEvent(Object source,
                  EventTarget target,
                  EventType<? extends MouseEvent> eventType,
                  double x,
                  double y,
                  double screenX,
                  double screenY,
                  MouseButton button,
                  int clickCount,
                  boolean shiftDown,
                  boolean controlDown,
                  boolean altDown,
                  boolean metaDown,
                  boolean primaryButtonDown,
                  boolean middleButtonDown,
                  boolean secondaryButtonDown,
                  boolean synthesized,
                  boolean popupTrigger,
                  boolean stillSincePress,
                  PickResult pickResult)

新しいMouseEventイベントを構築します。

パラメータ:

source - イベントのソース。 nullに設定できます。

target - イベントのターゲット。 nullに設定できます。

eventType - イベントのタイプ。

x - ソースを基準としたx。 ソース == nullであるか、ソースがノードでない場合は、シーン座標内にある必要があります。

y - ソースを基準としたy。 ソース == nullであるか、ソースがノードでない場合は、シーン座標内にある必要があります。

screenX - 画面に対して相対的なx座標。

screenY - 画面に対して相対的なy座標。

button - 使用されたマウス・ボタン

clickCount - クリック・カウント数

shiftDown - Shift修飾子が押された場合はtrueです。

controlDown - Ctrl修飾子が押された場合はtrueです。

altDown - Alt修飾子が押された場合はtrueです。

metaDown - Meta修飾子が押された場合はtrueです。

primaryButtonDown - プライマリ・ボタンが押下された場合はtrue。

middleButtonDown - 中央ボタンが押下された場合はtrue。

secondaryButtonDown - セカンダリ・ボタンが押下された場合はtrue。

synthesized - このイベントが合成された場合

popupTrigger - このイベントが現在のプラットフォームのポップアップ・トリガーを示すかどうか

stillSincePress - isStillSincePress()を参照

pickResult - 選択結果。 nullにでき、この場合は、追加の値がない2Dの選択結果が、シーン座標とターゲットに基づいて作成されます。

導入されたバージョン:

JavaFX 8.0

メソッドの詳細

getEventType

public EventType<? extends MouseEvent> getEventType()

クラスからコピーされた説明: Event

このイベントのイベント・タイプを取得します。 同じEventクラスの複数のオブジェクトは、異なるイベント・タイプを持つことができます。 これらのイベント・タイプでは、発生するイベントの種類をさらに指定します。

オーバーライド:

getEventType 、クラス: InputEvent

戻り値:

イベント・タイプ

copyFor

public MouseEvent copyFor(Object newSource,
                          EventTarget newTarget)

該当するイベントを別のソースおよびターゲット用にコピーします。 ほとんどの場合、このメソッドを使用する必要はなく、イベントを起動すると、自動的に呼び出されます。

オーバーライド:

copyFor 、クラス: Event

パラメータ:

newSource - 新しいイベント・ソース

newTarget - 新しいイベント・ターゲット

戻り値:

このイベントのコピー(別のソースおよびターゲット用)

copyFor

public MouseEvent copyFor(Object newSource,
                          EventTarget newTarget,
                          EventType<? extends MouseEvent> eventType)

指定のフィールドが置換された特定のイベントのコピーを作成します。

パラメータ:

newSource - コピーされたイベントの新しいソース

newTarget - コピーされたイベントの新しいターゲット

eventType - 新しいイベント・タイプ

戻り値:

フィールドが置換されたイベント・コピー

導入されたバージョン:

JavaFX 8.0

copyForMouseDragEvent

public static MouseDragEvent copyForMouseDragEvent(MouseEvent e,
                                                   Object source,
                                                   EventTarget target,
                                                   EventType<MouseDragEvent> type,
                                                   Object gestureSource,
                                                   PickResult pickResult)

MouseDragEventタイプのマウス・イベントのコピーを作成します。

パラメータ:

e - コピー対象のマウス・イベント

source - コピーされたイベントの新しいソース

target - コピーされたイベントの新しいターゲット

type - 新しいMouseDragEventタイプ

gestureSource - ジェスチャの新しいソース

pickResult - 選択結果。 nullに設定でき、その場合は、シーン座標に基づいて、追加の値のない2D選択結果が構築されます。

戻り値:

MouseEventから作成された新しいMouseDragEvent

導入されたバージョン:

JavaFX 8.0

isDragDetect

public boolean isDragDetect()

このイベントに続いてDRAG_DETECTEDイベントが発生するかどうかを判断します。 MOUSE_PRESSEDおよびMOUSE_DRAGGEDイベントに対してのみ有効です。

戻り値:

続いてDRAG_DETECTEDイベントが発生する場合はtrue

setDragDetect

public void setDragDetect(boolean dragDetect)

ドラッグ検出動作を強化します。 この値は、このイベントに続いてDRAG_DETECTEDイベントが発生するかどうかを示します。 MOUSE_PRESSEDおよびMOUSE_DRAGGEDイベントに対してのみ有効です。

パラメータ:

dragDetect - 続いてDRAG_DETECTEDイベントが発生するかどうか

getX

public final double getX()

MouseEventのソースの原点に対するイベントの相対水平位置。

戻り値:

MouseEventのソースの原点に対するイベントの相対水平位置。

getY

public final double getY()

MouseEventのソースの原点に対するイベントの相対垂直位置。

戻り値:

MouseEventのソースの原点に対するイベントの相対垂直位置。

getZ

public final double getZ()

MouseEventのソースの原点に対して相対的なイベントの深度位置。

戻り値:

MouseEventのソースの原点に対して相対的なイベントの深度位置。

導入されたバージョン:

JavaFX 8.0

getScreenX

public final double getScreenX()

イベントの水平方向の絶対位置を返します。

戻り値:

イベントの水平方向の絶対位置

getScreenY

public final double getScreenY()

イベントの垂直方向の絶対位置を返します。

戻り値:

イベントの垂直方向の絶対位置

getSceneX

public final double getSceneX()

MouseEventのソースが含まれているSceneの原点に対するイベントの相対水平位置を返します。 ノードがScene内にない場合は、MouseEventのノードの最もルートに近い親のboundsInParentに対する相対値になります。 3Dシーンでは、これは投影変換の適用後にフラットな座標を表します。

戻り値:

MouseEventのソースが含まれているSceneの原点に対するイベントの相対水平位置

getSceneY

public final double getSceneY()

MouseEventのソースが含まれているSceneの原点に対するイベントの相対垂直位置を返します。 ノードがScene内にない場合は、MouseEventのノードの最もルートに近い親のboundsInParentに対する相対値になります。 3Dシーンでは、これは投影変換の適用後にフラットな座標を表します。

戻り値:

MouseEventのソースが含まれているSceneの原点に対するイベントの相対垂直位置

getButton

public final MouseButton getButton()

このイベントの原因となったマウス・ボタン(ある場合)。

戻り値:

状態変化によってこのイベントを発生させたマウス・ボタン

getClickCount

public final int getClickCount()

このイベントに関連付けられたマウス・クリック数を返します。 すべてのMOUSE_MOVEDイベントのclickCount値は0です。 値はMOUSE_PRESSEDイベントの発生に伴って増加し、MOUSE_RELEASEDが発生するまで、後で生成されたMOUSE_CLICKEDイベントを含め、後続のすべてのイベントに対して同様に処理されます。 後続の2回の押下間のすべてのイベントが狭いリージョンで短時間に発生した場合(ネイティブ・オペレーティング・システムの構成に基づく)、値は1より大きい数値に増加します。

戻り値:

このイベントに関連付けられたマウス・クリック数

isStillSincePress

public final boolean isStillSincePress()

このイベントの直前に発生した押下イベント以降、システム提供のヒステリシス領域にマウス・カーソルが残っているかどうかを示します。

ノード上でマウスの押下と解放の両方が行われると、押下から解放までのマウスの移動量に関係なく、そのノードに対してクリック・イベントが生成されます。 単純なクリックとマウス・ドラッグでノードの反応を変える場合は、システムが提供する短い距離のしきい値に基づいてクリックとドラッグを区別する必要があります(クリック中の意図しないわずかな動きはよく発生します)。 このメソッドからtrueが返された場合はすべてのドラッグを無視し、このメソッドからfalseが返された場合はすべてのクリックを無視するようにすると、このことを簡単に実現できます。

戻り値:

このイベントの直前に発生した押下イベント以降、(システムのヒステリシス領域外への)大きなマウス移動がない場合はtrue。

isShiftDown

public final boolean isShiftDown()

このイベントでShift修飾子が押されたかどうか。

戻り値:

このイベントでShift修飾子が押されている場合はtrueです。

isControlDown

public final boolean isControlDown()

このイベントでCtrl修飾子が押されたかどうか。

戻り値:

このイベントでCtrl修飾子が押されている場合はtrueです。

isAltDown

public final boolean isAltDown()

このイベントでAlt修飾子が押されたかどうか。

戻り値:

このイベントでAlt修飾子が押されている場合はtrueです。

isMetaDown

public final boolean isMetaDown()

このイベントでMeta修飾子が押されたかどうか。

戻り値:

このイベントでMeta修飾子が押されている場合はtrueです。

isSynthesized

public boolean isSynthesized()

マウスやトラック・パッドのような通常のマウス・イベント・ソース・デバイスではなく、タッチ画面を使用したことによりこのイベントが合成されたかどうかを示します。 タッチ画面上で指をドラッグすると、スクロール・ジェスチャとマウス・ドラッグの両方が生成されます。 それに起因してアプリケーション内で競合が発生した場合は、このフラグを使用して、すでにスクロール・イベントとして処理されたタッチ画面上でのドラッグと通常のマウス・ドラッグを区別できます。

戻り値:

タッチ画面を使用したことによりこのイベントが合成された場合はtrue

導入されたバージョン:

JavaFX 2.2

isShortcutDown

public final boolean isShortcutDown()

このイベントでホスト・プラットフォームの一般的なShortcut修飾子が押されたかどうかを返します。 この一般的なShortcut修飾子は、ホスト・プラットフォームでショートカットに一般に広く使用されている修飾子キーです。 たとえば、WindowsではCtrl、MacではMeta (コマンド・キー)です。

戻り値:

Shortcut修飾子が押されている場合はtrue、それ以外の場合はfalseです。

isPopupTrigger

public final boolean isPopupTrigger()

このマウス・イベントがプラットフォームのポップアップ・メニュー・トリガー・イベントである場合はtrueを返します。

注: ポップアップ・メニューのトリガーはシステムによって異なります。 したがって、プラットフォーム間で適切に機能させるには、onMousePressedとmouseReleasedの両方でpopupTriggerをチェックする必要があります。

戻り値:

このマウス・イベントがプラットフォームのポップアップ・メニュー・トリガー・イベントである場合はtrue

導入されたバージョン:

JavaFX 8.0

isPrimaryButtonDown

public final boolean isPrimaryButtonDown()

プライマリ・ボタン(ボタン1、通常左側)が現在押下されている場合はtrueを返します。 このメソッドはプライマリ・ボタンが押下されたかどうかを示すもので、このイベントの原因となったボタン押下を示すgetButton()メソッドとは異なることに注意してください。

戻り値:

プライマリ・ボタン(ボタン1、通常左側)が現在押下されている場合はtrue

isSecondaryButtonDown

public final boolean isSecondaryButtonDown()

セカンダリ・ボタン(ボタン1、通常右側)が現在押下されている場合はtrueを返します。 このメソッドはセカンダリ・ボタンが押下されたかどうかを示すもので、このイベントの原因となったボタン押下を示すgetButton()メソッドとは異なることに注意してください。

戻り値:

セカンダリ・ボタン(ボタン3、通常右側)が現在押下されている場合はtrue

isMiddleButtonDown

public final boolean isMiddleButtonDown()

中央ボタン(ボタン2)が現在押下されている場合はtrueを返します。 このメソッドは中央ボタンが押下されたかどうかを示すもので、このイベントの原因となったボタン押下を示すgetButton()メソッドとは異なることに注意してください。

戻り値:

中央ボタン(ボタン2)が現在押下されている場合はtrue

toString

public String toString()

このMouseEventオブジェクトの文字列表現を返します。

オーバーライド:

toString、クラス: EventObject

戻り値:

このMouseEventオブジェクトの文字列表現

getPickResult

public final PickResult getPickResult()

選択内容に関する情報を返します。

戻り値:

選択内容に関する情報を含む新しいPickResultオブジェクト

導入されたバージョン:

JavaFX 8.0