UiElement (mini2Dx)

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

All Implemented Interfaces:

Hoverable

Direct Known Subclasses:

AnimatedImage, Checkbox, CustomUiElement, Image, Label, ParentUiElement, ProgressBar, RadioButton, Select, Slider, TextBox
```
public abstract class UiElement
extends java.lang.Object
implements Hoverable
```
Base class for all user interface elements

Field Summary

Fields
Modifier and Type	Field and Description
`protected org.mini2Dx.gdx.utils.Array<DeferredRunnable>`	`deferredLayout`
`protected org.mini2Dx.gdx.utils.Array<DeferredRunnable>`	`deferredRender`
`protected org.mini2Dx.gdx.utils.Array<DeferredRunnable>`	`deferredUpdate`
`protected org.mini2Dx.gdx.utils.Queue<UiEffect>`	`effects`
`protected float`	`height`
`protected java.lang.String`	`styleId`
`protected Visibility`	`visibility`
`protected float`	`width`
`protected float`	`x`
`protected float`	`y`
`protected int`	`zIndex`

Constructor Summary

Constructors
Constructor and Description
`UiElement()` Constructor.
`UiElement(float x, float y, float width, float height)` Constructor
`UiElement(java.lang.String id)` Constructor
`UiElement(java.lang.String id, float x, float y, float width, float height)` Constructor

Method Summary

