org.mini2Dx.ui.element

Class TabView

java.lang.Object

org.mini2Dx.ui.element.UiElement

org.mini2Dx.ui.element.ParentUiElement

org.mini2Dx.ui.element.TabView

All Implemented Interfaces:

FlexUiElement, Hoverable, Navigatable

public class TabView
extends ParentUiElement
implements Navigatable

A UiElement of tabs that can be switched between by the player

Field Summary

Fields

Modifier and Type	Field and Description
protected org.mini2Dx.gdx.utils.Array<Tab>	tabs

Fields inherited from class org.mini2Dx.ui.element.ParentUiElement

asyncRemoveAll, children, renderNode

Fields inherited from class org.mini2Dx.ui.element.UiElement

deferredLayout, deferredRender, deferredUpdate, effects, height, styleId, visibility, width, x, y, zIndex

Constructor Summary

Constructors

Constructor and Description
TabView() Constructor.
TabView(java.lang.String id) Constructor
TabView(java.lang.String id, float x, float y, float width, float height) Constructor
TabView(java.lang.String id, float x, float y, float width, float height, TabButton previousTabButton, TabButton nextTabButton) Constructor
TabView(java.lang.String id, TabButton previousTabButton, TabButton nextTabButton) Constructor

Method Summary

Modifier and Type	Method and Description
void	add(int index, Tab tab) Inserts a Tab into this TabView
void	add(Tab tab) Adds a Tab to this TabView
void	clearGamePadHotkeys() Unmaps all gamepad hotkeys
void	clearHotkeys() Unmaps all hotkeys
void	clearKeyboardHotkeys() Unmaps all keyboard hotkeys
boolean	containsTab(Tab tab) Returns if the TabView contains a Tab
protected ParentRenderNode<?,?>	createRenderNode(ParentRenderNode<?,?> parent) Creates the ParentRenderNode for this UiElement
Tab	getCurrentTab() Returns the currently visible Tab
int	getCurrentTabIndex() Returns the index of the currently visible Tab
UiElement	getElementById(java.lang.String id) Searches the UI for a UiElement with a given id.
UiNavigation	getNavigation() Returns the UiNavigation currently being navigated
TabButton	getNextTabButton()
TabButton	getPreviousTabButton()
StyleRule	getStyleRule()
Tab	getTab(int index) Returns the Tab at a specific index
int	getTotalTabs() Returns the total number of tabs in this TabView
ActionableRenderNode	hotkey(GamePadButton button) Returns the corresponding ActionableRenderNode mapped to a GamePadButton 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	nextTab() Navigates to the next Tab.
void	previousTab() Navigates to the previous Tab.
Tab	remove(int index) Removes a Tab at a specific index from this TabView
boolean	remove(Tab tab) Removes a Tab from this TabView
void	setCurrentTab(Tab tab) Sets the currently visible Tab
void	setCurrentTabIndex(int currentTabIndex) Sets the currently visible Tab
void	setHotkey(GamePadButton button, Actionable actionable) Maps a GamePadButton to a Actionable
void	setHotkey(int keycode, Actionable actionable) Maps a keyboard button to a Actionable
void	setNextTabButtonLayout(java.lang.String flexLayout)
void	setNextTabHotkey(GamePadButton button) Sets a GamePadButton as the hotkey for changing to the next tab
void	setNextTabHotkey(int keycode) Sets a keyboard key as the hotkey for changing to the next tab
void	setPreviousTabButtonLayout(java.lang.String flexLayout)
void	setPreviousTabHotkey(GamePadButton button) Sets a GamePadButton as the hotkey for changing to the previous tab
void	setPreviousTabHotkey(int keycode) Sets a keyboard key as the hotkey for changing to the previous tab
void	setStyleId(java.lang.String styleId) Sets the style if for this UiElement
void	setTabButtonLayout(java.lang.String flexLayout)
void	setVisibility(Visibility visibility) Sets the current Visibility of this UiElement
void	setZIndex(int zIndex) Sets the Z index of this UiElement.
void	syncWithLayout(UiContainerRenderTree rootNode) Syncs data between the UiElement and RenderNode during UI layout
void	syncWithUpdate(UiContainerRenderTree rootNode) Syncs data between the UiElement and RenderNode during update
void	unsetHotkey(GamePadButton button) Unmaps a GamePadButton hotkey
void	unsetHotkey(int keycode) Unmaps a keyboard hotkey
void	unsetNextTabHotkey(GamePadButton button) Unets a GamePadButton as the hotkey for changing to the next tab
void	unsetNextTabHotkey(int keycode) Unsets a keyboard key as the hotkey for changing to the next tab
void	unsetPreviousTabHotkey(GamePadButton button) Unets a GamePadButton as the hotkey for changing to the previous tab
void	unsetPreviousTabHotkey(int keycode) Unsets a keyboard key as the hotkey for changing to the previous tab

