Class ScrollPanel

java.lang.Object

net.minecraft.client.gui.components.events.AbstractContainerEventHandler

net.neoforged.neoforge.client.gui.widget.ScrollPanel

All Implemented Interfaces:

ContainerEventHandler, GuiEventListener, Renderable, TabOrderedElement, NarratableEntry, NarrationSupplier

Direct Known Subclasses:

ModListScreen.InfoPanel, ModMismatchDisconnectedScreen.MismatchInfoPanel

public abstract class ScrollPanel
extends AbstractContainerEventHandler
implements Renderable, NarratableEntry

Abstract scroll panel class.

Nested Class Summary

Nested classes/interfaces inherited from interface NarratableEntry

NarratableEntry.NarrationPriority

Field Summary

Fields

Modifier and Type	Field	Description
private final int	barBgColor
private final int	barBorderColor
private final int	barColor
private final int	barLeft
private final int	barWidth
protected final int	border
protected final int	bottom
protected boolean	captureMouse
private final Minecraft	client
protected final int	height
protected final int	left
protected final int	right
protected float	scrollDistance
private boolean	scrolling
protected final int	top
protected final int	width

Constructor Summary

Constructors

Constructor	Description
ScrollPanel(Minecraft client, int width, int height, int top, int left)
ScrollPanel(Minecraft client, int width, int height, int top, int left, int border)
ScrollPanel(Minecraft client, int width, int height, int top, int left, int border, int barWidth)
ScrollPanel(Minecraft client, int width, int height, int top, int left, int border, int barWidth, int barBgColor, int barColor, int barBorderColor)	Base constructor

Method Summary

Modifier and Type	Method	Description
private void	applyScrollLimits()
List<? extends GuiEventListener>	children()
protected boolean	clickPanel(double mouseX, double mouseY, MouseButtonEvent event)
protected void	drawBackground(GuiGraphicsExtractor guiGraphics, float partialTick)	Draws the background of the scroll panel.
protected void	drawGradientRect(GuiGraphicsExtractor guiGraphics, int left, int top, int right, int bottom, int color1, int color2)
protected abstract void	drawPanel(GuiGraphicsExtractor guiGraphics, int entryRight, int relativeY, int mouseX, int mouseY)	Draw anything special on the screen.
void	extractRenderState(GuiGraphicsExtractor guiGraphics, int mouseX, int mouseY, float partialTick)
private int	getBarHeight()
protected abstract int	getContentHeight()
private int	getMaxScroll()
protected int	getScrollAmount()
boolean	isMouseOver(double mouseX, double mouseY)
boolean	mouseClicked(MouseButtonEvent event, boolean doubleClick)
boolean	mouseDragged(MouseButtonEvent event, double deltaX, double deltaY)
boolean	mouseReleased(MouseButtonEvent event)
boolean	mouseScrolled(double x, double y, double scrollX, double scrollY)

Methods inherited from class AbstractContainerEventHandler

getFocused, isDragging, setDragging, setFocused

Methods inherited from class Object

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

Methods inherited from interface ContainerEventHandler

charTyped, getBorderForArrowNavigation, getChildAt, getCurrentFocusPath, isFocused, keyPressed, keyReleased, nextFocusPath, preeditUpdated, setFocused

Methods inherited from interface GuiEventListener

getRectangle, mouseMoved, shouldTakeFocusAfterInteraction

Methods inherited from interface NarratableEntry

getNarratables, isActive, narrationPriority

Methods inherited from interface NarrationSupplier

updateNarration

Methods inherited from interface TabOrderedElement

getTabOrderGroup

Field Details

client

private final Minecraft client

width

protected final int width

height

protected final int height

top

protected final int top

bottom

protected final int bottom

right

protected final int right

left

protected final int left

scrolling

private boolean scrolling

scrollDistance

protected float scrollDistance

captureMouse

protected boolean captureMouse

border

protected final int border

barWidth

private final int barWidth

barLeft

private final int barLeft

barBgColor

private final int barBgColor

barColor

