Package heronarts.glx.ui

Class UI2dScrollPane

java.lang.Object

heronarts.glx.ui.UIEventHandler

heronarts.glx.ui.UIObject

heronarts.glx.ui.UI2dComponent

heronarts.glx.ui.UI2dContainer

heronarts.glx.ui.UI2dScrollPane

All Implemented Interfaces:

UIContainer, LXLoopTask, Iterable<UIObject>

Direct Known Subclasses:

UIPerformancePane

public class UI2dScrollPane
extends UI2dContainer

A wrapper container to place a scrollable pane with an inset and an optional scroll bar drawn in the margin between the outer bounds and the inset.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static enum	UI2dScrollPane.HorizontalScrollBarPosition
static class	UI2dScrollPane.ScrollBar
static enum	UI2dScrollPane.VerticalScrollBarPosition

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

Modifier and Type	Field	Description
static final int	DEFAULT_BORDER_ROUNDING
static final int	DEFAULT_INSET
static final int	DEFAULT_PADDING
final UI2dScrollContainer	scrollContent

Fields inherited from class heronarts.glx.ui.UI2dContainer

bottomPadding, childSpacingX, childSpacingY, leftPadding, rightPadding, topPadding

Fields inherited from class heronarts.glx.ui.UI2dComponent

borderRoundingBottomLeft, borderRoundingBottomRight, borderRoundingTopLeft, borderRoundingTopRight, debug, debugName, hasBorderRounding, 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
UI2dScrollPane(UI ui, float x, float y, float w, float h)

Method Summary

Modifier and Type	Method	Description
protected void	drawBackground(UI ui, VGraphics vg)
protected void	drawBorder(UI ui, VGraphics vg)
float	getScrollX()
float	getScrollY()
protected void	onResize()	Subclasses may override this method, invoked when the component is resized
UI2dScrollPane	setContentBackgroundColor(UIColor color)
UI2dScrollPane	setContentInset(float inset)
UI2dScrollPane	setContentInset(float insetY, float insetX)
UI2dScrollPane	setContentInset(float insetTop, float insetRight, float insetBottom, float insetLeft)
UI2dScrollPane	setContentInsetBottom(float insetBottom)
UI2dScrollPane	setContentInsetLeft(float insetLeft)
UI2dScrollPane	setContentInsetRight(float insetTop)
UI2dScrollPane	setContentInsetTop(float insetTop)
UI2dScrollPane	setHorizontalScrollBarPosition(UI2dScrollPane.HorizontalScrollBarPosition horizontalScrollBarPosition)
UI2dScrollPane	setPadding(float padding)
UI2dScrollPane	setPadding(float paddingY, float paddingX)
UI2dScrollPane	setPadding(float paddingTop, float paddingRight, float paddingBottom, float paddingLeft)
UI2dScrollPane	setPaddingBottom(float paddingBottom)
UI2dScrollPane	setPaddingLeft(float paddingLeft)
UI2dScrollPane	setPaddingRight(float paddingRight)
UI2dScrollPane	setPaddingTop(float paddingTop)
UI2dScrollPane	setScrollX(float scrollX)
UI2dScrollPane	setScrollY(float scrollY)
UI2dScrollPane	setVerticalScrollBarPosition(UI2dScrollPane.VerticalScrollBarPosition verticalScrollBarPosition)

Methods inherited from class heronarts.glx.ui.UI2dContainer

addChildren, addTopLevelComponent, getBottomPadding, getChild, getChildren, getChildSpacingX, getChildSpacingY, getContentHeight, getContentTarget, getContentWidth, getLeftPadding, getRightPadding, getScrollHeight, getScrollWidth, getTopPadding, hasDragToReorder, isEmpty, iterator, newHorizontalContainer, newHorizontalContainer, newHorizontalContainer, newVerticalContainer, newVerticalContainer, newVerticalContainer, onDraw, onKeyPressed, onReflow, reflow, removeAllChildren, removeAllChildren, setArrowKeyFocus, setChildMargin, setChildSpacing, setChildSpacing, setChildSpacingX, setChildSpacingY, setContentHeight, setContentSize, setContentTarget, setContentWidth, setDragToReorder, setLayout, setLayout, setMinHeight, setMinWidth

Methods inherited from class heronarts.glx.ui.UI2dComponent

