org.mini2Dx.ui.element

Class ContentButton

java.lang.Object

org.mini2Dx.ui.element.UiElement

org.mini2Dx.ui.element.Button

org.mini2Dx.ui.element.ContentButton

All Implemented Interfaces:

Actionable, Hoverable

Direct Known Subclasses:

TabButton

public class ContentButton
extends Button

Implementation of Button that allows custom inner content

Field Summary

Fields

Modifier and Type	Field and Description
protected java.util.List<UiElement>	children
protected ContentButtonRenderNode	renderNode

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

layout

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

effects, styleId, visibility, zIndex

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
void	add(UiElement element) Adds a UiElement to this ContentButton
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
UiElement	getElementById(java.lang.String id) Searches the UI for a UiElement with a given id.
int	getTotalChildren() Returns the total number of child elements for this element
boolean	remove(UiElement element) Removes a UiElement from this ContentButton
void	setLayout(java.lang.String layout) Sets the current layout for this Button
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.Button

addActionListener, getLayout, isEnabled, notifyActionListenersOfBeginEvent, notifyActionListenersOfEndEvent, removeActionListener, setEnabled

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

Field Detail

children

protected final java.util.List<UiElement> children

renderNode

protected ContentButtonRenderNode renderNode

Constructor Detail

ContentButton

public ContentButton()

Constructor. Generates a unique ID for the ContentButton

ContentButton

public ContentButton(java.lang.String id)

Constructor

Parameters:

id - The unique ID of the ContentButton

Method Detail

add

public void add(UiElement element)

Adds a UiElement to this ContentButton

Parameters:

element - The UiElement to be added

remove

public boolean remove(UiElement element)

Removes a UiElement from this ContentButton

Parameters:

element - The UiElement to be removed

Returns:

True if the ContentButton contained the UiElement

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

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

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

setLayout

public void setLayout(java.lang.String layout)

Description copied from class: Button

Sets the current layout for this Button

Specified by:

setLayout in class Button

getElementById

public UiElement getElementById(java.lang.String id)

Description copied from class: UiElement

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.

Overrides:

getElementById in class UiElement

Parameters:

id - The UiElement identifier to search for

Returns:

Null if there is no such UiElement with the given id

getTotalChildren

public int getTotalChildren()

Returns the total number of child elements for this element

Returns:

0 is there are no children