Package Summary  Overview Summary

class:Keymap [NONE]


public interface Keymap
A collection of bindings of KeyStrokes to actions. The bindings are basically name-value pairs that potentially resolve in a hierarchy.

method:getName() [NONE]

  • getName

    String getName()
    Fetches the name of the set of key-bindings.
    Returns:
    the name
  • method:getDefaultAction() [NONE]

    getDefaultAction

    Action getDefaultAction()
    Fetches the default action to fire if a key is typed (i.e. a KEY_TYPED KeyEvent is received) and there is no binding for it. Typically this would be some action that inserts text so that the keymap doesn't require an action for each possible key.
    Returns:
    the default action

    method:setDefaultAction(javax.swing.Action) [NONE]

    setDefaultAction

    void setDefaultAction?(Action a)
    Set the default action to fire if a key is typed.
    Parameters:
    a - the action

    method:getAction(javax.swing.KeyStroke) [NONE]

    getAction

    Action getAction?(KeyStroke key)
    Fetches the action appropriate for the given symbolic event sequence. This is used by JTextController to determine how to interpret key sequences. If the binding is not resolved locally, an attempt is made to resolve through the parent keymap, if one is set.
    Parameters:
    key - the key sequence
    Returns:
    the action associated with the key sequence if one is defined, otherwise null

    method:getBoundKeyStrokes() [NONE]

    getBoundKeyStrokes

    KeyStroke[] getBoundKeyStrokes()
    Fetches all of the keystrokes in this map that are bound to some action.
    Returns:
    the list of keystrokes

    method:getBoundActions() [NONE]

    getBoundActions

    Action[] getBoundActions()
    Fetches all of the actions defined in this keymap.
    Returns:
    the list of actions

    method:getKeyStrokesForAction(javax.swing.Action) [NONE]

    getKeyStrokesForAction

    KeyStroke[] getKeyStrokesForAction?(Action a)
    Fetches the keystrokes that will result in the given action.
    Parameters:
    a - the action
    Returns:
    the list of keystrokes

    method:isLocallyDefined(javax.swing.KeyStroke) [NONE]

    isLocallyDefined

    boolean isLocallyDefined?(KeyStroke key)
    Determines if the given key sequence is locally defined.
    Parameters:
    key - the key sequence
    Returns:
    true if the key sequence is locally defined else false

    method:addActionForKeyStroke(javax.swing.KeyStroke,javax.swing.Action) [NONE]

    addActionForKeyStroke

    void addActionForKeyStroke?(KeyStroke key, Action a)
    Adds a binding to the keymap.
    Parameters:
    key - the key sequence
    a - the action

    method:removeKeyStrokeBinding(javax.swing.KeyStroke) [NONE]

    removeKeyStrokeBinding

    void removeKeyStrokeBinding?(KeyStroke keys)
    Removes a binding from the keymap.
    Parameters:
    keys - the key sequence

    method:removeBindings() [NONE]

    removeBindings

    void removeBindings()
    Removes all bindings from the keymap.

    method:getResolveParent() [NONE]

    getResolveParent

    Keymap getResolveParent()
    Fetches the parent keymap used to resolve key-bindings.
    Returns:
    the keymap

    method:setResolveParent(javax.swing.text.Keymap) [NONE]

    setResolveParent

    void setResolveParent?(Keymap parent)
    Sets the parent keymap, which will be used to resolve key-bindings. The behavior is unspecified if a Keymap has itself as one of its resolve parents.
    Parameters:
    parent - the parent keymap

    © 2021 Oracle Corporation and/or its affiliates