Package heronarts.glx.ui

Class UI2dScrollContext

java.lang.Object

heronarts.glx.ui.UIEventHandler

heronarts.glx.ui.UIObject

heronarts.glx.ui.UI2dComponent

heronarts.glx.ui.UI2dContainer

heronarts.glx.ui.UI2dContext

heronarts.glx.ui.UI2dScrollContext

All Implemented Interfaces:

UI2dScrollInterface, UIContainer, UILayer, LXLoopTask, Iterable<UIObject>

public class UI2dScrollContext
extends UI2dContext
implements UI2dScrollInterface

Nested Class Summary

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

UI2dContainer.ArrowKeyFocus, UI2dContainer.Layout, UI2dContainer.Position

Nested classes/interfaces inherited from class heronarts.glx.ui.UI2dComponent

UI2dComponent.Scissor, UI2dComponent.Scissored, UI2dComponent.UIDragReorder

Field Summary

Fields inherited from class heronarts.glx.ui.UI2dComponent

debug, debugName, height, marginBottom, marginLeft, marginRight, marginTop, redraw, scissor, textAlignHorizontal, textAlignVertical, textOffsetX, textOffsetY, width, x, y

Fields inherited from class heronarts.glx.ui.UIObject

children, hasFocus, visible

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
float	getScrollHeight()	Returns the height of scrolling content.
float	getScrollWidth()	Returns the width of scrolling content.
float	getScrollX()
float	getScrollY()
protected void	onMouseDragged(MouseEvent mouseEvent, float mx, float my, float dx, float dy)	Subclasses override to receive mouse events
protected void	onMouseScroll(MouseEvent mouseEvent, float mx, float my, float dx, float dy)	Subclasses override to receive mouse events
protected void	onResize()	Subclasses may override this method, invoked when the component is resized
protected void	onScrollChange()
UI2dContainer	setContentSize(float w, float h)
UI2dScrollContext	setHorizontalScrollingEnabled(boolean horizontalScrollingEnabled)
UI2dScrollContext	setMaxHeight(float maxHeight)	Sets a maximum height on the scroll container.
UI2dScrollContext	setMaxHeight(float maxHeight, boolean reflow)	Sets a maximum height on the scroll container.
UI2dScrollContext	setMaxWidth(float maxWidth)	Sets a maximum width on the scroll container.
UI2dScrollContext	setMaxWidth(float maxWidth, boolean reflow)	Sets a maximum width on the scroll container.
UI2dScrollContext	setScrollHeight(float scrollHeight)
UI2dScrollContext	setScrollSize(float scrollWidth, float scrollHeight)	Sets the size of the scrolled content, which could potentially be larger than the actual size of this element itself
UI2dScrollContext	setScrollWidth(float scrollWidth)
UI2dScrollContext	setScrollX(float scrollX)
UI2dScrollContext	setScrollY(float scrollY)
UI2dScrollContext	setVerticalScrollingEnabled(boolean verticalScrollingEnabled)

Methods inherited from class heronarts.glx.ui.UI2dContext

dispose, draw, draw, getPaint, getTexture, render, setOffscreen

Methods inherited from class heronarts.glx.ui.UI2dContainer

addChildren, addTopLevelComponent, getBottomPadding, getChild, getChildren, getContentHeight, getContentTarget, getContentWidth, getLeftPadding, getRightPadding, getTopPadding, hasDragToReorder, iterator, newHorizontalContainer, newHorizontalContainer, newHorizontalContainer, newVerticalContainer, newVerticalContainer, newVerticalContainer, onDraw, onKeyPressed, onReflow, reflow, removeAllChildren, removeAllChildren, setArrowKeyFocus, setChildMargin, setChildSpacing, setChildSpacing, setContentHeight, setContentTarget, setContentWidth, setDragToReorder, setLayout, setLayout, setMinHeight, setMinWidth, setPadding, setPadding, setPadding

Methods inherited from class heronarts.glx.ui.UI2dComponent

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

Methods inherited from class heronarts.glx.ui.UIObject

