org.dominokit.domino.ui.utils

Class KeyboardNavigation<V extends org.jboss.elemento.IsElement<?>>

java.lang.Object

org.dominokit.domino.ui.utils.KeyboardNavigation<V>

Type Parameters:

V - The element type

All Implemented Interfaces:

elemental2.dom.EventListener

Direct Known Subclasses:

MenuNavigation

public class KeyboardNavigation<V extends org.jboss.elemento.IsElement<?>>
extends Object
implements elemental2.dom.EventListener

A helper class to ease the keyboard navigation of a menu

See Also:

IsElement, EventListener

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	KeyboardNavigation.EscapeHandler Escape handler to be called when escape key is pressed
static class	KeyboardNavigation.EventOptions A utilty class to define stopPropagation and preventDefault options for an event
static interface	KeyboardNavigation.FocusCondition<V> A condition which evaluates if an item should be focused or not
static interface	KeyboardNavigation.FocusHandler<V> Focus handler to be called when an item gets focused
static interface	KeyboardNavigation.ItemNavigationHandler<V> Selection handler to be called when an item gets selected

Constructor Summary

Constructors

Constructor and Description
KeyboardNavigation(List<V> items)

Method Summary

Modifier and Type	Method and Description
static <V extends org.jboss.elemento.IsElement<?>> KeyboardNavigation<V>	create(List<V> items) Creates new navigation for a menu contains a list of items
void	focusAt(int index) Focuses an item at a specific index
KeyboardNavigation<V>	focusCondition(KeyboardNavigation.FocusCondition<V> focusCondition) Adds a condition which evaluates if an item should be focused or not
void	focusNext(V item) Force focus next focusable item based on the provided item
void	focusPrevious(V item) Focus the focusable item that is before the provided item.
void	focusTopFocusableItem() apply focus on the top most focusable item
void	handleEvent(elemental2.dom.Event evt)
boolean	isLastFocusableItem(V item)
KeyboardNavigation<V>	onEscape(KeyboardNavigation.EscapeHandler escapeHandler) Sets a handler which will be called when escape key is pressed
KeyboardNavigation<V>	onFocus(KeyboardNavigation.FocusHandler<V> focusHandler) Sets a handler which will be called when an item gets focused
KeyboardNavigation<V>	onSelect(KeyboardNavigation.ItemNavigationHandler<V> selectHandler) Sets a handler which will be called when an item gets selected
KeyboardNavigation<V>	registerNavigationHandler(String keyCode, KeyboardNavigation.ItemNavigationHandler<V> navigationHandler)
KeyboardNavigation<V>	removeNavigationHandler(String keyCode, KeyboardNavigation.ItemNavigationHandler<V> navigationHandler)
KeyboardNavigation<V>	setEnterHandler(KeyboardNavigation.ItemNavigationHandler<V> enterHandler) A handler to be called when the user press enter key
KeyboardNavigation<V>	setEnterOptions(KeyboardNavigation.EventOptions enterOptions) Set global stopPropagation and preventDefault for enter key events
KeyboardNavigation<V>	setGlobalOptions(KeyboardNavigation.EventOptions globalOptions) Set global stopPropagation and preventDefault for all navigation keyboard events
KeyboardNavigation<V>	setSpaceHandler(KeyboardNavigation.ItemNavigationHandler<V> spaceHandler) A handler to be called when the user press sapce key
KeyboardNavigation<V>	setSpaceOptions(KeyboardNavigation.EventOptions spaceOptions) Set global stopPropagation and preventDefault for space key events
KeyboardNavigation<V>	setTabHandler(KeyboardNavigation.ItemNavigationHandler<V> tabHandler) A handler to be called when the user press tab key
KeyboardNavigation<V>	setTabOptions(KeyboardNavigation.EventOptions tabOptions) Set global stopPropagation and preventDefault for tab key events

Methods inherited from class java.lang.Object

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

Constructor Detail

KeyboardNavigation

public KeyboardNavigation(List<V> items)

Method Detail

create

public static <V extends org.jboss.elemento.IsElement<?>> KeyboardNavigation<V> create(List<V> items)

Creates new navigation for a menu contains a list of items

Type Parameters:

V - the element type

Parameters:

items - the items of the menu

Returns:

new instance

onFocus

public KeyboardNavigation<V> onFocus(KeyboardNavigation.FocusHandler<V> focusHandler)

Sets a handler which will be called when an item gets focused

