org.mini2Dx.ui.element

Interface Navigatable

All Known Implementing Classes:

AbsoluteModal, AlignedModal, EditorNewFileDialog, EditorOpenFileDialog, Modal, Tab, TabView

public interface Navigatable

Common interface for UiElements that can be navigated by keyboard or controller

Method Summary

Modifier and Type	Method and Description
void	clearControllerHotkeys() Unmaps all controller hotkeys
void	clearHotkeys() Unmaps all hotkeys
void	clearKeyboardHotkeys() Unmaps all keyboard hotkeys
java.lang.String	getId() Returns the unique id of the Navigatable
UiNavigation	getNavigation() Returns the UiNavigation currently being navigated
ActionableRenderNode	hotkey(ControllerButton button) Returns the corresponding ActionableRenderNode mapped to a ControllerButton hotkey
ActionableRenderNode	hotkey(int keycode) Returns the corresponding ActionableRenderNode mapped to a keyboard hotkey
ActionableRenderNode	navigate(int keycode) Triggers a navigation and returns the newly highlighted ActionableRenderNode
void	setHotkey(ControllerButton button, Actionable actionable) Maps a ControllerButton to a Actionable
void	setHotkey(int keycode, Actionable actionable) Maps a keyboard button to a Actionable
void	unsetHotkey(ControllerButton button) Unmaps a ControllerButton hotkey
void	unsetHotkey(int keycode) Unmaps a keyboard hotkey

Method Detail

getId

java.lang.String getId()

Returns the unique id of the Navigatable

Returns:

A non-null String that is the id

navigate

ActionableRenderNode navigate(int keycode)

Triggers a navigation and returns the newly highlighted ActionableRenderNode

Parameters:

keycode - The navigation Input.Keys value

Returns:

Null if no UiNavigation is available

hotkey

ActionableRenderNode hotkey(int keycode)

Returns the corresponding ActionableRenderNode mapped to a keyboard hotkey

Parameters:

keycode - The Input.Keys keycode that is the hotkey

Returns:

Null if there is no mapping

hotkey

ActionableRenderNode hotkey(ControllerButton button)

Returns the corresponding ActionableRenderNode mapped to a ControllerButton hotkey

Parameters:

button - The ControllerButton that is the hotkey

Returns:

Null if there is no mapping

setHotkey

void setHotkey(ControllerButton button,
               Actionable actionable)

Maps a ControllerButton to a Actionable

Parameters:

button - The ControllerButton that is the hotkey

actionable - The Actionable to trigger when the hotkey is pressed

setHotkey

void setHotkey(int keycode,
               Actionable actionable)

Maps a keyboard button to a Actionable

Parameters:

keycode - The Input.Keys keycode that is the hotkey

actionable - The Actionable to trigger when the key is pressed

unsetHotkey

void unsetHotkey(ControllerButton button)

Unmaps a ControllerButton hotkey

Parameters:

button - The ControllerButton that is the hotkey

unsetHotkey

void unsetHotkey(int keycode)

Unmaps a keyboard hotkey

Parameters:

keycode - The Input.Keys keycode that is the hotkey

clearHotkeys

void clearHotkeys()

Unmaps all hotkeys

clearControllerHotkeys

void clearControllerHotkeys()

Unmaps all controller hotkeys

clearKeyboardHotkeys

void clearKeyboardHotkeys()

Unmaps all keyboard hotkeys

getNavigation

UiNavigation getNavigation()

Returns the UiNavigation currently being navigated

Returns:

Null if no navigation is occurring