Nested and Inner Type Summary

Modifier and Type	Class and Description
pack-priv static class	KeyboardManager.ComponentKeyStrokePair This class is used to create keys for a hashtable which looks up topContainers based on component, keystroke pairs This is used to make unregistering KeyStrokes fast

Field Summary

Modifier and Type	Field and Description
pack-priv Hashtable<KeyboardManager.ComponentKeyStrokePair, Container>	componentKeyStrokeMap Maps component/keystroke pairs to a topLevel container This is mainly used for fast unregister operations
pack-priv Hashtable<Container, Hashtable<Object, Object>>	containerMap maps top-level containers to a sub-hashtable full of keystrokes
pack-priv static KeyboardManager	currentManager

Constructor Summary

Access	Constructor and Description
pack-priv	KeyboardManager()

Method Summary

Modifier and Type	Method and Description
pack-priv void	fireBinding(JComponent c, KeyStroke ks, KeyEvent e, boolean pressed)
public boolean	fireKeyboardAction(KeyEvent e, boolean pressed, Container topAncestor) This method is called when the focused component (and none of its ancestors) want the key event.
public static KeyboardManager	getCurrentManager()
private static Container	getTopAncestor(JComponent c) Find the top focusable Window, or InternalFrame
public void	registerKeyStroke(KeyStroke k, JComponent c) register keystrokes here which are for the WHEN_IN_FOCUSED_WINDOW case.
public void	registerMenuBar(JMenuBar mb)
protected Hashtable<Object, Object>	registerNewTopContainer(Container topContainer)
public static void	setCurrentManager(KeyboardManager km)
public void	unregisterKeyStroke(KeyStroke ks, JComponent c)
public void	unregisterMenuBar(JMenuBar mb)

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Field Detail

componentKeyStrokeMap	back to summary
pack-priv Hashtable<KeyboardManager.ComponentKeyStrokePair, Container> componentKeyStrokeMap Maps component/keystroke pairs to a topLevel container This is mainly used for fast unregister operations

containerMap	back to summary
pack-priv Hashtable<Container, Hashtable<Object, Object>> containerMap maps top-level containers to a sub-hashtable full of keystrokes

currentManager	back to summary
pack-priv static KeyboardManager currentManager

Constructor Detail

KeyboardManager	back to summary
pack-priv KeyboardManager()

Method Detail

fireBinding	back to summary
pack-priv void fireBinding(JComponent c, KeyStroke ks, KeyEvent e, boolean pressed)

fireKeyboardAction	back to summary
public boolean fireKeyboardAction(KeyEvent e, boolean pressed, Container topAncestor) This method is called when the focused component (and none of its ancestors) want the key event. This will look up the keystroke to see if any children (or subchildren) of the specified container want a crack at the event. If one of them wants it, then it will "DO-THE-RIGHT-THING" Annotations @SuppressWarnings:deprecation

fireKeyboardAction

back to summary

public boolean fireKeyboardAction(KeyEvent e, boolean pressed, Container topAncestor)

This method is called when the focused component (and none of its ancestors) want the key event. This will look up the keystroke to see if any children (or subchildren) of the specified container want a crack at the event. If one of them wants it, then it will "DO-THE-RIGHT-THING"

Annotations

@SuppressWarnings:deprecation

getCurrentManager	back to summary
public static KeyboardManager getCurrentManager()

getTopAncestor	back to summary
private static Container getTopAncestor(JComponent c) Find the top focusable Window, or InternalFrame

registerKeyStroke	back to summary
public void registerKeyStroke(KeyStroke k, JComponent c) register keystrokes here which are for the WHEN_IN_FOCUSED_WINDOW case. Other types of keystrokes will be handled by walking the hierarchy That simplifies some potentially hairy stuff.

registerMenuBar	back to summary
public void registerMenuBar(JMenuBar mb)

registerNewTopContainer	back to summary
protected Hashtable<Object, Object> registerNewTopContainer(Container topContainer)

setCurrentManager	back to summary
public static void setCurrentManager(KeyboardManager km)

unregisterKeyStroke	back to summary
public void unregisterKeyStroke(KeyStroke ks, JComponent c)

unregisterMenuBar	back to summary
public void unregisterMenuBar(JMenuBar mb)

javax.swing back to summary

pack-priv Class KeyboardManager.ComponentKeyStrokePair

Class Inheritance

extends Object

java.lang.Object
javax.swing.KeyboardManager.ComponentKeyStrokePair

This class is used to create keys for a hashtable which looks up topContainers based on component, keystroke pairs This is used to make unregistering KeyStrokes fast

