CustomUiElement (mini2Dx)

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

All Implemented Interfaces:

Actionable, Hoverable
```
public abstract class CustomUiElement
extends UiElement
implements Actionable
```
Base class for implementing custom UiElements

Field Summary
- 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
`CustomUiElement()` Constructor.
`CustomUiElement(float x, float y, float width, float height)` Constructor
`CustomUiElement(java.lang.String id)` Constructor
`CustomUiElement(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`	`addActionListener(ActionListener listener)`
`void`	`attach(ParentRenderNode<?,?> parentRenderNode)` Attaches a `RenderNode` for this element to a parent `RenderNode`
`void`	`detach(ParentRenderNode<?,?> parentRenderNode)` Detaches this element's `RenderNode` from a parent `RenderNode`
`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
`StyleRule`	`getStyleRule()`
`abstract void`	`interpolate(float alpha)` Interpoalte the UI state
`void`	`invokeBeginHover()` Triggers the begin hover event
`void`	`invokeEndHover()` Triggers the end hover event
`boolean`	`isEnabled()`
`boolean`	`isInitialLayoutOccurred()`
`boolean`	`isInitialUpdateOccurred()`
`boolean`	`isRenderNodeDirty()`
`void`	`notifyActionListenersOfBeginEvent(EventTrigger eventTrigger, EventTriggerParams eventTriggerParams)`
`void`	`notifyActionListenersOfEndEvent(EventTrigger eventTrigger, EventTriggerParams eventTriggerParams)`
`void`	`removeActionListener(ActionListener listener)`
`abstract void`	`render(Graphics g, CustomUiElementRenderNode renderNode)` Render the `UiElement`
`void`	`setEnabled(boolean enabled)`
`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`	`setZIndex(int zIndex)` Sets the Z index of this `UiElement`.
`abstract void`	`update(UiContainerRenderTree uiContainer, float delta)` Update the UI state

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, getElementById, getHeight, getId, getMarginBottom, getMarginLeft, getMarginRight, getMarginTop, getPaddingBottom, getPaddingLeft, getPaddingRight, getPaddingTop, getStyleId, getVisibility, getWidth, getX, getY, getZIndex, hashCode, isDebugEnabled, isFlexLayout, 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, syncWithUpdate

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
addHoverListener, getId, notifyHoverListenersOnBeginHover, notifyHoverListenersOnEndHover, removeHoverListener

- Constructor Detail
  - CustomUiElement
```
public CustomUiElement()
```
    Constructor. Generates a unique ID for this Checkbox
  - CustomUiElement
```
public CustomUiElement(java.lang.String id)
```
    Constructor
    
    Parameters:
    
    id - The unique ID for this Checkbox
  - CustomUiElement
```
public CustomUiElement(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
  - CustomUiElement
```
public CustomUiElement(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
  - update
```
public abstract void update(UiContainerRenderTree uiContainer,
                            float delta)
```
    Update the UI state
    
    Parameters:
    
    uiContainer - The root UiElement
    
    delta - The time since the last update
  - interpolate
```
public abstract void interpolate(float alpha)
```
    Interpoalte the UI state
    
    Parameters:
    
    alpha -
  - render
```
public abstract void render(Graphics g,
                            CustomUiElementRenderNode renderNode)
```
    Render the UiElement
    
    Parameters:
    
    g - The Graphics context
    
    renderNode - The RenderNode detailing where to render the element
  - 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
  - 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
  - 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
  - getStyleRule
```
public StyleRule getStyleRule()
```
    Specified by:
    
    getStyleRule in class UiElement
  - 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
  - notifyActionListenersOfBeginEvent
```
public void notifyActionListenersOfBeginEvent(EventTrigger eventTrigger,
                                              EventTriggerParams eventTriggerParams)
```
    Specified by:
    
    notifyActionListenersOfBeginEvent in interface Actionable
  - notifyActionListenersOfEndEvent
```
public void notifyActionListenersOfEndEvent(EventTrigger eventTrigger,
                                            EventTriggerParams eventTriggerParams)
```
    Specified by:
    
    notifyActionListenersOfEndEvent in interface Actionable
  - isEnabled
```
public boolean isEnabled()
```
    Specified by:
    
    isEnabled in interface Actionable
  - setEnabled
```
public void setEnabled(boolean enabled)
```
    Specified by:
    
    setEnabled in interface Actionable
  - addActionListener
```
public void addActionListener(ActionListener listener)
```
    Specified by:
    
    addActionListener in interface Actionable
  - removeActionListener
```
public void removeActionListener(ActionListener listener)
```
    Specified by:
    
    removeActionListener in interface Actionable
  - 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

Class CustomUiElement

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

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

Constructor Detail

CustomUiElement

CustomUiElement

CustomUiElement

CustomUiElement

Method Detail

update

interpolate

render

attach

detach

invokeBeginHover

invokeEndHover

setVisibility

setStyleId

setZIndex

getStyleRule

isRenderNodeDirty

setRenderNodeDirty

isInitialLayoutOccurred

isInitialUpdateOccurred

notifyActionListenersOfBeginEvent

notifyActionListenersOfEndEvent

isEnabled

setEnabled

addActionListener

removeActionListener

getRenderX

getRenderY

getRenderWidth

getRenderHeight