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

インタフェースKeymap

public interface Keymap
アクションに対するキー・ストローク割当てのコレクションです。 この割当ては、基本的に名前と値のペアで構成され、潜在的に階層で解釈処理されます。

  • メソッドのサマリー

    修飾子と型 メソッド 説明
    void addActionForKeyStroke​(KeyStroke key, Action a)
    キーマップに割り当てを追加します。
    Action getAction​(KeyStroke key)
    指定されたシンボリック・イベント・シーケンスに適切なアクションを取得します。
    Action[] getBoundActions()
    このキーマップで定義されているアクションのすべてを取得します。
    KeyStroke[] getBoundKeyStrokes()
    特定のアクションに割り当てられているこのマップ内のキー・ストロークをすべて取得します。
    Action getDefaultAction()
    キーが入力されて(つまり、KEY_TYPEDキー・イベントが受信されて)その割当てがない場合に発生するデフォルトのアクションを取得します。
    KeyStroke[] getKeyStrokesForAction​(Action a)
    指定されたアクションを発生させるキー・ストロークを取得します。
    String getName()
    キー割当てのセット名を取得します。
    Keymap getResolveParent()
    キー割り当てを解釈処理するために使用する親キーマップを取得します。
    boolean isLocallyDefined​(KeyStroke key)
    指定されたキー・シーケンスがローカルに定義されているかどうかを判定します。
    void removeBindings()
    キーマップからすべての割り当てを削除します。
    void removeKeyStrokeBinding​(KeyStroke keys)
    キーマップから割り当てを削除します。
    void setDefaultAction​(Action a)
    キーが入力された場合に発生するデフォルト・アクションを設定します。
    void setResolveParent​(Keymap parent)
    親キーマップを設定します。これは、キー割り当てを解釈処理するために使われます。

  • メソッドの詳細

    • getName

      String getName()
      キー割当てのセット名を取得します。
      戻り値:
      名前

    • getDefaultAction

      Action getDefaultAction()
      キーが入力されて(つまり、KEY_TYPEDキー・イベントが受信されて)その割当てがない場合に発生するデフォルトのアクションを取得します。 一般的に、これはテキストを挿入するアクションなので、キーマップは可能なキーのそれぞれにアクションを要求しません。
      戻り値:
      デフォルトのアクション

    • setDefaultAction

      void setDefaultAction​(Action a)
      キーが入力された場合に発生するデフォルト・アクションを設定します。
      パラメータ:
      a - アクション

    • getAction

      Action getAction​(KeyStroke key)
      指定されたシンボリック・イベント・シーケンスに適切なアクションを取得します。 JTextControllerはこれを使って、キー・シーケンスの解釈方法を指定します。 割当てがローカルに解釈処理されない場合に親キーマップが設定されていれば、それを解釈処理するように試みます。
      パラメータ:
      key - キー・シーケンス
      戻り値:
      キー・シーケンスが定義されている場合はそれに関連したアクション、そうでない場合はnull

    • getBoundKeyStrokes

      KeyStroke[] getBoundKeyStrokes()
      特定のアクションに割り当てられているこのマップ内のキー・ストロークをすべて取得します。
      戻り値:
      キー・ストロークのリスト

    • getBoundActions

      Action[] getBoundActions()
      このキーマップで定義されているアクションのすべてを取得します。
      戻り値:
      アクションのリスト

    • getKeyStrokesForAction

      KeyStroke[] getKeyStrokesForAction​(Action a)
      指定されたアクションを発生させるキー・ストロークを取得します。
      パラメータ:
      a - アクション
      戻り値:
      キー・ストロークのリスト

    • isLocallyDefined

      boolean isLocallyDefined​(KeyStroke key)
      指定されたキー・シーケンスがローカルに定義されているかどうかを判定します。
      パラメータ:
      key - キー・シーケンス
      戻り値:
      キー・シーケンスがローカルに定義されている場合はtrue、そうでない場合はfalse

    • addActionForKeyStroke

      void addActionForKeyStroke​(KeyStroke key, Action a)
      キーマップに割り当てを追加します。
      パラメータ:
      key - キー・シーケンス
      a - アクション

    • removeKeyStrokeBinding

      void removeKeyStrokeBinding​(KeyStroke keys)
      キーマップから割り当てを削除します。
      パラメータ:
      keys - キー・シーケンス

    • removeBindings

      void removeBindings()
      キーマップからすべての割り当てを削除します。

    • getResolveParent

      Keymap getResolveParent()
      キー割り当てを解釈処理するために使用する親キーマップを取得します。
      戻り値:
      キーマップ

    • setResolveParent

      void setResolveParent​(Keymap parent)
      親キーマップを設定します。これは、キー割り当てを解釈処理するために使われます。 Keymapがそれ自身を解釈処理の親の1つとして持つ場合、動作は指定されていません。
      パラメータ:
      parent - 親キーマップ