org.mini2Dx.ui.element

Class UiElement

java.lang.Object

org.mini2Dx.ui.element.UiElement

All Implemented Interfaces:

Hoverable

Direct Known Subclasses:

Button, Column, Image, Label, Select, TabView, TextBox, UiContainer

public abstract class UiElement
extends java.lang.Object
implements Hoverable

Field Summary

Fields

Modifier and Type	Field and Description
protected java.util.Queue<UiEffect>	effects
protected java.lang.String	styleId
protected Visibility	visibility
protected int	zIndex

Constructor Summary

Constructors

Constructor and Description
UiElement()
UiElement(java.lang.String id)

Method Summary

Methods

Modifier and Type	Method and Description
void	addHoverListener(HoverListener listener)
void	applyEffect(UiEffect effect)
abstract void	attach(ParentRenderNode<?,?> parentRenderNode)
abstract void	detach(ParentRenderNode<?,?> parentRenderNode)
boolean	equals(java.lang.Object obj)
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.
java.lang.String	getId()
java.lang.String	getStyleId()
Visibility	getVisibility()
int	getZIndex()
int	hashCode()
boolean	isDebugEnabled()
void	notifyHoverListenersOnBeginHover()
void	notifyHoverListenersOnEndHover()
void	removeHoverListener(HoverListener listener)
void	setDebugEnabled(boolean debugEnabled)
abstract void	setStyleId(java.lang.String styleId)
abstract void	setVisibility(Visibility visibility)
abstract void	setZIndex(int zIndex)
abstract void	syncWithRenderNode()

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

visibility

protected Visibility visibility

styleId

protected java.lang.String styleId

zIndex

protected int zIndex

Constructor Detail

UiElement

public UiElement()

UiElement

public UiElement(java.lang.String id)

Method Detail

syncWithRenderNode

public abstract void syncWithRenderNode()

attach

public abstract void attach(ParentRenderNode<?,?> parentRenderNode)

detach

public abstract void detach(ParentRenderNode<?,?> parentRenderNode)

applyEffect

public void applyEffect(UiEffect effect)

getId

public java.lang.String getId()

Specified by:

getId in interface Hoverable

getVisibility

public Visibility getVisibility()

setVisibility

public abstract void setVisibility(Visibility visibility)

getStyleId

public java.lang.String getStyleId()

setStyleId

public abstract void setStyleId(java.lang.String styleId)

getZIndex

public int getZIndex()

setZIndex

public abstract void setZIndex(int zIndex)

addHoverListener

public void addHoverListener(HoverListener listener)

Specified by:

addHoverListener in interface Hoverable

removeHoverListener

public void removeHoverListener(HoverListener listener)

Specified by:

removeHoverListener in interface Hoverable

notifyHoverListenersOnBeginHover

public void notifyHoverListenersOnBeginHover()

Specified by:

notifyHoverListenersOnBeginHover in interface Hoverable

notifyHoverListenersOnEndHover

public void notifyHoverListenersOnEndHover()

Specified by:

notifyHoverListenersOnEndHover in interface Hoverable

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)