JavaTM 2 Platform
Standard Ed. 5.0

java.awt
クラス MenuItem

java.lang.Object
  上位を拡張 java.awt.MenuComponent
      上位を拡張 java.awt.MenuItem
すべての実装されたインタフェース:
Serializable, Accessible
直系の既知のサブクラス:
CheckboxMenuItem, Menu

public class MenuItem
extends MenuComponent
implements Accessible

メニュー内のすべての項目は、MenuItem クラスかそのサブクラスの 1 つに属している必要があります。

デフォルトの MenuItem オブジェクトは、単純なラベルの付いたメニュー項目を具現化します。

メニューバーのこの画像は 5 つのメニュー項目を示しています。以下の本文でこの図を説明する
最初の 2 つの項目は、"Basic""Simple" というラベルの付いた、単純なメニュー項目です。以下の 2 つの項目はセパレータで、それ自体がラベル "-" 付きで作成されるメニュー項目です。次は、"Check" というラベルの付いた CheckboxMenuItem のインスタンスです。最後のメニュー項目は "More Examples" というラベルの付いたサブメニューで、このサブメニューは Menu のインスタンスです。

メニュー項目が選択されると、AWT はメニュー項目にアクションイベントを送ります。そのイベントは ActionEvent のインスタンスなので、processEvent メソッドはそのイベントを調べて、それを processActionEvent に渡します。processActionEvent メソッドはイベントを、このメニュー項目によって生成されたアクションイベントの通知を対象として登録しているすべての ActionListener オブジェクトに転送します。

ただし、Menu サブクラスはこの動作をオーバーライドして、そのサブ項目の 1 つが選択されるまでどのイベントもフレームに送りません。

関連項目:
直列化された形式

入れ子のクラスの概要
protected  class MenuItem.AccessibleAWTMenuItem
          ユーザ補助機能のデフォルトサポートを提供するのに使用する MenuItem の内部クラスです。
 
クラス java.awt.MenuComponent から継承された入れ子のクラス/インタフェース
MenuComponent.AccessibleAWTMenuComponent
 
コンストラクタの概要
MenuItem()
          空ラベルを持ち、キーボードショートカットのない新しい MenuItem を構築します。
MenuItem(String label)
          指定されたラベルを持ち、キーボードショートカットのない新しい MenuItem を構築します。
MenuItem(String label, MenuShortcut s)
          関連しているキーボードショートカットを持つメニュー項目を構築します。
 
メソッドの概要
 void addActionListener(ActionListener l)
          このメニュー項目からアクションイベントを受け取るアクションリスナーを追加します。
 void addNotify()
          メニュー項目のピアを作成します。
 void deleteShortcut()
          このメニュー項目に関連した MenuShortcut オブジェクトがあれば削除します。
 void disable()
          推奨されていません。 JDK バージョン 1.1 以降は、setEnabled(boolean) を使用します。
protected  void disableEvents(long eventsToDisable)
          指定されたイベントマスクパラメータで定義するイベントについて、このメニュー項目への送信を不可にします。
 void enable()
          推奨されていません。 JDK バージョン 1.1 以降は、setEnabled(boolean) を使用します。
 void enable(boolean b)
          推奨されていません。 JDK バージョン 1.1 以降は、setEnabled(boolean) を使用します。
protected  void enableEvents(long eventsToEnable)
          指定されたイベントマスクパラメータで定義されるイベントについて、このメニュー項目への送信を可能にします。
 AccessibleContext getAccessibleContext()
          この MenuItem に関連付けられた AccessibleContext を返します。
 String getActionCommand()
          このメニュー項目によってトリガされるアクションイベントのコマンド名を返します。
 ActionListener[] getActionListeners()
          このメニュー項目に登録されたすべてのアクションリスナーの配列を返します。
 String getLabel()
          このメニュー項目のラベルを返します。
