モジュール java.desktop
パッケージ java.awt

クラスCheckbox

  • すべての実装されたインタフェース:
    ImageObserver, ItemSelectable, MenuContainer, Serializable, Accessible
    public class Checkbox
extends Component
implements ItemSelectable, Accessible
    チェックボックスは、「オン」(true)または「オフ」(false)のどちらかの状態になることができるグラフィカル・コンポーネントです。 チェックボックスをクリックすると、その状態を「オン」から「オフ」に、または「オフ」から「オン」に変更できます。

    次のコード例では、グリッド・レイアウトにチェックボックスのセットを生成します。 

     setLayout(new GridLayout(3, 1));
 add(new Checkbox("one", null, true));
 add(new Checkbox("two"));
 add(new Checkbox("three"));

    このイメージは、このコード例によって作成されるチェックボックスとグリッド・レイアウトを表します。

    次のコンテキストで図を説明する

    oneというラベルの付いたボタンは「オン」の状態で、ほかの2つのボタンは「オフ」の状態です。 GridLayoutクラスを使用するこの例では、3つのチェックボックスの状態がそれぞれ独立して設定されます。

    また、CheckboxGroupクラスを使って、いくつかのチェックボックスをグループ化して1つのオブジェクトで制御することもできます。 チェックボックス・グループでは、一度に1つのボタンだけを「オン」の状態にできます。 1つのチェックボックスをクリックしてオンにすると、同一グループ内のほかのチェックボックスは「オフ」の状態になります。

    導入されたバージョン:
    1.0
    関連項目:
    GridLayout, CheckboxGroup, 直列化された形式

    • コンストラクタの詳細

      • Checkbox

        public Checkbox()
         throws HeadlessException
        そのラベルが空の文字列のチェックボックスを作成します。 このチェックボックスの状態は「オフ」に設定され、チェックボックス・グループには属しません。
        例外:
        HeadlessException - GraphicsEnvironment.isHeadless()がtrueを返す場合
        関連項目:
        GraphicsEnvironment.isHeadless()

      • Checkbox

        public Checkbox​(String label)
         throws HeadlessException
        指定されたラベルが付いたチェックボックスを作成します。 このチェックボックスの状態は「オフ」に設定され、チェックボックス・グループには属しません。
        パラメータ:
        label - このチェックボックスの文字列ラベル、またはラベルがない場合はnull。
        例外:
        HeadlessException - GraphicsEnvironment.isHeadlessがtrueを返す場合
        関連項目:
        GraphicsEnvironment.isHeadless()

      • Checkbox

        public Checkbox​(String label,
                boolean state)
         throws HeadlessException
        指定されたラベルが付いたチェックボックスを作成し、指定された状態に設定します。 このチェックボックスは、どのチェックボックス・グループにも属しません。
        パラメータ:
        label - このチェックボックスの文字列ラベル。ラベルがない場合はnull
        state - このチェックボックスの初期状態
        例外:
        HeadlessException - GraphicsEnvironment.isHeadlessがtrueを返す場合
        関連項目:
        GraphicsEnvironment.isHeadless()

      • Checkbox

        public Checkbox​(String label,
                boolean state,
                CheckboxGroup group)
         throws HeadlessException
        指定されたラベルが付いたチェックボックスを、指定されたチェックボックス・グループに構築し、指定された状態に設定します。
        パラメータ:
        label - このチェックボックスの文字列ラベル、またはラベルがない場合はnull。
        state - このチェックボックスの初期状態。
        group - このチェックボックスのチェックボックス・グループ、またはグループがない場合はnull。
        例外:
        HeadlessException - GraphicsEnvironment.isHeadlessがtrueを返す場合
        導入されたバージョン:
        1.1
        関連項目:
        GraphicsEnvironment.isHeadless()

      • Checkbox

        public Checkbox​(String label,
                CheckboxGroup group,
                boolean state)
         throws HeadlessException
        指定されたラベルが付いたチェックボックスを、指定されたチェックボックス・グループに生成し、指定された状態に設定します。
        パラメータ:
        label - このチェックボックスの文字列ラベル、またはラベルがない場合はnull。
        group - このチェックボックスのチェックボックス・グループ、またはグループがない場合はnull。
        state - このチェックボックスの初期状態。
        例外:
        HeadlessException - GraphicsEnvironment.isHeadlessがtrueを返す場合
        導入されたバージョン:
        1.1
        関連項目:
        GraphicsEnvironment.isHeadless()

    • メソッドの詳細

      • addNotify

        public void addNotify()
        チェックボックスのピアを生成します。 これにより、チェックボックスの機能を変更することなく、その外観を変更することが可能になります。
        オーバーライド:
        addNotify、クラス: Component
        関連項目:
        Component.getToolkit()

      • getLabel

        public String getLabel()
        チェックボックスのラベルを取得します。
        戻り値:
        このチェックボックスのラベル。このチェックボックスにラベルがない場合はnull
        関連項目:
        setLabel(String)

      • setLabel

        public void setLabel​(String label)
        このチェックボックスのラベルを文字列引数に設定します。
        パラメータ:
        label - 新しいラベルとして設定する文字列。ラベルがない場合はnull
        関連項目:
        getLabel()

      • getState

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

      • setState

        public void setState​(boolean state)
        このチェックボックスの状態を、指定された状態に設定します。 boolean値trueは「オン」状態を示し、falseは「オフ」状態を示します。

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

        パラメータ:
        state - boolean値で表したチェックボックスの状態
        関連項目:
        getState()

      • getSelectedObjects

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

      • getCheckboxGroup

        public CheckboxGroup getCheckboxGroup()
        このチェックボックスのグループを判定します。
        戻り値:
        このチェックボックスのグループ。チェックボックスがグループに属さない場合はnull
        関連項目:
        setCheckboxGroup(CheckboxGroup)

      • setCheckboxGroup

        public void setCheckboxGroup​(CheckboxGroup g)
        このチェックボックスのグループを、指定されたチェックボックス・グループに設定します。 このチェックボックスがすでにほかのチェックボックス・グループにある場合は、最初にそのグループから削除されます。

        このチェックボックスの状態がtrueで、新しいグループのチェックボックスがすでに選択されている場合、このチェックボックスの状態がfalseに変更されます。 このチェックボックスの状態がtrueで、新しいグループのチェックボックスが選択されていない場合、このチェックボックスは新しいグループの選択されたチェックボックスになり、その状態はtrueです。

        パラメータ:
        g - 新しいチェックボックス・グループ。チェック・ボックス・グループからこのチェックボックスを削除する場合はnull
        関連項目:
        getCheckboxGroup()

      • getListeners

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

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

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

        オーバーライド:
        getListeners、クラス: Component
        型パラメータ:
        T - リスナーの型
        パラメータ:
        listenerType - 要求されるリスナーの型。java.util.EventListenerの子孫のインタフェースを指定してください
        戻り値:
        このチェックボックス上でFooListenerとして登録されたすべてのオブジェクトの配列、またはこのようなリスナーが登録されていない場合は空の配列
        例外:
        ClassCastException - listenerTypeで、java.util.EventListenerを実装するクラスまたはインタフェースが指定されなかった場合
        導入されたバージョン:
        1.3
        関連項目:
        getItemListeners()

      • processEvent

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

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

        オーバーライド:
        processEvent、クラス: Component
        パラメータ:
        e - イベント
        導入されたバージョン:
        1.1
        関連項目:
        ItemEvent, processItemEvent(java.awt.event.ItemEvent)

      • processItemEvent

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

        項目イベントがこのコンポーネント用に使用可能になっていないかぎり、このメソッドは呼び出されません。 項目イベントは、次の項目の1つが発生したときに使用可能になります。

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

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

        パラメータ:
        e - 項目イベント
        導入されたバージョン:
        1.1
        関連項目:
        ItemEvent, ItemListener, addItemListener(java.awt.event.ItemListener), Component.enableEvents(long)

      • paramString

        protected String paramString()
        このCheckboxの状態を表す文字列を返します。 このメソッドはデバッグ専用であり、返される文字列の内容および形式は実装によって異なる場合があります。 返される文字列は空の場合がありますが、nullにはなりません。
        オーバーライド:
        paramString、クラス: Component
        戻り値:
        このチェックボックスのパラメータ文字列

      • getAccessibleContext

        public AccessibleContext getAccessibleContext()
        このCheckBoxに関連付けられたAccessibleContextを取得します。 チェックボックスの場合、AccessibleContextはAccessibleAWTCheckboxの形式を取ります。 必要に応じて新規のAccessibleAWTCheckboxが生成されます。
        定義:
        getAccessibleContext、インタフェース: Accessible
        オーバーライド:
        getAccessibleContext、クラス: Component
        戻り値:
        このCheckboxのAccessibleContextとして機能するAccessibleAWTCheckbox
        導入されたバージョン:
        1.3