org.mini2Dx.ui.navigation

Class GridUiNavigation

java.lang.Object

org.mini2Dx.ui.navigation.GridUiNavigation

All Implemented Interfaces:

HoverListener, UiNavigation

public class GridUiNavigation
extends java.lang.Object
implements UiNavigation

A UiNavigation implementation that treats all UiElements as placed inside a grid

Constructor Summary

Constructors

Constructor and Description
GridUiNavigation(int xsColumns) Constructor

Method Summary

Modifier and Type	Method and Description
void	add(Actionable actionable) Adds a Actionable to end of the navigation
Actionable	get(int x, int y)
Actionable	getCursor() Returns the Actionable highlighted by the cursor
int	getTotalColumns() Returns the total amount of columns for the current ScreenSize
int	getTotalRows() Returns the total amount of rows for the current ScreenSize
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	onHoverBegin(Hoverable source) Called when the mouse begins hovering a Hoverable
void	onHoverEnd(Hoverable source) Called when the mouse finishes hovering a Hoverable
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
Actionable	resetCursor(boolean triggerHoverEvent) Resets the selection back to the first Actionable
void	set(int index, Actionable actionable) Replace an Actionable at a specific index
void	set(int x, int y, Actionable actionable) Replaces the Actionable at the specified grid coordinate
void	setWidth(ScreenSize screenSize, int columns) Sets the amount columns of the grid on a specific ScreenSize
java.lang.String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

GridUiNavigation

public GridUiNavigation(int xsColumns)

Constructor

Parameters:

xsColumns - The amount of columns of the grid on a ScreenSize.XS screen

Method Detail

layout

public void layout(ScreenSize screenSize)

Description copied from interface: UiNavigation

Re-orders elements based on screen size if necessary

Specified by:

layout in interface UiNavigation

Parameters:

screenSize - The current ScreenSize

add

public void add(Actionable actionable)

Description copied from interface: UiNavigation

Adds a Actionable to end of the navigation

Specified by:

add in interface UiNavigation

Parameters:

actionable - The Actionable to add

remove

public void remove(Actionable actionable)

Description copied from interface: UiNavigation

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

Specified by:

remove in interface UiNavigation

Parameters:

actionable - The Actionable to remove

removeAll

public void removeAll()

Description copied from interface: UiNavigation

Removes all Actionable instances from the navigation

Specified by:

removeAll in interface UiNavigation

set

public void set(int index,
                Actionable actionable)

Description copied from interface: UiNavigation

Replace an Actionable at a specific index

Specified by:

set in interface UiNavigation

Parameters:

index - The index to replace

actionable - The new Actionable

get

public Actionable get(int x,
                      int y)

set

public void set(int x,
                int y,
                Actionable actionable)

Replaces the Actionable at the specified grid coordinate

Parameters:

x - The grid x coordinate

y - The grid y coordinate

actionable - The new Actionable

navigate

public Actionable navigate(int keycode)

Description copied from interface: UiNavigation

Update (if required) navigation from key input

Specified by:

navigate in interface UiNavigation

Parameters:

keycode - The key that was pressed

Returns:

The currently highlighted Actionable

getCursor

public Actionable getCursor()

Description copied from interface: UiNavigation

Returns the Actionable highlighted by the cursor

Specified by:

getCursor in interface UiNavigation

Returns:

Null if there is no Actionable

resetCursor

public Actionable resetCursor()

Description copied from interface: UiNavigation

Resets the selection back to the first Actionable

Specified by:

resetCursor in interface UiNavigation

Returns:

The first Actionable

resetCursor

public Actionable resetCursor(boolean triggerHoverEvent)

Description copied from interface: UiNavigation

Resets the selection back to the first Actionable

Specified by:

resetCursor in interface UiNavigation

Parameters:

triggerHoverEvent - True if a hover event should be triggered. Typically used when a controller is being used for navigation.

Returns:

The first Actionable

setWidth

public void setWidth(ScreenSize screenSize,
                     int columns)

Sets the amount columns of the grid on a specific ScreenSize

Parameters:

screenSize - The ScreenSize

columns - The amount of columns in the grid

getTotalColumns

public int getTotalColumns()

Returns the total amount of columns for the current ScreenSize

Returns:

getTotalRows

public int getTotalRows()

Returns the total amount of rows for the current ScreenSize

Returns:

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

onHoverBegin

public void onHoverBegin(Hoverable source)

Description copied from interface: HoverListener

Called when the mouse begins hovering a Hoverable

Specified by:

onHoverBegin in interface HoverListener

Parameters:

source - The Hoverable that the mouse began hovering

onHoverEnd

public void onHoverEnd(Hoverable source)

Description copied from interface: HoverListener

Called when the mouse finishes hovering a Hoverable

Specified by:

onHoverEnd in interface HoverListener

Parameters:

source - The Hoverable that the mouse finished hovering