java.awt.event
クラス MouseWheelEvent

java.lang.Object
  java.util.EventObject
      java.awt.AWTEvent
          java.awt.event.ComponentEvent
              java.awt.event.InputEvent
                  java.awt.event.MouseEvent
                      java.awt.event.MouseWheelEvent

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

Serializable

public class MouseWheelEvent
extends MouseEvent

コンポーネント内でマウスホイールが回転したことを示すイベントです。

ホイールマウスは、中央のボタンの代わりにホイールを使用するマウスです。ホイールはユーザーの方向またはその反対方向に回転させることができます。マウスホイールは (ほかの使用方法もありますが) おもにスクロールするために使用されます。

MouseWheelEvent オブジェクトは、コンポーネントの addMouseWheelListener メソッドを使って「関連する」マウスイベントを受け取るように登録されているすべての MouseWheelListener オブジェクトに渡されます。各リスナーオブジェクトは、マウスイベントを含む MouseEvent を取得します。

マウスホイールが特にスクロール Component と関連するため、MouseWheelEvents はほかの MouseEvents とは多少異なった形で送信されます。これは、通常 MouseEvents がマウスカーソルのすぐ下にある Component の変更に影響を与える (たとえば、ボタンをクリックした場合) のに対して、MouseWheelEvents はマウスカーソルの影響を受けない機能があることによります (ScrollPane 内の Component 上にあるホイールの移動は ScrollPane のスクロールバーの 1 つをスクロールします)。

MouseWheelEvents はマウスカーソルの下にある Component からイベントの送信を開始します。この Component で MouseWheelEvents が有効でない場合、イベントは有効な MouseWheelEvents を持つ最初の上位 Container に送信されます。通常、これはホイールスクロールが有効な ScrollPane です。発生元 Component および x、ｙ 軸は、イベントの最終送信先 (ScrollPane) に関連します。これにより、ScrollPane を変更せずに複雑な GUI をインストールし、すべての MouseWheelEvents を ScrollPane に送信してスクロールできるようになります。

一部の AWT Component は、独自のスクロールバーを持ち、独自のスクロール操作を行うネイティブウィジェットを使って実装されます。これが true である特定の Component は、プラットフォームごとに異なります。マウスホイールがこのような Component のいずれかの上を移動すると、イベントは直接ネイティブウィジェットに送信され、上位 Component には送信されません。

プラットフォームは、マウスホイールの移動時に発生するスクロールの量をカスタマイズする機能を提供します。もっとも一般的な 2 つの設定は、特定の「ユニット」の数 (通常は、テキストベースのコンポーネントにおけるテキスト行)、または「ブロック」全体 (ページアップやページダウンに類似する) のスクロールです。MouseWheelEvent は、背後にあるプラットフォームの設定に準拠するためのメソッドを提供します。ユーザーは、これらのプラットフォームの設定をいつでも変更できます。MouseWheelEvents は最新の設定を反映します。

導入されたバージョン:

1.4

関連項目:

MouseWheelListener, ScrollPane, ScrollPane.setWheelScrollingEnabled(boolean), JScrollPane, JScrollPane.setWheelScrollingEnabled(boolean), 直列化された形式

フィールドの概要

static int	WHEEL_BLOCK_SCROLL 「ブロック」によるスクロール (Page Up キー、Page Down キーによるスクロールなど) を表す定数です。
static int	WHEEL_UNIT_SCROLL 「ユニット」によるスクロール (矢印キーによるスクロールなど) を表す定数です。

クラス java.awt.event.MouseEvent から継承されたフィールド

BUTTON1, BUTTON2, BUTTON3, MOUSE_CLICKED, MOUSE_DRAGGED, MOUSE_ENTERED, MOUSE_EXITED, MOUSE_FIRST, MOUSE_LAST, MOUSE_MOVED, MOUSE_PRESSED, MOUSE_RELEASED, MOUSE_WHEEL, NOBUTTON

クラス java.awt.event.InputEvent から継承されたフィールド

