org.mini2Dx.ui.element

Class Container

java.lang.Object

org.mini2Dx.ui.element.UiElement

org.mini2Dx.ui.element.ParentUiElement

org.mini2Dx.ui.element.Div

org.mini2Dx.ui.element.Container

All Implemented Interfaces:

FlexUiElement, Hoverable, Navigatable

public class Container
extends Div
implements Navigatable

Element for containing UiElements. Container can act as a window through UiTheme styles.

Field Summary

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
Container() Constructor.
Container(float x, float y, float width, float height) Constructor
Container(java.lang.String id) Constructor
Container(java.lang.String id, float x, float y, float width, float height) Constructor

Method Summary

Modifier and Type	Method and Description
void	clearGamePadHotkeys() Unmaps all gamepad hotkeys
void	clearHotkeys() Unmaps all hotkeys
void	clearKeyboardHotkeys() Unmaps all keyboard hotkeys
protected ParentRenderNode<?,?>	createRenderNode(ParentRenderNode<?,?> parent) Creates the ParentRenderNode for this UiElement
UiNavigation	getNavigation() Returns the UiNavigation currently being navigated
StyleRule	getStyleRule()
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	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	setNavigation(UiNavigation navigation)
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

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

withElements, withElements

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

add, add, attach, detach, get, getChild, getElementById, getFlexLayout, getRenderHeight, getRenderWidth, getRenderX, getRenderY, getTotalChildren, invokeBeginHover, invokeEndHover, isFlexLayout, isInitialLayoutOccurred, isInitialUpdateOccurred, isOverflowClipped, isRenderNodeDirty, remove, remove, removeAll, removeAllAsync, setFlex, setFlexLayout, setHeightFlex, setOverflowClipped, setRenderNodeDirty, setStyleId, setVisibility, setWidthFlex, setXFlex, setXYFlex, setYFlex, setZIndex, 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, syncWithLayout, 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

Constructor Detail

Container

public Container()

Constructor. Generates a unique ID for the Container

Container

public Container(java.lang.String id)

Constructor

Parameters:

id - The unique ID for the Container

Container

public Container(float x,
                 float y,
                 float width,
                 float height)

Constructor

Parameters:

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

Container

public Container(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

Method Detail

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

Overrides:

createRenderNode in class Div

Parameters:

parent - The parent of this node

Returns:

A new instance of ParentRenderNode

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

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

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

setNavigation

public void setNavigation(UiNavigation navigation)

getStyleRule

public StyleRule getStyleRule()

Overrides:

getStyleRule in class Div