Class ScrollContainerComponent

java.lang.Object

com.render.api.gui.GuiComponent<ContainerComponent>

com.render.api.gui.ContainerComponent

com.render.api.gui.ScrollContainerComponent

public final class ScrollContainerComponent
extends ContainerComponent

Retained two-axis scrolling container with independent overflow, overscroll, scrollbar, and snap policies.

Constructor Summary

Constructors

Constructor	Description
ScrollContainerComponent()

Method Summary

Modifier and Type	Method	Description
ScrollContainerComponent	animatedBorder(GuiAnimatedBorder animatedBorder)	Sets the animated border effect.
ScrollContainerComponent	animation(String name, GuiKeyframes keyframes)
ScrollContainerComponent	autoHeight()
ScrollContainerComponent	autoSize()
ScrollContainerComponent	autoWidth()
ScrollContainerComponent	backgroundColor(int argb)	Deprecated. Use backgroundColor(RenderColor).
ScrollContainerComponent	backgroundColor(RenderColor color)	Sets the background color in ARGB format.
ScrollContainerComponent	borderColor(int argb)	Deprecated. Use borderColor(RenderColor).
ScrollContainerComponent	borderColor(RenderColor color)	Sets the border color in ARGB format.
ScrollContainerComponent	borderWidth(float borderWidth)	Sets the border width in design-space pixels.
ScrollContainerComponent	cancel(String name)
protected com.render.api.gui.GuiBox	childLayoutViewport()	Returns the box used to arrange descendants.
protected float	childOffsetX()
protected float	childOffsetY()
protected boolean	clipsChildren()
protected boolean	containsChildClipPoint(float mouseX, float mouseY)
ScrollContainerComponent	cornerRadius(float cornerRadius)	Sets the border corner radius in design-space pixels.
ScrollContainerComponent	disabled(Consumer<ContainerComponent> consumer)
ScrollContainerComponent	focused(Consumer<ContainerComponent> consumer)
ScrollContainerComponent	gap(float gap)	Sets the spacing between flowed children in design-space pixels.
ScrollContainerComponent	glow(GuiGlow glow)	Sets the component glow effect.
ScrollContainerComponent	gradient(GuiGradient gradient)	Sets the background gradient.
protected boolean	handlesMouseClick(float mouseX, float mouseY, int button)
protected boolean	handlesMouseScroll(float mouseX, float mouseY)
ScrollContainerComponent	height(GuiLength height)	Sets a typed modern height.
ScrollContainerComponent	horizontalScrollIndicator(GuiScrollIndicator scrollIndicator)
ScrollContainerComponent	horizontalScrollStep(float scrollStep)
ScrollContainerComponent	hovered(Consumer<ContainerComponent> consumer)
protected boolean	isFocusable()
ScrollContainerComponent	layout(ContainerLayout childLayout)	Sets the layout mode used for child placement.
protected void	layoutChildren(com.render.api.gui.GuiRenderContext context)
float	maxScrollOffset()	Returns the maximum vertical scroll offset in design-space pixels.
float	maxScrollOffsetX()
protected boolean	onKeyPressed(com.render.api.gui.GuiRenderContext context, int keyCode, int scanCode, int modifiers)
protected void	onModernLayoutComplete()	Invoked after this component's descendants have been arranged by the modern layout engine.
protected boolean	onMouseClicked(com.render.api.gui.GuiRenderContext context, float mouseX, float mouseY, int button)
protected boolean	onMouseDragged(com.render.api.gui.GuiRenderContext context, float mouseX, float mouseY, int button, double dragX, double dragY)
protected boolean	onMouseReleased(com.render.api.gui.GuiRenderContext context, float mouseX, float mouseY, int button)
protected boolean	onMouseScrolled(com.render.api.gui.GuiRenderContext context, float mouseX, float mouseY, double horizontalAmount, double verticalAmount)
ScrollContainerComponent	overflow(GuiOverflowMode x, GuiOverflowMode y)	Sets independent horizontal and vertical overflow behavior.
GuiOverflowMode	overflowX()
ScrollContainerComponent	overflowX(GuiOverflowMode mode)
GuiOverflowMode	overflowY()
ScrollContainerComponent	overflowY(GuiOverflowMode mode)
ScrollContainerComponent	overscrollBehavior(GuiOverscrollBehavior x, GuiOverscrollBehavior y)	Controls whether unconsumed scrolling may chain to an ancestor.
ScrollContainerComponent	padding(float all)	Sets uniform inner padding in design-space pixels.
ScrollContainerComponent	padding(float vertical, float horizontal)	Sets symmetric inner padding in design-space pixels.
ScrollContainerComponent	padding(float top, float right, float bottom, float left)	Sets per-side inner padding in design-space pixels.
ScrollContainerComponent	pageMovementFactor(float factor)	Sets the fraction of a viewport moved by Page Up or Page Down.
ScrollContainerComponent	pause(String name)
ScrollContainerComponent	play(String name)
ScrollContainerComponent	position(float x, float y)	Sets the component position in design-space pixels.
ScrollContainerComponent	pressed(Consumer<ContainerComponent> consumer)
protected void	renderClippedChildren(com.render.api.gui.GuiRenderContext context)	Paints descendants through this component's overflow clip.
protected void	renderOverlay(com.render.api.gui.GuiRenderContext context)
protected void	resolveBaseProperties(com.render.api.gui.GuiPropertyValues properties)
ScrollContainerComponent	resume(String name)
ScrollContainerComponent	scrollAnchor(GuiComponent<?> child)	Keeps an explicitly selected direct child visually stable when content before it changes size.
GuiScrollbarGutter	scrollbarGutter()	Returns the gutter policy.
ScrollContainerComponent	scrollbarGutter(GuiScrollbarGutter gutter)	Selects persistent scrollbar layout-space reservation.
ScrollContainerComponent	scrollBehavior(GuiScrollBehavior behavior)	Selects immediate or retained smooth movement for wheel, keyboard, snap, and programmatic scrollTo(float, float) requests.
ScrollContainerComponent	scrollBy(float x, float y)	Requests movement relative to the current retained target.
ScrollContainerComponent	scrollIndicator(GuiScrollIndicator scrollIndicator)	Sets the scrollbar style.
GuiScrollMarkerGroup	scrollMarkerGroup()	Returns a detached marker-group configuration.
ScrollContainerComponent	scrollMarkerGroup(GuiScrollMarkerGroup group)	Enables retained marker navigation for registered snap children.
Map<GuiComponent<?>, Long>	scrollMarkerIdentities()	Returns stable marker identities keyed by their retained snap target.
float	scrollOffset()	Returns the current vertical scroll offset in design-space pixels.
ScrollContainerComponent	scrollOffset(float scrollOffset)	Sets the target vertical scroll offset in design-space pixels.
float	scrollOffsetX()
ScrollContainerComponent	scrollOffsetX(float scrollOffset)
ScrollContainerComponent	scrollPadding(float all)
ScrollContainerComponent	scrollPadding(GuiScrollInsets insets)	Insets the effective snap viewport without changing laid-out content.
ScrollContainerComponent	scrollPosition(float x, float y)
ScrollContainerComponent	scrollSnapType(GuiScrollSnapType value)
ScrollContainerComponent	scrollStartTarget(GuiComponent<?> child, GuiScrollSnapAlign x, GuiScrollSnapAlign y)	Selects a direct child that is aligned once after the first usable layout.
ScrollContainerComponent	scrollStep(float scrollStep)	Sets the amount of scroll applied per mouse-wheel step.
ScrollContainerComponent	scrollTo(float x, float y)	Requests a position using the configured scroll behavior.
ScrollContainerComponent	scrollTo(float x, float y, GuiScrollBehavior behavior)	Requests a position with an explicit behavior.
ScrollContainerComponent	scrollToChild(GuiComponent<?> child, GuiScrollSnapAlign x, GuiScrollSnapAlign y)	Aligns a direct child within the effective snap viewport.
ScrollContainerComponent	shadow(GuiShadow shadow)	Sets the component shadow effect.
protected boolean	shouldRouteToChildren(float mouseX, float mouseY)
ScrollContainerComponent	showHorizontalScrollIndicator(boolean enabled)
ScrollContainerComponent	showScrollIndicator(boolean enabled)	Enables or disables the scrollbar, creating a default one if needed.
ScrollContainerComponent	size(float width, float height)	Sets the component size in design-space pixels.
ScrollContainerComponent	size(GuiLength width, GuiLength height)
ScrollContainerComponent	smoothScroll(double durationSeconds, GuiEasing easing)	Configures retained smooth-scroll timing.
double	smoothScrollDurationSeconds()	Returns the configured smooth-scroll duration.
GuiEasing	smoothScrollEasing()	Returns the configured smooth-scroll easing.
ScrollContainerComponent	snapChild(GuiComponent<?> child, GuiScrollSnapAlign x, GuiScrollSnapAlign y)	Registers one direct child as a snap target on either axis.
ScrollContainerComponent	snapToNearest()	Moves enabled axes to their nearest registered snap target.
protected void	tick()
ScrollContainerComponent	transition(double durationSeconds, double delaySeconds, GuiEasing easing, GuiProperty<?>... properties)
ScrollContainerComponent	transition(double durationSeconds, double delaySeconds, GuiEasing easing, GuiPropertyGroup... groups)
ScrollContainerComponent	transition(double durationSeconds, GuiEasing easing, GuiProperty<?>... properties)
ScrollContainerComponent	transition(double durationSeconds, GuiEasing easing, GuiPropertyGroup... groups)
ScrollContainerComponent	transitionAll(double durationSeconds, double delaySeconds, GuiEasing easing)
ScrollContainerComponent	transitionAll(double durationSeconds, GuiEasing easing)
ScrollContainerComponent	translate(float translateX, float translateY)
ScrollContainerComponent	translateX(float translateX)
ScrollContainerComponent	translateY(float translateY)
ScrollContainerComponent	width(GuiLength width)	Sets a typed modern width.

