CheckboxMenuItem (Java Platform SE 8)

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)を返します。ただし、チェックボックスが選択されていない場合には、nullを返します。
`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()
```
    チェックボックス項目のピアを生成します。これにより、チェックボックス項目の機能を変更することなく、その外観を変更することが可能になります。ほとんどのアプリケーションはこのメソッドを直接には呼び出しません。
    
    オーバーライド:
    
    addNotify、クラス: MenuItem
    
    関連項目:
    
    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を返します。
    
    定義:
    
    getSelectedObjects、インタフェース: ItemSelectable
    
    関連項目:
    
    ItemSelectable
  - addItemListener
```
public void addItemListener(ItemListener l)
```
    指定された項目リスナーを、このチェックボックスの項目イベント受信のために追加します。項目イベントはsetState()の呼出しではなく、ユーザーのアクションに反応してリスナーに送信されます。lがnullの場合、例外はスローされず、処理も実行されません。
    AWTスレッド・モデルの詳細は、「AWTのスレッドの問題」を参照してください。
    
    定義:
    
    addItemListener、インタフェース: ItemSelectable
    
    パラメータ:
    
    l - 項目リスナー
    
    導入されたバージョン:
    
    JDK1.1
    
    関連項目:
    
    removeItemListener(java.awt.event.ItemListener), getItemListeners(), setState(boolean), ItemEvent, ItemListener
  - removeItemListener
```
public void removeItemListener(ItemListener l)
```
    このチェックボックス・メニュー項目からの項目イベントを受け取らないように、指定された項目リスナーを削除します。lがnullの場合、例外はスローされず、処理も実行されません。
    AWTスレッド・モデルの詳細は、「AWTのスレッドの問題」を参照してください。
    
    定義:
    
    removeItemListener、インタフェース: ItemSelectable
    
    パラメータ:
    
    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メソッドを使用して登録されます。
    FooListener.classなどのクラス・リテラルを使用してlistenerType引数を指定できます。たとえば、次のコードを使用して、その項目リスナーのCheckboxMenuItem cを照会できます。
```
ItemListener[] ils = (ItemListener[])(c.getListeners(ItemListener.class));
```
    このようなリスナーがない場合は空の配列を返します。
    オーバーライド:
    
    getListeners、クラス: MenuItem
    
    パラメータ:
    
    listenerType - 要求されるリスナーの型。java.util.EventListenerの子孫のインタフェースを指定してください
    
    戻り値:
    
    このチェックボックス・メニュー項目上でFooListenerとして登録されたすべてのオブジェクトの配列、またはこのようなリスナーが登録されていない場合は空の配列
    
    例外:
    
    ClassCastException - listenerTypeで、java.util.EventListenerを実装するクラスまたはインタフェースが指定されなかった場合
    
    導入されたバージョン:
    
    1.3
    
    関連項目:
    
    getItemListeners()
  - processEvent
```
protected void processEvent(AWTEvent e)
```
    このチェックボックス・メニュー項目のイベントを処理します。イベントがItemEventのインスタンスである場合、このメソッドはprocessItemEventメソッドを呼び出します。イベントが項目イベントでない場合、スーパー・クラスのprocessEventを呼び出します。
    現在、チェックボックス・メニュー項目がサポートしているのは、項目イベントだけです。
    イベント・パラメータがnullである場合は、動作が未指定のため、例外が発生する可能性があります。
    
    オーバーライド:
    
    processEvent、クラス: MenuItem
    
    パラメータ:
    
    e - イベント
    
    導入されたバージョン:
    
    JDK1.1
    
    関連項目:
    
    ItemEvent, processItemEvent(java.awt.event.ItemEvent)
  - processItemEvent
```
protected void processItemEvent(ItemEvent e)
```
    このチェックボックス・メニュー項目で発生する項目イベントを、登録されているすべてのItemListenerオブジェクトにディスパッチすることによって処理します。
    このメニュー項目で項目イベントが使用可能でない場合、このメソッドは呼び出されません。項目イベントは、次の項目の1つが発生したときに使用可能になります。
    - ItemListenerオブジェクトがaddItemListenerによって登録されている。
    - enableEventsによって項目イベントが使用可能になっている。
    イベント・パラメータがnullである場合は、動作が未指定のため、例外が発生する可能性があります。
    パラメータ:
    
    e - 項目イベント
    
    導入されたバージョン:
    
    JDK1.1
    
    関連項目:
    
    ItemEvent, ItemListener, addItemListener(java.awt.event.ItemListener), MenuItem.enableEvents(long)
  - paramString
```
public String paramString()
```
    このCheckBoxMenuItemの状態を表す文字列を返します。このメソッドはデバッグ専用であり、返される文字列の内容および形式は実装によって異なる場合があります。返される文字列は空の場合がありますが、nullにはなりません。
    
    オーバーライド:
    
    paramString、クラス: MenuItem
    
    戻り値:
    
    このチェックボックス・メニュー項目のパラメータ文字列
  - getAccessibleContext
```
public AccessibleContext getAccessibleContext()
```
    このCheckboxMenuItemに関連付けられたAccessibleContextを取得します。CheckboxMenuItemの場合、AccessibleContextはAccessibleAWTCheckboxMenuItemの形式を取ります。必要に応じて新規のAccessibleAWTCheckboxMenuItemが生成されます。
    
    定義:
    
    getAccessibleContext、インタフェース: Accessible
    
    オーバーライド:
    
    getAccessibleContext、クラス: MenuItem
    
    戻り値:
    
    このCheckboxMenuItemのAccessibleContextとして機能するAccessibleAWTCheckboxMenuItem
    
    導入されたバージョン:
    
    1.3

バグまたは機能を送信
詳細なAPIリファレンスおよび開発者ドキュメントについては、Java SEのドキュメントを参照してください。そのドキュメントには、概念的な概要、用語の定義、回避方法、有効なコード例などの、開発者を対象にしたより詳細な説明が含まれています。
Copyright © 1993, 2016, Oracle and/or its affiliates. All rights reserved.Use is subject to license terms Documentation Redistribution Policyも参照してください。

クラスCheckboxMenuItem

ネストされたクラスのサマリー

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

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

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

メソッドのサマリー

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

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

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

コンストラクタの詳細

CheckboxMenuItem

CheckboxMenuItem

CheckboxMenuItem

メソッドの詳細

addNotify

getState

setState

getSelectedObjects

addItemListener

removeItemListener

getItemListeners

getListeners

processEvent

processItemEvent

paramString

getAccessibleContext