ParentUiElement (mini2Dx)

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

All Implemented Interfaces:

Hoverable

Direct Known Subclasses:

Button, Column, TabView, UiContainer
```
public abstract class ParentUiElement
extends UiElement
```
Base class for UiElements that can contain child UiElements

Field Summary

Fields
Modifier and Type	Field and Description
`protected java.util.Queue<UiElement>`	`asyncAddQueue`
`protected java.util.concurrent.atomic.AtomicBoolean`	`asyncRemoveAll`
`protected java.util.Queue<UiElement>`	`asyncRemoveQueue`
`protected java.util.List<UiElement>`	`children`
`protected ParentRenderNode<?,?>`	`renderNode`

Fields inherited from class org.mini2Dx.ui.element.UiElement
deferred, effects, styleId, visibility, zIndex

Constructor Summary

Constructors
Constructor and Description

ParentUiElement()
Constructor.

ParentUiElement(java.lang.String id)
Constructor

Constructors
Constructor and Description
`ParentUiElement()` Constructor.
`ParentUiElement(java.lang.String id)` Constructor

Method Summary

All Methods Instance Methods Abstract Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`add(int index, UiElement element)` Inserts a `UiElement` at a specific index into this `ParentUiElement` 's child elements
`void`	`add(UiElement element)` Adds a `UiElement` to this `ParentUiElement`
`void`	`addAsync(UiElement element)` Adds a `UiElement` safely from a non-OpenGL thread
`void`	`attach(ParentRenderNode<?,?> parentRenderNode)` Attaches a `RenderNode` for this element to a parent `RenderNode`
`protected abstract ParentRenderNode<?,?>`	`createRenderNode(ParentRenderNode<?,?> parent)` Creates the `ParentRenderNode` for this `UiElement`
`void`	`detach(ParentRenderNode<?,?> parentRenderNode)` Detaches this element's `RenderNode` from a parent `RenderNode`
`UiElement`	`get(int index)` Returns the child `UiElement` at the specified index
`UiElement`	`getElementById(java.lang.String id)` Searches the UI for a `UiElement` with a given id.
`FlexDirection`	`getFlexDirection()` Returns the `FlexDirection` of this element
`java.lang.String`	`getHorizontalLayout()` Returns the current horizontal layout rules
`int`	`getTotalChildren()` Returns the total number of child elements for this element
`java.lang.String`	`getVerticalLayout()` Returns the current vertical layout rules
`boolean`	`isOverflowClipped()` Returns if child elements that overflow this element's bounds (e.g.
`UiElement`	`remove(int index)` Removes a child `UiElement` at a specific index
`boolean`	`remove(UiElement element)` Removes a `UiElement` from this `ParentUiElement`
`void`	`removeAll()` Removes all children from this `ParentUiElement`
`void`	`removeAllAsync()` Removes all children safely from a non-OpenGL thread
`void`	`removeAsync(UiElement element)` Removes a `UiElement` safely from a non-OpenGL thread
`void`	`setFlexDirection(FlexDirection flexDirection)` Sets the `FlexDirection` of this element
`void`	`setHorizontalLayout(java.lang.String layoutRuleset)` Sets the current horizontal layout rules
`void`	`setOverflowClipped(boolean overflowClipped)` Sets if child elements that overflow this element's bounds (e.g.
`void`	`setStyleId(java.lang.String styleId)` Sets the style if for this `UiElement`
`void`	`setVerticalLayout(java.lang.String layoutRuleset)` Sets the current vertical layout rules
`void`	`setVisibility(Visibility visibility)` Sets the current `Visibility` of this `UiElement`
`void`	`setZIndex(int zIndex)` Sets the Z index of this `UiElement`.
`void`	`syncWithRenderNode()` Syncs data between the `UiElement` and `RenderNode`

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

- Field Detail
  - children
```
protected final java.util.List<UiElement> children
```
  - asyncAddQueue
```
protected final java.util.Queue<UiElement> asyncAddQueue
```
  - asyncRemoveQueue
```
protected final java.util.Queue<UiElement> asyncRemoveQueue
```
  - asyncRemoveAll
```
protected final java.util.concurrent.atomic.AtomicBoolean asyncRemoveAll
```
  - renderNode
```
protected ParentRenderNode<?,?> renderNode
```
- Constructor Detail
  - ParentUiElement
```
public ParentUiElement()
```
    Constructor. Generates a unique ID for this ParentUiElement
  - ParentUiElement
```
public ParentUiElement(java.lang.String id)
```
    Constructor
    
    Parameters:
    
    id - The unique ID for this ParentUiElement
- Method Detail
  - createRenderNode
```
protected abstract ParentRenderNode<?,?> createRenderNode(ParentRenderNode<?,?> parent)
```
    Creates the ParentRenderNode for this UiElement
    
    Parameters:
    
    parent - The parent of this node
    
    Returns:
    
    A new instance of ParentRenderNode
  - get
```
public UiElement get(int index)
```
    Returns the child UiElement at the specified index
    
    Parameters:
    
    index - The index of the child element
    
    Returns:
    
    The UiElement instance
  - add
