org.dominokit.domino.ui.keyboard

Class KeyboardEvents<T extends elemental2.dom.Node>

java.lang.Object

org.dominokit.domino.ui.keyboard.KeyboardEvents<T>

Type Parameters:

T - the element type

public class KeyboardEvents<T extends elemental2.dom.Node>
extends Object

A helper class allowing listening to keyboard events on an element

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	KeyboardEvents.KeyboardEventOptions Context to hold keyboard event options

Field Summary

Fields

Modifier and Type	Field and Description
static String	ARROWDOWN
static String	ARROWUP
static String	BACKSPACE
static String	DELETE
static String	ENTER
static String	ESCAPE
static String	KEYDOWN
static String	KEYPRESS
static String	KEYUP
static String	SPACE
static String	TAB

Constructor Summary

Constructors

Constructor and Description
KeyboardEvents(List<T> elements)
KeyboardEvents(String eventType, List<T> elements)
KeyboardEvents(String eventType, T... elements)
KeyboardEvents(T... elements)

Method Summary

Modifier and Type	Method and Description
static <E extends elemental2.dom.HTMLElement> KeyboardEvents<E>	listenOn(org.jboss.elemento.IsElement<E>... elements) Deprecated. use listenOnKeyDown(IsElement...), listenOnKeyUp(IsElement...), listenOnKeyPress(IsElement...)
static <T extends elemental2.dom.Node> KeyboardEvents<T>	listenOn(T... elements) Deprecated. use listenOnKeyDown(Node...), listenOnKeyUp(Node...), listenOnKeyPress(Node...)
static <T extends elemental2.dom.HTMLElement> KeyboardEvents<T>	listenOnKeyDown(org.jboss.elemento.IsElement<T>... elements) Same as listenOnKeyDown(Node...) but with wrapper IsElement
static <T extends elemental2.dom.HTMLElement> KeyboardEvents<T>	listenOnKeyDown(List<org.jboss.elemento.IsElement<T>> elements) Same as listenOnKeyDown(Node...) but with wrapper IsElement
static <T extends elemental2.dom.Node> KeyboardEvents<T>	listenOnKeyDown(T... elements) Static factory for creation keyboard keydown event listener
static <T extends elemental2.dom.HTMLElement> KeyboardEvents<T>	listenOnKeyPress(org.jboss.elemento.IsElement<T>... elements) Same as listenOnKeyPress(Node...) but with wrapper IsElement
static <T extends elemental2.dom.HTMLElement> KeyboardEvents<T>	listenOnKeyPress(List<org.jboss.elemento.IsElement<T>> elements) Same as listenOnKeyPress(Node...) but with wrapper IsElement
static <T extends elemental2.dom.Node> KeyboardEvents<T>	listenOnKeyPress(T... elements) Static factory for creation keyboard keyPress event listener
static <T extends elemental2.dom.HTMLElement> KeyboardEvents<T>	listenOnKeyUp(org.jboss.elemento.IsElement<T>... elements) Same as listenOnKeyUp(Node...) but with wrapper IsElement
static <T extends elemental2.dom.HTMLElement> KeyboardEvents<T>	listenOnKeyUp(List<org.jboss.elemento.IsElement<T>> elements) Same as listenOnKeyUp(Node...) but with wrapper IsElement
static <T extends elemental2.dom.Node> KeyboardEvents<T>	listenOnKeyUp(T... elements) Static factory for creation keyboard keyUp event listener
KeyboardEvents<T>	on(String key, elemental2.dom.EventListener handler) On key button pressed
KeyboardEvents<T>	on(String key, elemental2.dom.EventListener handler, KeyboardEvents.KeyboardEventOptions options) On key button pressed with options
KeyboardEvents<T>	onArrowDown(elemental2.dom.EventListener arrowDownHandler) On arrow down button pressed
KeyboardEvents<T>	onArrowDown(elemental2.dom.EventListener arrowDownHandler, KeyboardEvents.KeyboardEventOptions options) On arrow down button pressed with options
KeyboardEvents<T>	onArrowUp(elemental2.dom.EventListener arrowUpHandler) On arrow up button pressed with options
KeyboardEvents<T>	onArrowUp(elemental2.dom.EventListener arrowUpHandler, KeyboardEvents.KeyboardEventOptions options) On arrow up button pressed with options
KeyboardEvents<T>	onArrowUpDown(elemental2.dom.EventListener arrowDownHandler) On arrow up or arrow down buttons pressed
KeyboardEvents<T>	onArrowUpDown(elemental2.dom.EventListener arrowDownHandler, KeyboardEvents.KeyboardEventOptions options) On arrow up or arrow down buttons pressed with options
KeyboardEvents<T>	onCtrlBackspace(elemental2.dom.EventListener ctrlBackspaceHandler) On ctrl + backspace buttons pressed
KeyboardEvents<T>	onCtrlBackspace(elemental2.dom.EventListener ctrlBackspaceHandler, KeyboardEvents.KeyboardEventOptions options) On ctrl + backspace buttons pressed with options
KeyboardEvents<T>	onDelete(elemental2.dom.EventListener deleteHandler) On delete button pressed
KeyboardEvents<T>	onDelete(elemental2.dom.EventListener deleteHandler, KeyboardEvents.KeyboardEventOptions options) On delete button pressed with options
KeyboardEvents<T>	onEnter(elemental2.dom.EventListener enterHandler) On enter button pressed
KeyboardEvents<T>	onEnter(elemental2.dom.EventListener enterHandler, KeyboardEvents.KeyboardEventOptions options) On enter button pressed with options
KeyboardEvents<T>	onEscape(elemental2.dom.EventListener escapeHandler) On escape button pressed
KeyboardEvents<T>	onEscape(elemental2.dom.EventListener escapeHandler, KeyboardEvents.KeyboardEventOptions options) On escape button pressed with options
KeyboardEvents<T>	onSpace(elemental2.dom.EventListener spaceHandler) On space button pressed
KeyboardEvents<T>	onSpace(elemental2.dom.EventListener spaceHandler, KeyboardEvents.KeyboardEventOptions options) On space button pressed with options
KeyboardEvents<T>	onTab(elemental2.dom.EventListener tabHandler) On tab button pressed
KeyboardEvents<T>	onTab(elemental2.dom.EventListener tabHandler, KeyboardEvents.KeyboardEventOptions options) On tab button pressed with options
KeyboardEvents<T>	setDefaultOptions(KeyboardEvents.KeyboardEventOptions defaultOptions) Sets the default KeyboardEvents.KeyboardEventOptions