addListener, addListener, addLoopTask, blur, bringToFront, focus, getDescription, getFocusedChild, getLX, getUI, hasDirectFocus, hasFocus, isVisible, loop, onBlur, onFocus, onUIResize, removeLoopTask, requireUIThread, setConsumeMousePress, setDebugId, toggleVisible, toString

Methods inherited from class heronarts.glx.ui.UIEventHandler

onKeyReleased, onMouseMoved, onMouseOut, onMouseOver, onMousePressed, onMouseReleased

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Constructor Details

UI2dScrollContext

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

Method Details

setMaxWidth

public UI2dScrollContext setMaxWidth(float maxWidth)

Sets a maximum width 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:

maxWidth - Maximum width before scrolling kicks in

Returns:

this

setMaxWidth

public UI2dScrollContext setMaxWidth(float maxWidth,
 boolean reflow)

Sets a maximum width 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:

maxWidth - Maximum width before scrolling kicks in

reflow - Reflow on this call

Returns:

this

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

setMaxHeight

public UI2dScrollContext setMaxHeight(float maxHeight,
 boolean reflow)

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

reflow - Reflow on this call

Returns:

this

setContentSize

public UI2dContainer setContentSize(float w,
 float h)

Overrides:

setContentSize in class UI2dContainer

setScrollSize

public UI2dScrollContext setScrollSize(float scrollWidth,
 float scrollHeight)

Sets the size of the scrolled content, which could potentially be larger than the actual size of this element itself

Specified by:

setScrollSize in interface UI2dScrollInterface

Parameters:

scrollWidth - Width of scrollable virtual pane

scrollHeight - Height of scrollable virtual pane

Returns:

getScrollHeight

public float getScrollHeight()

Description copied from class: UI2dContainer

Returns the height of scrolling content. By default this is the same as the height of the container itself, but if the container scrolls then the scroll height may be a larger value.

Specified by:

getScrollHeight in interface UI2dScrollInterface

Overrides:

getScrollHeight in class UI2dContainer

Returns:

Height of scrollable content

setScrollHeight

public UI2dScrollContext setScrollHeight(float scrollHeight)

Specified by:

setScrollHeight in interface UI2dScrollInterface

getScrollWidth

public float getScrollWidth()

Description copied from class: UI2dContainer

Returns the width of scrolling content. By default this is the same as the width of the container itself, but if the container scrolls then the scroll width may be a larger value.

Specified by:

getScrollWidth in interface UI2dScrollInterface

Overrides:

getScrollWidth in class UI2dContainer

Returns:

Width of scrollable content

setScrollWidth

public UI2dScrollContext setScrollWidth(float scrollWidth)

Specified by:

setScrollWidth in interface UI2dScrollInterface

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()

Specified by:

getScrollX in interface UI2dScrollInterface

getScrollY

public float getScrollY()

Specified by:

getScrollY in interface UI2dScrollInterface

onScrollChange

protected void onScrollChange()

setScrollX

public UI2dScrollContext setScrollX(float scrollX)

Specified by:

setScrollX in interface UI2dScrollInterface

setScrollY

public UI2dScrollContext setScrollY(float scrollY)

Specified by:

setScrollY in interface UI2dScrollInterface

onMouseDragged

protected void onMouseDragged(MouseEvent mouseEvent,
 float mx,
 float my,
 float dx,
 float dy)

Description copied from class: UIEventHandler

Subclasses override to receive mouse events

Overrides:

onMouseDragged in class UIEventHandler

Parameters:

mouseEvent - Mouse event

mx - x-coordinate

my - y-coordinate

dx - movement in x

dy - movement in y

onMouseScroll

protected void onMouseScroll(MouseEvent mouseEvent,
 float mx,
 float my,
 float dx,
 float dy)

Description copied from class: UIEventHandler

Subclasses override to receive mouse events

Overrides:

onMouseScroll in class UIEventHandler

Parameters:

mouseEvent - Mouse event

mx - x-coordinate

my - y-coordinate

dx - Amount of horizontal scroll

dy - Amount of vertical scroll