ALT_DOWN_MASK, ALT_GRAPH_DOWN_MASK, ALT_GRAPH_MASK, ALT_MASK, BUTTON1_DOWN_MASK, BUTTON1_MASK, BUTTON2_DOWN_MASK, BUTTON2_MASK, BUTTON3_DOWN_MASK, BUTTON3_MASK, CTRL_DOWN_MASK, CTRL_MASK, META_DOWN_MASK, META_MASK, SHIFT_DOWN_MASK, SHIFT_MASK

クラス java.awt.event.ComponentEvent から継承されたフィールド

COMPONENT_FIRST, COMPONENT_HIDDEN, COMPONENT_LAST, COMPONENT_MOVED, COMPONENT_RESIZED, COMPONENT_SHOWN

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

ACTION_EVENT_MASK, ADJUSTMENT_EVENT_MASK, COMPONENT_EVENT_MASK, consumed, CONTAINER_EVENT_MASK, FOCUS_EVENT_MASK, HIERARCHY_BOUNDS_EVENT_MASK, HIERARCHY_EVENT_MASK, id, INPUT_METHOD_EVENT_MASK, INVOCATION_EVENT_MASK, ITEM_EVENT_MASK, KEY_EVENT_MASK, MOUSE_EVENT_MASK, MOUSE_MOTION_EVENT_MASK, MOUSE_WHEEL_EVENT_MASK, PAINT_EVENT_MASK, RESERVED_ID_MAX, TEXT_EVENT_MASK, WINDOW_EVENT_MASK, WINDOW_FOCUS_EVENT_MASK, WINDOW_STATE_EVENT_MASK

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

source

コンストラクタの概要

MouseWheelEvent(Component source, int id, long when, int modifiers, int x, int y, int clickCount, boolean popupTrigger, int scrollType, int scrollAmount, int wheelRotation)
指定された発生元のコンポーネント、型、修飾子、座標、スクロールのタイプ、スクロールの量、およびホイール回転で、MouseWheelEvent オブジェクトを構築します。

MouseWheelEvent(Component source, int id, long when, int modifiers, int x, int y, int xAbs, int yAbs, int clickCount, boolean popupTrigger, int scrollType, int scrollAmount, int wheelRotation)
指定された発生元のコンポーネント、型、修飾子、座標、絶対座標、スクロールのタイプ、スクロールの量、およびホイール回転で、MouseWheelEvent オブジェクトを構築します。

メソッドの概要

int	getScrollAmount() マウスホイールの回転クリックごとにスクロールされるユニット数を返します。
int	getScrollType() このイベントに応答して発生するスクロールのタイプを返します。
int	getUnitsToScroll() プラットフォームの設定に適合する範囲で、ScrollPane または JScrollPane をスクロールする際に使用する一般的な MouseWheelListener の実装に役立つ便利なメソッドです。
int	getWheelRotation() マウスホイールを回転させた「クリック」数を返します。
String	paramString() このイベントを特定するパラメータの文字列を返します。

クラス java.awt.event.MouseEvent から継承されたメソッド

getButton, getClickCount, getLocationOnScreen, getMouseModifiersText, getPoint, getX, getXOnScreen, getY, getYOnScreen, isPopupTrigger, translatePoint

クラス java.awt.event.InputEvent から継承されたメソッド

consume, getModifiers, getModifiersEx, getModifiersExText, getWhen, isAltDown, isAltGraphDown, isConsumed, isControlDown, isMetaDown, isShiftDown

クラス java.awt.event.ComponentEvent から継承されたメソッド

getComponent

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

getID, setSource, toString

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

getSource

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

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

フィールドの詳細

WHEEL_UNIT_SCROLL

public static final int WHEEL_UNIT_SCROLL

「ユニット」によるスクロール (矢印キーによるスクロールなど) を表す定数です。

関連項目:

getScrollType(), 定数フィールド値

WHEEL_BLOCK_SCROLL

public static final int WHEEL_BLOCK_SCROLL

