org.mini2Dx.ui.element

Class Column

java.lang.Object

org.mini2Dx.ui.element.UiElement

org.mini2Dx.ui.element.Column

All Implemented Interfaces:

Hoverable

Direct Known Subclasses:

Container, Row, ScrollBox

public class Column
extends UiElement

Field Summary

Fields

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

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

effects, styleId, visibility, zIndex

Constructor Summary

Constructors

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

Method Summary

Methods

Modifier and Type	Method and Description
void	add(int index, UiElement element)
void	add(UiElement element)
void	attach(ParentRenderNode<?,?> parentRenderNode)
void	detach(ParentRenderNode<?,?> parentRenderNode)
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.
LayoutRuleset	getLayout()
boolean	remove(int index)
boolean	remove(UiElement element)
void	removeAll()
void	setLayout(LayoutRuleset layoutRuleset)
void	setStyleId(java.lang.String styleId)
void	setVisibility(Visibility visibility)
void	setZIndex(int zIndex)
void	syncWithRenderNode()
static Column	withElements(java.lang.String columnId, UiElement... elements)
static Column	withElements(UiElement... elements)

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

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

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

Field Detail

children

protected final java.util.List<UiElement> children

renderNode

protected AbstractColumnRenderNode<?> renderNode

Constructor Detail

Column

public Column()

Column

public Column(java.lang.String id)

Method Detail

add

public void add(UiElement element)

add

public void add(int index,
       UiElement element)

remove

public boolean remove(UiElement element)

remove

public boolean remove(int index)

removeAll

public void removeAll()

attach

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

Specified by:

attach in class UiElement

detach

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

Specified by:

detach in class UiElement

getLayout

public LayoutRuleset getLayout()

setLayout

public void setLayout(LayoutRuleset layoutRuleset)

setVisibility

public void setVisibility(Visibility visibility)

Specified by:

setVisibility in class UiElement

syncWithRenderNode

public void syncWithRenderNode()

Specified by:

syncWithRenderNode in class UiElement

setStyleId

public void setStyleId(java.lang.String styleId)

Specified by:

setStyleId in class UiElement

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

withElements

public static Column withElements(UiElement... elements)

withElements

public static Column withElements(java.lang.String columnId,
                  UiElement... elements)

setZIndex

public void setZIndex(int zIndex)

Specified by:

setZIndex in class UiElement