org.mini2Dx.ui.element

Class ScrollBox

java.lang.Object

org.mini2Dx.ui.element.UiElement

org.mini2Dx.ui.element.ParentUiElement

org.mini2Dx.ui.element.Div

org.mini2Dx.ui.element.ScrollBox

All Implemented Interfaces:

FlexUiElement, Hoverable

public class ScrollBox
extends Div

A scrollable view for UiElements

Field Summary

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

asyncRemoveAll, children, 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
ScrollBox() Constructor.
ScrollBox(float x, float y, float width, float height) Constructor
ScrollBox(java.lang.String id) Constructor
ScrollBox(java.lang.String id, float x, float y, float width, float height) 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	getMinHeight() Returns the minimum height for this ScrollBox.
float	getScrollContentHeight() Returns the height of the content within the scroll view
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	resizeScrollContentHeightToContents() Sets the scroll view height to be equal to the max Y of the child elements
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	setMinHeight(float minHeight) Sets the minimum height for this ScrollBox.
void	setScrollContentHeight(float scrollContentHeight) Sets the scroll view height.
void	setScrollFactor(float scrollFactor) Sets how much this ScrollBox scrolls when the up/down buttons are clicked
void	syncWithUpdate(UiContainerRenderTree rootNode) Syncs data between the UiElement and RenderNode during update

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

getStyleRule, withElements, withElements

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

add, add, attach, detach, get, getChild, getElementById, getFlexLayout, getRenderHeight, getRenderWidth, getRenderX, getRenderY, getTotalChildren, invokeBeginHover, invokeEndHover, isFlexLayout, isInitialLayoutOccurred, isInitialUpdateOccurred, isOverflowClipped, isRenderNodeDirty, remove, remove, removeAll, removeAllAsync, setFlex, setFlexLayout, setHeightFlex, setOverflowClipped, setRenderNodeDirty, setStyleId, setVisibility, setWidthFlex, setXFlex, setXYFlex, setYFlex, setZIndex, shrinkToContents, shrinkToContents

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, 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

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

ScrollBox

public ScrollBox(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

ScrollBox

public ScrollBox(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

createRenderNode

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

Description copied from class: ParentUiElement

Creates the ParentRenderNode for this UiElement

Overrides:

createRenderNode in class Div

Parameters:

parent - The parent of this node

Returns:

A new instance of ParentRenderNode

syncWithUpdate

public void syncWithUpdate(UiContainerRenderTree rootNode)

Description copied from class: UiElement

Syncs data between the UiElement and RenderNode during update

Overrides:

syncWithUpdate 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.

getMinHeight

public float getMinHeight()

Returns the minimum height for this ScrollBox. When set to Float.MIN_VALUE the value will be taken from the style.

Returns:

Float.MIN_VALUE by default

setMinHeight

public void setMinHeight(float minHeight)

Sets the minimum height for this ScrollBox. Setting this value overrides the style's minHeight value.

Parameters:

minHeight - The minimum height to set

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)

getScrollContentHeight

public float getScrollContentHeight()

Returns the height of the content within the scroll view

Returns:

setScrollContentHeight

public void setScrollContentHeight(float scrollContentHeight)

Sets the scroll view height. Note: If using flexLayout this will be overriden during layout()

Parameters:

scrollContentHeight -

resizeScrollContentHeightToContents

public void resizeScrollContentHeightToContents()

Sets the scroll view height to be equal to the max Y of the child elements