Methods inherited from class ContainerComponent

childLayout, flowColumn, flowRow, preferredHeight, preferredWidth, renderSelf, stack

Methods inherited from class GuiComponent

activeStateStyle, add, alignContent, alignItems, alignSelf, anchor, anchorName, anchorPlacement, applyStyle, aspectRatio, backdropFilters, backfaceVisibility, backgroundLayer, backgroundLayers, backgroundLayers, border, borderCollapse, borderSpacing, boxDecorationBreak, boxGlow, boxShadow, boxShadows, boxShadows, boxSizing, breakAfter, breakBefore, breakInside, captionSide, caretStyle, centered, childGap, children, clearChildren, clipChildren, clipPath, color, color, columnCount, columnFill, columnGap, columnRule, columnSpan, columnWidth, computedStyle, contextMenu, defaultDisplay, dirtyCategories, display, emptyCells, enabled, enabled, filters, findById, findById, flexBasis, flexDirection, flexGrow, flexShrink, flexWrap, focused, fragmentTree, gridAutoFlow, gridPlacement, gridTemplate, height, height, id, id, indeterminate, indeterminate, inlineStyle, inset, inset, intrinsicSize, invalidateModernLayout, isClippingChildren, justifyContent, justifyItems, justifySelf, lastInvalidationReason, layoutFragments, listStyleImage, listStylePosition, listStyleType, margin, margin, margin, marginBreak, markerGap, markerSide, maskLayers, maskLayers, matchesStyleState, maxHeight, maxWidth, minHeight, minWidth, motionPath, onCharTyped, onFocusChanged, opacity, order, orphans, outline, pageName, paint, parent, position, preferredHeightForWidth, pseudoElementBox, pseudoElementStyle, quotes, rangeState, rangeState, readOnly, readOnly, remove, removeStyleClass, renderChildren, requestFocus, required, required, rowGap, scrollMargin, scrollMargin, scrollSnapStop, self, startingStyle, stateProvider, styleAttribute, styleAttribute, styleClass, styleClasses, styledPseudoElements, styleOpen, styleState, styleState, tabIndex, tabIndex, tableLayout, tooltip, transform, transformBox, transformOrigin, transformStyle, transition, transition, transitionAll, validity, validity, verticalAlign, viewTransitionName, viewTransitionName, visible, visible, widows, width, width, writeModernInline, writeTextShadow, writingState, x, x, y, y, zIndex

