org.mini2Dx.ui

Class UiContainer

java.lang.Object

org.mini2Dx.ui.element.UiElement

org.mini2Dx.ui.element.ParentUiElement

org.mini2Dx.ui.UiContainer

All Implemented Interfaces:

org.mini2Dx.gdx.InputProcessor, FlexUiElement, Hoverable

public class UiContainer
extends ParentUiElement
implements org.mini2Dx.gdx.InputProcessor

The container for all UI elements. update(float) and render(Graphics) must be called by your GameContainer

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
UiContainer(GameContainer gc, AssetManager assetManager) Constructor
UiContainer(int width, int height, AssetManager assetManager)

Method Summary

Modifier and Type	Method and Description
void	addActionKey(int keycode) Add the key used for triggering actions (i.e.
void	addGamePadInput(GamePadUiInput<?> input) Adds a GamePadUiInput instance to this UiContainer
void	addInputSourceListener(UiInputSourceListener listener) Adds a UiInputSourceListener to this UiContainer
void	addScreenSizeListener(ScreenSizeListener listener) Adds a ScreenSizeListener to listen for ScreenSize change
void	addUiContainerListener(UiContainerListener listener) Adds a UiContainerListener to this UiContainer
void	attach(ParentRenderNode<?,?> parentRenderNode) Attaches a RenderNode for this element to a parent RenderNode
boolean	buttonDown(GamePadUiInput<?> controllerUiInput, GamePadButton button)
boolean	buttonUp(GamePadUiInput<?> controllerUiInput, GamePadButton button)
void	clearActionKeys() Clears the keys used for triggering actions (i.e.
void	clearActiveAction()
void	clearActiveNavigation() Clears the current Navigatable being navigated
protected ParentRenderNode<?,?>	createRenderNode(ParentRenderNode<?,?> parent) Creates the ParentRenderNode for this UiElement
void	detach(ParentRenderNode<?,?> parentRenderNode) Detaches this element's RenderNode from a parent RenderNode
void	dispose()
ActionableRenderNode	getActiveAction() Returns the currently hovered ActionableRenderNode
Navigatable	getActiveNavigation() Returns the currently active Navigatable
static Visibility	getDefaultVisibility() Returns the default Visibility for newly created UiElement objects
float	getHeight() Returns the height of the UiContainer
GamePadType	getLastGamePadType() Returns the last GamePadType used on the UiContainer
InputSource	getLastInputSource() Returns the last InputSource used on the UiContainer
float	getScaleX() Returns the configured Graphics scaling during rendering
float	getScaleY() Returns the configured Graphics scaling during rendering
ScreenSizeScaleMode	getScreenSizeScaleMode() Returns the scaling mode used for ScreenSize values
static UiContainerState	getState() Returns the current UiContainerState
StyleRule	getStyleRule()
static UiTheme	getTheme() Returns the UiTheme currently applied to this UiContainer
float	getWidth() Returns the width of the UiContainer
static boolean	isThemeApplied() Returns if a UiTheme has been applied to thi UiContainer
boolean	keyDown(int keycode)
boolean	keyNavigationAllowed() Returns if this UiContainer can be navigated by keyboard/gamepad
boolean	keyTyped(char character)
boolean	keyUp(int keycode)
boolean	mouseMoved(int screenX, int screenY)
boolean	pointerNavigationAllowed() Returns if this UiContainer can be navigated by touch/mouse
static void	relayoutAllUiContainers()
void	removeActionKey(int keycode) Removes a key used for triggering actions (i.e.
void	removeGamePadInput(GamePadUiInput<?> input) Removes a GamePadUiInput instance from this UiContainer
void	removeScreenSizeListener(ScreenSizeListener listener) Removes a ScreenSizeListener from this UiContainer
void	removeUiContainerListener(UiContainerListener listener) Removes a UiContainerListener from this UiContainer
void	removeUiContainerListener(UiInputSourceListener listener) Removes a UiInputSourceListener from this UiContainer
void	render(Graphics g) Renders all visible UiElements
boolean	scrolled(int amount)
void	set(int width, int height) Sets the width and height of the UiContainer
void	setActiveAction(ActionableRenderNode actionable)
void	setActiveNavigation(Navigatable activeNavigation) Sets the current Navigatable for UI navigation
static void	setDefaultVisibility(Visibility defaultVisibility) Sets the default Visibility for newly created UiElement objects
void	setLastGamePadType(GamePadType lastGamePadType) Sets the last GamePadType used on the UiContainer
void	setLastInputSource(InputSource lastInputSource) Sets the last InputSource used on the UiContainer
void	setNavigationMode(NavigationMode navigationMode) Sets the NavigationMode on this UiContainer
void	setPassThroughMouseMovement(boolean passThroughMouseMovement) Set to true if mouseMoved() events to should pass through this input handler regardless
void	setScale(float scaleX, float scaleY) Sets the Graphics scaling during rendering.
void	setScreenSizeScaleMode(ScreenSizeScaleMode screenSizeScaleMode) Sets the scaling mode used for ScreenSize values
void	setStyleId(java.lang.String styleId) Sets the style if for this UiElement
static void	setTheme(UiTheme theme) Sets the current UiTheme for this UiContainer
void	setViewport(Viewport viewport)
void	setVisibility(Visibility visibility) Sets the current Visibility of this UiElement
void	setZIndex(int zIndex) Sets the Z index of this UiElement.
boolean	touchDown(int screenX, int screenY, int pointer, int button)
boolean	touchDragged(int screenX, int screenY, int pointer)
boolean	touchUp(int screenX, int screenY, int pointer, int button)
void	update(float delta) Updates all UiElements

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

add, add, 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, setWidthFlex, setXFlex, setXYFlex, setYFlex, shrinkToContents, shrinkToContents, syncWithUpdate

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, getId, getMarginBottom, getMarginLeft, getMarginRight, getMarginTop, getPaddingBottom, getPaddingLeft, getPaddingRight, getPaddingTop, getStyleId, getVisibility, 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

Constructor Detail

UiContainer

public UiContainer(GameContainer gc,
                   AssetManager assetManager)

Constructor

Parameters:

gc - Your game's GameContainer

assetManager - The AssetManager for the game

UiContainer

public UiContainer(int width,
                   int height,
                   AssetManager assetManager)

Method Detail

relayoutAllUiContainers

public static void relayoutAllUiContainers()

dispose

public void dispose()

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

update

public void update(float delta)

Updates all UiElements

Parameters:

delta - The time since the last frame (in seconds)

render

public void render(Graphics g)

Renders all visible UiElements

Parameters:

g - The Graphics context

attach

public void attach(ParentRenderNode<?,?> parentRenderNode)

Description copied from class: UiElement

Attaches a RenderNode for this element to a parent RenderNode

Overrides:

attach in class ParentUiElement

Parameters:

parentRenderNode - The parent RenderNode to attach to

detach

public void detach(ParentRenderNode<?,?> parentRenderNode)

Description copied from class: UiElement

Detaches this element's RenderNode from a parent RenderNode

Overrides:

detach in class ParentUiElement

Parameters:

parentRenderNode - The parent RenderNode to detach from

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

addScreenSizeListener

public void addScreenSizeListener(ScreenSizeListener listener)

Adds a ScreenSizeListener to listen for ScreenSize change

Parameters:

listener - The ScreenSizeListener to add

removeScreenSizeListener

public void removeScreenSizeListener(ScreenSizeListener listener)

Removes a ScreenSizeListener from this UiContainer

Parameters:

listener - The ScreenSizeListener to remove

isThemeApplied

public static boolean isThemeApplied()

Returns if a UiTheme has been applied to thi UiContainer

Returns:

True if the UiTheme has been applied

getTheme

public static UiTheme getTheme()

Returns the UiTheme currently applied to this UiContainer

Returns:

Null if no UiTheme has been applied

setTheme

public static void setTheme(UiTheme theme)

Sets the current UiTheme for this UiContainer

Parameters:

theme - The UiTheme to apply

getState

public static UiContainerState getState()

Returns the current UiContainerState

Returns:

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

touchDown

public boolean touchDown(int screenX,
                         int screenY,
                         int pointer,
                         int button)

Specified by:

touchDown in interface org.mini2Dx.gdx.InputProcessor

touchUp

public boolean touchUp(int screenX,
                       int screenY,
                       int pointer,
                       int button)

Specified by:

touchUp in interface org.mini2Dx.gdx.InputProcessor

touchDragged

public boolean touchDragged(int screenX,
                            int screenY,
                            int pointer)

Specified by:

touchDragged in interface org.mini2Dx.gdx.InputProcessor

mouseMoved

public boolean mouseMoved(int screenX,
                          int screenY)

Specified by:

mouseMoved in interface org.mini2Dx.gdx.InputProcessor

scrolled

public boolean scrolled(int amount)

Specified by:

scrolled in interface org.mini2Dx.gdx.InputProcessor

keyTyped

public boolean keyTyped(char character)

Specified by:

keyTyped in interface org.mini2Dx.gdx.InputProcessor

keyDown

public boolean keyDown(int keycode)

Specified by:

keyDown in interface org.mini2Dx.gdx.InputProcessor

keyUp

public boolean keyUp(int keycode)

Specified by:

keyUp in interface org.mini2Dx.gdx.InputProcessor

buttonDown

public boolean buttonDown(GamePadUiInput<?> controllerUiInput,
                          GamePadButton button)

buttonUp

public boolean buttonUp(GamePadUiInput<?> controllerUiInput,
                        GamePadButton button)

setActiveAction

public void setActiveAction(ActionableRenderNode actionable)

setActiveNavigation

public void setActiveNavigation(Navigatable activeNavigation)

Sets the current Navigatable for UI navigation

Parameters:

activeNavigation - The current Navigatable being navigated

clearActiveAction

public void clearActiveAction()

clearActiveNavigation

public void clearActiveNavigation()

Clears the current Navigatable being navigated

getActiveNavigation

public Navigatable getActiveNavigation()

Returns the currently active Navigatable

Returns:

null if there is nothing active

getActiveAction

public ActionableRenderNode getActiveAction()

Returns the currently hovered ActionableRenderNode

Returns:

Null if nothing is hovered

getWidth

public float getWidth()

Returns the width of the UiContainer

Overrides:

getWidth in class UiElement

Returns:

The width in pixels

getHeight

public float getHeight()

Returns the height of the UiContainer

Overrides:

getHeight in class UiElement

Returns:

The height in pixels

getStyleRule

public StyleRule getStyleRule()

Specified by:

getStyleRule in class UiElement

set

public void set(int width,
                int height)

Sets the width and height of the UiContainer

Parameters:

width - The width in pixels

height - The height in pixels

getScaleX

public float getScaleX()

Returns the configured Graphics scaling during rendering

Returns:

1f by default

getScaleY

public float getScaleY()

Returns the configured Graphics scaling during rendering

Returns:

1f by default

setScale

public void setScale(float scaleX,
                     float scaleY)

Sets the Graphics scaling during rendering. Mouse/touch coordinates will be scaled accordingly.

Parameters:

scaleX - Scaling along the X axis

scaleY - Scaling along the Y axis

getLastInputSource

public InputSource getLastInputSource()

Returns the last InputSource used on the UiContainer

Returns:

setLastInputSource

public void setLastInputSource(InputSource lastInputSource)

Sets the last InputSource used on the UiContainer

Parameters:

lastInputSource - The InputSource last used

getLastGamePadType

public GamePadType getLastGamePadType()

Returns the last GamePadType used on the UiContainer

Returns:

setLastGamePadType

public void setLastGamePadType(GamePadType lastGamePadType)

Sets the last GamePadType used on the UiContainer

Parameters:

lastGamePadType - The GamePadType last used

addGamePadInput

public void addGamePadInput(GamePadUiInput<?> input)

Adds a GamePadUiInput instance to this UiContainer

Parameters:

input - The instance to add

removeGamePadInput

public void removeGamePadInput(GamePadUiInput<?> input)

Removes a GamePadUiInput instance from this UiContainer

Parameters:

input - The instance to remove

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

addActionKey

public void addActionKey(int keycode)

Add the key used for triggering actions (i.e. selecting a menu option)

Parameters:

keycode - The Input.Keys value

removeActionKey

public void removeActionKey(int keycode)

Removes a key used for triggering actions (i.e. selecting a menu option)

Parameters:

keycode - The Input.Keys value

clearActionKeys

public void clearActionKeys()

Clears the keys used for triggering actions (i.e. selecting a menu option)

setPassThroughMouseMovement

public void setPassThroughMouseMovement(boolean passThroughMouseMovement)

Set to true if mouseMoved() events to should pass through this input handler regardless

Parameters:

passThroughMouseMovement -

keyNavigationAllowed

public boolean keyNavigationAllowed()

Returns if this UiContainer can be navigated by keyboard/gamepad

Returns:

True by default

pointerNavigationAllowed

public boolean pointerNavigationAllowed()

Returns if this UiContainer can be navigated by touch/mouse

Returns:

True by default

setNavigationMode

public void setNavigationMode(NavigationMode navigationMode)

Sets the NavigationMode on this UiContainer

Parameters:

navigationMode - The NavigationMode

getScreenSizeScaleMode

public ScreenSizeScaleMode getScreenSizeScaleMode()

Returns the scaling mode used for ScreenSize values

Returns:

ScreenSizeScaleMode.NO_SCALING by default

setScreenSizeScaleMode

public void setScreenSizeScaleMode(ScreenSizeScaleMode screenSizeScaleMode)

Sets the scaling mode used for ScreenSize values

Parameters:

screenSizeScaleMode - The ScreenSizeScaleMode to set

addUiContainerListener

public void addUiContainerListener(UiContainerListener listener)

Adds a UiContainerListener to this UiContainer

Parameters:

listener - The UiContainerListener to be notified of events

removeUiContainerListener

public void removeUiContainerListener(UiContainerListener listener)

Removes a UiContainerListener from this UiContainer

Parameters:

listener - The UiContainerListener to stop receiving events

addInputSourceListener

public void addInputSourceListener(UiInputSourceListener listener)

Adds a UiInputSourceListener to this UiContainer

Parameters:

listener - The UiInputSourceListener to be notified of events

removeUiContainerListener

public void removeUiContainerListener(UiInputSourceListener listener)

Removes a UiInputSourceListener from this UiContainer

Parameters:

listener - The UiInputSourceListener to stop receiving events

getDefaultVisibility

public static Visibility getDefaultVisibility()

Returns the default Visibility for newly created UiElement objects

Returns:

A non-null Visibility value. Visibility.HIDDEN by default

setDefaultVisibility

public static void setDefaultVisibility(Visibility defaultVisibility)

Sets the default Visibility for newly created UiElement objects

Parameters:

defaultVisibility - The Visibility to set as default

setViewport

public void setViewport(Viewport viewport)