Methods inherited from class org.mini2Dx.ui.element.ParentUiElement

add, add, attach, detach, get, getChild, getFlexLayout, getRenderHeight, getRenderWidth, getRenderX, getRenderY, getTotalChildren, invokeBeginHover, invokeEndHover, isFlexLayout, isInitialLayoutOccurred, isInitialUpdateOccurred, isOverflowClipped, isRenderNodeDirty, remove, removeAll, removeAllAsync, setFlex, setFlexLayout, setHeightFlex, setOverflowClipped, setRenderNodeDirty, setWidthFlex, setXFlex, setXYFlex, setYFlex, shrinkToContents, shrinkToContents

Methods inherited from class org.mini2Dx.ui.element.UiElement

addEffectListener, addHoverListener, addNodeStateListener, alignAbove, alignBelow, alignEdgeToEdge, alignLeftOf, alignRightOf, applyEffect, deferUntilLayout, deferUntilLayout, deferUntilRender, deferUntilRender, deferUntilUpdate, deferUntilUpdate, deferUntilUpdate, deferUntilUpdate, equals, getContentHeight, getContentWidth, getHeight, getId, getMarginBottom, getMarginLeft, getMarginRight, getMarginTop, getPaddingBottom, getPaddingLeft, getPaddingRight, getPaddingTop, getStyleId, getVisibility, getWidth, getX, getY, getZIndex, hashCode, isDebugEnabled, isInitialised, notifyEffectListenersOnFinished, notifyHoverListenersOnBeginHover, notifyHoverListenersOnEndHover, notifyNodeStateListeners, removeEffectListener, removeHoverListener, removeNodeStateListener, set, setContentHeight, setContentWidth, setDebugEnabled, setHeight, setHeightToContentHeightOf, setHeightToHeightOf, setWidth, setWidthToContentWidthOf, setWidthToWidthOf, setX, setXY, setY, snapTo, snapTo, syncWithRender

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.mini2Dx.ui.element.Navigatable

getId

Field Detail

tabs

protected final org.mini2Dx.gdx.utils.Array<Tab> tabs

Constructor Detail

TabView

public TabView()

Constructor. Generates a unique ID for this TabView

TabView

public TabView(java.lang.String id)

Constructor

Parameters:

id - The unique ID of this TabView

TabView

public TabView(java.lang.String id,
               float x,
               float y,
               float width,
               float height)

Constructor

Parameters:

id - The unique ID for this element (if null an ID will be generated)

x - The x coordinate of this element relative to its parent

y - The y coordinate of this element relative to its parent

width - The width of this element

height - The height of this element

TabView

public TabView(java.lang.String id,
               TabButton previousTabButton,
               TabButton nextTabButton)

Constructor

Parameters:

id - The unique ID of this TabView

previousTabButton - The TabButton to use for changing to the previous tab

nextTabButton - The TabButton to use for changing to the next tab

TabView

public TabView(java.lang.String id,
               float x,
               float y,
               float width,
               float height,
               TabButton previousTabButton,
               TabButton nextTabButton)

Constructor

Parameters:

id - The unique ID of this TabView

x - The x coordinate of this element relative to its parent

y - The y coordinate of this element relative to its parent

width - The width of this element

height - The height of this element

previousTabButton - The TabButton to use for changing to the previous tab

nextTabButton - The TabButton to use for changing to the next tab

Method Detail

add

public void add(Tab tab)

Adds a Tab to this TabView

Parameters:

tab - The Tab to add

add

public void add(int index,
                Tab tab)

Inserts a Tab into this TabView

Parameters:

index - The index to insert at

tab - The Tab to insert

remove

public boolean remove(Tab tab)

