UiElement (mini2Dx)

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

All Implemented Interfaces:

Hoverable

Direct Known Subclasses:

AnimatedImage, Checkbox, 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 java.util.List<DeferredRunnable>`	`deferred`
`protected java.util.Queue<UiEffect>`	`effects`
`protected java.lang.String`	`styleId`
`protected Visibility`	`visibility`
`protected int`	`zIndex`

Constructor Summary

Constructors
Constructor and Description

UiElement()
Constructor.

UiElement(java.lang.String id)
Constructor

Constructors
Constructor and Description
`UiElement()` Constructor.
`UiElement(java.lang.String id)` 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`	`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`	`defer(java.lang.Runnable runnable)` Defers the execution of a `Runnable` instance until the next frame update
`DeferredRunnable`	`defer(java.lang.Runnable runnable, float duration)` 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)`
`UiElement`	`getElementById(java.lang.String id)` Searches the UI for a `UiElement` with a given id.
`java.lang.String`	`getId()` Returns the unique id
`java.lang.String`	`getStyleId()` Returns the current style id of this `UiElement`
`Visibility`	`getVisibility()` Returns the current `Visibility` of this `UiElement`
`int`	`getZIndex()` Returns the Z index of this `UiElement`
`int`	`hashCode()`
`boolean`	`isDebugEnabled()`
`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
`protected void`	`processDeferred()` Processes all deferred actions
`void`	`removeEffectListener(UiEffectListener listener)` Removes a `UiEffectListener` from this `UiElement`
`void`	`removeHoverListener(HoverListener listener)` Removes a `HoverListener` from this `Hoverable`
`void`	`setDebugEnabled(boolean debugEnabled)`
`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`
`abstract void`	`setZIndex(int zIndex)` Sets the Z index of this `UiElement`.
`abstract void`	`syncWithRenderNode()` Syncs data between the `UiElement` and `RenderNode`

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

- Field Detail
  - effects
```
protected final java.util.Queue<UiEffect> effects
```
  - deferred
```
protected final java.util.List<DeferredRunnable> deferred
```
  - visibility
```
protected Visibility visibility
```
  - styleId
```
protected java.lang.String styleId
```
  - zIndex
```
protected int zIndex
```
- 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
- Method Detail
  - syncWithRenderNode
```
public abstract void syncWithRenderNode()
```
    Syncs data between the UiElement and RenderNode
  - 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
  - defer
```
public DeferredRunnable defer(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
  - defer
```
public DeferredRunnable defer(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
  - processDeferred
```
protected void processDeferred()
```
    Processes all deferred actions
  - 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
  - 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)
```

Class UiElement

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

effects

deferred

visibility

styleId

zIndex

Constructor Detail

UiElement

UiElement

Method Detail

syncWithRenderNode

attach

detach

applyEffect

defer

defer

processDeferred

getId

getVisibility

setVisibility

getStyleId

setStyleId

getZIndex

setZIndex

addHoverListener

removeHoverListener

notifyHoverListenersOnBeginHover

addEffectListener

removeEffectListener

notifyHoverListenersOnEndHover

notifyEffectListenersOnFinished

getElementById

hashCode

equals

isDebugEnabled

setDebugEnabled