VerticalUiNavigation (mini2Dx-uats API)

java.lang.Object
- org.mini2Dx.ui.navigation.VerticalUiNavigation

All Implemented Interfaces:

UiNavigation
```
public class VerticalUiNavigation
extends java.lang.Object
implements UiNavigation
```
A UiNavigation implementation that treats all UiElements as stacked vertically

Constructor Summary

Constructors
Constructor and Description

VerticalUiNavigation()

Constructors
Constructor and Description
`VerticalUiNavigation()`

Method Summary

Methods
Modifier and Type	Method and Description
`void`	`add(Actionable actionable)` Adds a `Actionable` to end of the navigation
`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 `Actionable`s by 1 place
`Actionable`	`resetCursor()` Resets the selection back to the first `Actionable`
`void`	`set(int index, Actionable actionable)` Replace an `Actionable` at a specific index

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - VerticalUiNavigation
```
public VerticalUiNavigation()
```
- Method Detail
  - 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
  - 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
  - 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
  - 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
  - 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

Class VerticalUiNavigation

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

VerticalUiNavigation

Method Detail

add

remove

set

navigate

resetCursor

layout