Field Summary

Modifier and Type	Field and Description
pack-priv Object	component
pack-priv Object	keyStroke

Constructor Summary

Access	Constructor and Description
public	ComponentKeyStrokePair(Object comp, Object key)

Method Summary

Modifier and Type	Method and Description
public boolean	equals(Object o) Overrides java.lang.Object.equals. Indicates whether some other object is "equal to" this one.
public int	hashCode() Overrides java.lang.Object.hashCode. Returns a hash code value for this object.

Inherited from java.lang.Object:: clone finalize getClass notify notifyAll toString wait wait wait

Field Detail

component	back to summary
pack-priv Object component

keyStroke	back to summary
pack-priv Object keyStroke

Constructor Detail

ComponentKeyStrokePair	back to summary
public ComponentKeyStrokePair(Object comp, Object key)

Method Detail

equals back to summary

equals	back to summary
public boolean equals(Object o) Overrides java.lang.Object.equals. Doc from java.lang.Object.equals. Indicates whether some other object is "equal to" this one. The `equals` method implements an equivalence relation on non-null object references: It is reflexive: for any non-null reference value `x`, `x.equals(x)` should return `true`. It is symmetric: for any non-null reference values `x` and `y`, `x.equals(y)` should return `true` if and only if `y.equals(x)` returns `true`. It is transitive: for any non-null reference values `x`, `y`, and `z`, if `x.equals(y)` returns `true` and `y.equals(z)` returns `true`, then `x.equals(z)` should return `true`. It is consistent: for any non-null reference values `x` and `y`, multiple invocations of `x.equals(y)` consistently return `true` or consistently return `false`, provided no information used in `equals` comparisons on the objects is modified. For any non-null reference value `x`, `x.equals(null)` should return `false`. An equivalence relation partitions the elements it operates on into equivalence classes; all the members of an equivalence class are equal to each other. Members of an equivalence class are substitutable for each other, at least for some purposes.

public boolean equals(Object o)

Overrides java.lang.Object.equals.

Doc from java.lang.Object.equals.

Indicates whether some other object is "equal to" this one.

The equals method implements an equivalence relation on non-null object references:

It is reflexive: for any non-null reference value x, x.equals(x) should return true.
It is symmetric: for any non-null reference values x and y, x.equals(y) should return true if and only if y.equals(x) returns true.
It is transitive: for any non-null reference values x, y, and z, if x.equals(y) returns true and y.equals(z) returns true, then x.equals(z) should return true.
It is consistent: for any non-null reference values x and y, multiple invocations of x.equals(y) consistently return true or consistently return false, provided no information used in equals comparisons on the objects is modified.
For any non-null reference value x, x.equals(null) should return false.

An equivalence relation partitions the elements it operates on into equivalence classes; all the members of an equivalence class are equal to each other. Members of an equivalence class are substitutable for each other, at least for some purposes.

hashCode back to summary

hashCode	back to summary
public int hashCode() Overrides java.lang.Object.hashCode. Doc from java.lang.Object.hashCode. Returns a hash code value for this object. This method is supported for the benefit of hash tables such as those provided by `java.util.HashMap`. The general contract of `hashCode` is: Whenever it is invoked on the same object more than once during an execution of a Java application, the `hashCode` method must consistently return the same integer, provided no information used in `equals` comparisons on the object is modified. This integer need not remain consistent from one execution of an application to another execution of the same application. If two objects are equal according to the `equals` method, then calling the `hashCode` method on each of the two objects must produce the same integer result. It is not required that if two objects are unequal according to the `equals` method, then calling the `hashCode` method on each of the two objects must produce distinct integer results. However, the programmer should be aware that producing distinct integer results for unequal objects may improve the performance of hash tables.

public int hashCode()

Overrides java.lang.Object.hashCode.

Doc from java.lang.Object.hashCode.

Returns a hash code value for this object. This method is supported for the benefit of hash tables such as those provided by java.util.HashMap.

The general contract of hashCode is:

Whenever it is invoked on the same object more than once during an execution of a Java application, the hashCode method must consistently return the same integer, provided no information used in equals comparisons on the object is modified. This integer need not remain consistent from one execution of an application to another execution of the same application.
If two objects are equal according to the equals method, then calling the hashCode method on each of the two objects must produce the same integer result.
It is not required that if two objects are unequal according to the equals method, then calling the hashCode method on each of the two objects must produce distinct integer results. However, the programmer should be aware that producing distinct integer results for unequal objects may improve the performance of hash tables.