Methods inherited from class Object

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

Constructor Details

ScrollContainerComponent

public ScrollContainerComponent()

Method Details

scrollStep

public ScrollContainerComponent scrollStep(float scrollStep)

Sets the amount of scroll applied per mouse-wheel step.

Parameters:

scrollStep - scroll amount in design-space pixels

Returns:

this component

horizontalScrollStep

public ScrollContainerComponent horizontalScrollStep(float scrollStep)

scrollBehavior

public ScrollContainerComponent scrollBehavior(GuiScrollBehavior behavior)

Selects immediate or retained smooth movement for wheel, keyboard, snap, and programmatic scrollTo(float, float) requests.

Parameters:

behavior - scrolling behavior

Returns:

this component

smoothScroll

public ScrollContainerComponent smoothScroll(double durationSeconds,
 GuiEasing easing)

Configures retained smooth-scroll timing.

Parameters:

durationSeconds - positive duration

easing - progress easing

Returns:

this component

smoothScrollDurationSeconds

public double smoothScrollDurationSeconds()

Returns the configured smooth-scroll duration.

Returns:

duration in seconds

smoothScrollEasing

public GuiEasing smoothScrollEasing()

Returns the configured smooth-scroll easing.

Returns:

easing function

pageMovementFactor

public ScrollContainerComponent pageMovementFactor(float factor)

