heronarts.p3lx.ui

Class UI2dScrollContext

java.lang.Object

heronarts.p3lx.ui.UIEventHandler

heronarts.p3lx.ui.UIObject

heronarts.p3lx.ui.UI2dComponent

heronarts.p3lx.ui.UI2dContainer

heronarts.p3lx.ui.UI2dContext

heronarts.p3lx.ui.UI2dScrollContext

All Implemented Interfaces:

LXLoopTask, UIContainer, Iterable<UIObject>

Direct Known Subclasses:

UIDeviceBin, UIItemList.ScrollList

public class UI2dScrollContext
extends UI2dContext

Nested Class Summary

Nested classes/interfaces inherited from class heronarts.p3lx.ui.UI2dContainer

UI2dContainer.ArrowKeyFocus, UI2dContainer.Layout

Field Summary

Fields inherited from class heronarts.p3lx.ui.UI2dComponent

bottomMargin, height, leftMargin, rightMargin, textAlignHorizontal, textAlignVertical, textOffsetX, textOffsetY, topMargin, width, x, y

Fields inherited from class heronarts.p3lx.ui.UIObject

children, hasFocus, mousePressContextMenu, visible

Constructor Summary

Constructors

Constructor and Description
UI2dScrollContext(UI ui, float x, float y, float w, float h)

Method Summary

Modifier and Type	Method and Description
float	getScrollHeight()
float	getScrollWidth()
float	getScrollX()
float	getScrollY()
protected void	onMouseWheel(MouseEvent e, float mx, float my, float delta) Subclasses override to receive mouse events
protected void	onResize() Subclasses may override this method, invoked when the component is resized
UI2dContainer	setContentSize(float w, float h)
UI2dScrollContext	setHorizontalScrollingEnabled(boolean horizontalScrollingEnabled)
UI2dScrollContext	setMaxHeight(float maxHeight) Sets a maximum height on the scroll container.
UI2dScrollContext	setScrollHeight(float scrollHeight)
UI2dScrollContext	setScrollSize(float scrollWidth, float scrollHeight)
UI2dScrollContext	setScrollWidth(float scrollWidth)
UI2dScrollContext	setScrollX(float scrollX)
UI2dScrollContext	setScrollY(float scrollY)
UI2dScrollContext	setVerticalScrollingEnabled(boolean verticalScrollingEnabled)

Methods inherited from class heronarts.p3lx.ui.UI2dContext

drawBackground, getGraphics

Methods inherited from class heronarts.p3lx.ui.UI2dContainer

addChildren, addTopLevelComponent, getChild, getChildren, getContentHeight, getContentTarget, getContentWidth, iterator, newHorizontalContainer, newHorizontalContainer, newHorizontalContainer, newVerticalContainer, newVerticalContainer, newVerticalContainer, onKeyPressed, reflow, removeAllChildren, setArrowKeyFocus, setChildMargin, setChildSpacing, setChildSpacing, setContentHeight, setContentTarget, setContentWidth, setLayout, setMinHeight, setMinWidth, setPadding, setPadding, setPadding

Methods inherited from class heronarts.p3lx.ui.UI2dComponent

addToContainer, addToContainer, breakTextToWidth, clipTextToWidth, contains, drawBorder, drawFocus, drawFocusCorners, drawFocusCorners, getBackgroundColor, getBorderColor, getBorderRounding, getBorderWeight, getContainer, getFocusColor, getFocusSize, getFont, getFontColor, getHeight, getNextSibling, getParent, getPrevSibling, getWidth, getX, getY, hasBackground, hasBorder, hasFont, hasFontColor, isMappable, redraw, removeFromContainer, setBackground, setBackgroundColor, setBorder, setBorderColor, setBorderRounding, setBorderWeight, setBottomMargin, setContainerIndex, setDescription, setFocusBackground, setFocusBackgroundColor, setFocusColor, setFocusCorners, setFont, setFontColor, setFontColor, setHeight, setLeftMargin, setMappable, setMargin, setMargin, setMargin, setPosition, setPosition, setPosition, setPosition, setRightMargin, setSize, setTextAlignment, setTextAlignment, setTextOffset, setTopMargin, setVisible, setWidth, setX, setY

Methods inherited from class heronarts.p3lx.ui.UIObject

addLoopTask, beginDraw, blur, bringToFront, consumeKeyEvent, consumeMousePress, consumeMouseWheelEvent, endDraw, focus, getDescription, getFocusedChild, getLX, getUI, hasDirectFocus, hasFocus, isVisible, keyEventConsumed, loop, mousePressConsumed, onBlur, onDraw, onFocus, onUIResize, removeLoopTask, toggleVisible

Methods inherited from class heronarts.p3lx.ui.UIEventHandler

onKeyReleased, onKeyTyped, onMouseClicked, onMouseDragged, onMouseMoved, onMouseOut, onMouseOver, onMousePressed, onMouseReleased

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Constructor Detail

UI2dScrollContext

public UI2dScrollContext(UI ui,
                         float x,
                         float y,
                         float w,
                         float h)

Method Detail

setMaxHeight

public UI2dScrollContext setMaxHeight(float maxHeight)

Sets a maximum height on the scroll container. Resize or dynamic layout operations up to this size will actually resize the container and texture itself. But past that point, scroll operation occurs.

Parameters:

maxHeight - Maximum height before scrolling kicks in

Returns:

this

setContentSize

public UI2dContainer setContentSize(float w,
                                    float h)

Overrides:

setContentSize in class UI2dContainer

setScrollSize

public UI2dScrollContext setScrollSize(float scrollWidth,
                                       float scrollHeight)

getScrollHeight

public float getScrollHeight()

setScrollHeight

public UI2dScrollContext setScrollHeight(float scrollHeight)

getScrollWidth

public float getScrollWidth()

setScrollWidth

public UI2dScrollContext setScrollWidth(float scrollWidth)

setHorizontalScrollingEnabled

public UI2dScrollContext setHorizontalScrollingEnabled(boolean horizontalScrollingEnabled)

setVerticalScrollingEnabled

public UI2dScrollContext setVerticalScrollingEnabled(boolean verticalScrollingEnabled)

onResize

protected void onResize()

Description copied from class: UI2dComponent

Subclasses may override this method, invoked when the component is resized

Overrides:

onResize in class UI2dContext

getScrollX

public float getScrollX()

getScrollY

public float getScrollY()

setScrollX

public UI2dScrollContext setScrollX(float scrollX)

setScrollY

public UI2dScrollContext setScrollY(float scrollY)

onMouseWheel

protected void onMouseWheel(MouseEvent e,
                            float mx,
                            float my,
                            float delta)

Description copied from class: UIEventHandler

Subclasses override to receive mouse events

Overrides:

onMouseWheel in class UIEventHandler

Parameters:

e - Mouse event

mx - x-coordinate

my - y-coordinate

delta - Amount of wheel movement