Removes a Tab from this TabView

Parameters:

tab - The Tab to remove

Returns:

True if this TabView contained the Tab

remove

public Tab remove(int index)

Removes a Tab at a specific index from this TabView

Overrides:

remove in class ParentUiElement

Parameters:

index - The index to remove

Returns:

The Tab that was removed

getTab

public Tab getTab(int index)

Returns the Tab at a specific index

Parameters:

index - The index of the Tab

Returns:

The Tab at the specified index

containsTab

public boolean containsTab(Tab tab)

Returns if the TabView contains a Tab

Parameters:

tab - The Tab to search for

Returns:

True if the Tab is added to this TabView

getTotalTabs

public int getTotalTabs()

Returns the total number of tabs in this TabView

Returns:

0 if no Tabs have been added

syncWithLayout

public void syncWithLayout(UiContainerRenderTree rootNode)

Description copied from class: UiElement

Syncs data between the UiElement and RenderNode during UI layout

Overrides:

syncWithLayout in class UiElement

syncWithUpdate

public void syncWithUpdate(UiContainerRenderTree rootNode)

Description copied from class: UiElement

Syncs data between the UiElement and RenderNode during update

Overrides:

syncWithUpdate in class ParentUiElement

createRenderNode

protected ParentRenderNode<?,?> createRenderNode(ParentRenderNode<?,?> parent)

Description copied from class: ParentUiElement

Creates the ParentRenderNode for this UiElement

Specified by:

createRenderNode in class ParentUiElement

Parameters:

parent - The parent of this node

Returns:

A new instance of ParentRenderNode

setVisibility

public void setVisibility(Visibility visibility)

Description copied from class: UiElement

Sets the current Visibility of this UiElement

Overrides:

setVisibility in class ParentUiElement

Parameters:

visibility - The Visibility to set

setStyleId

public void setStyleId(java.lang.String styleId)

Description copied from class: UiElement

Sets the style if for this UiElement

Overrides:

setStyleId in class ParentUiElement

Parameters:

styleId - The style id to set

setZIndex

public void setZIndex(int zIndex)

Description copied from class: UiElement

Sets the Z index of this UiElement. Elements will be rendered on different Z layers in ascending Z order (negatives values first, positive values last)

Overrides:

setZIndex in class ParentUiElement

Parameters:

zIndex - The Z index

getStyleRule

public StyleRule getStyleRule()

Specified by:

getStyleRule in class UiElement

getCurrentTab

public Tab getCurrentTab()

Returns the currently visible Tab

Returns:

Null if no Tab is visible

setCurrentTab

public void setCurrentTab(Tab tab)

Sets the currently visible Tab

Parameters:

tab - The Tab to set as visible (must already be added to the TabView

getCurrentTabIndex

public int getCurrentTabIndex()

Returns the index of the currently visible Tab

Returns:

0 by default

setCurrentTabIndex

public void setCurrentTabIndex(int currentTabIndex)

Sets the currently visible Tab

Parameters:

currentTabIndex - The index of the Tab

nextTab

public void nextTab()

Navigates to the next Tab. If the current tab is the last tab, this will loop back to the first tab.

previousTab

public void previousTab()

Navigates to the previous Tab. If the current tab is the first tab, this will loop to the last tab.

navigate

public ActionableRenderNode navigate(int keycode)

Description copied from interface: Navigatable

Triggers a navigation and returns the newly highlighted ActionableRenderNode

Specified by:

navigate in interface Navigatable

Parameters:

keycode - The navigation Input.Keys value

Returns:

Null if no UiNavigation is available

hotkey

public ActionableRenderNode hotkey(int keycode)

Description copied from interface: Navigatable

Returns the corresponding ActionableRenderNode mapped to a keyboard hotkey

Specified by:

hotkey in interface Navigatable

Parameters:

keycode - The Input.Keys keycode that is the hotkey

Returns:

Null if there is no mapping

hotkey

public ActionableRenderNode hotkey(GamePadButton button)

Description copied from interface: Navigatable

Returns the corresponding ActionableRenderNode mapped to a GamePadButton hotkey

Specified by:

hotkey in interface Navigatable

Parameters:

button - The GamePadButton that is the hotkey

Returns:

Null if there is no mapping

getNavigation

public UiNavigation getNavigation()

Description copied from interface: Navigatable

Returns the UiNavigation currently being navigated

Specified by:

getNavigation in interface Navigatable

Returns:

Null if no navigation is occurring

setPreviousTabHotkey

public void setPreviousTabHotkey(int keycode)

Sets a keyboard key as the hotkey for changing to the previous tab

Parameters:

keycode - The Input.Keys keycode

setPreviousTabHotkey

public void setPreviousTabHotkey(GamePadButton button)

Sets a GamePadButton as the hotkey for changing to the previous tab

Parameters:

button - The GamePadButton

setNextTabHotkey

public void setNextTabHotkey(int keycode)

Sets a keyboard key as the hotkey for changing to the next tab

Parameters:

keycode - The Input.Keys keycode

setNextTabHotkey

public void setNextTabHotkey(GamePadButton button)

Sets a GamePadButton as the hotkey for changing to the next tab

Parameters:

button - The GamePadButton

unsetPreviousTabHotkey

public void unsetPreviousTabHotkey(int keycode)

Unsets a keyboard key as the hotkey for changing to the previous tab

Parameters:

keycode - The Input.Keys keycode

unsetPreviousTabHotkey

public void unsetPreviousTabHotkey(GamePadButton button)

Unets a GamePadButton as the hotkey for changing to the previous tab

Parameters:

button - The GamePadButton

unsetNextTabHotkey

public void unsetNextTabHotkey(int keycode)

Unsets a keyboard key as the hotkey for changing to the next tab

Parameters:

keycode - The Input.Keys keycode

unsetNextTabHotkey

public void unsetNextTabHotkey(GamePadButton button)

Unets a GamePadButton as the hotkey for changing to the next tab

Parameters:

button - The GamePadButton

setHotkey

public void setHotkey(GamePadButton button,
                      Actionable actionable)

Description copied from interface: Navigatable

Maps a GamePadButton to a Actionable

Specified by:

setHotkey in interface Navigatable

Parameters:

button - The GamePadButton that is the hotkey

actionable - The Actionable to trigger when the hotkey is pressed

setHotkey

public void setHotkey(int keycode,
                      Actionable actionable)

Description copied from interface: Navigatable

Maps a keyboard button to a Actionable

Specified by:

setHotkey in interface Navigatable

Parameters:

keycode - The Input.Keys keycode that is the hotkey

actionable - The Actionable to trigger when the key is pressed

unsetHotkey

public void unsetHotkey(GamePadButton button)

Description copied from interface: Navigatable

Unmaps a GamePadButton hotkey

Specified by:

unsetHotkey in interface Navigatable

Parameters:

button - The GamePadButton that is the hotkey

unsetHotkey

public void unsetHotkey(int keycode)

Description copied from interface: Navigatable

Unmaps a keyboard hotkey

Specified by:

unsetHotkey in interface Navigatable

Parameters:

keycode - The Input.Keys keycode that is the hotkey

clearGamePadHotkeys

public void clearGamePadHotkeys()

Description copied from interface: Navigatable

Unmaps all gamepad hotkeys

Specified by:

clearGamePadHotkeys in interface Navigatable

clearKeyboardHotkeys

public void clearKeyboardHotkeys()

Description copied from interface: Navigatable

Unmaps all keyboard hotkeys

Specified by:

clearKeyboardHotkeys in interface Navigatable

clearHotkeys

public void clearHotkeys()

Description copied from interface: Navigatable

Unmaps all hotkeys

Specified by:

clearHotkeys in interface Navigatable

setPreviousTabButtonLayout

public void setPreviousTabButtonLayout(java.lang.String flexLayout)

setNextTabButtonLayout

public void setNextTabButtonLayout(java.lang.String flexLayout)

setTabButtonLayout

public void setTabButtonLayout(java.lang.String flexLayout)

getPreviousTabButton

public TabButton getPreviousTabButton()

getNextTabButton

public TabButton getNextTabButton()

getElementById

public UiElement getElementById(java.lang.String id)

Description copied from class: UiElement

Searches the UI for a UiElement with a given id. Warning: This can be an expensive operation for complex UIs. It is recommended you cache results.

Overrides:

getElementById in class ParentUiElement

Parameters:

id - The UiElement identifier to search for

Returns:

Null if there is no such UiElement with the given id