Sets the fraction of a viewport moved by Page Up or Page Down.

Parameters:

factor - fraction in the range 0..1

Returns:

this component

scrollPadding

public ScrollContainerComponent scrollPadding(GuiScrollInsets insets)

Insets the effective snap viewport without changing laid-out content.

Parameters:

insets - snap viewport insets

Returns:

this component

scrollPadding

public ScrollContainerComponent scrollPadding(float all)

scrollbarGutter

public ScrollContainerComponent scrollbarGutter(GuiScrollbarGutter gutter)

Selects persistent scrollbar layout-space reservation.

Parameters:

gutter - gutter policy

Returns:

this component

scrollbarGutter

public GuiScrollbarGutter scrollbarGutter()

Returns the gutter policy.

Returns:

gutter policy

scrollMarkerGroup

public ScrollContainerComponent scrollMarkerGroup(GuiScrollMarkerGroup group)

Enables retained marker navigation for registered snap children.

Parameters:

group - marker group, or null to disable it

Returns:

this component

scrollMarkerGroup

public GuiScrollMarkerGroup scrollMarkerGroup()

Returns a detached marker-group configuration.

Returns:

marker group, or null

scrollMarkerIdentities

public Map<GuiComponent<?>, Long> scrollMarkerIdentities()

Returns stable marker identities keyed by their retained snap target.

Returns:

immutable target-to-identity map

overflow

public ScrollContainerComponent overflow(GuiOverflowMode x,
 GuiOverflowMode y)

Sets independent horizontal and vertical overflow behavior.

Parameters:

x - horizontal overflow behavior

y - vertical overflow behavior

Returns:

this component

overflowX

public ScrollContainerComponent overflowX(GuiOverflowMode mode)

overflowY

public ScrollContainerComponent overflowY(GuiOverflowMode mode)

overflowX

public GuiOverflowMode overflowX()

overflowY

public GuiOverflowMode overflowY()

overscrollBehavior

public ScrollContainerComponent overscrollBehavior(GuiOverscrollBehavior x,
 GuiOverscrollBehavior y)

