org.mini2Dx.ui.element

Class Button

java.lang.Object

org.mini2Dx.ui.element.UiElement

org.mini2Dx.ui.element.Button

All Implemented Interfaces:

Actionable, Hoverable

Direct Known Subclasses:

ContentButton, ImageButton, TextButton

public abstract class Button
extends UiElement
implements Actionable

Base class for button implementations

Field Summary

Fields

Modifier and Type	Field and Description
protected java.lang.String	layout

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

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)
java.lang.String	getLayout() Returns the current layout for this Button
boolean	isEnabled()
void	notifyActionListenersOfBeginEvent()
void	notifyActionListenersOfEndEvent()
void	removeActionListener(ActionListener listener)
void	setEnabled(boolean enabled)
abstract void	setLayout(java.lang.String layout) Sets the current layout for this Button

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

addEffectListener, addHoverListener, applyEffect, attach, detach, equals, getElementById, getId, getStyleId, getVisibility, getZIndex, hashCode, isDebugEnabled, notifyEffectListenersOnFinished, notifyHoverListenersOnBeginHover, notifyHoverListenersOnEndHover, removeEffectListener, removeHoverListener, setDebugEnabled, setStyleId, setVisibility, setZIndex, syncWithRenderNode

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

layout

protected java.lang.String layout

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

notifyActionListenersOfBeginEvent

public void notifyActionListenersOfBeginEvent()

Specified by:

notifyActionListenersOfBeginEvent in interface Actionable

notifyActionListenersOfEndEvent

public void notifyActionListenersOfEndEvent()

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

getLayout

public java.lang.String getLayout()

Returns the current layout for this Button

Returns:

LayoutRuleset.DEFAULT_LAYOUT by default

setLayout

public abstract void setLayout(java.lang.String layout)

Sets the current layout for this Button

Parameters:

layout -