org.mini2Dx.ui.element

Class ProgressBar

java.lang.Object

org.mini2Dx.ui.element.UiElement

org.mini2Dx.ui.element.ProgressBar

All Implemented Interfaces:

FlexUiElement, Hoverable

public class ProgressBar
extends UiElement
implements FlexUiElement

Implements a progress/loading bar

Field Summary

Fields

Modifier and Type	Field and Description
protected ProgressBarRenderNode	renderNode

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

deferredLayout, deferredRender, deferredUpdate, effects, height, styleId, visibility, width, x, y, zIndex

Constructor Summary

Constructors

Constructor and Description
ProgressBar()
ProgressBar(float x, float y, float width, float height) Constructor
ProgressBar(java.lang.String id)
ProgressBar(java.lang.String id, float x, float y, float width, float height) Constructor

Method Summary

Modifier and Type	Method and Description
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
java.lang.String	getFlexLayout() Returns the currently used flex layout
float	getMax()
float	getMin()
int	getRenderHeight() Returns the height this element is currently rendering at
int	getRenderWidth() Returns the width this element is currently rendering at
int	getRenderX() Returns X coordinate of where this element is currently rendering
int	getRenderY() Returns Y coordinate of where this element is currently rendering
StyleRule	getStyleRule()
float	getValue()
void	invokeBeginHover() Triggers the begin hover event
void	invokeEndHover() Triggers the end hover event
boolean	isFlexLayout() Returns if this UiElement is using a flex layout
boolean	isInitialLayoutOccurred()
boolean	isInitialUpdateOccurred()
boolean	isRenderNodeDirty()
void	setFlex(float x, float y, float width, float height) Equivalent to UiElement.set(float, float, float, float) for usage with flex layout
void	setFlexLayout(java.lang.String flexLayout) Sets the current flex layout
void	setHeightFlex(float height) Equivalent to UiElement.setHeight(float) for usage with flex layout
void	setMax(float max)
void	setMin(float min)
void	setRenderNodeDirty()
void	setStyleId(java.lang.String styleId) Sets the style if for this UiElement
void	setValue(float value)
void	setVisibility(Visibility visibility) Sets the current Visibility of this UiElement
void	setWidthFlex(float width) Equivalent to UiElement.setWidth(float) for usage with flex layout
void	setXFlex(float x) Equivalent to UiElement.setX(float) for usage with flex layout
void	setXYFlex(float x, float y) Equivalent to UiElement.setXY(float, float) for usage with flex layout
void	setYFlex(float y) Equivalent to UiElement.setY(float) for usage with flex layout
void	setZIndex(int zIndex) Sets the Z index of this UiElement.
void	syncWithUpdate(UiContainerRenderTree rootNode) Syncs data between the UiElement and RenderNode during update

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

addEffectListener, addHoverListener, addNodeStateListener, alignAbove, alignBelow, alignEdgeToEdge, alignLeftOf, alignRightOf, applyEffect, deferUntilLayout, deferUntilLayout, deferUntilRender, deferUntilRender, deferUntilUpdate, deferUntilUpdate, deferUntilUpdate, deferUntilUpdate, equals, getContentHeight, getContentWidth, getElementById, getHeight, getId, getMarginBottom, getMarginLeft, getMarginRight, getMarginTop, getPaddingBottom, getPaddingLeft, getPaddingRight, getPaddingTop, getStyleId, getVisibility, getWidth, getX, getY, getZIndex, hashCode, isDebugEnabled, isInitialised, notifyEffectListenersOnFinished, notifyHoverListenersOnBeginHover, notifyHoverListenersOnEndHover, notifyNodeStateListeners, removeEffectListener, removeHoverListener, removeNodeStateListener, set, setContentHeight, setContentWidth, setDebugEnabled, setHeight, setHeightToContentHeightOf, setHeightToHeightOf, setWidth, setWidthToContentWidthOf, setWidthToWidthOf, setX, setXY, setY, snapTo, snapTo, syncWithLayout, syncWithRender

Methods inherited from class java.lang.Object

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

Field Detail

renderNode

protected ProgressBarRenderNode renderNode

Constructor Detail

ProgressBar

public ProgressBar()

ProgressBar

public ProgressBar(java.lang.String id)

ProgressBar

public ProgressBar(float x,
                   float y,
                   float width,
                   float height)

Constructor

Parameters:

x - The x coordinate of this element relative to its parent

y - The y coordinate of this element relative to its parent

width - The width of this element

height - The height of this element

ProgressBar