Controls whether unconsumed scrolling may chain to an ancestor.

Parameters:

x - horizontal boundary behavior

y - vertical boundary behavior

Returns:

this component

scrollSnapType

public ScrollContainerComponent scrollSnapType(GuiScrollSnapType value)

snapChild

public ScrollContainerComponent snapChild(GuiComponent<?> child,
 GuiScrollSnapAlign x,
 GuiScrollSnapAlign y)

Registers one direct child as a snap target on either axis.

Parameters:

child - direct child target

x - horizontal alignment

y - vertical alignment

Returns:

this component

scrollStartTarget

public ScrollContainerComponent scrollStartTarget(GuiComponent<?> child,
 GuiScrollSnapAlign x,
 GuiScrollSnapAlign y)

Selects a direct child that is aligned once after the first usable layout.

Parameters:

child - direct child target

x - horizontal alignment

y - vertical alignment

Returns:

this component

scrollAnchor

public ScrollContainerComponent scrollAnchor(GuiComponent<?> child)

Keeps an explicitly selected direct child visually stable when content before it changes size.

Parameters:

child - anchor child, or null to disable anchoring

Returns:

this component

layout

public ScrollContainerComponent layout(ContainerLayout childLayout)

Sets the layout mode used for child placement.

Overrides:

layout in class ContainerComponent

Parameters:

childLayout - child layout mode

Returns:

this component

gap

public ScrollContainerComponent gap(float gap)

Sets the spacing between flowed children in design-space pixels.

Overrides:

gap in class ContainerComponent

Parameters:

gap - child gap

Returns:

this component

position

public ScrollContainerComponent position(float x,
 float y)

Sets the component position in design-space pixels.

Overrides:

position in class GuiComponent<ContainerComponent>

Parameters:

x - x position

y - y position

Returns:

this component

translateX

public ScrollContainerComponent translateX(float translateX)

Overrides:

translateX in class GuiComponent<ContainerComponent>

translateY

public ScrollContainerComponent translateY(float translateY)

Overrides:

translateY in class GuiComponent<ContainerComponent>

translate

public ScrollContainerComponent translate(float translateX,
 float translateY)

Overrides:

translate in class GuiComponent<ContainerComponent>

size

public ScrollContainerComponent size(float width,
 float height)

Sets the component size in design-space pixels.

Overrides:

size in class GuiComponent<ContainerComponent>

Parameters:

width - component width

height - component height

Returns:

this component

autoWidth

public ScrollContainerComponent autoWidth()

Overrides:

autoWidth in class GuiComponent<ContainerComponent>

autoHeight

public ScrollContainerComponent autoHeight()

Overrides:

autoHeight in class GuiComponent<ContainerComponent>

autoSize

public ScrollContainerComponent autoSize()

Overrides:

autoSize in class GuiComponent<ContainerComponent>

padding

public ScrollContainerComponent padding(float all)

Sets uniform inner padding in design-space pixels.

Overrides:

padding in class GuiComponent<ContainerComponent>

Parameters:

all - padding for every side

Returns:

this component

padding

public ScrollContainerComponent padding(float vertical,
 float horizontal)

Sets symmetric inner padding in design-space pixels.

Overrides:

padding in class GuiComponent<ContainerComponent>

Parameters:

vertical - top and bottom padding

horizontal - left and right padding

Returns:

this component

padding

public ScrollContainerComponent padding(float top,
 float right,
 float bottom,
 float left)

Sets per-side inner padding in design-space pixels.

Overrides:

padding in class GuiComponent<ContainerComponent>

Parameters:

top - top padding

right - right padding

bottom - bottom padding

left - left padding

Returns:

this component

backgroundColor

public ScrollContainerComponent backgroundColor(RenderColor color)

Sets the background color in ARGB format.

Overrides:

backgroundColor in class GuiComponent<ContainerComponent>

Parameters:

color - background color

Returns:

this component

width

public ScrollContainerComponent width(GuiLength width)

