org.mini2Dx.ui.element

Class ScrollBox

java.lang.Object

org.mini2Dx.ui.element.UiElement

org.mini2Dx.ui.element.ParentUiElement

org.mini2Dx.ui.element.Column

org.mini2Dx.ui.element.ScrollBox

All Implemented Interfaces:

Hoverable

public class ScrollBox
extends Column

A scrollable view for UiElements

Field Summary

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

asyncAddQueue, asyncRemoveAll, asyncRemoveQueue, children, renderNode

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

effects, styleId, visibility, zIndex

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
void	addScrollListener(ScrollListener listener) Adds a ScrollListener to this ScrollBox
protected ParentRenderNode<?,?>	createRenderNode(ParentRenderNode<?,?> parent) Creates the ParentRenderNode for this UiElement
float	getMaxHeight() Returns the maximum height for this ScrollBox
float	getScrollFactor() Returns how much this ScrollBox scrolls when the up/down buttons are clicked (expressed as a % between 0.0 and 1.0)
void	notifyScrollListeners(float scrollThumbPosition) Notifies all ScrollListener instances that a scroll occurred on this ScrollBox
void	removeScrollListener(ScrollListener listener) Removes a ScrollListener from this ScrollBox
void	scrollTo(UiElement element, boolean immediate) Moves the scroll thumb until the UiElement is visible
void	scrollToBottom(boolean immediate) Scrolls to the last element in the ScrollBox
void	scrollToTop(boolean immediate) Scrolls to the first element in the ScrollBox
void	setMaxHeight(float maxHeight) Sets the maximum height for this ScrollBox
void	setScrollFactor(float scrollFactor) Sets how much this ScrollBox scrolls when the up/down buttons are clicked
void	syncWithRenderNode() Syncs data between the UiElement and RenderNode

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

withElements, withElements

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

add, add, addAsync, attach, detach, getElementById, getFlexDirection, getLayout, getTotalChildren, remove, remove, removeAll, removeAllAsync, removeAsync, setFlexDirection, setLayout, setStyleId, setVisibility, setZIndex

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

Constructor Detail

ScrollBox

public ScrollBox()

Constructor. Generates a unique ID for this ScrollBox

ScrollBox

public ScrollBox(java.lang.String id)

Constructor

Parameters:

id - The unique ID for this ScrollBox

Method Detail

createRenderNode

protected ParentRenderNode<?,?> createRenderNode(ParentRenderNode<?,?> parent)

Description copied from class: ParentUiElement

Creates the ParentRenderNode for this UiElement

Overrides:

createRenderNode in class Column

Parameters:

parent - The parent of this node

Returns:

A new instance of ParentRenderNode

syncWithRenderNode

public void syncWithRenderNode()

Description copied from class: UiElement

Syncs data between the UiElement and RenderNode

Overrides:

syncWithRenderNode in class ParentUiElement

scrollTo

public void scrollTo(UiElement element,
                     boolean immediate)

Moves the scroll thumb until the UiElement is visible

Parameters:

element - The UiElement to scroll to

immediate - True if the ScrollBox should "jump" to the element. False if the scrolling should be smooth.

scrollToTop

public void scrollToTop(boolean immediate)

Scrolls to the first element in the ScrollBox

Parameters:

immediate - True if the ScrollBox should "jump" to the element. False if the scrolling should be smooth.

scrollToBottom

public void scrollToBottom(boolean immediate)

Scrolls to the last element in the ScrollBox

Parameters:

immediate - True if the ScrollBox should "jump" to the element. False if the scrolling should be smooth.

getMaxHeight

public float getMaxHeight()

Returns the maximum height for this ScrollBox

Returns:

Float.MAX_VALUE by default

setMaxHeight

public void setMaxHeight(float maxHeight)

Sets the maximum height for this ScrollBox

Parameters:

maxHeight - The maximum height to set

getScrollFactor

public float getScrollFactor()

Returns how much this ScrollBox scrolls when the up/down buttons are clicked (expressed as a % between 0.0 and 1.0)

Returns:

DEFAULT_SCROLL_FACTOR by default

setScrollFactor

public void setScrollFactor(float scrollFactor)

Sets how much this ScrollBox scrolls when the up/down buttons are clicked

Parameters:

scrollFactor - A % between 0.0 and 1.0

addScrollListener

public void addScrollListener(ScrollListener listener)

Adds a ScrollListener to this ScrollBox

Parameters:

listener - The ScrollListener to add

removeScrollListener

public void removeScrollListener(ScrollListener listener)

Removes a ScrollListener from this ScrollBox

Parameters:

listener - The ScrollListener to remove

notifyScrollListeners

public void notifyScrollListeners(float scrollThumbPosition)

Notifies all ScrollListener instances that a scroll occurred on this ScrollBox

Parameters:

scrollThumbPosition - The position of the scroll thumb (between 0.0 and 1.0)