All Methods Instance Methods Abstract Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`addEffectListener(UiEffectListener listener)` Adds a `UiEffectListener` to this `UiElement`
`void`	`addHoverListener(HoverListener listener)` Adds a `HoverListener` to listen for hover events
`void`	`addNodeStateListener(NodeStateListener listener)`
`void`	`alignAbove(UiElement alignToElement, HorizontalAlignment horizontalAlignment)` Aligns the bottom edge of this element to the top of another element
`void`	`alignBelow(UiElement alignToElement, HorizontalAlignment horizontalAlignment)` Aligns the top edge of this element to the bottom of another element
`void`	`alignEdgeToEdge(UiElement alignToElement, HorizontalAlignment horizontalAlignment, VerticalAlignment verticalAlignment)` Aligns the edges of this `UiElement` to the edges of another element.
`void`	`alignLeftOf(UiElement alignToElement, VerticalAlignment verticalAlignment)` Aligns the right edge of this element to the left edge of another element
`void`	`alignRightOf(UiElement alignToElement, VerticalAlignment verticalAlignment)` Aligns the left edge of this element to the right edge of another element
`void`	`applyEffect(UiEffect effect)` Applies a `UiEffect` to this element
`abstract void`	`attach(ParentRenderNode<?,?> parentRenderNode)` Attaches a `RenderNode` for this element to a parent `RenderNode`
`DeferredRunnable`	`deferUntilLayout(java.lang.Runnable runnable)` Defers the execution of a `Runnable` instance until the next UI re-layout completes
`DeferredRunnable`	`deferUntilLayout(java.lang.Runnable runnable, boolean skipQueue)` Defers the execution of a `Runnable` instance until the next UI re-layout completes
`DeferredRunnable`	`deferUntilRender(java.lang.Runnable runnable)` Defers the execution of a `Runnable` instance until the UI render completes
`DeferredRunnable`	`deferUntilRender(java.lang.Runnable runnable, boolean skipQueue)` Defers the execution of a `Runnable` instance until the UI render completes
`DeferredRunnable`	`deferUntilUpdate(java.lang.Runnable runnable)` Defers the execution of a `Runnable` instance until the next frame update
`DeferredRunnable`	`deferUntilUpdate(java.lang.Runnable runnable, boolean skipQueue)` Defers the execution of a `Runnable` instance for a period of time
`DeferredRunnable`	`deferUntilUpdate(java.lang.Runnable runnable, float duration)` Defers the execution of a `Runnable` instance for a period of time
`DeferredRunnable`	`deferUntilUpdate(java.lang.Runnable runnable, float duration, boolean skipQueue)` Defers the execution of a `Runnable` instance for a period of time
`abstract void`	`detach(ParentRenderNode<?,?> parentRenderNode)` Detaches this element's `RenderNode` from a parent `RenderNode`
`boolean`	`equals(java.lang.Object obj)`
`float`	`getContentHeight()` Returns the height of this element minus its margin and padding
`float`	`getContentWidth()` Returns the width of this element minus its margin and padding
`UiElement`	`getElementById(java.lang.String id)` Searches the UI for a `UiElement` with a given id.
`float`	`getHeight()`
`java.lang.String`	`getId()` Returns the unique id
`int`	`getMarginBottom()`
`int`	`getMarginLeft()`
`int`	`getMarginRight()`
`int`	`getMarginTop()`
`int`	`getPaddingBottom()`
`int`	`getPaddingLeft()`
`int`	`getPaddingRight()`
`int`	`getPaddingTop()`
`abstract int`	`getRenderHeight()` Returns the height this element is currently rendering at
`abstract int`	`getRenderWidth()` Returns the width this element is currently rendering at
`abstract int`	`getRenderX()` Returns X coordinate of where this element is currently rendering
`abstract int`	`getRenderY()` Returns Y coordinate of where this element is currently rendering
`java.lang.String`	`getStyleId()` Returns the current style id of this `UiElement`
`abstract StyleRule`	`getStyleRule()`
`Visibility`	`getVisibility()` Returns the current `Visibility` of this `UiElement`
`float`	`getWidth()`
`float`	`getX()`
`float`	`getY()`
`int`	`getZIndex()` Returns the Z index of this `UiElement`
`int`	`hashCode()`
`boolean`	`isDebugEnabled()`
`boolean`	`isFlexLayout()` Returns if this `UiElement` is using a flex layout
`boolean`	`isInitialised()` Returns if the `UiElement` has been initialised within the render tree
`abstract boolean`	`isInitialLayoutOccurred()`
`abstract boolean`	`isInitialUpdateOccurred()`
`abstract boolean`	`isRenderNodeDirty()`
`void`	`notifyEffectListenersOnFinished(UiEffect effect)` Notifies all `UiEffectListener`s of the finished event
`void`	`notifyHoverListenersOnBeginHover()` Notifies all `HoverListener`s of the begin hover event
`void`	`notifyHoverListenersOnEndHover()` Notifies all `HoverListener`s of the end hover event
`void`	`notifyNodeStateListeners(NodeState nodeState)`
`void`	`removeEffectListener(UiEffectListener listener)` Removes a `UiEffectListener` from this `UiElement`
`void`	`removeHoverListener(HoverListener listener)` Removes a `HoverListener` from this `Hoverable`
`void`	`removeNodeStateListener(NodeStateListener listener)`
`boolean`	`set(float x, float y, float width, float height)` Sets the x, y, width and height of this element
`boolean`	`setContentHeight(float contentHeight)` Sets the content height.
`boolean`	`setContentWidth(float contentWidth)` Sets the content width.
`void`	`setDebugEnabled(boolean debugEnabled)`
`boolean`	`setHeight(float height)` Sets the height of this element
`void`	`setHeightToContentHeightOf(UiElement otherElement)` Sets the height of this element to match the content height of another `UiElement`.
`void`	`setHeightToHeightOf(UiElement otherElement)` Sets the height of this element to match the height of another `UiElement`
`abstract void`	`setRenderNodeDirty()`
`abstract void`	`setStyleId(java.lang.String styleId)` Sets the style if for this `UiElement`
`abstract void`	`setVisibility(Visibility visibility)` Sets the current `Visibility` of this `UiElement`
`boolean`	`setWidth(float width)` Sets the width of this element
`void`	`setWidthToContentWidthOf(UiElement otherElement)` Sets the width of this element to match the content width of another `UiElement`.
`void`	`setWidthToWidthOf(UiElement otherElement)` Sets the width of this element to match the width of another `UiElement`
`boolean`	`setX(float x)` Sets the x coordinate of this element.
`boolean`	`setXY(float x, float y)` Sets the x and y coordinates of this element
`boolean`	`setY(float y)` Sets the y coordinate of this element
`abstract void`	`setZIndex(int zIndex)` Sets the Z index of this `UiElement`.
`void`	`snapTo(UiElement snapToElement)` Snaps this `UiElement` to the top-left corner of another `UiElement`
`void`	`snapTo(UiElement snapToElement, HorizontalAlignment horizontalAlignment, VerticalAlignment verticalAlignment)` Snaps this `UiElement` to the same area of another element.
`void`	`syncWithLayout(UiContainerRenderTree rootNode)` Syncs data between the `UiElement` and `RenderNode` during UI layout
`void`	`syncWithRender(UiContainerRenderTree rootNode)` Syncs data between the `UiElement` and `RenderNode` during UI render
`void`	`syncWithUpdate(UiContainerRenderTree rootNode)` Syncs data between the `UiElement` and `RenderNode` during update

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