<T extends EventListener>
T[]
getListeners(Class<T> listenerType)
          この MenuItemFooListener として、現在登録されているすべてのオブジェクトの配列を返します。
 MenuShortcut getShortcut()
          このメニュー項目に関連した MenuShortcut オブジェクトを返します。
 boolean isEnabled()
          このメニュー項目が使用可能になっているかどうかを判定します。
 String paramString()
          この MenuItem の状態を表す文字列を返します。
protected  void processActionEvent(ActionEvent e)
          このメニュー項目で発生したアクションイベントを、登録された ActionListener オブジェクトにディスパッチすることにより、このアクションイベントを処理します。
protected  void processEvent(AWTEvent e)
          このメニュー項目のイベントを処理します。
 void removeActionListener(ActionListener l)
          指定されたアクションリスナーを削除します。
 void setActionCommand(String command)
          このメニュー項目でトリガされるアクションイベントのコマンド名を設定します。
 void setEnabled(boolean b)
          このメニュー項目を選択可能にするかどうかを設定します。
 void setLabel(String label)
          このメニュー項目のラベルを指定されたラベルに設定します。
 void setShortcut(MenuShortcut s)
          このメニュー項目に関連した MenuShortcut オブジェクトを設定します。
 
クラス java.awt.MenuComponent から継承されたメソッド
dispatchEvent, getFont, getName, getParent, getPeer, getTreeLock, postEvent, removeNotify, setFont, setName, toString
 
クラス java.lang.Object から継承されたメソッド
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

コンストラクタの詳細

MenuItem

public MenuItem()
         throws HeadlessException
空ラベルを持ち、キーボードショートカットのない新しい MenuItem を構築します。

例外:
HeadlessException - GraphicsEnvironment.isHeadless() が true を返す場合
導入されたバージョン:
JDK1.1
関連項目:
GraphicsEnvironment.isHeadless()

MenuItem

public MenuItem(String label)
         throws HeadlessException
指定されたラベルを持ち、キーボードショートカットのない新しい MenuItem を構築します。ただし、ラベルでの "-" の使用は、メニュー項目間のセパレータを示すために予約されます。デフォルトでは、セパレータを除くすべてのメニュー項目が使用可能です。

パラメータ:
label - このメニュー項目のラベル
例外:
HeadlessException - GraphicsEnvironment.isHeadless() が true を返す場合
導入されたバージョン:
JDK1.0
関連項目:
GraphicsEnvironment.isHeadless()

MenuItem

public MenuItem(String label,
                MenuShortcut s)
         throws HeadlessException
関連しているキーボードショートカットを持つメニュー項目を構築します。ただし、ラベルでの "-" の使用は、メニュー項目間のセパレータを示すために予約されます。デフォルトでは、セパレータを除くすべてのメニュー項目が使用可能です。

パラメータ:
label - このメニュー項目のラベル
s - このメニュー項目に関連した MenuShortcut のインスタンス
例外:
HeadlessException - GraphicsEnvironment.isHeadless() が true を返す場合
導入されたバージョン:
JDK1.1
関連項目:
GraphicsEnvironment.isHeadless()
メソッドの詳細

addNotify

public void addNotify()
メニュー項目のピアを作成します。ピアを使用すると、ピアの機能性を変えずに、メニュー項目の外観を変更することができます。


getLabel

public String getLabel()
このメニュー項目のラベルを返します。

戻り値:
このメニュー項目のラベル。このメニュー項目がラベルを持たない場合は null
導入されたバージョン:
JDK1.0
関連項目:
setLabel(java.lang.String)

setLabel

public void setLabel(String label)
このメニュー項目のラベルを指定されたラベルに設定します。

パラメータ:
label - 新しいラベル。ラベルがない場合は null
導入されたバージョン:
JDK1.0
関連項目:
getLabel()

isEnabled

public boolean isEnabled()
このメニュー項目が使用可能になっているかどうかを判定します。

導入されたバージョン:
JDK1.0
関連項目:
setEnabled(boolean)

setEnabled

public void setEnabled(boolean b)
このメニュー項目を選択可能にするかどうかを設定します。