Description copied from class: GuiComponent

Sets a typed modern width. This declaration is used only by a modern host.

Overrides:

width in class GuiComponent<ContainerComponent>

Parameters:

width - typed width

Returns:

this component

height

public ScrollContainerComponent height(GuiLength height)

Description copied from class: GuiComponent

Sets a typed modern height.

Overrides:

height in class GuiComponent<ContainerComponent>

Parameters:

height - typed height

Returns:

this component

size

public ScrollContainerComponent size(GuiLength width,
 GuiLength height)

Overrides:

size in class GuiComponent<ContainerComponent>

backgroundColor

@Deprecated(forRemoval=false)
public ScrollContainerComponent backgroundColor(int argb)

Deprecated.

Use backgroundColor(RenderColor).

Overrides:

backgroundColor in class GuiComponent<ContainerComponent>

shadow

public ScrollContainerComponent shadow(GuiShadow shadow)

Sets the component shadow effect.

Overrides:

shadow in class GuiComponent<ContainerComponent>

Parameters:

shadow - shadow configuration, or null to clear it

Returns:

this component

glow

public ScrollContainerComponent glow(GuiGlow glow)

Sets the component glow effect.

Overrides:

glow in class GuiComponent<ContainerComponent>

Parameters:

glow - glow configuration, or null to clear it

Returns:

this component

gradient

public ScrollContainerComponent gradient(GuiGradient gradient)

Sets the background gradient.

Overrides:

gradient in class GuiComponent<ContainerComponent>

Parameters:

gradient - gradient configuration, or null to clear it

Returns:

this component

animatedBorder

public ScrollContainerComponent animatedBorder(GuiAnimatedBorder animatedBorder)

Sets the animated border effect.

Overrides:

animatedBorder in class GuiComponent<ContainerComponent>

Parameters:

animatedBorder - animated border configuration, or null to clear it

Returns:

this component

transitionAll

public ScrollContainerComponent transitionAll(double durationSeconds,
 GuiEasing easing)

Overrides:

transitionAll in class GuiComponent<ContainerComponent>

transitionAll

public ScrollContainerComponent transitionAll(double durationSeconds,
 double delaySeconds,
 GuiEasing easing)

Overrides:

transitionAll in class GuiComponent<ContainerComponent>

transition

public ScrollContainerComponent transition(double durationSeconds,
 GuiEasing easing,
 GuiProperty<?>... properties)

Overrides:

transition in class GuiComponent<ContainerComponent>

transition

public ScrollContainerComponent transition(double durationSeconds,
 double delaySeconds,
 GuiEasing easing,
 GuiProperty<?>... properties)

Overrides:

transition in class GuiComponent<ContainerComponent>

transition

public ScrollContainerComponent transition(double durationSeconds,
 GuiEasing easing,
 GuiPropertyGroup... groups)

Overrides:

transition in class GuiComponent<ContainerComponent>

transition

public ScrollContainerComponent transition(double durationSeconds,
 double delaySeconds,
 GuiEasing easing,
 GuiPropertyGroup... groups)

Overrides:

transition in class GuiComponent<ContainerComponent>

hovered

public ScrollContainerComponent hovered(Consumer<ContainerComponent> consumer)

Overrides:

hovered in class GuiComponent<ContainerComponent>

pressed

public ScrollContainerComponent pressed(Consumer<ContainerComponent> consumer)

Overrides:

pressed in class GuiComponent<ContainerComponent>

focused

public ScrollContainerComponent focused(Consumer<ContainerComponent> consumer)

Overrides:

focused in class GuiComponent<ContainerComponent>

disabled

public ScrollContainerComponent disabled(Consumer<ContainerComponent> consumer)

Overrides:

disabled in class GuiComponent<ContainerComponent>

animation

public ScrollContainerComponent animation(String name,
 GuiKeyframes keyframes)

Overrides:

animation in class GuiComponent<ContainerComponent>

play

public ScrollContainerComponent play(String name)

