java.awt
クラス CheckboxMenuItem

java.lang.Object
  java.awt.MenuComponent
      java.awt.MenuItem
          java.awt.CheckboxMenuItem

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

ItemSelectable, Serializable, Accessible

public class CheckboxMenuItem
extends MenuItem
implements ItemSelectable, Accessible

このクラスは、メニューに追加できるチェックボックスを表します。メニュー内のチェックボックスを選択すると、その状態が「オン」から「オフ」へ、または「オフ」から「オン」へ変更されます。

次の図は、CheckBoxMenuItem のインスタンスが含まれているメニューを表します。

Check というラベルの付いた項目は、「オフ」の状態のチェックボックスメニュー項目を示します。

チェックボックスメニュー項目を選択すると、AWT は項目イベントをその項目に送ります。このイベントは ItemEvent のインスタンスなので、processEvent メソッドはそのイベントを調べて processItemEvent に渡します。後者のメソッドは、このメニュー項目によって生成される項目イベントの通知を登録しているすべての ItemListener オブジェクトにそのイベントを送ります。

導入されたバージョン:

JDK1.0

関連項目:

ItemEvent, ItemListener, 直列化された形式

入れ子のクラスの概要

protected class

CheckboxMenuItem.AccessibleAWTCheckboxMenuItem ユーザ補助機能のデフォルトサポートを提供するために使用する CheckboxMenuItem の内部クラスです。

クラス java.awt.MenuItem から継承された入れ子のクラス/インタフェース

MenuItem.AccessibleAWTMenuItem

クラス java.awt.MenuComponent から継承された入れ子のクラス/インタフェース

MenuComponent.AccessibleAWTMenuComponent

コンストラクタの概要

CheckboxMenuItem()
空のラベルが付いた、チェックボックスメニュー項目を生成します。

CheckboxMenuItem(String label)
指定されたラベルが付いた、チェックボックスメニュー項目を生成します。

CheckboxMenuItem(String label, boolean state)
指定されたラベルが付いたチェックボックスメニュー項目を、指定された状態で生成します。

メソッドの概要

void	addItemListener(ItemListener l) 指定された項目リスナーを、このチェックボックスの項目イベント受信のために追加します。
void	addNotify() チェックボックス項目のピアを生成します。
AccessibleContext	getAccessibleContext() この CheckboxMenuItem に関連付けられた AccessibleContext を返します。
ItemListener[]	getItemListeners() このチェックボックスメニュー項目に登録されているすべての項目リスナーの配列を返します。
<T extends EventListener> T[]	getListeners(Class<T> listenerType) この CheckboxMenuItem に FooListener として現在登録されているすべてのオブジェクトの配列を返します。
Object[]	getSelectedObjects() チェックボックスメニュー項目のラベルを含む配列 (長さ 1) を返します。
boolean	getState() このチェックボックスメニュー項目の状態が「オン」であるか「オフ」であるかを判定します。
String	paramString() この CheckBoxMenuItem の状態を表す文字列を返します。
protected void	processEvent(AWTEvent e) このチェックボックスメニュー項目のイベントを処理します。
protected void	processItemEvent(ItemEvent e) このチェックボックスメニュー項目で発生する項目イベントを、登録されている ItemListener オブジェクトにディスパッチすることにより、項目イベントを処理します。
void	removeItemListener(ItemListener l) このチェックボックスメニュー項目からの項目イベントを受け取らないように、指定された項目リスナーを削除します。
void	setState(boolean b) このチェックボックスメニュー項目を、指定された状態に設定します。

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

addActionListener, deleteShortcut, disable, disableEvents, enable, enable, enableEvents, getActionCommand, getActionListeners, getLabel, getShortcut, isEnabled, processActionEvent, removeActionListener, setActionCommand, setEnabled, setLabel, setShortcut

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

コンストラクタの詳細

CheckboxMenuItem