Methods inherited from interface org.mini2Dx.ui.element.Hoverable
invokeBeginHover, invokeEndHover

- Field Detail
  - effects
```
protected final org.mini2Dx.gdx.utils.Queue<UiEffect> effects
```
  - deferredLayout
```
protected final org.mini2Dx.gdx.utils.Array<DeferredRunnable> deferredLayout
```
  - deferredUpdate
```
protected final org.mini2Dx.gdx.utils.Array<DeferredRunnable> deferredUpdate
```
  - deferredRender
```
protected final org.mini2Dx.gdx.utils.Array<DeferredRunnable> deferredRender
```
  - visibility
```
protected Visibility visibility
```
  - styleId
```
protected java.lang.String styleId
```
  - zIndex
```
protected int zIndex
```
  - x
```
protected float x
```
  - y
```
protected float y
```
  - width
```
protected float width
```
  - height
```
protected float height
```
- Constructor Detail
  - UiElement
```
public UiElement()
```
    Constructor. Generates a unique ID for this element.
  - UiElement
```
public UiElement(java.lang.String id)
```
    Constructor
    
    Parameters:
    
    id - The unique ID for this element (if null an ID will be generated)
  - UiElement
```
public UiElement(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
  - UiElement
```
public UiElement(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
  - isInitialLayoutOccurred
```
public abstract boolean isInitialLayoutOccurred()
```
  - isInitialUpdateOccurred
```
public abstract boolean isInitialUpdateOccurred()
```
  - isInitialised
```
public boolean isInitialised()
```
    Returns if the UiElement has been initialised within the render tree
    
    Returns:
    
    False if a layout() and update() call has not yet occurred on the element
  - isRenderNodeDirty
```
public abstract boolean isRenderNodeDirty()
```
  - setRenderNodeDirty
```
public abstract void setRenderNodeDirty()
```
  - syncWithLayout
```
public void syncWithLayout(UiContainerRenderTree rootNode)
```
    Syncs data between the UiElement and RenderNode during UI layout
  - syncWithUpdate
```
public void syncWithUpdate(UiContainerRenderTree rootNode)
```
    Syncs data between the UiElement and RenderNode during update
  - syncWithRender
```
public void syncWithRender(UiContainerRenderTree rootNode)
```
    Syncs data between the UiElement and RenderNode during UI render
  - alignEdgeToEdge
```
public void alignEdgeToEdge(UiElement alignToElement,
                            HorizontalAlignment horizontalAlignment,
                            VerticalAlignment verticalAlignment)
```
    Aligns the edges of this UiElement to the edges of another element.
    
    Parameters:
    
    alignToElement - The UiElement to align with. Note: This can also be the UiContainer
    
    horizontalAlignment - HorizontalAlignment.LEFT aligns the right-side of this element to the left side of the align element. HorizontalAlignment.CENTER aligns the center of this element to the center of the align element. HorizontalAlignment.RIGHT aligns the left-side of this element to the right-side of the align element.
    
    verticalAlignment - VerticalAlignment.TOP aligns the bottom-side of this element to the top-side of the align element. VerticalAlignment.MIDDLE aligns the middle of this element to the middle of the align element. VerticalAlignment.BOTTOM aligns the top-side of this element to the bottom-side of the align element.
  - alignLeftOf
```
public void alignLeftOf(UiElement alignToElement,
                        VerticalAlignment verticalAlignment)
```
    Aligns the right edge of this element to the left edge of another element
    
    Parameters:
    
    alignToElement - The UiElement to align with. Note: This can also be the UiContainer
    
    verticalAlignment - VerticalAlignment.TOP aligns the top-side of this element to the top-side of the align element. * VerticalAlignment.MIDDLE aligns the middle of this element to the middle of the align element. * VerticalAlignment.BOTTOM aligns the bottom-side of this element to the bottom-side of the align element.
  - alignRightOf
```
public void alignRightOf(UiElement alignToElement,
                         VerticalAlignment verticalAlignment)
```
    Aligns the left edge of this element to the right edge of another element
    
    Parameters:
    
    alignToElement - The UiElement to align with. Note: This can also be the UiContainer
    
    verticalAlignment - VerticalAlignment.TOP aligns the top-side of this element to the top-side of the align element. * VerticalAlignment.MIDDLE aligns the middle of this element to the middle of the align element. * VerticalAlignment.BOTTOM aligns the bottom-side of this element to the bottom-side of the align element.
  - alignBelow
```
public void alignBelow(UiElement alignToElement,
                       HorizontalAlignment horizontalAlignment)
```
    Aligns the top edge of this element to the bottom of another element
    
    Parameters:
    
    alignToElement - The UiElement to align with. Note: This can also be the UiContainer
    
    horizontalAlignment - HorizontalAlignment.LEFT aligns the left-side of this element to the left side of the align element. HorizontalAlignment.CENTER aligns the center of this element to the center of the align element. HorizontalAlignment.RIGHT aligns the right-side of this element to the right-side of the align element.
  - alignAbove
```
public void alignAbove(UiElement alignToElement,
                       HorizontalAlignment horizontalAlignment)
```
    Aligns the bottom edge of this element to the top of another element
    
    Parameters:
    
    alignToElement - The UiElement to align with. Note: This can also be the UiContainer
    
    horizontalAlignment - HorizontalAlignment.LEFT aligns the left-side of this element to the left side of the align element. * HorizontalAlignment.CENTER aligns the center of this element to the center of the align element. * HorizontalAlignment.RIGHT aligns the right-side of this element to the right-side of the align element.
  - snapTo
```
public void snapTo(UiElement snapToElement)
```
    Snaps this UiElement to the top-left corner of another UiElement
    
    Parameters:
    
    snapToElement - The UiElement to snap to. Note: This can also be the UiContainer
  - snapTo
```
public void snapTo(UiElement snapToElement,
                   HorizontalAlignment horizontalAlignment,
                   VerticalAlignment verticalAlignment)
```
    Snaps this UiElement to the same area of another element.
    
    Parameters:
    
    snapToElement - The UiElement to snap to. Note: This can also be the UiContainer
    
    horizontalAlignment - The HorizontalAlignment of this element within the area of the align element
    
    verticalAlignment - The VerticalAlignment of this element within the area of the align element
  - setWidthToWidthOf
```
public void setWidthToWidthOf(UiElement otherElement)
```
    Sets the width of this element to match the width of another UiElement
    
    Parameters:
    
    otherElement - The UiElement to get the width of
  - setWidthToContentWidthOf
```
public void setWidthToContentWidthOf(UiElement otherElement)
```
    Sets the width of this element to match the content width of another UiElement. See getContentWidth()
    
    Parameters:
    
    otherElement - The UiElement to get the content width of
  - setHeightToHeightOf
```
public void setHeightToHeightOf(UiElement otherElement)
```
    Sets the height of this element to match the height of another UiElement
    
    Parameters:
    
    otherElement - The UiElement to get the height of
  - setHeightToContentHeightOf
```
public void setHeightToContentHeightOf(UiElement otherElement)
```
    Sets the height of this element to match the content height of another UiElement. See getContentHeight()
    
    Parameters:
    
    otherElement - The UiElement to get the content height of
  - attach
```
public abstract void attach(ParentRenderNode<?,?> parentRenderNode)
```
    Attaches a RenderNode for this element to a parent RenderNode
    
    Parameters:
    
    parentRenderNode - The parent RenderNode to attach to
  - detach
```
public abstract void detach(ParentRenderNode<?,?> parentRenderNode)
```
    Detaches this element's RenderNode from a parent RenderNode
    
    Parameters:
    
    parentRenderNode - The parent RenderNode to detach from
  - applyEffect
```
public void applyEffect(UiEffect effect)
```
    Applies a UiEffect to this element
    
    Parameters:
    
    effect - The UiEffect to be applied
  - deferUntilUpdate
```
public DeferredRunnable deferUntilUpdate(java.lang.Runnable runnable)
```
    Defers the execution of a Runnable instance until the next frame update
    
    Parameters:
    
    runnable - The Runnable to execute
    
    Returns:
    
    A DeferredRunnable that can be cancelled
  - deferUntilUpdate
```
public DeferredRunnable deferUntilUpdate(java.lang.Runnable runnable,
                                         float duration)
```
    Defers the execution of a Runnable instance for a period of time
    
    Parameters:
    
    runnable - The Runnable to execute
    
    duration - The time to wait (in seconds) until executing the Runnable
    
    Returns:
    
    A DeferredRunnable that can be cancelled
  - deferUntilUpdate
```
public DeferredRunnable deferUntilUpdate(java.lang.Runnable runnable,
                                         boolean skipQueue)
```
    Defers the execution of a Runnable instance for a period of time
    
    Parameters:
    
    runnable - The Runnable to execute
    
    skipQueue - True if the task should skip to the front of the deferred queue
    
    Returns:
    
    A DeferredRunnable that can be cancelled
  - deferUntilUpdate
```
public DeferredRunnable deferUntilUpdate(java.lang.Runnable runnable,
                                         float duration,
                                         boolean skipQueue)
```
    Defers the execution of a Runnable instance for a period of time
    
    Parameters:
    
    runnable - The Runnable to execute
    
    duration - The time to wait (in seconds) until executing the Runnable
    
    skipQueue - True if the task should skip to the front of the deferred queue
    
    Returns:
    
    A DeferredRunnable that can be cancelled
  - deferUntilLayout
```
public DeferredRunnable deferUntilLayout(java.lang.Runnable runnable)
```
    Defers the execution of a Runnable instance until the next UI re-layout completes
    
    Parameters:
    
    runnable - The Runnable to execute
    
    Returns:
    
    A DeferredRunnable that can be cancelled
  - deferUntilLayout
```
public DeferredRunnable deferUntilLayout(java.lang.Runnable runnable,
                                         boolean skipQueue)
```
    Defers the execution of a Runnable instance until the next UI re-layout completes
    
    Parameters:
    
    runnable - The Runnable to execute
    
    skipQueue - True if the task should skip to the front of the deferred queue
    
    Returns:
    
    A DeferredRunnable that can be cancelled
  - deferUntilRender
```
public DeferredRunnable deferUntilRender(java.lang.Runnable runnable)
```
    Defers the execution of a Runnable instance until the UI render completes
    
    Parameters:
    
    runnable - The Runnable to execute
    
    Returns:
    
    A DeferredRunnable that can be cancelled
  - deferUntilRender
```
public DeferredRunnable deferUntilRender(java.lang.Runnable runnable,
                                         boolean skipQueue)
```
    Defers the execution of a Runnable instance until the UI render completes
    
    Parameters:
    
    runnable - The Runnable to execute
    
    skipQueue - True if the task should skip to the front of the deferred queue
    
    Returns:
    
    A DeferredRunnable that can be cancelled
  - getId
```
public java.lang.String getId()
```
    Description copied from interface: Hoverable
    
    Returns the unique id
    
    Specified by:
    
    getId in interface Hoverable
    
    Returns:
  - getVisibility
```
public Visibility getVisibility()
```
    Returns the current Visibility of this UiElement
    
    Returns:
  - setVisibility
```
public abstract void setVisibility(Visibility visibility)
```
    Sets the current Visibility of this UiElement
    
    Parameters:
    
    visibility - The Visibility to set
  - getStyleId
```
public java.lang.String getStyleId()
```
    Returns the current style id of this UiElement
    
    Returns:
    
    UiTheme.DEFAULT_STYLE_ID by default
  - setStyleId
```
public abstract void setStyleId(java.lang.String styleId)
```
    Sets the style if for this UiElement
    
    Parameters:
    
    styleId - The style id to set
  - getZIndex
```
public int getZIndex()
```
    Returns the Z index of this UiElement
    
    Returns:
    
    0 by default
  - setZIndex
```
public abstract void setZIndex(int zIndex)
```
    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)
    
    Parameters:
    
    zIndex - The Z index
  - addHoverListener
