org.mini2Dx.ui.element

Class Button

java.lang.Object

org.mini2Dx.ui.element.UiElement

org.mini2Dx.ui.element.ParentUiElement

org.mini2Dx.ui.element.Button

All Implemented Interfaces:

Actionable, Hoverable

Direct Known Subclasses:

ImageButton, TabButton, TextButton

public class Button
extends ParentUiElement
implements Actionable

A button implementation that stores child elements such as Label, Image, etc.

Field Summary

Fields inherited from class org.mini2Dx.ui.element.ParentUiElement

asyncAddQueue, asyncRemoveAll, asyncRemoveQueue, children, renderNode

Fields inherited from class org.mini2Dx.ui.element.UiElement

deferredQueue, effects, styleId, visibility, zIndex

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
void	addActionListener(ActionListener listener)
protected ParentRenderNode<?,?>	createRenderNode(ParentRenderNode<?,?> parent) Creates the ParentRenderNode for this UiElement
boolean	isEnabled()
void	notifyActionListenersOfBeginEvent(EventTrigger eventTrigger, EventTriggerParams eventTriggerParams)
void	notifyActionListenersOfEndEvent(EventTrigger eventTrigger, EventTriggerParams eventTriggerParams)
void	removeActionListener(ActionListener listener)
void	setEnabled(boolean enabled)

Methods inherited from class org.mini2Dx.ui.element.ParentUiElement

add, add, addAsync, attach, defer, detach, getElementById, getFlexDirection, getLayout, getTotalChildren, remove, remove, removeAll, removeAllAsync, removeAsync, setFlexDirection, setLayout, setStyleId, setVisibility, setZIndex, syncWithRenderNode

Methods inherited from class org.mini2Dx.ui.element.UiElement

addEffectListener, addHoverListener, applyEffect, equals, getId, getStyleId, getVisibility, getZIndex, hashCode, isDebugEnabled, notifyEffectListenersOnFinished, notifyHoverListenersOnBeginHover, notifyHoverListenersOnEndHover, removeEffectListener, removeHoverListener, setDebugEnabled

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

Button

public Button()

Constructor. Generates a unique ID for this Button

Button

public Button(java.lang.String id)

Constructor

Parameters:

id - The unique ID of this Button

Method Detail

createRenderNode

protected ParentRenderNode<?,?> createRenderNode(ParentRenderNode<?,?> parent)

Description copied from class: ParentUiElement

Creates the ParentRenderNode for this UiElement

Specified by:

createRenderNode in class ParentUiElement

Parameters:

parent - The parent of this node

Returns:

A new instance of ParentRenderNode

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

addActionListener

public void addActionListener(ActionListener listener)

Specified by:

addActionListener in interface Actionable

removeActionListener

public void removeActionListener(ActionListener listener)

Specified by:

removeActionListener 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