UiContainer (mini2Dx)

java.lang.Object
- org.mini2Dx.ui.element.UiElement
- - org.mini2Dx.ui.element.ParentUiElement
  - - org.mini2Dx.ui.UiContainer

All Implemented Interfaces:

com.badlogic.gdx.InputProcessor, Hoverable
```
public class UiContainer
extends ParentUiElement
implements com.badlogic.gdx.InputProcessor
```
The container for all UI elements. update(float), interpolate(float) and render(Graphics) must be called by your GameContainer

Field Summary
- Fields inherited from class org.mini2Dx.ui.element.ParentUiElement
  asyncAddQueue, asyncRemoveAll, asyncRemoveQueue, children, renderNode
- Fields inherited from class org.mini2Dx.ui.element.UiElement
  deferred, effects, styleId, visibility, zIndex

Constructor Summary

Constructors
Constructor and Description
`UiContainer(GameContainer gc, com.badlogic.gdx.assets.AssetManager assetManager)` Constructor
`UiContainer(int width, int height, com.badlogic.gdx.assets.AssetManager assetManager)`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`addControllerInput(ControllerUiInput<?> input)` Adds a `ControllerUiInput` instance to this `UiContainer`
`void`	`addListener(UiContainerListener listener)` Adds a `UiContainerListener` to this `UiContainer`
`void`	`addScreenSizeListener(ScreenSizeListener listener)` Adds a `ScreenSizeListener` to listen for `ScreenSize` change
`void`	`attach(ParentRenderNode<?,?> parentRenderNode)` Attaches a `RenderNode` for this element to a parent `RenderNode`
`boolean`	`buttonDown(ControllerUiInput<?> controllerUiInput, ControllerButton button)`
`boolean`	`buttonUp(ControllerUiInput<?> controllerUiInput, ControllerButton button)`
`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()`
`Navigatable`	`getActiveNavigation()` Returns the currently active `Navigatable`
`static Visibility`	`getDefaultVisibility()` Returns the default `Visibility` for newly created `UiElement` objects
`int`	`getHeight()` Returns the height of the `UiContainer`
`ControllerType`	`getLastControllerType()` Returns the last `ControllerType` 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
`UiTheme`	`getTheme()` Returns the `UiTheme` currently applied to this `UiContainer`
`int`	`getWidth()` Returns the width of the `UiContainer`
`void`	`interpolate(float alpha)` Interpolates all `UiElement`s
`boolean`	`isThemeApplied()` Returns if a `UiTheme` has been applied to thi `UiContainer`
`boolean`	`keyDown(int keycode)`
`boolean`	`keyTyped(char character)`
`boolean`	`keyUp(int keycode)`
`boolean`	`mouseMoved(int screenX, int screenY)`
`static void`	`relayoutAllUiContainers()`
`void`	`removeControllerInput(ControllerUiInput<?> input)` Removes a `ControllerUiInput` instance from this `UiContainer`
`void`	`removeListener(UiContainerListener listener)` Removes a `UiContainerListener` from this `UiContainer`
`void`	`removeScreenSizeListener(ScreenSizeListener listener)` Removes a `ScreenSizeListener` from this `UiContainer`
`void`	`render(Graphics g)` Renders all visible `UiElement`s
`boolean`	`scrolled(int amount)`
`void`	`set(int width, int height)` Sets the width and height of the `UiContainer`
`void`	`setActionKey(int actionKey)` Sets the key used for triggering actions (i.e.
`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`	`setKeyboardNavigationEnabled(boolean keyboardNavigationEnabled)` Sets if desktop-based games uses keyboard navigation instead of mouse navigation.
`void`	`setLastControllerType(ControllerType lastControllerType)` Sets the last `ControllerType` used on the `UiContainer`
`void`	`setLastInputSource(InputSource lastInputSource)` Sets the last `InputSource` used on the `UiContainer`
`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`
`void`	`setTheme(UiTheme theme)` Sets the current `UiTheme` for this `UiContainer`
`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 `UiElement`s

Methods inherited from class org.mini2Dx.ui.element.ParentUiElement
add, add, addAsync, get, getElementById, getFlexDirection, getHorizontalLayout, getTotalChildren, getVerticalLayout, isOverflowClipped, remove, remove, removeAll, removeAllAsync, removeAsync, setFlexDirection, setHorizontalLayout, setOverflowClipped, setVerticalLayout, syncWithRenderNode

Methods inherited from class org.mini2Dx.ui.element.UiElement
addEffectListener, addHoverListener, applyEffect, defer, defer, equals, getId, getStyleId, getVisibility, getZIndex, hashCode, isDebugEnabled, notifyEffectListenersOnFinished, notifyHoverListenersOnBeginHover, notifyHoverListenersOnEndHover, processDeferred, removeEffectListener, removeHoverListener, setDebugEnabled

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

- Constructor Detail
  - UiContainer
```
public UiContainer(GameContainer gc,
                   com.badlogic.gdx.assets.AssetManager assetManager)
```
    Constructor
    
    Parameters:
    
    gc - Your game's GameContainer
    
    assetManager - The AssetManager for the game
  - UiContainer
```
public UiContainer(int width,
                   int height,
                   com.badlogic.gdx.assets.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)
  - interpolate
```
public void interpolate(float alpha)
```
    Interpolates all UiElements
    
    Parameters:
    
    alpha - The interpolation alpha
  - 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 boolean isThemeApplied()
```
    Returns if a UiTheme has been applied to thi UiContainer
    
    Returns:
    
    True if the UiTheme has been applied
  - getTheme
```
public UiTheme getTheme()
```
    Returns the UiTheme currently applied to this UiContainer
    
    Returns:
    
    Null if no UiTheme has been applied
  - setTheme
```
public void setTheme(UiTheme theme)
```
    Sets the current UiTheme for this UiContainer
    
    Parameters:
    
    theme - The UiTheme to apply
  - 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 com.badlogic.gdx.InputProcessor
  - touchUp
```
public boolean touchUp(int screenX,
                       int screenY,
                       int pointer,
                       int button)
```
    Specified by:
    
    touchUp in interface com.badlogic.gdx.InputProcessor
  - touchDragged
```
public boolean touchDragged(int screenX,
                            int screenY,
                            int pointer)
```
    Specified by:
    
    touchDragged in interface com.badlogic.gdx.InputProcessor
  - mouseMoved
```
public boolean mouseMoved(int screenX,
                          int screenY)
```
    Specified by:
    
    mouseMoved in interface com.badlogic.gdx.InputProcessor
  - scrolled
```
public boolean scrolled(int amount)
```
    Specified by:
    
    scrolled in interface com.badlogic.gdx.InputProcessor
  - keyTyped
```
public boolean keyTyped(char character)
```
    Specified by:
    
    keyTyped in interface com.badlogic.gdx.InputProcessor
  - keyDown
```
public boolean keyDown(int keycode)
```
    Specified by:
    
    keyDown in interface com.badlogic.gdx.InputProcessor
  - keyUp
```
public boolean keyUp(int keycode)
```
    Specified by:
    
    keyUp in interface com.badlogic.gdx.InputProcessor
  - buttonDown
```
public boolean buttonDown(ControllerUiInput<?> controllerUiInput,
                          ControllerButton button)
```
  - buttonUp
```
public boolean buttonUp(ControllerUiInput<?> controllerUiInput,
                        ControllerButton button)
```
  - setActiveNavigation
```
public void setActiveNavigation(Navigatable activeNavigation)
```
    Sets the current Navigatable for UI navigation
    
    Parameters:
    
    activeNavigation - The current Navigatable being navigated
  - 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
  - getWidth
```
public int getWidth()
```
    Returns the width of the UiContainer
    
    Returns:
    
    The width in pixels
  - getHeight
```
public int getHeight()
```
    Returns the height of the UiContainer
    
    Returns:
    
    The height in pixels
  - 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
  - getLastControllerType
```
public ControllerType getLastControllerType()
```
    Returns the last ControllerType used on the UiContainer
    
    Returns:
  - setLastControllerType
```
public void setLastControllerType(ControllerType lastControllerType)
```
    Sets the last ControllerType used on the UiContainer
    
    Parameters:
    
    lastControllerType - The ControllerType last used
  - addControllerInput
```
public void addControllerInput(ControllerUiInput<?> input)
```
    Adds a ControllerUiInput instance to this UiContainer
    
    Parameters:
    
    input - The instance to add
  - removeControllerInput
```
public void removeControllerInput(ControllerUiInput<?> input)
```
    Removes a ControllerUiInput 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
  - setActionKey
```
public void setActionKey(int actionKey)
```
    Sets the key used for triggering actions (i.e. selecting a menu option)
    
    Parameters:
    
    actionKey - The Input.Keys value
  - setKeyboardNavigationEnabled
```
public void setKeyboardNavigationEnabled(boolean keyboardNavigationEnabled)
```
    Sets if desktop-based games uses keyboard navigation instead of mouse navigation. Note: This does not effect hotkeys
    
    Parameters:
    
    keyboardNavigationEnabled - True if the desktop-based game should only navigate by keyboard
  - 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
  - addListener
```
public void addListener(UiContainerListener listener)
```
    Adds a UiContainerListener to this UiContainer
    
    Parameters:
    
    listener - The UiContainerListener to be notified of events
  - removeListener
```
public void removeListener(UiContainerListener listener)
```
    Removes a UiContainerListener from this UiContainer
    
    Parameters:
    
    listener - The UiContainerListener 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

Class UiContainer

Field Summary

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

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

Constructor Summary

Method Summary

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

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

Methods inherited from class java.lang.Object

Constructor Detail

UiContainer

UiContainer

Method Detail

relayoutAllUiContainers

dispose

createRenderNode

update

interpolate

render

attach

detach

setVisibility

addScreenSizeListener

removeScreenSizeListener

isThemeApplied

getTheme

setTheme

setStyleId

touchDown

touchUp

touchDragged

mouseMoved

scrolled

keyTyped

keyDown

keyUp

buttonDown

buttonUp

setActiveNavigation

clearActiveNavigation

getActiveNavigation

getWidth

getHeight

set

getScaleX

getScaleY

setScale

getLastInputSource

setLastInputSource

getLastControllerType

setLastControllerType

addControllerInput

removeControllerInput

setZIndex

setActionKey

setKeyboardNavigationEnabled

getScreenSizeScaleMode

setScreenSizeScaleMode

addListener

removeListener

getDefaultVisibility

setDefaultVisibility