```
public void addHoverListener(HoverListener listener)
```
    Description copied from interface: Hoverable
    
    Adds a HoverListener to listen for hover events
    
    Specified by:
    
    addHoverListener in interface Hoverable
    
    Parameters:
    
    listener - The HoverListener to add
  - removeHoverListener
```
public void removeHoverListener(HoverListener listener)
```
    Description copied from interface: Hoverable
    
    Removes a HoverListener from this Hoverable
    
    Specified by:
    
    removeHoverListener in interface Hoverable
    
    Parameters:
    
    listener - The HoverListener to remove
  - notifyHoverListenersOnBeginHover
```
public void notifyHoverListenersOnBeginHover()
```
    Notifies all HoverListeners of the begin hover event
    
    Specified by:
    
    notifyHoverListenersOnBeginHover in interface Hoverable
  - addEffectListener
```
public void addEffectListener(UiEffectListener listener)
```
    Adds a UiEffectListener to this UiElement
    
    Parameters:
    
    listener - The UiEffectListener to add
  - removeEffectListener
```
public void removeEffectListener(UiEffectListener listener)
```
    Removes a UiEffectListener from this UiElement
    
    Parameters:
    
    listener - The UiEffectListener to remove
  - notifyHoverListenersOnEndHover
```
public void notifyHoverListenersOnEndHover()
```
    Notifies all HoverListeners of the end hover event
    
    Specified by:
    
    notifyHoverListenersOnEndHover in interface Hoverable
  - notifyEffectListenersOnFinished