Methods inherited from class java.lang.Object

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

Field Detail

ESCAPE

public static final String ESCAPE

See Also:

Constant Field Values

KEYDOWN

public static final String KEYDOWN

See Also:

Constant Field Values

KEYUP

public static final String KEYUP

See Also:

Constant Field Values

KEYPRESS

public static final String KEYPRESS

See Also:

Constant Field Values

ARROWDOWN

public static final String ARROWDOWN

See Also:

Constant Field Values

ARROWUP

public static final String ARROWUP

See Also:

Constant Field Values

ENTER

public static final String ENTER

See Also:

Constant Field Values

DELETE

public static final String DELETE

See Also:

Constant Field Values

SPACE

public static final String SPACE

See Also:

Constant Field Values

TAB

public static final String TAB

See Also:

Constant Field Values

BACKSPACE

public static final String BACKSPACE

See Also:

Constant Field Values

Constructor Detail

KeyboardEvents

public KeyboardEvents(String eventType,
                      T... elements)

Parameters:

eventType - The eventType that will trigger the handlers

elements - varargs of the target elements

KeyboardEvents

public KeyboardEvents(String eventType,
                      List<T> elements)

Parameters:

eventType - The eventType that will trigger the handlers

elements - varargs of the target elements

KeyboardEvents

public KeyboardEvents(T... elements)

Parameters:

elements - the target elements

KeyboardEvents

public KeyboardEvents(List<T> elements)

Parameters:

elements - the target elements

Method Detail

listenOn

@Deprecated
public static <T extends elemental2.dom.Node> KeyboardEvents<T> listenOn(T... elements)

Deprecated. use listenOnKeyDown(Node...), listenOnKeyUp(Node...), listenOnKeyPress(Node...)

Static factory for creation keyboard event listener

Type Parameters:

T - the type of the element

Parameters:

elements - the target elements

Returns:

new instance

listenOn

@Deprecated
public static <E extends elemental2.dom.HTMLElement> KeyboardEvents<E> listenOn(org.jboss.elemento.IsElement<E>... elements)

Deprecated. use listenOnKeyDown(IsElement...), listenOnKeyUp(IsElement...), listenOnKeyPress(IsElement...)

Same as listenOn(Node...) but with wrapper IsElement

Type Parameters:

E - the type of the element

Parameters:

elements - the target IsElement

