org.mini2Dx.ui.element

Class Checkbox

java.lang.Object

org.mini2Dx.ui.element.UiElement

org.mini2Dx.ui.element.Checkbox

All Implemented Interfaces:

Actionable, Hoverable

public class Checkbox
extends UiElement
implements Actionable

Implements a checkbox that can be checked or unchecked by the player

Field Summary

Fields

Modifier and Type	Field and Description
protected CheckboxRenderNode	renderNode

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

deferredQueue, effects, styleId, visibility, zIndex

Constructor Summary

Constructors

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

Method Summary

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	defer(java.lang.Runnable runnable) Defers the execution of a Runnable instance until the next frame update
void	detach(ParentRenderNode<?,?> parentRenderNode) Detaches this element's RenderNode from a parent RenderNode
boolean	isChecked()
boolean	isEnabled()
boolean	isResponsive()
void	notifyActionListenersOfBeginEvent(EventTrigger eventTrigger, EventTriggerParams eventTriggerParams)
void	notifyActionListenersOfEndEvent(EventTrigger eventTrigger, EventTriggerParams eventTriggerParams)
void	removeActionListener(ActionListener listener)
void	setChecked(boolean checked)
void	setEnabled(boolean enabled)
void	setResponsive(boolean responsive)
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.
void	syncWithRenderNode() Syncs data between the UiElement and RenderNode

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

addEffectListener, addHoverListener, applyEffect, equals, getElementById, 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

Field Detail

renderNode

protected CheckboxRenderNode renderNode

Constructor Detail

Checkbox

public Checkbox()

Constructor. Generates a unique ID for this Checkbox

Checkbox

public Checkbox(java.lang.String id)

Constructor

Parameters:

id - The unique ID for this Checkbox

Method Detail

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

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

addActionListener

public void addActionListener(ActionListener listener)

Specified by:

addActionListener in interface Actionable

removeActionListener

public void removeActionListener(ActionListener listener)

Specified by:

removeActionListener in interface Actionable

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

defer

public void defer(java.lang.Runnable runnable)

Description copied from class: UiElement

Defers the execution of a Runnable instance until the next frame update

Specified by:

defer in class UiElement

Parameters:

runnable - The Runnable to execute

syncWithRenderNode

public void syncWithRenderNode()

Description copied from class: UiElement

Syncs data between the UiElement and RenderNode

Specified by:

syncWithRenderNode in class UiElement

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

isChecked

public boolean isChecked()

setChecked

public void setChecked(boolean checked)

isResponsive

public boolean isResponsive()

setResponsive

public void setResponsive(boolean responsive)

isEnabled

public boolean isEnabled()

Specified by:

isEnabled in interface Actionable

setEnabled

public void setEnabled(boolean enabled)

Specified by:

setEnabled in interface Actionable