```
public void notifyEffectListenersOnFinished(UiEffect effect)
```
    Notifies all UiEffectListeners of the finished event
    
    Parameters:
    
    effect - The UiEffect that finished
  - addNodeStateListener
```
public void addNodeStateListener(NodeStateListener listener)
```
  - removeNodeStateListener
```
public void removeNodeStateListener(NodeStateListener listener)
```
  - notifyNodeStateListeners
```
public void notifyNodeStateListeners(NodeState nodeState)
```
  - getElementById
```
public UiElement getElementById(java.lang.String id)
```
    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.
    
    Parameters:
    
    id - The UiElement identifier to search for
    
    Returns:
    
    Null if there is no such UiElement with the given id
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class java.lang.Object
  - equals
```
public boolean equals(java.lang.Object obj)
```
    Overrides:
    
    equals in class java.lang.Object
  - isDebugEnabled
```
public boolean isDebugEnabled()
```
  - setDebugEnabled
```
public void setDebugEnabled(boolean debugEnabled)
```
  - getX
```
public float getX()
```
  - getY
```
public float getY()
```
  - getWidth
```
public float getWidth()
```
  - getHeight
```
public float getHeight()
```
  - set
```
public boolean set(float x,
                   float y,
                   float width,
                   float height)
```
    Sets the x, y, width and height of this element
    
    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
    
    Returns:
    
    True if the x or y coordinate or width or height changed
  - setXY