Returns:

new instance

listenOnKeyDown

public static <T extends elemental2.dom.Node> KeyboardEvents<T> listenOnKeyDown(T... elements)

Static factory for creation keyboard keydown event listener

Type Parameters:

T - the type of the element

Parameters:

elements - the target element

Returns:

new instance

listenOnKeyDown

public static <T extends elemental2.dom.HTMLElement> KeyboardEvents<T> listenOnKeyDown(org.jboss.elemento.IsElement<T>... elements)

Same as listenOnKeyDown(Node...) but with wrapper IsElement

Type Parameters:

T - the type of the element

Parameters:

elements - the target IsElement

Returns:

new instance

listenOnKeyDown

public static <T extends elemental2.dom.HTMLElement> KeyboardEvents<T> listenOnKeyDown(List<org.jboss.elemento.IsElement<T>> elements)

Same as listenOnKeyDown(Node...) but with wrapper IsElement

Type Parameters:

T - the type of the element

Parameters:

elements - the target IsElement

Returns:

new instance

listenOnKeyUp

public static <T extends elemental2.dom.Node> KeyboardEvents<T> listenOnKeyUp(T... elements)

Static factory for creation keyboard keyUp event listener

Type Parameters:

T - the type of the element

Parameters:

elements - the target element

Returns:

new instance

listenOnKeyUp

public static <T extends elemental2.dom.HTMLElement> KeyboardEvents<T> listenOnKeyUp(org.jboss.elemento.IsElement<T>... elements)

Same as listenOnKeyUp(Node...) but with wrapper IsElement

Type Parameters:

T - the type of the element

Parameters:

elements - the target IsElement

Returns:

new instance

listenOnKeyUp

public static <T extends elemental2.dom.HTMLElement> KeyboardEvents<T> listenOnKeyUp(List<org.jboss.elemento.IsElement<T>> elements)

Same as listenOnKeyUp(Node...) but with wrapper IsElement

Type Parameters:

T - the type of the element

Parameters:

elements - the target IsElement

Returns:

new instance

listenOnKeyPress

public static <T extends elemental2.dom.Node> KeyboardEvents<T> listenOnKeyPress(T... elements)

Static factory for creation keyboard keyPress event listener

Type Parameters:

T - the type of the element

Parameters:

elements - the target element

Returns:

new instance

listenOnKeyPress

public static <T extends elemental2.dom.HTMLElement> KeyboardEvents<T> listenOnKeyPress(org.jboss.elemento.IsElement<T>... elements)

Same as listenOnKeyPress(Node...) but with wrapper IsElement

Type Parameters:

T - the type of the element

Parameters:

elements - the target IsElement

Returns:

new instance

listenOnKeyPress

public static <T extends elemental2.dom.HTMLElement> KeyboardEvents<T> listenOnKeyPress(List<org.jboss.elemento.IsElement<T>> elements)

Same as listenOnKeyPress(Node...) but with wrapper IsElement

Type Parameters:

T - the type of the element

Parameters:

elements - the target IsElement

Returns:

new instance

onEscape

public KeyboardEvents<T> onEscape(elemental2.dom.EventListener escapeHandler)

On escape button pressed

Parameters:

escapeHandler - the EventListener to call

Returns:

same instance

onEscape

public KeyboardEvents<T> onEscape(elemental2.dom.EventListener escapeHandler,
                                  KeyboardEvents.KeyboardEventOptions options)

On escape button pressed with options

Parameters:

escapeHandler - the EventListener to call

options - the KeyboardEvents.KeyboardEventOptions

Returns:

same instance

onArrowUpDown

public KeyboardEvents<T> onArrowUpDown(elemental2.dom.EventListener arrowDownHandler)

On arrow up or arrow down buttons pressed

Parameters:

arrowDownHandler - the EventListener to call

Returns:

same instance

onArrowUpDown

public KeyboardEvents<T> onArrowUpDown(elemental2.dom.EventListener arrowDownHandler,
                                       KeyboardEvents.KeyboardEventOptions options)

On arrow up or arrow down buttons pressed with options

Parameters:

arrowDownHandler - the EventListener to call

options - the KeyboardEvents.KeyboardEventOptions

Returns:

same instance

onArrowDown

public KeyboardEvents<T> onArrowDown(elemental2.dom.EventListener arrowDownHandler)

On arrow down button pressed

Parameters:

arrowDownHandler - the EventListener to call

Returns:

same instance

onArrowDown

