java.awt.event

クラス ActionEvent

java.lang.Object

java.util.EventObject

java.awt.AWTEvent

java.awt.event.ActionEvent

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

Serializable

public class ActionEvent
extends AWTEvent

コンポーネントが定義するアクションが発生したことを示す、セマンティックイベントです。この高レベルイベントは、コンポーネント (Button など) 固有アクションが発生したときに (押されたなど)、コンポーネントによって生成されます。イベントは、コンポーネントの addActionListener メソッドを使って、それらのイベントを受け取るように登録されているすべての ActionListener オブジェクトに渡されます。

注: キーボードを使用して Button で ActionEvent を呼び出すには、スペースバーを使用します。

ActionListener インタフェースを実装するオブジェクトは、イベントが発生したときにこの ActionEvent を取得します。したがってリスナーは、個々のマウス移動やマウスクリックを詳細に処理することなく、「ボタンが押された」などの「意味のある (セマンティック)」イベントを処理できます。

特定の ActionEvent インスタンスの id パラメータが ACTION_FIRST から ACTION_LAST までの範囲にない場合に、未指定の動作が発生します。

導入されたバージョン:

1.1

関連項目:

ActionListener, Tutorial: How to Write an Action Listener, 直列化された形式

フィールドのサマリー

フィールド

修飾子と型	フィールドと説明
static int	ACTION_FIRST アクションイベントに使用される ID の範囲内の最初の番号です。
static int	ACTION_LAST アクションイベントに使用される ID の範囲内の最後の番号です。
static int	ACTION_PERFORMED このイベント ID は、意味のあるアクションが発生したことを示します。
static int	ALT_MASK Alt 修飾子です。
static int	CTRL_MASK Ctrl 修飾子です。
static int	META_MASK Meta 修飾子です。
static int	SHIFT_MASK Shift 修飾子です。

クラス 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

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

コンストラクタ

コンストラクタと説明
ActionEvent(Object source, int id, String command) ActionEvent オブジェクトを構築します。
ActionEvent(Object source, int id, String command, int modifiers) 修飾キーで ActionEvent オブジェクトを構築します。
ActionEvent(Object source, int id, String command, long when, int modifiers) 指定された修飾キーとタイムスタンプで ActionEvent オブジェクトを構築します。

メソッドのサマリー

メソッド

修飾子と型	メソッドと説明
String	getActionCommand() このアクションに関連付けられたコマンド文字列を返します。
int	getModifiers() このアクションイベント中に押された修飾キーを返します。
long	getWhen() このイベントが発生した時点のタイムスタンプを返します。
String	paramString() このアクションイベントを識別するパラメータ文字列を返します。

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

consume, getID, isConsumed, setSource, toString

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

getSource

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

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

フィールドの詳細

SHIFT_MASK

public static final int SHIFT_MASK

Shift 修飾子です。イベント中に Shift キーが押されたことを示します。

関連項目:

定数フィールド値

CTRL_MASK

public static final int CTRL_MASK

Ctrl 修飾子です。イベント中に Ctrl キーが押されたことを示します。

関連項目:

定数フィールド値

META_MASK

public static final int META_MASK

Meta 修飾子です。イベント中に Meta キーが押されたことを示します。

関連項目:

定数フィールド値

ALT_MASK

public static final int ALT_MASK

Alt 修飾子です。イベント中に Alt キーが押されたことを示します。

関連項目:

定数フィールド値

ACTION_FIRST

public static final int ACTION_FIRST

アクションイベントに使用される ID の範囲内の最初の番号です。

関連項目:

定数フィールド値

ACTION_LAST

public static final int ACTION_LAST

アクションイベントに使用される ID の範囲内の最後の番号です。

関連項目:

定数フィールド値

ACTION_PERFORMED

public static final int ACTION_PERFORMED

このイベント ID は、意味のあるアクションが発生したことを示します。

関連項目:

定数フィールド値

コンストラクタの詳細

ActionEvent

public ActionEvent(Object source,
           int id,
           String command)