```
public boolean setXY(float x,
                     float y)
```
    Sets the x and y coordinates of this element
    
    Parameters:
    
    x - The x coordinate (in pixels) relative to its parent
    
    y - The y coordinate (in pixels) relative to its parent
    
    Returns:
    
    True if the x or y coordinate changed
  - setX
```
public boolean setX(float x)
```
    Sets the x coordinate of this element.
    
    Parameters:
    
    x - The x coordinate (in pixels) relative to its parent
    
    Returns:
    
    True if the x coordinate changed
  - setY
```
public boolean setY(float y)
```
    Sets the y coordinate of this element
    
    Parameters:
    
    y - The y coordinate (in pixels) relative to its parent
    
    Returns:
    
    True if the y coordinate changed
  - setWidth
```
public boolean setWidth(float width)
```
    Sets the width of this element
    
    Parameters:
    
    width - The width in pixels
    
    Returns:
    
    True if the width changed
  - setHeight
```
public boolean setHeight(float height)
```
    Sets the height of this element
    
    Parameters:
    
    height - The height in pixels
    
    Returns:
    
    True if the height changed
  - getContentWidth
```
public float getContentWidth()
```
    Returns the width of this element minus its margin and padding
    
    Returns:
  - getContentHeight
```
public float getContentHeight()
```
    Returns the height of this element minus its margin and padding
    
    Returns:
  - setContentWidth
