org.mini2Dx.ui.navigation

Interface UiNavigation

All Known Implementing Classes:

GridUiNavigation, TabViewUiNavigation, VerticalUiNavigation

public interface UiNavigation

Common interface for user interface navigation

Method Summary

Modifier and Type	Method and Description
void	add(Actionable actionable) Adds a Actionable to end of the navigation
Actionable	getCursor() Returns the Actionable highlighted by the cursor
void	layout(ScreenSize screenSize) Re-orders elements based on screen size if necessary
Actionable	navigate(int keycode) Update (if required) navigation from key input
void	remove(Actionable actionable) Removes a Actionable from the navigation and shifts any following Actionables by 1 place
void	removeAll() Removes all Actionable instances from the navigation
Actionable	resetCursor() Resets the selection back to the first Actionable
void	set(int index, Actionable actionable) Replace an Actionable at a specific index

Method Detail

layout

void layout(ScreenSize screenSize)

Re-orders elements based on screen size if necessary

Parameters:

screenSize - The current ScreenSize

resetCursor

Actionable resetCursor()

Resets the selection back to the first Actionable

Returns:

The first Actionable

getCursor

Actionable getCursor()

Returns the Actionable highlighted by the cursor

Returns:

Null if there is no Actionable

add

void add(Actionable actionable)

Adds a Actionable to end of the navigation

Parameters:

actionable - The Actionable to add

remove

void remove(Actionable actionable)

Removes a Actionable from the navigation and shifts any following Actionables by 1 place

Parameters:

actionable - The Actionable to remove

removeAll

void removeAll()

Removes all Actionable instances from the navigation

set

void set(int index,
         Actionable actionable)

Replace an Actionable at a specific index

Parameters:

index - The index to replace

actionable - The new Actionable

navigate

Actionable navigate(int keycode)

Update (if required) navigation from key input

Parameters:

keycode - The key that was pressed

Returns:

The currently highlighted Actionable