Class AbstractScrollArea

java.lang.Object

net.minecraft.client.gui.components.AbstractWidget

net.minecraft.client.gui.components.AbstractScrollArea

All Implemented Interfaces:

GuiEventListener, Renderable, TabOrderedElement, LayoutElement, NarratableEntry, NarrationSupplier

Direct Known Subclasses:

AbstractContainerWidget, AbstractTextAreaWidget

public abstract class AbstractScrollArea
extends AbstractWidget

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final record	AbstractScrollArea.ScrollbarSettings

Nested classes/interfaces inherited from class AbstractWidget

AbstractWidget.WithInactiveMessage

Nested classes/interfaces inherited from interface NarratableEntry

NarratableEntry.NarrationPriority

Field Summary

Fields

Modifier and Type	Field	Description
private double	scrollAmount
private static final int	SCROLLBAR_MIN_HEIGHT
static final int	SCROLLBAR_WIDTH
private final AbstractScrollArea.ScrollbarSettings	scrollbarSettings
private static final Identifier	SCROLLER_BACKGROUND_SPRITE
private static final Identifier	SCROLLER_SPRITE
private boolean	scrolling

Fields inherited from class AbstractWidget

active, alpha, height, isHovered, message, packedFGColor, UNSET_FG_COLOR, visible, width

Constructor Summary

Constructors

Constructor	Description
AbstractScrollArea(int x, int y, int width, int height, Component message, AbstractScrollArea.ScrollbarSettings scrollbarSettings)

Method Summary

Modifier and Type	Method	Description
protected abstract int	contentHeight()
static AbstractScrollArea.ScrollbarSettings	defaultSettings(int scrollRate)
protected boolean	isOverScrollbar(double x, double y)
int	maxScrollAmount()
boolean	mouseDragged(MouseButtonEvent event, double dx, double dy)
boolean	mouseScrolled(double mx, double my, double scrollX, double scrollY)
void	onRelease(MouseButtonEvent event)
void	refreshScrollAmount()
protected void	renderScrollbar(GuiGraphics graphics, int mouseX, int mouseY)
protected boolean	scrollable()
double	scrollAmount()
int	scrollbarWidth()
protected int	scrollBarX()
int	scrollBarY()
protected int	scrollerHeight()
protected double	scrollRate()
void	setScrollAmount(double scrollAmount)
boolean	updateScrolling(MouseButtonEvent event)

Methods inherited from class AbstractWidget

clearFGColor, createNarrationMessage, defaultButtonNarrationText, getAlpha, getBottom, getFGColor, getHeight, getMessage, getRectangle, getRight, getTabOrderGroup, getWidth, getX, getY, handleCursor, isActive, isFocused, isHovered, isHoveredOrFocused, isMouseOver, isValidClickButton, mouseClicked, mouseReleased, narrationPriority, nextFocusPath, onClick, onDrag, playButtonClickSound, playDownSound, render, renderScrollingStringOverContents, renderWidget, setAlpha, setFGColor, setFocused, setHeight, setMessage, setRectangle, setSize, setTabOrderGroup, setTooltip, setTooltipDelay, setWidth, setX, setY, updateNarration, updateWidgetNarration, visitWidgets, wrapDefaultNarrationMessage

Methods inherited from class Object

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

Methods inherited from interface GuiEventListener

charTyped, getBorderForArrowNavigation, getCurrentFocusPath, keyPressed, keyReleased, mouseMoved, shouldTakeFocusAfterInteraction

Methods inherited from interface LayoutElement

setPosition

Methods inherited from interface NarratableEntry

getNarratables

Field Details

SCROLLBAR_WIDTH

public static final int SCROLLBAR_WIDTH

See Also:

• Constant Field Values

SCROLLBAR_MIN_HEIGHT

private static final int SCROLLBAR_MIN_HEIGHT

See Also:

• Constant Field Values

SCROLLER_SPRITE

private static final Identifier SCROLLER_SPRITE

SCROLLER_BACKGROUND_SPRITE

private static final Identifier SCROLLER_BACKGROUND_SPRITE

scrollbarSettings

private final AbstractScrollArea.ScrollbarSettings scrollbarSettings

scrollAmount

private double scrollAmount

scrolling

private boolean scrolling

Constructor Details

AbstractScrollArea

public AbstractScrollArea(int x,
 int y,
 int width,
 int height,
 Component message,
 AbstractScrollArea.ScrollbarSettings scrollbarSettings)

Method Details

mouseScrolled

public boolean mouseScrolled(double mx,
 double my,
 double scrollX,
 double scrollY)

mouseDragged

public boolean mouseDragged(MouseButtonEvent event,
 double dx,
 double dy)

Specified by:

mouseDragged in interface GuiEventListener

Overrides:

mouseDragged in class AbstractWidget

onRelease

public void onRelease(MouseButtonEvent event)

Overrides:

onRelease in class AbstractWidget

scrollAmount

public double scrollAmount()

setScrollAmount

public void setScrollAmount(double scrollAmount)

updateScrolling

public boolean updateScrolling(MouseButtonEvent event)

isOverScrollbar

protected boolean isOverScrollbar(double x,
 double y)

refreshScrollAmount

public void refreshScrollAmount()

maxScrollAmount

public int maxScrollAmount()

scrollable

protected boolean scrollable()

scrollbarWidth

public int scrollbarWidth()

scrollerHeight

protected int scrollerHeight()

scrollBarX

protected int scrollBarX()

scrollBarY

public int scrollBarY()

renderScrollbar

protected void renderScrollbar(GuiGraphics graphics,
 int mouseX,
 int mouseY)

contentHeight

protected abstract int contentHeight()

scrollRate

protected double scrollRate()

defaultSettings

public static AbstractScrollArea.ScrollbarSettings defaultSettings(int scrollRate)