クラス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のインスタンスが含まれているメニューを表します。

Basic、Simple、Check、およびMore Examplesという項目を含むExamplesというラベルの付いたメニュー。 Check項目はオフ状態のCheckBoxMenuItemインスタンス。

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

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

導入されたバージョン:
1.0
関連項目:

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

    ネストされたクラス
    修飾子と型
    クラス
    説明
    protected class 
    CheckboxMenuItem.AccessibleAWTCheckboxMenuItem
    アクセシビリティのデフォルト・サポートを提供するために使用するCheckboxMenuItemの内部クラスです。

    クラスMenuItemで宣言されたネストされたクラス/インタフェース

    MenuItem.AccessibleAWTMenuItem
    修飾子と型
    クラス
    説明
    protected class 
    MenuItem.AccessibleAWTMenuItem
    アクセシビリティのデフォルト・サポートを提供するために使用されるMenuItemの内部クラスです。

    クラスMenuComponentで宣言されたネストされたクラス/インタフェース

    MenuComponent.AccessibleAWTMenuComponent
    修飾子と型
    クラス
    説明
    protected class 
    MenuComponent.AccessibleAWTMenuComponent
    アクセシビリティのデフォルト・サポートを提供するために使用されるMenuComponentの内部クラスです。

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

    コンストラクタ
    コンストラクタ
    説明
    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)
    このチェック・ボックス・メニュー項目を指定された状態に設定します。

    クラスで宣言されたメソッド MenuItem

    addActionListener, deleteShortcut, disable, disableEvents, enable, enable, enableEvents, getActionCommand, getActionListeners, getLabel, getShortcut, isEnabled, processActionEvent, removeActionListener, setActionCommand, setEnabled, setLabel, setShortcut
    修飾子と型
    メソッド
    説明
    void
    addActionListener(ActionListener l)
    このメニュー項目からアクション・イベントを受け取るために、指定されたアクション・リスナーを追加します。
    void
    deleteShortcut()
    このメニュー項目に関連付けられたMenuShortcutオブジェクトをすべて削除します。
    void
    disable()
    非推奨。
    JDKバージョン1.1で、setEnabled(boolean)に置き換えられています。
    protected final void
    disableEvents(long eventsToDisable)
    指定されたイベント・マスク・パラメータで定義するイベントについて、このメニュー項目への送信を不可にします。
    void
    enable()
    非推奨。
    JDKバージョン1.1で、setEnabled(boolean)に置き換えられています。
    void
    enable(boolean b)
    非推奨。
    JDKバージョン1.1で、setEnabled(boolean)に置き換えられています。
    protected final void
    enableEvents(long eventsToEnable)
    指定されたイベント・マスク・パラメータで定義されるイベントについて、このメニュー項目への送信を可能にします。
    String
    getActionCommand()
    このメニュー項目によってトリガーされるアクション・イベントのコマンド名を返します。
    ActionListener[]
    getActionListeners()
    このメニュー項目に登録されたすべてのアクション・リスナーの配列を返します。
    String
    getLabel()
    このメニュー項目のラベルを返します。
    MenuShortcut
    getShortcut()
    このメニュー項目に関連付けられたMenuShortcutオブジェクトを取得します。
    boolean
    isEnabled()
    このメニュー項目が使用可能になっているかどうかを判定します。
    protected void
    processActionEvent(ActionEvent e)
    このメニュー項目で発生するアクション・イベントを、登録されているActionListenerオブジェクトにディスパッチすることによって処理します。
    void
    removeActionListener(ActionListener l)
    以後このメニュー項目からアクション・イベントを受け取らないように、指定されたアクション・リスナーを削除します。
    void
    setActionCommand(String command)
    このメニュー項目でトリガーされるアクション・イベントのコマンド名を設定します。
    void
    setEnabled(boolean b)
    このメニュー項目を選択可能にするかどうかを設定します。
    void
    setLabel(String label)
    このメニュー項目のラベルを指定されたラベルに設定します。
    void
    setShortcut(MenuShortcut s)
    このメニュー項目に関連付けられたMenuShortcutオブジェクトを設定します。

    クラスで宣言されたメソッド MenuComponent

    dispatchEvent, getFont, getName, getParent, getTreeLock, postEvent, removeNotify, setFont, setName, toString
    修飾子と型
    メソッド
    説明
    final void
    dispatchEvent(AWTEvent e)
    このコンポーネントまたはそのサブコンポーネントの1つにイベントを送ります。
    Font
    getFont()
    このメニュー・コンポーネントに使用するフォントを返します。
    String
    getName()
    メニュー・コンポーネントの名前を返します。
    MenuContainer
    getParent()
    このメニュー・コンポーネントの親コンテナを返します。
    protected final Object
    getTreeLock()
    AWTコンポーネント・ツリーおよびレイアウト操作に対する、このコンポーネントのロック・オブジェクト(スレッド同期化モニターを所有するオブジェクト)を取得します。
    boolean
    postEvent(Event evt)
    非推奨。
    JDKバージョン1.1で、dispatchEventに置き換えられています。
    void
    removeNotify()
    メニュー・コンポーネントのピアを削除します。
    void
    setFont(Font f)
    このメニュー・コンポーネントに使用するフォントを、指定されたフォントに設定します。
    void
    setName(String name)
    コンポーネントの名前を、指定された文字列に設定します。
    String
    toString()
    このメニュー・コンポーネントの表現を文字列として返します。

    クラスオブジェクトで宣言されたメソッド

    clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
    修飾子と型
    メソッド
    説明
    protected Object
    clone()
    このオブジェクトのコピーを作成して、返します。
    boolean
    equals(Object obj)
    このオブジェクトと他のオブジェクトが等しいかどうかを示します。
    protected void
    finalize()
    削除予定のため非推奨: このAPI要素は、将来のバージョンで削除される可能性があります。
    最終決定は非推奨であり、将来のリリースで削除される可能性があります。
    final Class<?>
    getClass()
    このObjectの実行時クラスを返します。
    int
    hashCode()
    このオブジェクトに対するハッシュ・コード値を返します。
    final void
    notify()
    このオブジェクトのモニターで待機中のスレッドを1つ再開します。
    final void
    notifyAll()
    このオブジェクトのモニターで待機中のすべてのスレッドを再開します。
    final void
    wait()
    現在のスレッドが目覚めるまで待機します。通常、notifiedまたはinterruptedです。
    final void
    wait(long timeoutMillis)
    現在のスレッドは、通常、notifiedまたはinterruptedであるか、一定のリアルタイムが経過するまで、目覚めるまで待機します。
    final void
    wait(long timeoutMillis, int nanos)
    現在のスレッドは、通常、notifiedまたはinterruptedであるか、一定のリアルタイムが経過するまで、目覚めるまで待機します。

  • コンストラクタの詳細

    • CheckboxMenuItem

      public CheckboxMenuItem() throws HeadlessException
      空のラベルが付いたチェックボックス・メニュー項目を生成します。 項目の初期状態は「オフ」に設定されます。
      スロー:
      HeadlessException - GraphicsEnvironment.isHeadless()がtrueを返す場合
      導入されたバージョン:
      1.1
      関連項目:

    • CheckboxMenuItem

      public CheckboxMenuItem(String label) throws HeadlessException
      指定されたラベルが付いたチェックボックス・メニュー項目を生成します。 項目の初期状態は「オフ」に設定されます。
      パラメータ:
      label - チェックボックス・メニュー項目の文字列ラベル、またはラベルが付いていないメニュー項目の場合はnull。
      スロー:
      HeadlessException - GraphicsEnvironment.isHeadless()がtrueを返す場合
      関連項目:

    • CheckboxMenuItem

      public CheckboxMenuItem(String label, boolean state) throws HeadlessException
      指定されたラベルが付いたチェックボックス・メニュー項目を、指定された状態で生成します。
      パラメータ:
      label - チェックボックス・メニュー項目の文字列ラベル、またはラベルが付いていないメニュー項目の場合はnull。
      state - メニュー項目の初期状態。trueは「オン」を、falseは「オフ」を示す
      スロー:
      HeadlessException - GraphicsEnvironment.isHeadless()がtrueを返す場合
      導入されたバージョン:
      1.1
      関連項目:

  • メソッドの詳細

    • addNotify

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

    • getState

      public boolean getState()
      このチェックボックス・メニュー項目の状態が「オン」であるか「オフ」であるかを判定します。
      戻り値:
      このチェックボックス・メニュー項目の状態。trueは「オン」を、falseは「オフ」を示す
      関連項目:

    • setState

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

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

      パラメータ:
      b - チェックボックス・メニュー項目が「オン」の場合はtrue、そうでない場合はfalse
      関連項目:

    • getSelectedObjects

      public Object[] getSelectedObjects()
      チェックボックス・メニュー・アイテム・ラベルを含む配列(長さ1)またはチェックボックスが選択されていない場合はnullを返します。
      定義:
      getSelectedObjects、インタフェースItemSelectable
      戻り値:
      選択したオブジェクトのリスト、またはnull
      関連項目:

    • addItemListener

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

      AWTスレッド・モデルの詳細は、「AWTのスレッドの問題」を参照してください。

      定義:
      addItemListener、インタフェースItemSelectable
      パラメータ:
      l - 項目リスナー
      導入されたバージョン:
      1.1
      関連項目:

    • removeItemListener

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

      AWTスレッド・モデルの詳細は、「AWTのスレッドの問題」を参照してください。

      定義:
      removeItemListener、インタフェースItemSelectable
      パラメータ:
      l - 項目リスナー
      導入されたバージョン:
      1.1
      関連項目:

    • getItemListeners

      public ItemListener[] getItemListeners()
      このチェックボックス・メニュー項目に登録されているすべての項目リスナーの配列を返します。
      戻り値:
      このチェックボックス・メニュー項目のすべてのItemListener。項目リスナーが現在登録されていない場合は空の配列
      導入されたバージョン:
      1.4
      関連項目:

    • 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
      型パラメータ:
      T - リスナーの型
      パラメータ:
      listenerType - 要求されるリスナーの型; java.util.EventListenerの下位インタフェースを指定
      戻り値:
      このチェックボックス・メニュー項目上でFooListenerとして登録されたすべてのオブジェクトの配列、またはこのようなリスナーが登録されていない場合は空の配列
      スロー:
      ClassCastException - listenerTypeで、java.util.EventListenerを実装するクラスまたはインタフェースが指定されなかった場合
      導入されたバージョン:
      1.3
      関連項目:

    • processEvent

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

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

      イベント・パラメータがnullである場合は、動作が未指定のため、例外が発生する可能性があります。

      オーバーライド:
      processEvent、クラスMenuItem
      パラメータ:
      e - イベント
      導入されたバージョン:
      1.1
      関連項目:

    • processItemEvent

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

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

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

      イベント・パラメータがnullである場合は、動作が未指定のため、例外が発生する可能性があります。

      パラメータ:
      e - 項目イベント
      導入されたバージョン:
      1.1
      関連項目:

    • 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