Top Description Fields Constructors Methods

org.fxmisc.wellbehaved.event

public Class Nodes

Class Inheritance

extends Object

java.lang.Object
org.fxmisc.wellbehaved.event.Nodes

Imports

java.util.AbstractMap.SimpleEntry, .ArrayList, .List, .Map, .Map.Entry, .Stack, javafx.collections.MapChangeListener, .ObservableMap, javafx.event.Event, .EventHandler, .EventType, javafx.scene.Node, org.fxmisc.wellbehaved.event.InputMap.HandlerConsumer

Helper class for "installing/uninstalling" an InputMap into a Node.

Method Summary

To add an InputMap as a default behavior that can be overridden later, use addFallbackInputMap(Node, InputMap).
To add an InputMap that might override default behaviors, use addInputMap(Node, InputMap).
To remove an InputMap, use removeInputMap(Node, InputMap).
See also pushInputMap(Node, InputMap) and popInputMap(Node) for temporary behavior modification.

Field Summary

Modifier and Type	Field and Description
private static final String	P_HANDLERS
private static final String	P_INPUTMAP
private static final String	P_STACK

Constructor Summary

Access	Constructor and Description
public	Nodes()

Method Summary

Modifier and Type	Method and Description
public static void	addFallbackInputMap(Node node, InputMap<?> im) Adds the given input map to the end of the node's list of input maps, so that an event will be pattern-matched against all other input maps currently "installed" in the node before being pattern-matched against the given input map.
public static void	addInputMap(Node node, InputMap<?> im) Adds the given input map to the start of the node's list of input maps, so that an event will be pattern-matched against the given input map before being pattern-matched against any other input maps currently "installed" in the node.
private static List<Map.Entry<EventType<?>, EventHandler<?>>>	getHandlers(Node node)
public static InputMap<?>	getInputMap(Node node) Gets the `InputMap` for the given node or `InputMap#empty()` if there is none.
private static InputMap<?>	getInputMapUnsafe(Node node) Expects a `init(Node)` call with the given node before this one is called
private static ObservableMap<Object, Object>	getProperties(Node node)
private static Stack<InputMap<?>>	getStack(Node node)
private static void	init(Node node)
public static boolean	popInputMap(Node node) If the internal stack has an `InputMap`, removes the current `InputMap` that was installed on the give node via `pushInputMap(Node, InputMap)`, reinstalls the previous `InputMap`, and then returns true.
public static void	pushInputMap(Node node, InputMap<?> im) Removes the currently installed `InputMap` (InputMap1) on the given node and installs the `im` (InputMap2) in its place.
public static void	removeInputMap(Node node, InputMap<?> im) Removes (or uninstalls) the given input map from the node.
private static void	setInputMapUnsafe(Node node, InputMap<?> im) Expects a `init(Node)` call with the given node before this one is called

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

Field Detail

P_HANDLERS	back to summary
private static final String P_HANDLERS

P_INPUTMAP	back to summary
private static final String P_INPUTMAP

P_STACK	back to summary
private static final String P_STACK

Constructor Detail

Nodes	back to summary
public Nodes()

Method Detail

addFallbackInputMap	back to summary
public static void addFallbackInputMap(Node node, InputMap<?> im) Adds the given input map to the end of the node's list of input maps, so that an event will be pattern-matched against all other input maps currently "installed" in the node before being pattern-matched against the given input map.

addInputMap	back to summary
public static void addInputMap(Node node, InputMap<?> im) Adds the given input map to the start of the node's list of input maps, so that an event will be pattern-matched against the given input map before being pattern-matched against any other input maps currently "installed" in the node.

getHandlers	back to summary
private static List<Map.Entry<EventType<?>, EventHandler<?>>> getHandlers(Node node)

getInputMap	back to summary
public static InputMap<?> getInputMap(Node node) Gets the `InputMap` for the given node or `InputMap#empty()` if there is none.

getInputMapUnsafe	back to summary
private static InputMap<?> getInputMapUnsafe(Node node) Expects a `init(Node)` call with the given node before this one is called

getProperties	back to summary
private static ObservableMap<Object, Object> getProperties(Node node)

getStack	back to summary
private static Stack<InputMap<?>> getStack(Node node)

init	back to summary
private static void init(Node node)

popInputMap	back to summary
public static boolean popInputMap(Node node) If the internal stack has an `InputMap`, removes the current `InputMap` that was installed on the give node via `pushInputMap(Node, InputMap)`, reinstalls the previous `InputMap`, and then returns true. If the stack is empty, returns false.

pushInputMap	back to summary
public static void pushInputMap(Node node, InputMap<?> im) Removes the currently installed `InputMap` (InputMap1) on the given node and installs the `im` (InputMap2) in its place. When finished, InputMap2 can be uninstalled and InputMap1 reinstalled via `popInputMap(Node)`. Multiple InputMaps can be installed so that InputMap(n) will be installed over InputMap(n-1)

removeInputMap	back to summary
public static void removeInputMap(Node node, InputMap<?> im) Removes (or uninstalls) the given input map from the node.

setInputMapUnsafe	back to summary
private static void setInputMapUnsafe(Node node, InputMap<?> im) Expects a `init(Node)` call with the given node before this one is called