public KeyboardEvents<T> onArrowDown(elemental2.dom.EventListener arrowDownHandler,
                                     KeyboardEvents.KeyboardEventOptions options)

On arrow down button pressed with options

Parameters:

arrowDownHandler - the EventListener to call

options - the KeyboardEvents.KeyboardEventOptions

Returns:

same instance

onArrowUp

public KeyboardEvents<T> onArrowUp(elemental2.dom.EventListener arrowUpHandler)

On arrow up button pressed with options

Parameters:

arrowUpHandler - the EventListener to call

Returns:

same instance

onArrowUp

public KeyboardEvents<T> onArrowUp(elemental2.dom.EventListener arrowUpHandler,
                                   KeyboardEvents.KeyboardEventOptions options)

On arrow up button pressed with options

Parameters:

arrowUpHandler - the EventListener to call

options - the KeyboardEvents.KeyboardEventOptions

Returns:

same instance

onEnter

public KeyboardEvents<T> onEnter(elemental2.dom.EventListener enterHandler)

On enter button pressed

Parameters:

enterHandler - the EventListener to call

Returns:

same instance

onEnter

public KeyboardEvents<T> onEnter(elemental2.dom.EventListener enterHandler,
                                 KeyboardEvents.KeyboardEventOptions options)

On enter button pressed with options

Parameters:

enterHandler - the EventListener to call

options - the KeyboardEvents.KeyboardEventOptions

Returns:

same instance

onDelete

public KeyboardEvents<T> onDelete(elemental2.dom.EventListener deleteHandler)

On delete button pressed

Parameters:

deleteHandler - the EventListener to call

Returns:

same instance

onDelete

public KeyboardEvents<T> onDelete(elemental2.dom.EventListener deleteHandler,
                                  KeyboardEvents.KeyboardEventOptions options)

On delete button pressed with options

Parameters:

deleteHandler - the EventListener to call

options - the KeyboardEvents.KeyboardEventOptions

Returns:

same instance

onSpace

public KeyboardEvents<T> onSpace(elemental2.dom.EventListener spaceHandler)

On space button pressed

Parameters:

spaceHandler - the EventListener to call

Returns:

same instance

onSpace

public KeyboardEvents<T> onSpace(elemental2.dom.EventListener spaceHandler,
                                 KeyboardEvents.KeyboardEventOptions options)

On space button pressed with options

Parameters:

spaceHandler - the EventListener to call

options - the KeyboardEvents.KeyboardEventOptions

Returns:

same instance

onTab

public KeyboardEvents<T> onTab(elemental2.dom.EventListener tabHandler)

On tab button pressed

Parameters:

tabHandler - the EventListener to call

Returns:

same instance

onTab

public KeyboardEvents<T> onTab(elemental2.dom.EventListener tabHandler,
                               KeyboardEvents.KeyboardEventOptions options)

On tab button pressed with options

Parameters:

tabHandler - the EventListener to call

options - the KeyboardEvents.KeyboardEventOptions

Returns:

same instance

on

public KeyboardEvents<T> on(String key,
                            elemental2.dom.EventListener handler,
                            KeyboardEvents.KeyboardEventOptions options)

On key button pressed with options

Parameters:

handler - the EventListener to call

options - the KeyboardEvents.KeyboardEventOptions

Returns:

same instance

on

public KeyboardEvents<T> on(String key,
                            elemental2.dom.EventListener handler)

On key button pressed

Parameters:

handler - the EventListener to call

Returns:

same instance

onCtrlBackspace

public KeyboardEvents<T> onCtrlBackspace(elemental2.dom.EventListener ctrlBackspaceHandler)

On ctrl + backspace buttons pressed

Parameters:

ctrlBackspaceHandler - the EventListener to call

Returns:

same instance

onCtrlBackspace

public KeyboardEvents<T> onCtrlBackspace(elemental2.dom.EventListener ctrlBackspaceHandler,
                                         KeyboardEvents.KeyboardEventOptions options)

On ctrl + backspace buttons pressed with options

Parameters:

ctrlBackspaceHandler - the EventListener to call

options - the KeyboardEvents.KeyboardEventOptions

Returns:

same instance

setDefaultOptions

public KeyboardEvents<T> setDefaultOptions(KeyboardEvents.KeyboardEventOptions defaultOptions)

Sets the default KeyboardEvents.KeyboardEventOptions

Parameters:

defaultOptions - the default KeyboardEvents.KeyboardEventOptions

Returns:

same instance