Module org.autogui

Package org.autogui.swing

Class GuiSwingKeyBinding

java.lang.Object

org.autogui.swing.GuiSwingKeyBinding

public class GuiSwingKeyBinding
extends Object

a class for automatic key-stroke assignments. It relies on KeyboardFocusManager which can steel key-events globally.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	GuiSwingKeyBinding.KeyBindDispatcher
static interface	GuiSwingKeyBinding.KeyPrecedence
static class	GuiSwingKeyBinding.KeyPrecedenceDepth
static class	GuiSwingKeyBinding.KeyPrecedenceFlag
static class	GuiSwingKeyBinding.KeyPrecedenceSet	a set of key-precedence information: a key-precedence becomes a flag value (GuiSwingKeyBinding.KeyPrecedenceFlag which indicates the type of action, or a view-depth (GuiSwingKeyBinding.KeyPrecedenceDepth).
static class	GuiSwingKeyBinding.KeyStrokeAction
static class	GuiSwingKeyBinding.KeyStrokeActionForAction
static class	GuiSwingKeyBinding.KeyStrokeActionForComponent
static class	GuiSwingKeyBinding.KeyStrokeActionForFunction<CompType extends JComponent>
static class	GuiSwingKeyBinding.KeyStrokeActionForInputMap	a predefined key-binding by the component UI
static class	GuiSwingKeyBinding.KeyStrokeActionForValuePane
static interface	GuiSwingKeyBinding.RecommendedKeyStroke

Field Summary

Fields

Modifier and Type	Field	Description
protected List<GuiSwingKeyBinding.KeyStrokeAction>	assigned
protected Set<KeyStroke>	assignedKeys
protected GuiSwingKeyBinding.KeyBindDispatcher	dispatcher
protected Map<KeyStroke,Map<GuiSwingKeyBinding.KeyPrecedenceSet,List<GuiSwingKeyBinding.KeyStrokeAction>>>	keyToPrecToActions
static GuiSwingKeyBinding.KeyPrecedenceFlag	PRECEDENCE_FLAG_HIGH
static GuiSwingKeyBinding.KeyPrecedenceFlag	PRECEDENCE_FLAG_LIB_SPECIFIED
static GuiSwingKeyBinding.KeyPrecedenceFlag	PRECEDENCE_FLAG_USER_SPECIFIED	user specified a key-stroke by the GuiIncluded(keyStroke=...) annotation
static GuiSwingKeyBinding.KeyPrecedenceSet	PRECEDENCE_SET_INPUT_MAP
static int	PRECEDENCE_TYPE_DEPTH
static int	PRECEDENCE_TYPE_FLAG_HIGH
static int	PRECEDENCE_TYPE_FLAG_LIB_SPECIFIED
static int	PRECEDENCE_TYPE_FLAG_USER_SPECIFIED
protected List<BiConsumer<GuiSwingKeyBinding,Component>>	traverseFunctions

Constructor Summary

Constructors

Constructor	Description
GuiSwingKeyBinding()

Method Summary

Modifier and Type	Method	Description
GuiSwingKeyBinding	addDefaultExcluded()
GuiSwingKeyBinding	addDefaultExcludedKey(int k, int mod)
GuiSwingKeyBinding	addKeyBindingForComponentTree(Component c)
GuiSwingKeyBinding	addTraverseFunction(BiConsumer<GuiSwingKeyBinding,Component> f)
GuiSwingKeyBinding	addTraverseFunctionDefault()
void	assign()
void	bind(JComponent component)
boolean	bind(KeyStroke key, Map<GuiSwingKeyBinding.KeyPrecedenceSet,List<GuiSwingKeyBinding.KeyStrokeAction>> precToActions)
static boolean	checkMenuModifiersMask(int constKey, int testedMods)
static KeyStroke	copyWithModifiers(KeyStroke stroke, int mod)
static GuiSwingKeyBinding	createWithDefaultExcluded()
static GuiSwingKeyBinding	createWithoutAutomaticBindings()
List<GuiSwingKeyBinding.KeyStrokeAction>	getAssigned()
List<GuiSwingKeyBinding.KeyStrokeAction>	getAssignedFromDispatcher()
GuiSwingKeyBinding.KeyBindDispatcher	getDispatcher()
static KeyStroke	getKeyStroke(String key)
GuiSwingKeyBinding	putForComponentInputMap(JComponent c)
GuiSwingKeyBinding	putForComponentInputMap(JComponent c, int depth)
GuiSwingKeyBinding	putForValuePane(GuiSwingView.ValuePane<?> pane, int depth)
<CompType extends JComponent> GuiSwingKeyBinding	putHighPrecedence(CompType c, KeyStroke keyStroke, Consumer<CompType> f)
GuiSwingKeyBinding	putHighPrecedenceAction(JComponent c, KeyStroke keyStroke, Action action)
GuiSwingKeyBinding	putHighPrecedencePaneFocus(JComponent c, KeyStroke keyStroke)
boolean	putItem(GuiSwingView.ValuePane<?> pane, int depth, PopupCategorized.CategorizedMenuItem item)
boolean	putItemRecommended(GuiSwingView.ValuePane<?> pane, int depth, GuiSwingKeyBinding.RecommendedKeyStroke item)
GuiSwingKeyBinding	putKeyStroke(GuiSwingKeyBinding.KeyStrokeAction item)
boolean	putKeyStroke(GuiSwingView.ValuePane<?> pane, int depth, PopupCategorized.CategorizedMenuItem i, Action item)
boolean	putKeyStrokeFocus(GuiSwingView.ValuePane<?> pane, int depth, KeyStroke stroke)
<T extends Component> GuiSwingKeyBinding	putTraverse(Class<T> type, Predicate<T> predicate, BiConsumer<GuiSwingKeyBinding,T> put)	append a traversal function for setting key-strokes for a specified component by a given function.
<CompType extends JComponent> GuiSwingKeyBinding	putTraverseHighPrecedence(Class<CompType> type, Predicate<CompType> predicate, KeyStroke keyStroke, Consumer<CompType> f)	append a traversal function for setting a function with a key-stroke for a specific component.
<CompType extends JComponent> GuiSwingKeyBinding	putTraverseHighPrecedenceAction(Class<CompType> type, Predicate<CompType> predicate, KeyStroke keyStroke, Action action)	append a traversal function for setting an action with a key-stroke for a specific component.
<CompType extends JComponent> GuiSwingKeyBinding	putTraverseHighPrecedencePaneFocus(Class<CompType> type, Predicate<CompType> predicate, KeyStroke keyStroke)	append a traversal function for setting focus action with a key-stroke for a specific component.
void	setDispatcher()	Deprecated.
void	setDispatcher(JComponent component)
GuiSwingKeyBinding	traverseKeyBinding(Component c, int depth)
void	unbind()	Deprecated.
void	unbind(JComponent component)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details

traverseFunctions

protected List<BiConsumer<GuiSwingKeyBinding,Component>> traverseFunctions

keyToPrecToActions

protected Map<KeyStroke,Map<GuiSwingKeyBinding.KeyPrecedenceSet,List<GuiSwingKeyBinding.KeyStrokeAction>>> keyToPrecToActions

assigned

protected List<GuiSwingKeyBinding.KeyStrokeAction> assigned

assignedKeys

protected Set<KeyStroke> assignedKeys

dispatcher

protected GuiSwingKeyBinding.KeyBindDispatcher dispatcher

PRECEDENCE_TYPE_FLAG_HIGH

public static int PRECEDENCE_TYPE_FLAG_HIGH

PRECEDENCE_TYPE_FLAG_USER_SPECIFIED

public static int PRECEDENCE_TYPE_FLAG_USER_SPECIFIED

PRECEDENCE_TYPE_DEPTH

public static int PRECEDENCE_TYPE_DEPTH

PRECEDENCE_TYPE_FLAG_LIB_SPECIFIED

public static int PRECEDENCE_TYPE_FLAG_LIB_SPECIFIED

PRECEDENCE_FLAG_HIGH

public static GuiSwingKeyBinding.KeyPrecedenceFlag PRECEDENCE_FLAG_HIGH

PRECEDENCE_FLAG_USER_SPECIFIED

public static GuiSwingKeyBinding.KeyPrecedenceFlag PRECEDENCE_FLAG_USER_SPECIFIED

user specified a key-stroke by the GuiIncluded(keyStroke=...) annotation

PRECEDENCE_FLAG_LIB_SPECIFIED

public static GuiSwingKeyBinding.KeyPrecedenceFlag PRECEDENCE_FLAG_LIB_SPECIFIED

PRECEDENCE_SET_INPUT_MAP

public static GuiSwingKeyBinding.KeyPrecedenceSet PRECEDENCE_SET_INPUT_MAP

Constructor Details

GuiSwingKeyBinding

public GuiSwingKeyBinding()

Method Details

createWithDefaultExcluded

public static GuiSwingKeyBinding createWithDefaultExcluded()

Returns:

a default key-binding with excluding some keys by addDefaultExcluded() and with default traversing function by addTraverseFunctionDefault().

createWithoutAutomaticBindings

public static GuiSwingKeyBinding createWithoutAutomaticBindings()

Returns:

a key-binding without automatic traversing and bindings

putTraverseHighPrecedencePaneFocus

public <CompType extends JComponent>
GuiSwingKeyBinding putTraverseHighPrecedencePaneFocus(Class<CompType> type,
 Predicate<CompType> predicate,
 KeyStroke keyStroke)

append a traversal function for setting focus action with a key-stroke for a specific component.

     GuiSwingKeyBinding.createWithoutAutomaticBindings()
        .putTraverseHighPrecedencePaneFocus(ValuePane.class, vp -> vp.getSwingViewContext().getName().equals("prop"),
                    GuiSwingKeyBinding.getKeyStroke("shift X"))
 

Type Parameters:

CompType - the component type

Parameters:

type - the component type

predicate - predicate for specifying the component

keyStroke - the key-stroke for focusing

Returns:

this

putTraverseHighPrecedenceAction

public <CompType extends JComponent>
GuiSwingKeyBinding putTraverseHighPrecedenceAction(Class<CompType> type,
 Predicate<CompType> predicate,
 KeyStroke keyStroke,
 Action action)

append a traversal function for setting an action with a key-stroke for a specific component.

     GuiSwingKeyBinding.createWithoutAutomaticBindings()
        .putTraverseHighPrecedenceAction(ValuePane.class, vp -> vp.getSwingViewContext().getName().equals("prop"),
                    GuiSwingKeyBinding.getKeyStroke("shift X"), action)
 

Type Parameters:

CompType - the component type

Parameters:

type - the component type

predicate - predicate for specifying the component

keyStroke - the key-stroke for the action

action - the action executed by the key-stroke

Returns:

this

putTraverseHighPrecedence

public <CompType extends JComponent>
GuiSwingKeyBinding putTraverseHighPrecedence(Class<CompType> type,
 Predicate<CompType> predicate,
 KeyStroke keyStroke,
 Consumer<CompType> f)

append a traversal function for setting a function with a key-stroke for a specific component.

     GuiSwingKeyBinding.createWithoutAutomaticBindings()
        .putTraverseHighPrecedence(ValuePane.class, vp -> vp.getSwingViewContext().getName().equals("prop"),
                    GuiSwingKeyBinding.getKeyStroke("shift X"), comp -> System.out.println(comp))
 

Type Parameters:

CompType - the component type

Parameters:

type - the component type

predicate - predicate for specifying the component

keyStroke - the key-stroke for the function

f - the function executed by the key-stroke

Returns:

this

putTraverse

public <T extends Component> GuiSwingKeyBinding putTraverse(Class<T> type,
 Predicate<T> predicate,
 BiConsumer<GuiSwingKeyBinding,T> put)

append a traversal function for setting key-strokes for a specified component by a given function. the binding will be happen only the first component matched by the predicate.

Type Parameters:

T - the component type

Parameters:

type - the component type

predicate - predicate for specifying the component

put - a function for setting up key-strokes for the component

Returns:

this

putHighPrecedencePaneFocus

public GuiSwingKeyBinding putHighPrecedencePaneFocus(JComponent c,
 KeyStroke keyStroke)

putHighPrecedenceAction

public GuiSwingKeyBinding putHighPrecedenceAction(JComponent c,
 KeyStroke keyStroke,
 Action action)

putHighPrecedence

public <CompType extends JComponent>
GuiSwingKeyBinding putHighPrecedence(CompType c,
 KeyStroke keyStroke,
 Consumer<CompType> f)

addTraverseFunctionDefault

public GuiSwingKeyBinding addTraverseFunctionDefault()

addTraverseFunction

public GuiSwingKeyBinding addTraverseFunction(BiConsumer<GuiSwingKeyBinding,Component> f)

getKeyStroke

public static KeyStroke getKeyStroke(String key)

copyWithModifiers

public static KeyStroke copyWithModifiers(KeyStroke stroke,
 int mod)

bind

public void bind(JComponent component)

addDefaultExcluded

public GuiSwingKeyBinding addDefaultExcluded()

addDefaultExcludedKey

public GuiSwingKeyBinding addDefaultExcludedKey(int k,
 int mod)

addKeyBindingForComponentTree

public GuiSwingKeyBinding addKeyBindingForComponentTree(Component c)

traverseKeyBinding

public GuiSwingKeyBinding traverseKeyBinding(Component c,
 int depth)

putForValuePane

public GuiSwingKeyBinding putForValuePane(GuiSwingView.ValuePane<?> pane,
 int depth)

putForComponentInputMap

public GuiSwingKeyBinding putForComponentInputMap(JComponent c,
 int depth)

putForComponentInputMap

public GuiSwingKeyBinding putForComponentInputMap(JComponent c)

assign

public void assign()

putItem

public boolean putItem(GuiSwingView.ValuePane<?> pane,
 int depth,
 PopupCategorized.CategorizedMenuItem item)

putItemRecommended

public boolean putItemRecommended(GuiSwingView.ValuePane<?> pane,
 int depth,
 GuiSwingKeyBinding.RecommendedKeyStroke item)

putKeyStroke

public boolean putKeyStroke(GuiSwingView.ValuePane<?> pane,
 int depth,
 PopupCategorized.CategorizedMenuItem i,
 Action item)

putKeyStrokeFocus

public boolean putKeyStrokeFocus(GuiSwingView.ValuePane<?> pane,
 int depth,
 KeyStroke stroke)

putKeyStroke

public GuiSwingKeyBinding putKeyStroke(GuiSwingKeyBinding.KeyStrokeAction item)

checkMenuModifiersMask

public static boolean checkMenuModifiersMask(int constKey,
 int testedMods)

bind

public boolean bind(KeyStroke key,
 Map<GuiSwingKeyBinding.KeyPrecedenceSet,List<GuiSwingKeyBinding.KeyStrokeAction>> precToActions)

setDispatcher

@Deprecated
public void setDispatcher()

Deprecated.

setDispatcher

public void setDispatcher(JComponent component)

Parameters:

component - the root pane

Since:

1.4

unbind

@Deprecated
public void unbind()

Deprecated.

unbind

public void unbind(JComponent component)

Parameters:

component - the root pane, the former parameter of setDispatcher(JComponent)

Since:

1.4

getDispatcher

public GuiSwingKeyBinding.KeyBindDispatcher getDispatcher()

getAssigned

public List<GuiSwingKeyBinding.KeyStrokeAction> getAssigned()

getAssignedFromDispatcher

public List<GuiSwingKeyBinding.KeyStrokeAction> getAssignedFromDispatcher()