org.mini2Dx.ui.element

Class ParentUiElement

java.lang.Object

org.mini2Dx.ui.element.UiElement

org.mini2Dx.ui.element.ParentUiElement

All Implemented Interfaces:

FlexUiElement, Hoverable

Direct Known Subclasses:

Button, Div, TabView, UiContainer

public abstract class ParentUiElement
extends UiElement
implements FlexUiElement

Base class for UiElements that can contain child UiElements

Field Summary

Fields

Modifier and Type	Field and Description
protected java.util.concurrent.atomic.AtomicBoolean	asyncRemoveAll
protected org.mini2Dx.gdx.utils.Array<UiElement>	children
protected ParentRenderNode<?,?>	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
ParentUiElement() Constructor.
ParentUiElement(float x, float y, float width, float height) Constructor
ParentUiElement(java.lang.String id) Constructor
ParentUiElement(java.lang.String id, float x, float y, float width, float height) Constructor

Method Summary

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	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	getChild(int i) Returns the child UiElement
UiElement	getElementById(java.lang.String id) Searches the UI for a UiElement with a given id.
java.lang.String	getFlexLayout() Returns the currently used flex layout
int	getRenderHeight() Returns the height this element is currently rendering at
int	getRenderWidth() Returns the width this element is currently rendering at
int	getRenderX() Returns X coordinate of where this element is currently rendering
int	getRenderY() Returns Y coordinate of where this element is currently rendering
int	getTotalChildren() Returns the total number of child elements for this element
void	invokeBeginHover() Triggers the begin hover event
void	invokeEndHover() Triggers the end hover event
boolean	isFlexLayout() Returns if this UiElement is using a flex layout
boolean	isInitialLayoutOccurred()
boolean	isInitialUpdateOccurred()
boolean	isOverflowClipped() Returns if child elements that overflow this element's bounds (e.g.
boolean	isRenderNodeDirty()
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	setFlex(float x, float y, float width, float height) Equivalent to UiElement.set(float, float, float, float) for usage with flex layout
void	setFlexLayout(java.lang.String flexLayout) Sets the current flex layout
void	setHeightFlex(float height) Equivalent to UiElement.setHeight(float) for usage with flex layout
void	setOverflowClipped(boolean overflowClipped) Sets if child elements that overflow this element's bounds (e.g.
void	setRenderNodeDirty()
void	setStyleId(java.lang.String styleId) Sets the style if for this UiElement
void	setVisibility(Visibility visibility) Sets the current Visibility of this UiElement
void	setWidthFlex(float width) Equivalent to UiElement.setWidth(float) for usage with flex layout
void	setXFlex(float x) Equivalent to UiElement.setX(float) for usage with flex layout
void	setXYFlex(float x, float y) Equivalent to UiElement.setXY(float, float) for usage with flex layout
void	setYFlex(float y) Equivalent to UiElement.setY(float) for usage with flex layout
void	setZIndex(int zIndex) Sets the Z index of this UiElement.
void	shrinkToContents(boolean recursive) Shrinks the width and height for this element based on its children
void	shrinkToContents(boolean recursive, java.lang.Runnable callback)
void	syncWithUpdate(UiContainerRenderTree rootNode) Syncs data between the UiElement and RenderNode during update

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, getStyleRule, 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

Field Detail

children

protected final org.mini2Dx.gdx.utils.Array<UiElement> children

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

ParentUiElement

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

ParentUiElement

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

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

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

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

getChild

public UiElement getChild(int i)

Returns the child UiElement

Parameters:

i - The child index

Returns:

shrinkToContents

public void shrinkToContents(boolean recursive)

Shrinks the width and height for this element based on its children

shrinkToContents

public void shrinkToContents(boolean recursive,
                             java.lang.Runnable callback)

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

invokeBeginHover

public void invokeBeginHover()

Description copied from interface: Hoverable

Triggers the begin hover event

Specified by:

invokeBeginHover in interface Hoverable

invokeEndHover

public void invokeEndHover()

Description copied from interface: Hoverable

Triggers the end hover event

Specified by:

invokeEndHover in interface Hoverable

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

syncWithUpdate

public void syncWithUpdate(UiContainerRenderTree rootNode)

Description copied from class: UiElement

Syncs data between the UiElement and RenderNode during update

Overrides:

syncWithUpdate 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

getFlexLayout

public java.lang.String getFlexLayout()

Description copied from interface: FlexUiElement

Returns the currently used flex layout

Specified by:

getFlexLayout in interface FlexUiElement

Returns:

null if no flex layout is used

setFlexLayout

public void setFlexLayout(java.lang.String flexLayout)

Description copied from interface: FlexUiElement

Sets the current flex layout

Specified by:

setFlexLayout in interface FlexUiElement

Parameters:

flexLayout - see: FlexLayoutRuleset

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

isRenderNodeDirty

public boolean isRenderNodeDirty()

Specified by:

isRenderNodeDirty in class UiElement

setRenderNodeDirty

public void setRenderNodeDirty()

Specified by:

setRenderNodeDirty in class UiElement

isInitialLayoutOccurred

public boolean isInitialLayoutOccurred()

Specified by:

isInitialLayoutOccurred in class UiElement

isInitialUpdateOccurred

public boolean isInitialUpdateOccurred()

Specified by:

isInitialUpdateOccurred in class UiElement

getRenderX

public int getRenderX()

Description copied from class: UiElement

Returns X coordinate of where this element is currently rendering

Specified by:

getRenderX in class UiElement

Returns:

Integer.MIN_VALUE if not rendering

getRenderY

public int getRenderY()

Description copied from class: UiElement

Returns Y coordinate of where this element is currently rendering

Specified by:

getRenderY in class UiElement

Returns:

Integer.MIN_VALUE if not rendering

getRenderWidth

public int getRenderWidth()

Description copied from class: UiElement

Returns the width this element is currently rendering at

Specified by:

getRenderWidth in class UiElement

Returns:

-1 if not rendering

getRenderHeight

public int getRenderHeight()

Description copied from class: UiElement

Returns the height this element is currently rendering at

Specified by:

getRenderHeight in class UiElement

Returns:

-1 if not rendering

isFlexLayout

public boolean isFlexLayout()

Description copied from class: UiElement

Returns if this UiElement is using a flex layout

Specified by:

isFlexLayout in interface FlexUiElement

Overrides:

isFlexLayout in class UiElement

Returns:

False by default

setFlex

public void setFlex(float x,
                    float y,
                    float width,
                    float height)

Equivalent to UiElement.set(float, float, float, float) for usage with flex layout

Parameters:

x - The x coordinate (in pixels) relative to its parent

y - The y coordinate (in pixels) relative to its parent

width - The width in pixels

height - The height in pixels

setXYFlex

public void setXYFlex(float x,
                      float y)

Equivalent to UiElement.setXY(float, float) for usage with flex layout

Parameters:

x - The x coordinate (in pixels) relative to its parent

y - The y coordinate (in pixels) relative to its parent

setXFlex

public void setXFlex(float x)

Equivalent to UiElement.setX(float) for usage with flex layout

Parameters:

x - The x coordinate (in pixels) relative to its parent

setYFlex

public void setYFlex(float y)

Equivalent to UiElement.setY(float) for usage with flex layout

Parameters:

y - The y coordinate (in pixels) relative to its parent

setWidthFlex

public void setWidthFlex(float width)

Equivalent to UiElement.setWidth(float) for usage with flex layout

Parameters:

width - The width in pixels

setHeightFlex

public void setHeightFlex(float height)

Equivalent to UiElement.setHeight(float) for usage with flex layout

Parameters:

height - The height in pixels