org.fxmisc.wellbehaved.event

Interface EventPattern<T extends javafx.event.Event,U extends T>

public interface EventPattern<T extends javafx.event.Event,U extends T>

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. 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

Fields

Modifier and Type	Field and Description
static javafx.scene.input.KeyCombination.Modifier[]	ALL_MODIFIERS_AS_ANY

Method Summary

Modifier and Type	Method and Description
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.
static <T extends javafx.event.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.
static EventPattern<javafx.event.Event,javafx.scene.input.MouseEvent>	dragDetected()
static <T extends javafx.event.Event> EventPattern<javafx.event.Event,T>	eventType(javafx.event.EventType<? extends T> eventType)
java.util.Set<javafx.event.EventType<? extends U>>	getEventTypes()
static EventPattern<javafx.event.Event,javafx.scene.input.KeyEvent>	keyPressed()
static EventPattern<javafx.event.Event,javafx.scene.input.KeyEvent>	keyPressed(javafx.scene.input.KeyCode code, javafx.scene.input.KeyCombination.Modifier... modifiers)
static EventPattern<javafx.event.Event,javafx.scene.input.KeyEvent>	keyPressed(javafx.scene.input.KeyCombination combination)
static EventPattern<javafx.event.Event,javafx.scene.input.KeyEvent>	keyPressed(java.util.function.Predicate<javafx.scene.input.KeyCode> keyTest, javafx.scene.input.KeyCombination.Modifier... modifiers)
static EventPattern<javafx.event.Event,javafx.scene.input.KeyEvent>	keyPressed(java.lang.String character, javafx.scene.input.KeyCombination.Modifier... modifiers)
static EventPattern<javafx.event.Event,javafx.scene.input.KeyEvent>	keyPressedNoMod(java.lang.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.
static EventPattern<javafx.event.Event,javafx.scene.input.KeyEvent>	keyReleased()
static EventPattern<javafx.event.Event,javafx.scene.input.KeyEvent>	keyReleased(javafx.scene.input.KeyCode code, javafx.scene.input.KeyCombination.Modifier... modifiers)
static EventPattern<javafx.event.Event,javafx.scene.input.KeyEvent>	keyReleased(javafx.scene.input.KeyCombination combination)
static EventPattern<javafx.event.Event,javafx.scene.input.KeyEvent>	keyReleased(java.util.function.Predicate<javafx.scene.input.KeyCode> keyTest, javafx.scene.input.KeyCombination.Modifier... modifiers)
static EventPattern<javafx.event.Event,javafx.scene.input.KeyEvent>	keyReleased(java.lang.String character, javafx.scene.input.KeyCombination.Modifier... modifiers)
static EventPattern<javafx.event.Event,javafx.scene.input.KeyEvent>	keyReleasedNoMod(java.lang.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.
static EventPattern<javafx.event.Event,javafx.scene.input.KeyEvent>	keyTyped()
static EventPattern<javafx.event.Event,javafx.scene.input.KeyEvent>	keyTyped(java.util.function.Predicate<java.lang.String> charTest, javafx.scene.input.KeyCombination.Modifier... modifiers)
static EventPattern<javafx.event.Event,javafx.scene.input.KeyEvent>	keyTyped(java.lang.String character, javafx.scene.input.KeyCombination.Modifier... modifiers)
static EventPattern<javafx.event.Event,javafx.scene.input.KeyEvent>	keyTypedNoMod(java.lang.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.
java.util.Optional<? extends U>	match(T event) Returns a non-empty Optional when a match is found.
static EventPattern<javafx.event.Event,javafx.scene.input.MouseEvent>	mouseClicked()
static EventPattern<javafx.event.Event,javafx.scene.input.MouseEvent>	mouseClicked(javafx.scene.input.MouseButton button)
static EventPattern<javafx.event.Event,javafx.scene.input.MouseEvent>	mouseDragged()
static EventPattern<javafx.event.Event,javafx.scene.input.MouseEvent>	mouseEntered()
static EventPattern<javafx.event.Event,javafx.scene.input.MouseEvent>	mouseEnteredTarget()
static EventPattern<javafx.event.Event,javafx.scene.input.MouseEvent>	mouseExited()
static EventPattern<javafx.event.Event,javafx.scene.input.MouseEvent>	mouseExitedTarget()
static EventPattern<javafx.event.Event,javafx.scene.input.MouseEvent>	mouseMoved()
static EventPattern<javafx.event.Event,javafx.scene.input.MouseEvent>	mousePressed()
static EventPattern<javafx.event.Event,javafx.scene.input.MouseEvent>	mousePressed(javafx.scene.input.MouseButton button)
static EventPattern<javafx.event.Event,javafx.scene.input.MouseEvent>	mouseReleased()
static EventPattern<javafx.event.Event,javafx.scene.input.MouseEvent>	mouseReleased(javafx.scene.input.MouseButton button)
default EventPattern<T,U>	onlyIf(java.util.function.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
default EventPattern<T,U>	unless(java.util.function.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

static final javafx.scene.input.KeyCombination.Modifier[] ALL_MODIFIERS_AS_ANY

Method Detail

match

java.util.Optional<? extends U> match(T event)

Returns a non-empty Optional when a match is found.

getEventTypes

java.util.Set<javafx.event.EventType<? extends U>> getEventTypes()

andThen

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.

onlyIf

default EventPattern<T,U> onlyIf(java.util.function.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

default EventPattern<T,U> unless(java.util.function.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

anyOf

@SafeVarargs
static <T extends javafx.event.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).

eventType

static <T extends javafx.event.Event> EventPattern<javafx.event.Event,T> eventType(javafx.event.EventType<? extends T> eventType)

keyPressed

static EventPattern<javafx.event.Event,javafx.scene.input.KeyEvent> keyPressed()

keyPressed

static EventPattern<javafx.event.Event,javafx.scene.input.KeyEvent> keyPressed(javafx.scene.input.KeyCombination combination)

keyPressed

static EventPattern<javafx.event.Event,javafx.scene.input.KeyEvent> keyPressed(javafx.scene.input.KeyCode code,
                                                                               javafx.scene.input.KeyCombination.Modifier... modifiers)

keyPressed

static EventPattern<javafx.event.Event,javafx.scene.input.KeyEvent> keyPressed(java.util.function.Predicate<javafx.scene.input.KeyCode> keyTest,
                                                                               javafx.scene.input.KeyCombination.Modifier... modifiers)

keyPressed

static EventPattern<javafx.event.Event,javafx.scene.input.KeyEvent> keyPressed(java.lang.String character,
                                                                               javafx.scene.input.KeyCombination.Modifier... modifiers)

keyPressedNoMod

static EventPattern<javafx.event.Event,javafx.scene.input.KeyEvent> keyPressedNoMod(java.lang.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

static EventPattern<javafx.event.Event,javafx.scene.input.KeyEvent> keyReleased()

keyReleased

static EventPattern<javafx.event.Event,javafx.scene.input.KeyEvent> keyReleased(javafx.scene.input.KeyCombination combination)

keyReleased

static EventPattern<javafx.event.Event,javafx.scene.input.KeyEvent> keyReleased(javafx.scene.input.KeyCode code,
                                                                                javafx.scene.input.KeyCombination.Modifier... modifiers)

keyReleased

static EventPattern<javafx.event.Event,javafx.scene.input.KeyEvent> keyReleased(java.util.function.Predicate<javafx.scene.input.KeyCode> keyTest,
                                                                                javafx.scene.input.KeyCombination.Modifier... modifiers)

keyReleased

static EventPattern<javafx.event.Event,javafx.scene.input.KeyEvent> keyReleased(java.lang.String character,
                                                                                javafx.scene.input.KeyCombination.Modifier... modifiers)

keyReleasedNoMod

static EventPattern<javafx.event.Event,javafx.scene.input.KeyEvent> keyReleasedNoMod(java.lang.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

static EventPattern<javafx.event.Event,javafx.scene.input.KeyEvent> keyTyped()

keyTyped

static EventPattern<javafx.event.Event,javafx.scene.input.KeyEvent> keyTyped(java.util.function.Predicate<java.lang.String> charTest,
                                                                             javafx.scene.input.KeyCombination.Modifier... modifiers)

keyTyped

static EventPattern<javafx.event.Event,javafx.scene.input.KeyEvent> keyTyped(java.lang.String character,
                                                                             javafx.scene.input.KeyCombination.Modifier... modifiers)

keyTypedNoMod

static EventPattern<javafx.event.Event,javafx.scene.input.KeyEvent> keyTypedNoMod(java.lang.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.

mouseClicked

static EventPattern<javafx.event.Event,javafx.scene.input.MouseEvent> mouseClicked()

mouseClicked

static EventPattern<javafx.event.Event,javafx.scene.input.MouseEvent> mouseClicked(javafx.scene.input.MouseButton button)

mousePressed

static EventPattern<javafx.event.Event,javafx.scene.input.MouseEvent> mousePressed()

mousePressed

static EventPattern<javafx.event.Event,javafx.scene.input.MouseEvent> mousePressed(javafx.scene.input.MouseButton button)

mouseReleased

static EventPattern<javafx.event.Event,javafx.scene.input.MouseEvent> mouseReleased()

mouseReleased

static EventPattern<javafx.event.Event,javafx.scene.input.MouseEvent> mouseReleased(javafx.scene.input.MouseButton button)

mouseMoved

static EventPattern<javafx.event.Event,javafx.scene.input.MouseEvent> mouseMoved()

mouseDragged

static EventPattern<javafx.event.Event,javafx.scene.input.MouseEvent> mouseDragged()

dragDetected

static EventPattern<javafx.event.Event,javafx.scene.input.MouseEvent> dragDetected()

mouseEntered

static EventPattern<javafx.event.Event,javafx.scene.input.MouseEvent> mouseEntered()

mouseEnteredTarget

static EventPattern<javafx.event.Event,javafx.scene.input.MouseEvent> mouseEnteredTarget()

mouseExited

static EventPattern<javafx.event.Event,javafx.scene.input.MouseEvent> mouseExited()

mouseExitedTarget

static EventPattern<javafx.event.Event,javafx.scene.input.MouseEvent> mouseExitedTarget()