ActionEvent オブジェクトを構築します。

このメソッドは source が null の場合に IllegalArgumentException をスローします。null command 文字列は誤りではありませんが、推奨されません。

パラメータ:

source - イベントを発生させたオブジェクト

id - イベントを識別する整数。許容される値については、ActionEvent のクラスの説明を参照してください。

command - イベントに関連付ける 1 つのコマンド (または複数のコマンドのいずれか) を指定できる文字列

例外:

IllegalArgumentException - source が null である場合

関連項目:

EventObject.getSource(), AWTEvent.getID(), getActionCommand()

ActionEvent

public ActionEvent(Object source,
           int id,
           String command,
           int modifiers)

修飾キーで ActionEvent オブジェクトを構築します。

このメソッドは source が null の場合に IllegalArgumentException をスローします。null command 文字列は誤りではありませんが、推奨されません。

パラメータ:

source - イベントを発生させたオブジェクト

id - イベントを識別する整数。許容される値については、ActionEvent のクラスの説明を参照してください。

command - イベントに関連付ける 1 つのコマンド (または複数のコマンドのいずれか) を指定できる文字列

modifiers - イベント中に押された修飾キー (Shift、Ctrl、Alt、Meta)。負の値のパラメータを渡すことはお勧めできません。ゼロの値は修飾子が渡されなかったことを意味します

例外:

IllegalArgumentException - source が null である場合

関連項目:

EventObject.getSource(), AWTEvent.getID(), getActionCommand(), getModifiers()

ActionEvent

public ActionEvent(Object source,
           int id,
           String command,
           long when,
           int modifiers)

指定された修飾キーとタイムスタンプで ActionEvent オブジェクトを構築します。

このメソッドは source が null の場合に IllegalArgumentException をスローします。null command 文字列は誤りではありませんが、推奨されません。

パラメータ:

source - イベントを発生させたオブジェクト

id - イベントを識別する整数。許容される値については、ActionEvent のクラスの説明を参照してください。

command - イベントに関連付ける 1 つのコマンド (または複数のコマンドのいずれか) を指定できる文字列

modifiers - イベント中に押された修飾キー (Shift、Ctrl、Alt、Meta)。負の値のパラメータを渡すことはお勧めできません。ゼロの値は修飾子が渡されなかったことを意味します

when - イベントの発生時間を渡す long 値負またはゼロの値を渡すことはお勧めできません

例外:

IllegalArgumentException - source が null である場合

導入されたバージョン:

1.4

関連項目:

EventObject.getSource(), AWTEvent.getID(), getActionCommand(), getModifiers(), getWhen()

メソッドの詳細

getActionCommand

public String getActionCommand()

このアクションに関連付けられたコマンド文字列を返します。「モーダル」コンポーネントはこの文字列を使って、その状態に応じていくつかのコマンドのいずれかを指定できます。たとえば、1 つのボタンで「詳細を表示」と「詳細を隠す」を切り替えられます。ソースオブジェクトとイベントはどちらの場合も同じですが、コマンド文字列が意図されたアクションを識別します。

null コマンド文字列がこの ActionEvent のコンストラクタに渡されると、このメソッドは null を返します。

戻り値:

このイベントのコマンドを識別する文字列

getWhen

public long getWhen()

このイベントが発生した時点のタイムスタンプを返します。ActionEvent が高レベルのセマンティックイベントであるため、タイムスタンプは通常は基本となる InputEvent と同じです。

戻り値:

このイベントのタイムスタンプ

導入されたバージョン:

1.4

getModifiers

public int getModifiers()

このアクションイベント中に押された修飾キーを返します。

戻り値:

修飾子定数のビット単位論理和

paramString

public String paramString()

このアクションイベントを識別するパラメータ文字列を返します。このメソッドは、イベントログの作成およびデバッグに便利です。

オーバーライド:

paramString、クラス: AWTEvent

戻り値:

イベントを識別する文字列とそれに関連付けられたコマンド