Overrides:

play in class GuiComponent<ContainerComponent>

pause

public ScrollContainerComponent pause(String name)

Overrides:

pause in class GuiComponent<ContainerComponent>

resume

public ScrollContainerComponent resume(String name)

Overrides:

resume in class GuiComponent<ContainerComponent>

cancel

public ScrollContainerComponent cancel(String name)

Overrides:

cancel in class GuiComponent<ContainerComponent>

borderColor

public ScrollContainerComponent borderColor(RenderColor color)

Sets the border color in ARGB format.

Overrides:

borderColor in class GuiComponent<ContainerComponent>

Parameters:

color - border color

Returns:

this component

borderColor

@Deprecated(forRemoval=false)
public ScrollContainerComponent borderColor(int argb)

Deprecated.

Use borderColor(RenderColor).

Overrides:

borderColor in class GuiComponent<ContainerComponent>

borderWidth

public ScrollContainerComponent borderWidth(float borderWidth)

Sets the border width in design-space pixels.

Overrides:

borderWidth in class GuiComponent<ContainerComponent>

Parameters:

borderWidth - border width

Returns:

this component

cornerRadius

public ScrollContainerComponent cornerRadius(float cornerRadius)

Sets the border corner radius in design-space pixels.

Overrides:

cornerRadius in class GuiComponent<ContainerComponent>

Parameters:

cornerRadius - corner radius

Returns:

this component

scrollIndicator

public ScrollContainerComponent scrollIndicator(GuiScrollIndicator scrollIndicator)

Sets the scrollbar style.

Parameters:

scrollIndicator - scrollbar configuration, or null to disable it

Returns:

this component

horizontalScrollIndicator

public ScrollContainerComponent horizontalScrollIndicator(GuiScrollIndicator scrollIndicator)

showScrollIndicator

public ScrollContainerComponent showScrollIndicator(boolean enabled)

Enables or disables the scrollbar, creating a default one if needed.

Parameters:

enabled - true to render the scrollbar when scrolling is possible

Returns:

this component

showHorizontalScrollIndicator

public ScrollContainerComponent showHorizontalScrollIndicator(boolean enabled)

scrollOffset

public float scrollOffset()

Returns the current vertical scroll offset in design-space pixels.

Returns:

current scroll offset

scrollOffsetX

public float scrollOffsetX()

scrollOffset

public ScrollContainerComponent scrollOffset(float scrollOffset)

Sets the target vertical scroll offset in design-space pixels.

Parameters:

scrollOffset - scroll offset

Returns:

this component

scrollOffsetX

public ScrollContainerComponent scrollOffsetX(float scrollOffset)

scrollPosition

public ScrollContainerComponent scrollPosition(float x,
 float y)

scrollTo

public ScrollContainerComponent scrollTo(float x,
 float y)

Requests a position using the configured scroll behavior.

Parameters:

x - horizontal offset

y - vertical offset

Returns:

this component

scrollTo

public ScrollContainerComponent scrollTo(float x,
 float y,
 GuiScrollBehavior behavior)

Requests a position with an explicit behavior.

Parameters:

x - horizontal offset

y - vertical offset

behavior - movement behavior

Returns:

this component

scrollBy

public ScrollContainerComponent scrollBy(float x,
 float y)

Requests movement relative to the current retained target.

Parameters:

x - horizontal delta

y - vertical delta

Returns:

this component

scrollToChild

public ScrollContainerComponent scrollToChild(GuiComponent<?> child,
 GuiScrollSnapAlign x,
 GuiScrollSnapAlign y)

Aligns a direct child within the effective snap viewport.

Parameters:

child - direct child

x - horizontal alignment

y - vertical alignment

Returns:

this component

maxScrollOffset

public float maxScrollOffset()

Returns the maximum vertical scroll offset in design-space pixels.

Returns:

maximum scroll offset

maxScrollOffsetX

public float maxScrollOffsetX()

childLayoutViewport

protected com.render.api.gui.GuiBox childLayoutViewport()