Parameters:

focusHandler - A KeyboardNavigation.FocusHandler

Returns:

same instance

onSelect

public KeyboardNavigation<V> onSelect(KeyboardNavigation.ItemNavigationHandler<V> selectHandler)

Sets a handler which will be called when an item gets selected

Parameters:

selectHandler - A KeyboardNavigation.ItemNavigationHandler

Returns:

same instance

onEscape

public KeyboardNavigation<V> onEscape(KeyboardNavigation.EscapeHandler escapeHandler)

Sets a handler which will be called when escape key is pressed

Parameters:

escapeHandler - A KeyboardNavigation.EscapeHandler

Returns:

same instance

focusCondition

public KeyboardNavigation<V> focusCondition(KeyboardNavigation.FocusCondition<V> focusCondition)

Adds a condition which evaluates if an item should be focused or not

Parameters:

focusCondition - a condition returns true if an item should be focused, false otherwise

Returns:

same instance

handleEvent

public void handleEvent(elemental2.dom.Event evt)

Specified by:

handleEvent in interface elemental2.dom.EventListener

setEnterHandler

public KeyboardNavigation<V> setEnterHandler(KeyboardNavigation.ItemNavigationHandler<V> enterHandler)

A handler to be called when the user press enter key

Parameters:

enterHandler - KeyboardNavigation.ItemNavigationHandler

Returns:

same navigation instance

setTabHandler

public KeyboardNavigation<V> setTabHandler(KeyboardNavigation.ItemNavigationHandler<V> tabHandler)

A handler to be called when the user press tab key

Parameters:

tabHandler - KeyboardNavigation.ItemNavigationHandler

Returns:

same navigation instance

setSpaceHandler

public KeyboardNavigation<V> setSpaceHandler(KeyboardNavigation.ItemNavigationHandler<V> spaceHandler)

A handler to be called when the user press sapce key

Parameters:

spaceHandler - KeyboardNavigation.ItemNavigationHandler

Returns:

same navigation instance

setGlobalOptions

public KeyboardNavigation<V> setGlobalOptions(KeyboardNavigation.EventOptions globalOptions)

Set global stopPropagation and preventDefault for all navigation keyboard events

Parameters:

globalOptions - KeyboardNavigation.EventOptions

Returns:

same navigation instance

setEnterOptions

public KeyboardNavigation<V> setEnterOptions(KeyboardNavigation.EventOptions enterOptions)

Set global stopPropagation and preventDefault for enter key events

Parameters:

enterOptions - KeyboardNavigation.EventOptions

Returns:

same navigation instance

setTabOptions

public KeyboardNavigation<V> setTabOptions(KeyboardNavigation.EventOptions tabOptions)

Set global stopPropagation and preventDefault for tab key events

Parameters:

tabOptions - KeyboardNavigation.EventOptions

Returns:

same navigation instance

setSpaceOptions

public KeyboardNavigation<V> setSpaceOptions(KeyboardNavigation.EventOptions spaceOptions)

Set global stopPropagation and preventDefault for space key events

Parameters:

spaceOptions - KeyboardNavigation.EventOptions

Returns:

same navigation instance

focusNext

public void focusNext(V item)

Force focus next focusable item based on the provided item

Parameters:

item - Base item to focus the next item based on

isLastFocusableItem

public boolean isLastFocusableItem(V item)

Parameters:

item - The item to check if is the last focusable item in the items list

Returns:

boolean, true if the item is the last focusable item

focusTopFocusableItem

public void focusTopFocusableItem()

apply focus on the top most focusable item

focusPrevious

public void focusPrevious(V item)

Focus the focusable item that is before the provided item.

Parameters:

item - The item to base focus on

focusAt

public void focusAt(int index)

Focuses an item at a specific index

Parameters:

index - the index of the item

registerNavigationHandler

public KeyboardNavigation<V> registerNavigationHandler(String keyCode,
                                                       KeyboardNavigation.ItemNavigationHandler<V> navigationHandler)

Parameters:

keyCode - String keyboard key code

navigationHandler - the navigation handler to be registered

Returns:

same instance

removeNavigationHandler

public KeyboardNavigation<V> removeNavigationHandler(String keyCode,
                                                     KeyboardNavigation.ItemNavigationHandler<V> navigationHandler)

Parameters:

keyCode - String keyboard key code

navigationHandler - the navigation handler to be removed

Returns:

same instance