パラメータ:
b - このメニュー項目を使用可能にする場合は true、使用不可にする場合は false
導入されたバージョン:
JDK1.1
関連項目:
isEnabled()

enable

@Deprecated
public void enable()
推奨されていません。 JDK バージョン 1.1 以降は、setEnabled(boolean) を使用します。


enable

@Deprecated
public void enable(boolean b)
推奨されていません。 JDK バージョン 1.1 以降は、setEnabled(boolean) を使用します。


disable

@Deprecated
public void disable()
推奨されていません。 JDK バージョン 1.1 以降は、setEnabled(boolean) を使用します。


getShortcut

public MenuShortcut getShortcut()
このメニュー項目に関連した MenuShortcut オブジェクトを返します。

戻り値:
このメニュー項目に関連したメニューショートカット。何も指定されていない場合は null
導入されたバージョン:
JDK1.1
関連項目:
setShortcut(java.awt.MenuShortcut)

setShortcut

public void setShortcut(MenuShortcut s)
このメニュー項目に関連した MenuShortcut オブジェクトを設定します。メニューショートカットがすでにこのメニュー項目に関連した場合は、置き換えられます。

パラメータ:
s - このメニュー項目に関連したメニューショートカット
導入されたバージョン:
JDK1.1
関連項目:
getShortcut()

deleteShortcut

public void deleteShortcut()
このメニュー項目に関連した MenuShortcut オブジェクトがあれば削除します。

導入されたバージョン:
JDK1.1

enableEvents

protected final void enableEvents(long eventsToEnable)
指定されたイベントマスクパラメータで定義されるイベントについて、このメニュー項目への送信を可能にします。

イベント型は、その型のリスナーがそのメニュー項目に追加されると、自動的に使用可能になります。このメソッドを呼び出す必要があるのは、MenuItem のサブクラスが、指定されたイベント型を processEvent に送る場合だけです。リスナーが登録されているかどうかはこの場合関係ありません。

パラメータ:
eventsToEnable - イベントタイプを定義するイベントマスク
導入されたバージョン:
JDK1.1
関連項目:
processEvent(java.awt.AWTEvent), disableEvents(long), Component.enableEvents(long)

disableEvents

protected final void disableEvents(long eventsToDisable)
指定されたイベントマスクパラメータで定義するイベントについて、このメニュー項目への送信を不可にします。

パラメータ:
eventsToDisable - イベントタイプを定義するイベントマスク
導入されたバージョン:
JDK1.1
関連項目:
processEvent(java.awt.AWTEvent), enableEvents(long), Component.disableEvents(long)

setActionCommand

public void setActionCommand(String command)
このメニュー項目でトリガされるアクションイベントのコマンド名を設定します。

デフォルトでは、アクションコマンドはメニュー項目のラベルに設定されます。

パラメータ:
command - このメニュー項目用に設定されるアクションコマンド
導入されたバージョン:
JDK1.1
関連項目:
getActionCommand()

getActionCommand

public String getActionCommand()
このメニュー項目によってトリガされるアクションイベントのコマンド名を返します。

導入されたバージョン:
JDK1.1
関連項目:
setActionCommand(java.lang.String)

addActionListener

public void addActionListener(ActionListener l)
このメニュー項目からアクションイベントを受け取るアクションリスナーを追加します。l が null の場合、例外はスローされず、処理も実行されません。

パラメータ:
l - アクションリスナー
導入されたバージョン:
JDK1.1
関連項目:
removeActionListener(java.awt.event.ActionListener), getActionListeners(), ActionEvent, ActionListener

removeActionListener

public void removeActionListener(ActionListener l)
指定されたアクションリスナーを削除します。これによってそのリスナーは、以後、このメニュー項目からアクションイベントを受け取りません。l が null の場合、例外はスローされず、処理も実行されません。

パラメータ:
l - アクションリスナー
導入されたバージョン:
JDK1.1
関連項目:
addActionListener(java.awt.event.ActionListener), getActionListeners(), ActionEvent, ActionListener

getActionListeners

