モジュール java.desktop
パッケージ javax.swing

インタフェースButtonModel

すべてのスーパー・インタフェース:
ItemSelectable
既知のすべての実装クラス:
DefaultButtonModel, JToggleButton.ToggleButtonModel
public interface ButtonModel extends ItemSelectable
ボタンの状態モデルです。

このモデルは、チェックボックスやラジオ・ボタンなどの特殊なボタンにも、通常のボタンにも同様に使用します。 あとで説明しますが、実際に状態を管理するためにモデル上でメソッドを呼び出すのは、ボタンのUIです。

簡単に言うと、通常のボタンの上でマウス・ボタンを押して指を離すと、ボタンがトリガーされ、ActionEventがトリガーされます。 ボタンのルック・アンド・フィールによって定義されているキーボード・キー(典型例はスペース・バー)でも、同じ動作を行えます。 ボタンがフォーカスされた状態でこのキーを押して指を離すと、同じ結果になります。 チェックボックスとラジオ・ボタンの場合、ここで説明したようなマウスまたはキーボードの操作で、ボタンが選択されます。

詳しく述べると、ボタンの状態モデルは、マウスで使用した場合に、次のように動作します。
ボタンの上でマウスを押すと、モデルが作動準備完了で押下状態になります。 マウスが押された状態であるかぎり、マウスをボタンの外側に移動しても、モデルは押下状態のままになります。 逆に、ボタンの境界内でマウスを押下状態のままにしている間のみ、モデルが作動準備完了になります(ボタンの中や外に移動できますが、モデルはボタン内で費やされた時間の部分の間だけ作動準備完了になります)。 モデルが作動準備完了状態の間にマウスが離される、つまり、マウスがそのボタンの上で以前に押されていた(およびまだ離されていない)後に、ボタンの上でマウスが離されると、ボタンがトリガーされ、ActionEventが起動されます。 マウスが離されると、モデルの作動準備が解除され、押下されていない状態になります。

詳しく述べると、ボタンの状態モデルは、キーボードで使用した場合に、次のように動作します。
ボタンがフォーカスされている間に、ルック・アンド・フィール定義のキーボード・キーを押すと、モデルが作動準備完了で押下状態になります。 このキーが押されたままであるかぎり、モデルはこの状態のままになります。 キーを離すと、モデルが作動準備解除され、押下されていない状態に設定され、ボタンがトリガーされて、ActionEventが起動されます。