private final int barColor

barBorderColor

private final int barBorderColor

Constructor Details

ScrollPanel

public ScrollPanel(Minecraft client,
 int width,
 int height,
 int top,
 int left)

Parameters:

client - the minecraft instance this ScrollPanel should use

width - the width

height - the height

top - the offset from the top (y coord)

left - the offset from the left (x coord)

ScrollPanel

public ScrollPanel(Minecraft client,
 int width,
 int height,
 int top,
 int left,
 int border)

Parameters:

client - the minecraft instance this ScrollPanel should use

width - the width

height - the height

top - the offset from the top (y coord)

left - the offset from the left (x coord)

border - the size of the border

ScrollPanel

public ScrollPanel(Minecraft client,
 int width,
 int height,
 int top,
 int left,
 int border,
 int barWidth)

Parameters:

client - the minecraft instance this ScrollPanel should use

width - the width

height - the height

top - the offset from the top (y coord)

left - the offset from the left (x coord)

border - the size of the border

barWidth - the width of the scroll bar

ScrollPanel

public ScrollPanel(Minecraft client,
 int width,
 int height,
 int top,
 int left,
 int border,
 int barWidth,
 int barBgColor,
 int barColor,
 int barBorderColor)

Base constructor

Parameters:

client - the minecraft instance this ScrollPanel should use

width - the width

height - the height

top - the offset from the top (y coord)

left - the offset from the left (x coord)

border - the size of the border

barWidth - the width of the scroll bar

barBgColor - the color for the scroll bar background

barColor - the color for the scroll bar handle

barBorderColor - the border color for the scroll bar handle

Method Details

getContentHeight

protected abstract int getContentHeight()

drawBackground

protected void drawBackground(GuiGraphicsExtractor guiGraphics,
 float partialTick)

Draws the background of the scroll panel. This runs AFTER Scissors are enabled.

drawPanel

protected abstract void drawPanel(GuiGraphicsExtractor guiGraphics,
 int entryRight,
 int relativeY,
 int mouseX,
 int mouseY)

Draw anything special on the screen. Scissor (RenderSystem.enableScissor) is enabled for anything that is rendered outside the view box. Do not mess with Scissor unless you support this.

clickPanel

protected boolean clickPanel(double mouseX,
 double mouseY,
 MouseButtonEvent event)

getMaxScroll

private int getMaxScroll()

applyScrollLimits

private void applyScrollLimits()

mouseScrolled

public boolean mouseScrolled(double x,
 double y,
 double scrollX,
 double scrollY)

Specified by:

mouseScrolled in interface ContainerEventHandler

Specified by:

mouseScrolled in interface GuiEventListener

getScrollAmount

protected int getScrollAmount()

isMouseOver

public boolean isMouseOver(double mouseX,
 double mouseY)

Specified by:

isMouseOver in interface GuiEventListener

mouseClicked

public boolean mouseClicked(MouseButtonEvent event,
 boolean doubleClick)

Specified by:

mouseClicked in interface ContainerEventHandler

Specified by:

mouseClicked in interface GuiEventListener

mouseReleased

public boolean mouseReleased(MouseButtonEvent event)

Specified by:

mouseReleased in interface ContainerEventHandler

Specified by:

mouseReleased in interface GuiEventListener

getBarHeight

private int getBarHeight()

mouseDragged

public boolean mouseDragged(MouseButtonEvent event,
 double deltaX,
 double deltaY)

Specified by:

mouseDragged in interface ContainerEventHandler

Specified by:

mouseDragged in interface GuiEventListener

extractRenderState

public void extractRenderState(GuiGraphicsExtractor guiGraphics,
 int mouseX,
 int mouseY,
 float partialTick)

Specified by:

extractRenderState in interface Renderable

drawGradientRect

protected void drawGradientRect(GuiGraphicsExtractor guiGraphics,
 int left,
 int top,
 int right,
 int bottom,
 int color1,
 int color2)

children

public List<? extends GuiEventListener> children()

Specified by:

children in interface ContainerEventHandler