「ブロック」によるスクロール (Page Up キー、Page Down キーによるスクロールなど) を表す定数です。

関連項目:

getScrollType(), 定数フィールド値

コンストラクタの詳細

MouseWheelEvent

public MouseWheelEvent(Component source,
                       int id,
                       long when,
                       int modifiers,
                       int x,
                       int y,
                       int clickCount,
                       boolean popupTrigger,
                       int scrollType,
                       int scrollAmount,
                       int wheelRotation)

指定された発生元のコンポーネント、型、修飾子、座標、スクロールのタイプ、スクロールの量、およびホイール回転で、MouseWheelEvent オブジェクトを構築します。

絶対座標 xAbs と yAbs は、画面上の発生元コンポーネントの位置に相対座標 x と y を加算した値に設定されます。発生元コンポーネントが表示されていない場合、xAbs と yAbs は 0 に設定されます。

無効な id を渡して、特定できない動作を発生させないようにしてください。このメソッドは source が null の場合に IllegalArgumentException をスローします。

パラメータ:

source - イベントの発生元の Component

id - イベントを特定する整数

when - イベントの発生時刻を指定する long 値

modifiers - イベント発生時に押された修飾キー (Shift、Ctrl、Alt、メタなど)

x - マウス位置の X 座標 (水平方向)

y - マウス位置の Y 座標 (垂直方向)

clickCount - イベントに関連したマウスクリックの回数

popupTrigger - boolean 型。ポップアップメニューに対するイベントの場合は true

scrollType - このイベントに応答して発生するスクロールのタイプ。有効な値は WHEEL_UNIT_SCROLL および WHEEL_BLOCK_SCROLL

scrollAmount - scrollType が WHEEL_UNIT_SCROLL の場合、スクロールされるユニット数

wheelRotation - マウスホイールが回転した総数 (「クリック」数)

例外:

IllegalArgumentException - source が null の場合

関連項目:

MouseEvent.MouseEvent(java.awt.Component, int, long, int, int, int, int, boolean), MouseEvent.MouseEvent(java.awt.Component, int, long, int, int, int, int, int, int, boolean, int)

MouseWheelEvent

public MouseWheelEvent(Component source,
                       int id,
                       long when,
                       int modifiers,
                       int x,
                       int y,
                       int xAbs,
                       int yAbs,
                       int clickCount,
                       boolean popupTrigger,
                       int scrollType,
                       int scrollAmount,
                       int wheelRotation)

指定された発生元のコンポーネント、型、修飾子、座標、絶対座標、スクロールのタイプ、スクロールの量、およびホイール回転で、MouseWheelEvent オブジェクトを構築します。

無効な id を渡して、特定できない動作を発生させないようにしてください。このメソッドは source が null の場合に IllegalArgumentException をスローします。

コンストラクタに渡された相対座標と絶対座標の値が矛盾している場合でも MouseWheelEvent インスタンスは作成され、例外はスローされません。

パラメータ:

source - イベントの発生元の Component

id - イベントを特定する整数

when - イベントの発生時刻を指定する long 値

modifiers - イベント発生時に押された修飾キー (Shift、Ctrl、Alt、メタなど)

x - マウス位置の X 座標 (水平方向)

y - マウス位置の Y 座標 (垂直方向)

xAbs - マウス位置の絶対 X 座標 (水平方向)

yAbs - マウス位置の絶対 Y 座標 (垂直方向)

clickCount - イベントに関連したマウスクリックの回数

popupTrigger - boolean 型。ポップアップメニューに対するイベントの場合は true

scrollType - このイベントに応答して発生するスクロールのタイプ。有効な値は WHEEL_UNIT_SCROLL および WHEEL_BLOCK_SCROLL

scrollAmount - scrollType が WHEEL_UNIT_SCROLL の場合、スクロールされるユニット数

wheelRotation - マウスホイールが回転した総数 (「クリック」数)

例外:

IllegalArgumentException - source が null の場合

導入されたバージョン:

1.6

関連項目:

MouseEvent.MouseEvent(java.awt.Component, int, long, int, int, int, int, boolean), MouseEvent.MouseEvent(java.awt.Component, int, long, int, int, int, int, int, int, boolean, int)

メソッドの詳細

getScrollType

public int getScrollType()

このイベントに応答して発生するスクロールのタイプを返します。これはネイティブプラットフォームによって決まります。次に有効な値を示します。

• MouseWheelEvent.WHEEL_UNIT_SCROLL
• MouseWheelEvent.WHEEL_BLOCK_SCROLL

戻り値:

ネイティブプラットフォームの構成により、MouseWheelEvent.WHEEL_UNIT_SCROLL または MouseWheelEvent.WHEEL_BLOCK_SCROLL のいずれか

関連項目:

Adjustable.getUnitIncrement(), Adjustable.getBlockIncrement(), Scrollable.getScrollableUnitIncrement(java.awt.Rectangle, int, int), Scrollable.getScrollableBlockIncrement(java.awt.Rectangle, int, int)

getScrollAmount

public int getScrollAmount()

マウスホイールの回転クリックごとにスクロールされるユニット数を返します。getScrollType が MouseWheelEvent.WHEEL_UNIT_SCROLL を返す場合にのみ有効です。

戻り値:

スクロールするユニット数、または未定義の値 (getScrollType が MouseWheelEvent.WHEEL_BLOCK_SCROLL を返す場合)

関連項目:

getScrollType()

getWheelRotation

public int getWheelRotation()

マウスホイールを回転させた「クリック」数を返します。

戻り値:

マウスホイールが上側またはユーザーから見て反対方向に回転した場合は負の値、マウスホイールが下側またはユーザー方向に回転した場合は正の値

getUnitsToScroll

public int getUnitsToScroll()

プラットフォームの設定に適合する範囲で、ScrollPane または JScrollPane をスクロールする際に使用する一般的な MouseWheelListener の実装に役立つ便利なメソッドです。ただし、ScrollPane および JScrollPane には、すでにこの機能が組み込まれています。

このメソッドは、スクロールのタイプが MouseWheelEvent.WHEEL_UNIT_SCROLL の場合にスクロールするユニット数を返します。これは、getScrollType が MouseWheelEvent.WHEEL_UNIT_SCROLL を返す場合にのみ呼び出します。

スクロールの方向、ホイールの移動量、およびホイールスクロールに関するプラットフォームの設定がすべて関係します。このメソッドは Adjustable または Scrollable ユニット増分値を考慮せず、また考慮できません。 この値はスクロールコンポーネントによって変わるためです。

このメソッドがリスナーで使用される簡単な例を次に示します。

 
  mouseWheelMoved(MouseWheelEvent event) {
      ScrollPane sp = getScrollPaneFromSomewhere(); 
      Adjustable adj = sp.getVAdjustable()
      if (MouseWheelEvent.getScrollType() == WHEEL_UNIT_SCROLL) {
          int totalScrollAmount =
              event.getUnitsToScroll() *
              adj.getUnitIncrement();
          adj.setValue(adj.getValue() + totalScrollAmount);
      }
  }
 

戻り値:

マウスホイールの回転の方向と量、およびネイティブプラットフォームのホイールスクロール設定に基づいてスクロールされるユニット数

関連項目:

getScrollType(), getScrollAmount(), MouseWheelListener, Adjustable, Adjustable.getUnitIncrement(), Scrollable, Scrollable.getScrollableUnitIncrement(java.awt.Rectangle, int, int), ScrollPane, ScrollPane.setWheelScrollingEnabled(boolean), JScrollPane, JScrollPane.setWheelScrollingEnabled(boolean)

paramString

public String paramString()

このイベントを特定するパラメータの文字列を返します。このメソッドは、イベントログの作成およびデバッグに使用します。

オーバーライド:

クラス MouseEvent 内の paramString

戻り値:

イベントを特定する文字列とその属性