java.awt
クラス CheckboxMenuItem

java.lang.Object
  |
  +--java.awt.MenuComponent
        |
        +--java.awt.MenuItem
              |
              +--java.awt.CheckboxMenuItem

public class CheckboxMenuItem

extends MenuItem

implements ItemSelectable

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

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

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

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

導入されたバージョン:

JDK1.0

関連項目:

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

コンストラクタの概要

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

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

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

メソッドの概要

void	addItemListener(ItemListener l) このチェックボックスメニュー項目からの項目イベントを受け取れるように、指定された項目リスナーを追加します。
void	addNotify() チェックボックス項目のピアを作成します。
Object[]	getSelectedObjects() チェックボックスメニュー項目のラベルを含む配列 (長さ 1) を返します。
boolean	getState() このチェックボックスメニュー項目の状態が「オン」であるか「オフ」であるか判定します。
String	paramString() このチェックボックスメニュー項目の状態を表すパラメータ文字列を返します。
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, 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()

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

導入されたバージョン:

JDK1.1

CheckboxMenuItem

public CheckboxMenuItem(String label)

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

パラメータ:

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

CheckboxMenuItem

public CheckboxMenuItem(String label,
                        boolean state)

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

パラメータ:

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

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

導入されたバージョン:

JDK1.1

メソッドの詳細

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 は「オフ」を示します。

パラメータ:

b - チェックボックスメニュー項目の状態を示す boolean 値

関連項目:

getState()

getSelectedObjects

public Object[] getSelectedObjects()

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

定義:

インタフェース ItemSelectable 内の getSelectedObjects

関連項目:

ItemSelectable

addItemListener

public void addItemListener(ItemListener l)

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

定義:

インタフェース ItemSelectable 内の addItemListener

パラメータ:

l - 項目リスナー

導入されたバージョン:

JDK1.1

関連項目:

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

removeItemListener

public void removeItemListener(ItemListener l)

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

定義:

インタフェース ItemSelectable 内の removeItemListener

パラメータ:

l - 項目リスナー

導入されたバージョン:

JDK1.1

関連項目:

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

processEvent

protected void processEvent(AWTEvent e)

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

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

パラメータ:

e - イベント

オーバーライド:

クラス MenuItem 内の processEvent

導入されたバージョン:

JDK1.1

関連項目:

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

processItemEvent

protected void processItemEvent(ItemEvent e)

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

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

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

パラメータ:

e - 項目イベント

導入されたバージョン:

JDK1.1

関連項目:

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

paramString

public String paramString()

このチェックボックスメニュー項目の状態を表すパラメータ文字列を返します。この文字列はデバッグの際に便利です。

戻り値:

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

オーバーライド:

クラス MenuItem 内の paramString