```
public boolean setContentWidth(float contentWidth)
```
    Sets the content width. See: getContentWidth()
    
    Parameters:
    
    contentWidth -
    
    Returns:
    
    True if the width changed
  - setContentHeight
```
public boolean setContentHeight(float contentHeight)
```
    Sets the content height. See: getContentHeight()
    
    Parameters:
    
    contentHeight -
    
    Returns:
    
    True if the height changed
  - getStyleRule
```
public abstract StyleRule getStyleRule()
```
  - getMarginTop
```
public int getMarginTop()
```
  - getMarginBottom
```
public int getMarginBottom()
```
  - getMarginLeft
```
public int getMarginLeft()
```
  - getMarginRight
```
public int getMarginRight()
```
  - getPaddingTop
```
public int getPaddingTop()
```
  - getPaddingBottom
```
public int getPaddingBottom()
```
  - getPaddingLeft
```
public int getPaddingLeft()
```
  - getPaddingRight
```
public int getPaddingRight()
```
  - getRenderX
```
public abstract int getRenderX()
```
    Returns X coordinate of where this element is currently rendering
    
    Returns:
    
    Integer.MIN_VALUE if not rendering
  - getRenderY
```
public abstract int getRenderY()
```
    Returns Y coordinate of where this element is currently rendering
    
    Returns:
    
    Integer.MIN_VALUE if not rendering
  - getRenderWidth
```
public abstract int getRenderWidth()
```
    Returns the width this element is currently rendering at
    
    Returns:
    
    -1 if not rendering
  - getRenderHeight
```
public abstract int getRenderHeight()
```
    Returns the height this element is currently rendering at
    
    Returns:
    
    -1 if not rendering
  - isFlexLayout
```
public boolean isFlexLayout()
```
    Returns if this UiElement is using a flex layout
    
    Returns:

Class UiElement

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Methods inherited from interface org.mini2Dx.ui.element.Hoverable

Field Detail

effects

deferredLayout

deferredUpdate

deferredRender

visibility

styleId

zIndex

x

y

width

height

Constructor Detail

UiElement

UiElement

UiElement

UiElement

Method Detail

isInitialLayoutOccurred

isInitialUpdateOccurred

isInitialised

isRenderNodeDirty

setRenderNodeDirty

syncWithLayout

syncWithUpdate

syncWithRender

alignEdgeToEdge

alignLeftOf

alignRightOf

alignBelow

alignAbove

snapTo

snapTo

setWidthToWidthOf

setWidthToContentWidthOf

setHeightToHeightOf

setHeightToContentHeightOf

attach

detach

applyEffect

deferUntilUpdate

deferUntilUpdate

deferUntilUpdate

deferUntilUpdate

deferUntilLayout

deferUntilLayout

deferUntilRender

deferUntilRender

getId

getVisibility

setVisibility

getStyleId

setStyleId

getZIndex

setZIndex

addHoverListener

removeHoverListener

notifyHoverListenersOnBeginHover

addEffectListener

removeEffectListener

notifyHoverListenersOnEndHover

notifyEffectListenersOnFinished

addNodeStateListener

removeNodeStateListener

notifyNodeStateListeners

getElementById

hashCode

equals

isDebugEnabled

setDebugEnabled

getX

getY

getWidth

getHeight