public CheckboxMenuItem()
                 throws HeadlessException

空のラベルが付いた、チェックボックスメニュー項目を生成します。項目の初期状態は「オフ」に設定されます。

例外:

HeadlessException - GraphicsEnvironment.isHeadless() が true を返す場合

導入されたバージョン:

JDK1.1

関連項目:

GraphicsEnvironment.isHeadless()

CheckboxMenuItem

public CheckboxMenuItem(String label)
                 throws HeadlessException

指定されたラベルが付いた、チェックボックスメニュー項目を生成します。項目の初期状態は「オフ」に設定されます。

パラメータ:

label - チェックボックスメニュー項目の文字列ラベル。メニュー項目にラベルがない場合は null

例外:

HeadlessException - GraphicsEnvironment.isHeadless() が true を返す場合

関連項目:

GraphicsEnvironment.isHeadless()

CheckboxMenuItem

public CheckboxMenuItem(String label,
                        boolean state)
                 throws HeadlessException

指定されたラベルが付いたチェックボックスメニュー項目を、指定された状態で生成します。

パラメータ:

label - チェックボックスメニュー項目の文字列ラベル。メニュー項目にラベルがない場合は null

state - メニュー項目の初期状態。true は「オン」を、false は「オフ」を示す

例外:

HeadlessException - GraphicsEnvironment.isHeadless() が true を返す場合

導入されたバージョン:

JDK1.1

関連項目:

GraphicsEnvironment.isHeadless()

メソッドの詳細

addNotify

public void addNotify()

チェックボックス項目のピアを生成します。これにより、チェックボックス項目の機能を変更することなく、その外観を変更することが可能になります。ほとんどのアプリケーションはこのメソッドを直接呼び出すことはありません。

オーバーライド:

クラス MenuItem 内の addNotify

関連項目:

Toolkit.createCheckboxMenuItem(java.awt.CheckboxMenuItem), Component.getToolkit()

getState

public boolean getState()

このチェックボックスメニュー項目の状態が「オン」であるか「オフ」であるかを判定します。

戻り値:

このチェックボックスメニュー項目の状態。true は「オン」を、false は「オフ」を示す

関連項目:

setState(boolean)

setState

public void setState(boolean b)

このチェックボックスメニュー項目を、指定された状態に設定します。boolean 値 true は「オン」を示し、false は「オフ」を示します。

このメソッドは主にチェックボックスメニュー項目のステータス初期化のために使用してください。チェックボックスのステータスをプログラムで設定しても ItemEvent は開始されません。ItemEvent を開始する唯一の方法はユーザの操作だけです。

パラメータ:

b - チェックボックスメニューアイテムが「オン」の場合は true、そうでない場合は false

関連項目:

getState()

getSelectedObjects

public Object[] getSelectedObjects()

チェックボックスメニュー項目のラベルを含む配列 (長さ 1) を返します。ただし、チェックボックスが選択されていない場合には、null を返します。

定義:

インタフェース ItemSelectable 内の getSelectedObjects

関連項目:

ItemSelectable

addItemListener

public void addItemListener(ItemListener l)

指定された項目リスナーを、このチェックボックスの項目イベント受信のために追加します。項目イベントは setState() の呼び出しではなく、ユーザのアクションに反応してリスナーに送信されます。l が null の場合、例外はスローされず、処理も実行されません。

定義:

インタフェース ItemSelectable 内の addItemListener

パラメータ:

l - 項目リスナー

導入されたバージョン:

JDK1.1

関連項目:

removeItemListener(java.awt.event.ItemListener), getItemListeners(), setState(boolean), ItemEvent, ItemListener

removeItemListener

public void removeItemListener(ItemListener l)

このチェックボックスメニュー項目からの項目イベントを受け取らないように、指定された項目リスナーを削除します。l が null の場合、例外はスローされず、処理も実行されません。

定義:

インタフェース ItemSelectable 内の removeItemListener

パラメータ:

l - 項目リスナー

導入されたバージョン:

JDK1.1

関連項目:

addItemListener(java.awt.event.ItemListener), getItemListeners(), ItemEvent, ItemListener

getItemListeners

public ItemListener[] getItemListeners()

このチェックボックスメニュー項目に登録されているすべての項目リスナーの配列を返します。

戻り値:

このチェックボックスメニュー項目のすべての ItemListener。項目リスナーが現在登録されていない場合は空の配列を返す

導入されたバージョン:

1.4

関連項目:

addItemListener(java.awt.event.ItemListener), removeItemListener(java.awt.event.ItemListener), ItemEvent, ItemListener

getListeners

public <T extends EventListener> T[] getListeners(Class<T> listenerType)

この CheckboxMenuItem に FooListener として現在登録されているすべてのオブジェクトの配列を返します。この FooListener は addFooListener メソッドで登録されたものです。

listenerType 引数は FooListener.class のようなクラスリテラルで指定できます。たとえば、この項目リスナーに対する CheckboxMenuItem c の照会は次のコードで行います。

ItemListener[] ils = (ItemListener[])(c.getListeners(ItemListener.class));

このようなリスナーがない場合は空の配列を返します。

オーバーライド:

クラス MenuItem 内の getListeners

パラメータ:

listenerType - 要求されるリスナーの型。java.util.EventListener の下位インタフェースを指定

戻り値:

このチェックボックスメニュー項目に FooListener として登録されているすべてのオブジェクトの配列。リスナーが登録されていない場合は空の配列を返す

例外:

ClassCastException - listenerType が java.util.EventListener を実装するクラスまたはインタフェースを指定しない場合

導入されたバージョン:

1.3

関連項目:

getItemListeners()

processEvent

protected void processEvent(AWTEvent e)

このチェックボックスメニュー項目のイベントを処理します。イベントが ItemEvent のインスタンスである場合、このメソッドは processItemEvent メソッドを呼び出します。イベントが項目イベントでない場合、スーパークラスの processEvent を呼び出します。

現在、チェックボックスメニュー項目がサポートしているのは、項目イベントだけです。

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

オーバーライド:

クラス MenuItem 内の processEvent

パラメータ:

e - イベント

導入されたバージョン:

JDK1.1

関連項目:

ItemEvent, processItemEvent(java.awt.event.ItemEvent)

processItemEvent

protected void processItemEvent(ItemEvent e)

このチェックボックスメニュー項目で発生する項目イベントを、登録されている ItemListener オブジェクトにディスパッチすることにより、項目イベントを処理します。

このメニュー項目で項目イベントが使用可能でない場合、このメソッドは呼び出されません。項目イベントは、次のいずれかの場合に使用可能になります。

• ItemListener オブジェクトが addItemListener を使って登録される
• enableEvents によって項目イベントが使用可能になっている

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

パラメータ:

e - 項目イベント

導入されたバージョン:

JDK1.1

関連項目:

ItemEvent, ItemListener, addItemListener(java.awt.event.ItemListener), MenuItem.enableEvents(long)

paramString

public String paramString()

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

オーバーライド:

クラス MenuItem 内の paramString

戻り値:

このチェックボックスメニュー項目のパラメータ文字列

getAccessibleContext

public AccessibleContext getAccessibleContext()

この CheckboxMenuItem に関連付けられた AccessibleContext を返します。CheckboxMenuItem の場合、AccessibleContext は AccessibleAWTCheckboxMenuItem の形式を取ります。必要に応じて新規の AccessibleAWTCheckboxMenuItem が生成されます。

定義:

インタフェース Accessible 内の getAccessibleContext

オーバーライド:

クラス MenuItem 内の getAccessibleContext

戻り値:

この CheckboxMenuItem の AccessibleContext として機能する AccessibleAWTCheckboxMenuItem