public ProgressBar(java.lang.String id,
                   float x,
                   float y,
                   float width,
                   float height)

Constructor

Parameters:

id - The unique ID for this element (if null an ID will be generated)

x - The x coordinate of this element relative to its parent

y - The y coordinate of this element relative to its parent

width - The width of this element

height - The height of this element

Method Detail

syncWithUpdate

public void syncWithUpdate(UiContainerRenderTree rootNode)

Description copied from class: UiElement

Syncs data between the UiElement and RenderNode during update

Overrides:

syncWithUpdate in class 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

invokeBeginHover

public void invokeBeginHover()

Description copied from interface: Hoverable

Triggers the begin hover event

Specified by:

invokeBeginHover in interface Hoverable

invokeEndHover

public void invokeEndHover()

Description copied from interface: Hoverable

Triggers the end hover event

Specified by:

invokeEndHover in interface Hoverable

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

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

getStyleRule

public StyleRule getStyleRule()

Specified by:

getStyleRule in class UiElement

getFlexLayout

public java.lang.String getFlexLayout()

Description copied from interface: FlexUiElement

Returns the currently used flex layout

Specified by:

getFlexLayout in interface FlexUiElement

Returns:

null if no flex layout is used

setFlexLayout

public void setFlexLayout(java.lang.String flexLayout)

Description copied from interface: FlexUiElement

Sets the current flex layout

Specified by:

setFlexLayout in interface FlexUiElement

Parameters:

flexLayout - see: FlexLayoutRuleset

getMin

public float getMin()

setMin

public void setMin(float min)

getMax

public float getMax()

setMax

public void setMax(float max)

getValue

public float getValue()

setValue

public void setValue(float value)

isRenderNodeDirty

public boolean isRenderNodeDirty()

Specified by:

isRenderNodeDirty in class UiElement

setRenderNodeDirty

public void setRenderNodeDirty()

Specified by:

setRenderNodeDirty in class UiElement

isInitialLayoutOccurred

public boolean isInitialLayoutOccurred()

Specified by:

isInitialLayoutOccurred in class UiElement

isInitialUpdateOccurred

public boolean isInitialUpdateOccurred()

Specified by:

isInitialUpdateOccurred in class UiElement

getRenderX

public int getRenderX()

Description copied from class: UiElement

Returns X coordinate of where this element is currently rendering

Specified by:

getRenderX in class UiElement

Returns:

Integer.MIN_VALUE if not rendering

getRenderY

public int getRenderY()

Description copied from class: UiElement

Returns Y coordinate of where this element is currently rendering

Specified by:

getRenderY in class UiElement

Returns:

Integer.MIN_VALUE if not rendering

getRenderWidth

public int getRenderWidth()

Description copied from class: UiElement

Returns the width this element is currently rendering at

Specified by:

getRenderWidth in class UiElement

Returns:

-1 if not rendering

getRenderHeight

public int getRenderHeight()

Description copied from class: UiElement

Returns the height this element is currently rendering at

Specified by:

getRenderHeight in class UiElement

Returns:

-1 if not rendering

isFlexLayout

public boolean isFlexLayout()

Description copied from class: UiElement

Returns if this UiElement is using a flex layout

Specified by:

isFlexLayout in interface FlexUiElement

Overrides:

isFlexLayout in class UiElement

Returns:

False by default

setFlex

public void setFlex(float x,
                    float y,
                    float width,
                    float height)

Equivalent to UiElement.set(float, float, float, float) for usage with flex layout

Parameters:

x - The x coordinate (in pixels) relative to its parent

y - The y coordinate (in pixels) relative to its parent

width - The width in pixels

height - The height in pixels

setXYFlex

public void setXYFlex(float x,
                      float y)

Equivalent to UiElement.setXY(float, float) for usage with flex layout

Parameters:

x - The x coordinate (in pixels) relative to its parent

y - The y coordinate (in pixels) relative to its parent

setXFlex

public void setXFlex(float x)

Equivalent to UiElement.setX(float) for usage with flex layout

Parameters:

x - The x coordinate (in pixels) relative to its parent

setYFlex

public void setYFlex(float y)

Equivalent to UiElement.setY(float) for usage with flex layout

Parameters:

y - The y coordinate (in pixels) relative to its parent

setWidthFlex

public void setWidthFlex(float width)

Equivalent to UiElement.setWidth(float) for usage with flex layout

Parameters:

width - The width in pixels

setHeightFlex

public void setHeightFlex(float height)

Equivalent to UiElement.setHeight(float) for usage with flex layout

Parameters:

height - The height in pixels