addAfterSibling, addBeforeSibling, addToContainer, addToContainer, addToContainer, addToContainer, addToContainer, addToContainer, addToContainer, addToContainer, assertValidContainer, clipTextToWidth, clipTextToWidth, contains, dbch, drawComponentBackground, drawFocus, drawFocusCorners, drawFocusCorners, drawParentBackground, getAbsoluteX, getAbsoluteY, getBackgroundColor, getBorderColor, getBorderWeight, getBottomMargin, getContainer, getDebugClassHierarchy, getDebugClassHierarchy, getFocusColor, getFocusSize, getFont, getFontColor, getHeight, getLeftMargin, getMappableParameter, getNextSibling, getNextSibling, getParent, getPrevSibling, getPrevSibling, getRightMargin, getTopMargin, 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, addLoopTask, blur, bringToFront, dispose, focus, getDescription, getFocusedChild, getLX, getUI, hasDirectFocus, hasFocus, isVisible, isVisible, loop, onBlur, onFocus, onUIResize, removeLoopTask, requireUIThread, setConsumeMousePress, setDebugId, setMouseCursor, toggleVisible, toString

Methods inherited from class heronarts.glx.ui.UIEventHandler

onGamepadAxisChanged, onGamepadButtonPressed, onGamepadButtonReleased, onKeyReleased, onMouseDragged, onMouseMoved, onMouseOut, onMouseOver, onMousePressed, onMouseReleased, onMouseScroll

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

Field Details

DEFAULT_INSET

public static final int DEFAULT_INSET

See Also:

• Constant Field Values

DEFAULT_PADDING

public static final int DEFAULT_PADDING

See Also:

• Constant Field Values

DEFAULT_BORDER_ROUNDING

public static final int DEFAULT_BORDER_ROUNDING

See Also:

• Constant Field Values

scrollContent

public final UI2dScrollContainer scrollContent

Constructor Details

UI2dScrollPane

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

Method Details

onResize

protected void onResize()

Description copied from class: UI2dComponent

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

Overrides:

onResize in class UI2dComponent

setContentBackgroundColor

public UI2dScrollPane setContentBackgroundColor(UIColor color)

setContentInset

public UI2dScrollPane setContentInset(float inset)

setContentInset

public UI2dScrollPane setContentInset(float insetY,
 float insetX)

setContentInset

public UI2dScrollPane setContentInset(float insetTop,
 float insetRight,
 float insetBottom,
 float insetLeft)

setContentInsetTop

public UI2dScrollPane setContentInsetTop(float insetTop)

setContentInsetRight

public UI2dScrollPane setContentInsetRight(float insetTop)

setContentInsetBottom

public UI2dScrollPane setContentInsetBottom(float insetBottom)

setContentInsetLeft

public UI2dScrollPane setContentInsetLeft(float insetLeft)

setPadding

public UI2dScrollPane setPadding(float padding)

Overrides:

setPadding in class UI2dContainer

setPadding

public UI2dScrollPane setPadding(float paddingY,
 float paddingX)

Overrides:

setPadding in class UI2dContainer

setPaddingTop

public UI2dScrollPane setPaddingTop(float paddingTop)

setPaddingRight

public UI2dScrollPane setPaddingRight(float paddingRight)

setPaddingBottom

public UI2dScrollPane setPaddingBottom(float paddingBottom)

setPaddingLeft

public UI2dScrollPane setPaddingLeft(float paddingLeft)

setPadding

public UI2dScrollPane setPadding(float paddingTop,
 float paddingRight,
 float paddingBottom,
 float paddingLeft)

Overrides:

setPadding in class UI2dContainer

getScrollX

public float getScrollX()

getScrollY

public float getScrollY()

setScrollX

public UI2dScrollPane setScrollX(float scrollX)

setScrollY

public UI2dScrollPane setScrollY(float scrollY)

setVerticalScrollBarPosition

public UI2dScrollPane setVerticalScrollBarPosition(UI2dScrollPane.VerticalScrollBarPosition verticalScrollBarPosition)

setHorizontalScrollBarPosition

public UI2dScrollPane setHorizontalScrollBarPosition(UI2dScrollPane.HorizontalScrollBarPosition horizontalScrollBarPosition)

drawBackground

protected void drawBackground(UI ui,
 VGraphics vg)

Overrides:

drawBackground in class UI2dComponent

drawBorder

protected void drawBorder(UI ui,
 VGraphics vg)

Overrides:

drawBorder in class UI2dComponent