Description copied from class: GuiComponent

Returns the box used to arrange descendants. Scroll containers override this to reserve persistent scrollbar gutters.

Overrides:

childLayoutViewport in class GuiComponent<ContainerComponent>

clipsChildren

protected boolean clipsChildren()

Overrides:

clipsChildren in class GuiComponent<ContainerComponent>

renderClippedChildren

protected void renderClippedChildren(com.render.api.gui.GuiRenderContext context)

Description copied from class: GuiComponent

Paints descendants through this component's overflow clip.

Overrides:

renderClippedChildren in class GuiComponent<ContainerComponent>

shouldRouteToChildren

protected boolean shouldRouteToChildren(float mouseX,
 float mouseY)

Overrides:

shouldRouteToChildren in class GuiComponent<ContainerComponent>

containsChildClipPoint

protected boolean containsChildClipPoint(float mouseX,
 float mouseY)

Overrides:

containsChildClipPoint in class GuiComponent<ContainerComponent>

childOffsetX

protected float childOffsetX()

Overrides:

childOffsetX in class GuiComponent<ContainerComponent>

childOffsetY

protected float childOffsetY()

Overrides:

childOffsetY in class GuiComponent<ContainerComponent>

resolveBaseProperties

protected void resolveBaseProperties(com.render.api.gui.GuiPropertyValues properties)

Overrides:

resolveBaseProperties in class ContainerComponent

layoutChildren

protected void layoutChildren(com.render.api.gui.GuiRenderContext context)

Overrides:

layoutChildren in class GuiComponent<ContainerComponent>

onModernLayoutComplete

protected void onModernLayoutComplete()

Description copied from class: GuiComponent

Invoked after this component's descendants have been arranged by the modern layout engine.

Overrides:

onModernLayoutComplete in class GuiComponent<ContainerComponent>

handlesMouseScroll

protected boolean handlesMouseScroll(float mouseX,
 float mouseY)

Overrides:

handlesMouseScroll in class GuiComponent<ContainerComponent>

onMouseScrolled

protected boolean onMouseScrolled(com.render.api.gui.GuiRenderContext context,
 float mouseX,
 float mouseY,
 double horizontalAmount,
 double verticalAmount)

Overrides:

onMouseScrolled in class GuiComponent<ContainerComponent>

isFocusable

protected boolean isFocusable()

Overrides:

isFocusable in class GuiComponent<ContainerComponent>

onKeyPressed

protected boolean onKeyPressed(com.render.api.gui.GuiRenderContext context,
 int keyCode,
 int scanCode,
 int modifiers)

Overrides:

onKeyPressed in class GuiComponent<ContainerComponent>

tick

protected void tick()

Overrides:

tick in class GuiComponent<ContainerComponent>

handlesMouseClick

protected boolean handlesMouseClick(float mouseX,
 float mouseY,
 int button)

Overrides:

handlesMouseClick in class GuiComponent<ContainerComponent>

onMouseClicked

protected boolean onMouseClicked(com.render.api.gui.GuiRenderContext context,
 float mouseX,
 float mouseY,
 int button)

Overrides:

onMouseClicked in class GuiComponent<ContainerComponent>

onMouseDragged

protected boolean onMouseDragged(com.render.api.gui.GuiRenderContext context,
 float mouseX,
 float mouseY,
 int button,
 double dragX,
 double dragY)

Overrides:

onMouseDragged in class GuiComponent<ContainerComponent>

onMouseReleased

protected boolean onMouseReleased(com.render.api.gui.GuiRenderContext context,
 float mouseX,
 float mouseY,
 int button)

Overrides:

onMouseReleased in class GuiComponent<ContainerComponent>

renderOverlay

protected void renderOverlay(com.render.api.gui.GuiRenderContext context)

Overrides:

renderOverlay in class GuiComponent<ContainerComponent>

snapToNearest

public ScrollContainerComponent snapToNearest()

Moves enabled axes to their nearest registered snap target.

Returns:

this component