導入されたバージョン:
1.2

  • メソッドのサマリー

    修飾子と型
    メソッド
    説明
    void
    addActionListener​(ActionListener l)
    モデルにActionListenerを追加します。
    void
    addChangeListener​(ChangeListener l)
    モデルにChangeListenerを追加します。
    void
    addItemListener​(ItemListener l)
    モデルにItemListenerを追加します。
    String
    getActionCommand()
    ボタンのアクション・コマンド文字列を返します。
    default ButtonGroup
    getGroup()
    ボタンが属するグループを返します。
    int
    getMnemonic()
    ボタンのキーボード・ニーモニックを返します。
    boolean
    isArmed()
    ボタンが作動準備状態であることを示します。
    boolean
    isEnabled()
    マウス・ポインタなどの入力デバイスで、ボタンを選択したり、トリガーしたりできるかどうかを示します。
    boolean
    isPressed()
    ボタンが押されているかどうかを示します。
    boolean
    isRollover()
    マウス・ポインタがボタンの上にあるかどうかを示します。
    boolean
    isSelected()
    ボタンが選択されているかどうかを示します。
    void
    removeActionListener​(ActionListener l)
    モデルからActionListenerを削除します。
    void
    removeChangeListener​(ChangeListener l)
    モデルからChangeListenerを削除します。
    void
    removeItemListener​(ItemListener l)
    モデルからItemListenerを削除します。
    void
    setActionCommand​(String s)
    ボタンがトリガーされたときにActionEventの一部として送られるアクション・コマンド文字列を設定します。
    void
    setArmed​(boolean b)
    ボタンを作動準備状態または作動準備が解除された状態としてマークします。
    void
    setEnabled​(boolean b)
    ボタンを有効または無効にします。
    void
    setGroup​(ButtonGroup group)
    ボタンが属するグループを識別します。これは、グループ内で排他的な選択をするラジオ・ボタンに必要です。
    void
    setMnemonic​(int key)
    ボタンのキーボード・ニーモニック(ショートカット・キーまたはアクセラレータ・キー)を設定します。
    void
    setPressed​(boolean b)
    ボタンを押された状態または押されていない状態に設定します。
    void
    setRollover​(boolean b)
    ボタンのロールオーバー状態を設定またはクリアします。
    void
    setSelected​(boolean b)
    ボタンを選択または選択解除します。

    インタフェース java.awt.ItemSelectableで宣言されたメソッド

    getSelectedObjects

  • メソッドの詳細

    • isArmed

      boolean isArmed()
      ボタンが作動準備状態であることを示します。
      戻り値:
      ボタンが作動準備状態で、トリガーされる準備ができている場合はtrue
      関連項目:
      setArmed(boolean)

    • isSelected

      boolean isSelected()
      ボタンが選択されているかどうかを示します。 ラジオ・ボタンやチェックボックスなどの特定の種類のボタンにだけ必要です。
      戻り値:
      ボタンが選択されている場合はtrue

    • isEnabled

      boolean isEnabled()
      マウス・ポインタなどの入力デバイスで、ボタンを選択したり、トリガーしたりできるかどうかを示します。
      戻り値:
      ボタンが有効な場合はtrue

    • isPressed

      boolean isPressed()
      ボタンが押されているかどうかを示します。
      戻り値:
      ボタンが押されている場合はtrue

    • isRollover

      boolean isRollover()
      マウス・ポインタがボタンの上にあるかどうかを示します。
      戻り値:
      マウス・ポインタがボタンの上にある場合はtrue

    • setArmed

      void setArmed​(boolean b)
      ボタンを作動準備状態または作動準備が解除された状態としてマークします。
      パラメータ:
      b - ボタンを作動準備状態にするかどうか

    • setSelected

      void setSelected​(boolean b)
      ボタンを選択または選択解除します。
      パラメータ:
      b - ボタンを選択する場合はtrue、選択を解除する場合はfalse

    • setEnabled

      void setEnabled​(boolean b)
      ボタンを有効または無効にします。
      パラメータ:
      b - ボタンを有効にするかどうか
      関連項目:
      isEnabled()

    • setPressed

      void setPressed​(boolean b)
      ボタンを押された状態または押されていない状態に設定します。
      パラメータ:
      b - ボタンを押された状態にするかどうか
      関連項目:
      isPressed()

    • setRollover

      void setRollover​(boolean b)
      ボタンのロールオーバー状態を設定またはクリアします。
      パラメータ:
      b - ボタンがロールオーバー状態かどうか
      関連項目:
      isRollover()

    • setMnemonic

      void setMnemonic​(int key)
      ボタンのキーボード・ニーモニック(ショートカット・キーまたはアクセラレータ・キー)を設定します。
      パラメータ:
      key - アクセラレータ・キーを指定する整数値

    • getMnemonic

      int getMnemonic()
      ボタンのキーボード・ニーモニックを返します。
      戻り値:
      アクセラレータ・キーを指定する整数値
      関連項目:
      setMnemonic(int)

    • setActionCommand

      void setActionCommand​(String s)
      ボタンがトリガーされたときにActionEventの一部として送られるアクション・コマンド文字列を設定します。
      パラメータ:
      s - 生成したイベントを識別するString
      関連項目:
      getActionCommand(), ActionEvent.getActionCommand()

    • getActionCommand

      String getActionCommand()
      ボタンのアクション・コマンド文字列を返します。
      戻り値:
      生成したイベントを識別するString
      関連項目:
      setActionCommand(java.lang.String)

    • setGroup

      void setGroup​(ButtonGroup group)
      ボタンが属するグループを識別します。これは、グループ内で排他的な選択をするラジオ・ボタンに必要です。
      パラメータ:
      group - ボタンが属するButtonGroup

    • getGroup

      default ButtonGroup getGroup()
      ボタンが属するグループを返します。 通常、グループ内で排他的に選択されるラジオ・ボタンで使用されます。
      実装要件:
      このメソッドのデフォルト実装はnullを返します。 サブクラスは、setGroup()によって設定されたグループを返す必要があります。
      戻り値:
      ボタンが属するButtonGroup
      導入されたバージョン:
      10

    • addActionListener

      void addActionListener​(ActionListener l)
      モデルにActionListenerを追加します。
      パラメータ:
      l - 追加するリスナー

    • removeActionListener

      void removeActionListener​(ActionListener l)
      モデルからActionListenerを削除します。
      パラメータ:
      l - 削除するリスナー

    • addItemListener

      void addItemListener​(ItemListener l)
      モデルにItemListenerを追加します。
      定義:
      addItemListener 、インタフェース: ItemSelectable
      パラメータ:
      l - 追加するリスナー
      関連項目:
      ItemEvent

    • removeItemListener

      void removeItemListener​(ItemListener l)
      モデルからItemListenerを削除します。
      定義:
      removeItemListener 、インタフェース: ItemSelectable
      パラメータ:
      l - 削除するリスナー
      関連項目:
      ItemEvent

    • addChangeListener

      void addChangeListener​(ChangeListener l)
      モデルにChangeListenerを追加します。
      パラメータ:
      l - 追加するリスナー

    • removeChangeListener

      void removeChangeListener​(ChangeListener l)
      モデルからChangeListenerを削除します。
      パラメータ:
      l - 削除するリスナー