WellBehavedFX 0.3.3 · org.fxmisc.wellbehaved.event.EventPattern

Helper class for pattern-matching one or more EventTypes (e.g. the "case" line in a powerful switch statement). When match(Event) returns a non-empty Optional, the corresponding InputHandler will be called.

Usages

This class provides a number of static factory methods that provide the base pattern to match.

Most will use the ones for the common event types: keyPressed(), keyTyped(), mousePressed(), mouseClicked(), mouseDragged(), etc.
For custom events or super event types (e.g. javafx.scene.input.InputEvent#ANY), one will use the base pattern, eventType(EventType)

Once a base pattern is created, one can further define the pattern for which to match for by adding what are known as "guards" in pattern matching: andThen(EventPattern), onlyIf(Predicate), unless(Predicate), and anyOf(EventPattern[]). See each method's javadoc for more info.

Examples


// a pattern that matches any key pressed event
keyPressed()

// a pattern that matches only key pressed events where the user
// pressed a digit key
keyPressed().onlyIf(pressedKey -> pressedKey.getCode().isDigitKey())

Field Summary

Modifier and Type	Field and Description
public static final KeyCombination.Modifier[]	ALL_MODIFIERS_AS_ANY

Method Summary

Modifier and Type	Method and Description
public default <V extends U> EventPattern<T, V>	andThen(EventPattern<? super U, V> next) Returns an EventPattern that matches the given event type only when this event pattern matches it and the `next` EventPattern matches it.
public static <T extends Event, U extends T> EventPattern<T, U>	anyOf(EventPattern<T, ? extends U>... events) Returns an EventPattern that matches the given event type when any of the given EventPatterns match the given event type; useful when one wants to specify the same behavior for a variety of events (i.e. the "copy" action when a user press "CTRL+C" on Windows or "COMMAND+C" on Mac).
public static EventPattern<Event, MouseEvent>	dragDetected()
public static <T extends Event> EventPattern<Event, T>	eventType(EventType<? extends T> eventType)
public Set<EventType<? extends U>>	getEventTypes()
public static EventPattern<Event, KeyEvent>	keyPressed()
public static EventPattern<Event, KeyEvent>	keyPressed(KeyCombination combination)
public static EventPattern<Event, KeyEvent>	keyPressed(KeyCode code, KeyCombination.Modifier... modifiers)
public static EventPattern<Event, KeyEvent>	keyPressed(Predicate<KeyCode> keyTest, KeyCombination.Modifier... modifiers)
public static EventPattern<Event, KeyEvent>	keyPressed(String character, KeyCombination.Modifier... modifiers)
public static EventPattern<Event, KeyEvent>	keyPressedNoMod(String character) Matches the given key pressed event regardless of modifiers; this should only be used for the rare KeyEvents which require a pressed modifier (e.g. Shift) to generate it (e.g. "{").
public static EventPattern<Event, KeyEvent>	keyReleased()
public static EventPattern<Event, KeyEvent>	keyReleased(KeyCombination combination)
public static EventPattern<Event, KeyEvent>	keyReleased(KeyCode code, KeyCombination.Modifier... modifiers)
public static EventPattern<Event, KeyEvent>	keyReleased(Predicate<KeyCode> keyTest, KeyCombination.Modifier... modifiers)
public static EventPattern<Event, KeyEvent>	keyReleased(String character, KeyCombination.Modifier... modifiers)
public static EventPattern<Event, KeyEvent>	keyReleasedNoMod(String character) Matches the given key released event regardless of modifiers; this should only be used for the rare KeyEvents which require a pressed modifier (e.g. Shift) to generate it (e.g. "{").
public static EventPattern<Event, KeyEvent>	keyTyped()
public static EventPattern<Event, KeyEvent>	keyTyped(Predicate<String> charTest, KeyCombination.Modifier... modifiers)
public static EventPattern<Event, KeyEvent>	keyTyped(String character, KeyCombination.Modifier... modifiers)
public static EventPattern<Event, KeyEvent>	keyTypedNoMod(String character) Matches the given key typed event regardless of modifiers; this should only be used for the rare KeyEvents which require a pressed modifier (e.g. Shift) to generate it (e.g. "{").
public Optional<? extends U>	match(T event) Returns a non-empty `Optional` when a match is found.
public static EventPattern<Event, MouseEvent>	mouseClicked()
public static EventPattern<Event, MouseEvent>	mouseClicked(MouseButton button)
public static EventPattern<Event, MouseEvent>	mouseDragged()
public static EventPattern<Event, MouseEvent>	mouseEntered()
public static EventPattern<Event, MouseEvent>	mouseEnteredTarget()
public static EventPattern<Event, MouseEvent>	mouseExited()
public static EventPattern<Event, MouseEvent>	mouseExitedTarget()
public static EventPattern<Event, MouseEvent>	mouseMoved()
public static EventPattern<Event, MouseEvent>	mousePressed()
public static EventPattern<Event, MouseEvent>	mousePressed(MouseButton button)
public static EventPattern<Event, MouseEvent>	mouseReleased()
public static EventPattern<Event, MouseEvent>	mouseReleased(MouseButton button)
public default EventPattern<T, U>	onlyIf(Predicate<? super U> condition) Returns an EventPattern that matches the given event type only if this event pattern matches it and the event type passed the given `condition`
public default EventPattern<T, U>	unless(Predicate<? super U> condition) Returns an EventPattern that matches the given event type only if this event pattern matches it and the event type fails the given `condition`

Field Detail

ALL_MODIFIERS_AS_ANY	back to summary
public static final KeyCombination.Modifier[] ALL_MODIFIERS_AS_ANY

Method Detail

andThen	back to summary
public default <V extends U> EventPattern<T, V> andThen(EventPattern<? super U, V> next) Returns an EventPattern that matches the given event type only when this event pattern matches it and the `next` EventPattern matches it.

anyOf	back to summary
public static <T extends Event, U extends T> EventPattern<T, U> anyOf(EventPattern<T, ? extends U>... events) Returns an EventPattern that matches the given event type when any of the given EventPatterns match the given event type; useful when one wants to specify the same behavior for a variety of events (i.e. the "copy" action when a user press "CTRL+C" on Windows or "COMMAND+C" on Mac). Annotations @SafeVarargs

anyOf

back to summary

public static <T extends Event, U extends T> EventPattern<T, U> anyOf(EventPattern<T, ? extends U>... events)

Returns an EventPattern that matches the given event type when any of the given EventPatterns match the given event type; useful when one wants to specify the same behavior for a variety of events (i.e. the "copy" action when a user press "CTRL+C" on Windows or "COMMAND+C" on Mac).

Annotations

@SafeVarargs

dragDetected	back to summary
public static EventPattern<Event, MouseEvent> dragDetected()

eventType	back to summary
public static <T extends Event> EventPattern<Event, T> eventType(EventType<? extends T> eventType)

getEventTypes	back to summary
public Set<EventType<? extends U>> getEventTypes()

keyPressed	back to summary
public static EventPattern<Event, KeyEvent> keyPressed()

keyPressed	back to summary
public static EventPattern<Event, KeyEvent> keyPressed(KeyCombination combination)

keyPressed	back to summary
public static EventPattern<Event, KeyEvent> keyPressed(KeyCode code, KeyCombination.Modifier... modifiers)

keyPressed	back to summary
public static EventPattern<Event, KeyEvent> keyPressed(Predicate<KeyCode> keyTest, KeyCombination.Modifier... modifiers)

keyPressed	back to summary
public static EventPattern<Event, KeyEvent> keyPressed(String character, KeyCombination.Modifier... modifiers)

keyPressedNoMod back to summary

keyPressedNoMod	back to summary
public static EventPattern<Event, KeyEvent> keyPressedNoMod(String character) Matches the given key pressed event regardless of modifiers; this should only be used for the rare KeyEvents which require a pressed modifier (e.g. Shift) to generate it (e.g. "{"). If passed in a regular character (e.g. "a") and this appears before another EventPattern (e.g. keyPressed("a", SHORTCUT_DOWN)) in an `InputMap#sequence(InputMap[])`, the second EventPattern will never run.

public static EventPattern<Event, KeyEvent> keyPressedNoMod(String character)

Matches the given key pressed event regardless of modifiers; this should only be used for the rare KeyEvents which require a pressed modifier (e.g. Shift) to generate it (e.g. "{"). If passed in a regular character (e.g. "a") and this appears before another EventPattern (e.g. keyPressed("a", SHORTCUT_DOWN)) in an InputMap#sequence(InputMap[]), the second EventPattern will never run.

keyReleased	back to summary
public static EventPattern<Event, KeyEvent> keyReleased()

keyReleased	back to summary
public static EventPattern<Event, KeyEvent> keyReleased(KeyCombination combination)

keyReleased	back to summary
public static EventPattern<Event, KeyEvent> keyReleased(KeyCode code, KeyCombination.Modifier... modifiers)

keyReleased	back to summary
public static EventPattern<Event, KeyEvent> keyReleased(Predicate<KeyCode> keyTest, KeyCombination.Modifier... modifiers)

keyReleased	back to summary
public static EventPattern<Event, KeyEvent> keyReleased(String character, KeyCombination.Modifier... modifiers)

keyReleasedNoMod back to summary

keyReleasedNoMod	back to summary
public static EventPattern<Event, KeyEvent> keyReleasedNoMod(String character) Matches the given key released event regardless of modifiers; this should only be used for the rare KeyEvents which require a pressed modifier (e.g. Shift) to generate it (e.g. "{"). If passed in a regular character (e.g. "a") and this appears before another EventPattern (e.g. keyReleased("a", SHORTCUT_DOWN)) in an `InputMap#sequence(InputMap[])`, the second EventPattern will never run.

public static EventPattern<Event, KeyEvent> keyReleasedNoMod(String character)

Matches the given key released event regardless of modifiers; this should only be used for the rare KeyEvents which require a pressed modifier (e.g. Shift) to generate it (e.g. "{"). If passed in a regular character (e.g. "a") and this appears before another EventPattern (e.g. keyReleased("a", SHORTCUT_DOWN)) in an InputMap#sequence(InputMap[]), the second EventPattern will never run.

keyTyped	back to summary
public static EventPattern<Event, KeyEvent> keyTyped()

keyTyped	back to summary
public static EventPattern<Event, KeyEvent> keyTyped(Predicate<String> charTest, KeyCombination.Modifier... modifiers)

keyTyped	back to summary
public static EventPattern<Event, KeyEvent> keyTyped(String character, KeyCombination.Modifier... modifiers)

keyTypedNoMod back to summary

keyTypedNoMod	back to summary
public static EventPattern<Event, KeyEvent> keyTypedNoMod(String character) Matches the given key typed event regardless of modifiers; this should only be used for the rare KeyEvents which require a pressed modifier (e.g. Shift) to generate it (e.g. "{"). If passed in a regular character (e.g. "a") and this appears before another EventPattern (e.g. keyTyped("a", SHORTCUT_DOWN)) in an `InputMap#sequence(InputMap[])`, the second EventPattern will never run.

public static EventPattern<Event, KeyEvent> keyTypedNoMod(String character)

Matches the given key typed event regardless of modifiers; this should only be used for the rare KeyEvents which require a pressed modifier (e.g. Shift) to generate it (e.g. "{"). If passed in a regular character (e.g. "a") and this appears before another EventPattern (e.g. keyTyped("a", SHORTCUT_DOWN)) in an InputMap#sequence(InputMap[]), the second EventPattern will never run.

match	back to summary
public Optional<? extends U> match(T event) Returns a non-empty `Optional` when a match is found.

mouseClicked	back to summary
public static EventPattern<Event, MouseEvent> mouseClicked()

mouseClicked	back to summary
public static EventPattern<Event, MouseEvent> mouseClicked(MouseButton button)

mouseDragged	back to summary
public static EventPattern<Event, MouseEvent> mouseDragged()

mouseEntered	back to summary
public static EventPattern<Event, MouseEvent> mouseEntered()

mouseEnteredTarget	back to summary
public static EventPattern<Event, MouseEvent> mouseEnteredTarget()

mouseExited	back to summary
public static EventPattern<Event, MouseEvent> mouseExited()

mouseExitedTarget	back to summary
public static EventPattern<Event, MouseEvent> mouseExitedTarget()

mouseMoved	back to summary
public static EventPattern<Event, MouseEvent> mouseMoved()

mousePressed	back to summary
public static EventPattern<Event, MouseEvent> mousePressed()

mousePressed	back to summary
public static EventPattern<Event, MouseEvent> mousePressed(MouseButton button)

mouseReleased	back to summary
public static EventPattern<Event, MouseEvent> mouseReleased()

mouseReleased	back to summary
public static EventPattern<Event, MouseEvent> mouseReleased(MouseButton button)

onlyIf	back to summary
public default EventPattern<T, U> onlyIf(Predicate<? super U> condition) Returns an EventPattern that matches the given event type only if this event pattern matches it and the event type passed the given `condition`

unless	back to summary
public default EventPattern<T, U> unless(Predicate<? super U> condition) Returns an EventPattern that matches the given event type only if this event pattern matches it and the event type fails the given `condition`