```
public void add(UiElement element)
```
    Adds a UiElement to this ParentUiElement
    
    Parameters:
    
    element - The UiElement to be added
  - add
```
public void add(int index,
                UiElement element)
```
    Inserts a UiElement at a specific index into this ParentUiElement 's child elements
    
    Parameters:
    
    index - The index to insert at
    
    element - The UiElement to be inserted
  - addAsync
```
public void addAsync(UiElement element)
```
    Adds a UiElement safely from a non-OpenGL thread
    
    Parameters:
    
    element - The UiElement to be added
  - remove
```
public boolean remove(UiElement element)
```
    Removes a UiElement from this ParentUiElement
    
    Parameters:
    
    element - The UiElement to be removed
    
    Returns:
    
    True if the ParentUiElement contained the UiElement
  - removeAsync
```
public void removeAsync(UiElement element)
```
    Removes a UiElement safely from a non-OpenGL thread
    
    Parameters:
    
    element - The UiElement to be remove
  - remove
```
public UiElement remove(int index)
```
    Removes a child UiElement at a specific index
    
    Parameters:
    
    index - The index to remove at
    
    Returns:
    
    The UiElement that was removed
  - removeAll
```
public void removeAll()
```
    Removes all children from this ParentUiElement
  - removeAllAsync
```
public void removeAllAsync()
```
    Removes all children safely from a non-OpenGL thread
  - attach
```
public void attach(ParentRenderNode<?,?> parentRenderNode)
```
    Description copied from class: UiElement
    
    Attaches a RenderNode for this element to a parent RenderNode
    
    Specified by:
    
    attach in class UiElement
    
    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
    
    Specified by:
    
    detach in class UiElement
    
    Parameters:
    
    parentRenderNode - The parent RenderNode to detach from
  - getHorizontalLayout
```
public java.lang.String getHorizontalLayout()
```
    Returns the current horizontal layout rules
    
    Returns:
  - setHorizontalLayout
```
public void setHorizontalLayout(java.lang.String layoutRuleset)
```
    Sets the current horizontal layout rules
    
    Parameters:
    
    layoutRuleset -
  - getVerticalLayout
```
public java.lang.String getVerticalLayout()
```
    Returns the current vertical layout rules
    
    Returns:
  - setVerticalLayout
```
public void setVerticalLayout(java.lang.String layoutRuleset)
```
    Sets the current vertical layout rules
    
    Parameters:
    
    layoutRuleset -
  - isOverflowClipped
```
public boolean isOverflowClipped()
```
    Returns if child elements that overflow this element's bounds (e.g. using offsets or margins) have their rendering clipped to the element's bounds
    
    Returns:
    
    False by default
  - setOverflowClipped
```
public void setOverflowClipped(boolean overflowClipped)
```
    Sets if child elements that overflow this element's bounds (e.g. using offsets or margins) have their rendering clipped to the element's bounds
    
    Parameters:
    
    overflowClipped - True if child elements should have their rendering clipped
  - setVisibility
```
public void setVisibility(Visibility visibility)
```
    Description copied from class: UiElement
    
    Sets the current Visibility of this UiElement
    
    Specified by:
    
    setVisibility in class UiElement
    
    Parameters:
    
    visibility - The Visibility to set
  - syncWithRenderNode
```
public void syncWithRenderNode()
```
    Description copied from class: UiElement
    
    Syncs data between the UiElement and RenderNode
    
    Specified by:
    
    syncWithRenderNode in class UiElement
  - setStyleId
```
public void setStyleId(java.lang.String styleId)
```
    Description copied from class: UiElement
    
    Sets the style if for this UiElement
    
    Specified by:
    
    setStyleId in class UiElement
    
    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)
    
    Specified by:
    
    setZIndex in class UiElement
    
    Parameters:
    
    zIndex - The Z index
  - getTotalChildren
```
public int getTotalChildren()
```
    Returns the total number of child elements for this element
    
    Returns:
    
    0 is there are no children
  - 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 UiElement
    
    Parameters:
    
    id - The UiElement identifier to search for
    
    Returns:
    
    Null if there is no such UiElement with the given id
  - getFlexDirection
```
public FlexDirection getFlexDirection()
```
    Returns the FlexDirection of this element
    
    Returns:
    
    The FlexDirection - defaults to FlexDirection.COLUMN
  - setFlexDirection
```
public void setFlexDirection(FlexDirection flexDirection)
```
    Sets the FlexDirection of this element
    
    Parameters:
    
    flexDirection - The FlexDirection to set

Class ParentUiElement

Field Summary

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

Constructor Summary

Method Summary

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

Methods inherited from class java.lang.Object

Field Detail

children

asyncAddQueue

asyncRemoveQueue

asyncRemoveAll

renderNode

Constructor Detail

ParentUiElement

ParentUiElement

Method Detail

createRenderNode

get

add

add

addAsync

remove

removeAsync

remove

removeAll

removeAllAsync

attach

detach

getHorizontalLayout

setHorizontalLayout

getVerticalLayout

setVerticalLayout

isOverflowClipped

setOverflowClipped

setVisibility

syncWithRenderNode

setStyleId

setZIndex

getTotalChildren

getElementById

getFlexDirection

setFlexDirection