public ActionListener[] getActionListeners()
このメニュー項目に登録されたすべてのアクションリスナーの配列を返します。

戻り値:
このメニュー項目のすべての ActionListener、または現在アクションリスナーが登録されていない場合は空の配列
導入されたバージョン:
1.4
関連項目:
addActionListener(java.awt.event.ActionListener), removeActionListener(java.awt.event.ActionListener), ActionEvent, ActionListener

getListeners

public <T extends EventListener> T[] getListeners(Class<T> listenerType)
この MenuItemFooListener として、現在登録されているすべてのオブジェクトの配列を返します。FooListeneraddFooListener メソッドを使用して登録されます。

FooListener.class などのクラスリテラルを持つ listenerType 引数を指定できます。たとえば、次のコードを使用して、その項目リスナーの MenuItem m を照会できます。

ActionListener[] als = (ActionListener[])(m.getListeners(ActionListener.class));
このようなリスナーがない場合は空の配列を返します。

パラメータ:
listenerType - 要求されるリスナーの型。java.util.EventListener の下位インタフェースを指定
戻り値:
このメニュー項目の FooListener として登録されたすべてのオブジェクトの配列、またはこのようなリスナーが追加されなかった場合は空の配列
例外:
ClassCastException - listenerTypejava.util.EventListener を実装するクラスまたはインタフェースを指定しない場合
導入されたバージョン:
1.3
関連項目:
getActionListeners()

processEvent

protected void processEvent(AWTEvent e)
このメニュー項目のイベントを処理します。イベントが ActionEvent のインスタンスの場合、MenuItem によって定義されたほかのメソッドである processActionEvent を呼び出します。

現在、メニュー項目はアクションイベントだけをサポートしています。

イベントパラメータが null の場合の動作は定義されていないため例外がスローされます。

オーバーライド:
クラス MenuComponent 内の processEvent
パラメータ:
e - イベント
導入されたバージョン:
JDK1.1
関連項目:
processActionEvent(java.awt.event.ActionEvent)

processActionEvent

protected void processActionEvent(ActionEvent e)
このメニュー項目で発生したアクションイベントを、登録された ActionListener オブジェクトにディスパッチすることにより、このアクションイベントを処理します。このメソッドは、アクションイベントがこのコンポーネント用に使用可能にならないかぎり呼び出されません。アクションイベントは、次の項目の 1 つが発生したときに使用可能になります。

イベントパラメータが null の場合の動作は定義されていないため例外がスローされます。

パラメータ:
e - アクションイベント
導入されたバージョン:
JDK1.1
関連項目:
ActionEvent, ActionListener, enableEvents(long)

paramString

public String paramString()
この MenuItem の状態を表す文字列を返します。このメソッドは、デバッグ専用であり、返される文字列の内容および形式は実装によって異なります。返される文字列は空の場合がありますが、null にはなりません。

オーバーライド:
クラス MenuComponent 内の paramString
戻り値:
このメニュー項目のパラメータ文字列

getAccessibleContext

public AccessibleContext getAccessibleContext()
この MenuItem に関連付けられた AccessibleContext を返します。メニューバーの場合、AccessibleContext は AccessibleAWTMenuItem の形式を取ります。必要に応じて新規の AccessibleAWTMenuItem インスタンスが作成されます。

定義:
インタフェース Accessible 内の getAccessibleContext
オーバーライド:
クラス MenuComponent 内の getAccessibleContext
戻り値:
この MenuItem の AccessibleContext として機能する AccessibleAWTMenuItem

JavaTM 2 Platform
Standard Ed. 5.0

バグの報告と機能のリクエスト
さらに詳しい API リファレンスおよび開発者ドキュメントについては、Java 2 SDK SE 開発者用ドキュメントを参照してください。開発者向けの詳細な解説、概念の概要、用語の定義、バグの回避策、およびコード実例が含まれています。

Copyright 2004 Sun Microsystems, Inc. All rights reserved. Use is subject to license terms. Documentation Redistribution Policy も参照してください。