Package net.neoforged.neoforge.client.gui.widget

Class ExtendedButton

java.lang.Object

net.minecraft.client.gui.components.AbstractWidget

net.minecraft.client.gui.components.AbstractButton

net.minecraft.client.gui.components.Button

net.neoforged.neoforge.client.gui.widget.ExtendedButton

All Implemented Interfaces:

GuiEventListener, Renderable, TabOrderedElement, LayoutElement, NarratableEntry, NarrationSupplier, IAbstractWidgetExtension

Direct Known Subclasses:

UnicodeGlyphButton

public class ExtendedButton
extends Button

This class provides a button that fixes several bugs present in the vanilla GuiButton drawing code. The gist of it is that it allows buttons of any size without gaps in the graphics and with the borders drawn properly. It also prevents button text from extending out of the sides of the button by trimming the end of the string and adding an ellipsis.

The code that handles drawing the button is in GuiUtils.

Author:

bspkrs

Nested Class Summary

Nested classes/interfaces inherited from class net.minecraft.client.gui.components.Button

Button.Builder, Button.CreateNarration, Button.OnPress

Nested classes/interfaces inherited from interface net.minecraft.client.gui.narration.NarratableEntry

NarratableEntry.NarrationPriority

Field Summary

Fields inherited from class net.minecraft.client.gui.components.Button

BIG_WIDTH, createNarration, DEFAULT_HEIGHT, DEFAULT_NARRATION, DEFAULT_SPACING, DEFAULT_WIDTH, onPress, SMALL_WIDTH

Fields inherited from class net.minecraft.client.gui.components.AbstractButton

SPRITES, TEXT_MARGIN

Fields inherited from class net.minecraft.client.gui.components.AbstractWidget

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

Fields inherited from interface net.minecraft.client.gui.components.events.GuiEventListener

DOUBLE_CLICK_THRESHOLD_MS

Constructor Summary

Constructors

Constructor	Description
ExtendedButton(int xPos, int yPos, int width, int height, Component displayString, Button.OnPress handler)
ExtendedButton(int xPos, int yPos, int width, int height, Component displayString, Button.OnPress handler, Button.CreateNarration createNarration)
ExtendedButton(Button.Builder builder)

Method Summary

Modifier and Type	Method	Description
void	renderWidget(GuiGraphics guiGraphics, int mouseX, int mouseY, float partialTick)	Draws this button to the screen.

Methods inherited from class net.minecraft.client.gui.components.Button

builder, createNarrationMessage, onPress, updateWidgetNarration

Methods inherited from class net.minecraft.client.gui.components.AbstractButton

keyPressed, onClick, renderString

Methods inherited from class net.minecraft.client.gui.components.AbstractWidget

clearFGColor, clicked, defaultButtonNarrationText, getBottom, getFGColor, getHeight, getMessage, getRectangle, getRight, getTabOrderGroup, getTooltip, getWidth, getX, getY, isActive, isFocused, isHovered, isHoveredOrFocused, isMouseOver, isValidClickButton, mouseClicked, mouseDragged, mouseReleased, narrationPriority, nextFocusPath, onDrag, onRelease, playDownSound, render, renderScrollingString, renderScrollingString, renderScrollingString, setAlpha, setFGColor, setFocused, setHeight, setMessage, setRectangle, setSize, setTabOrderGroup, setTooltip, setTooltipDelay, setWidth, setX, setY, updateNarration, visitWidgets, wrapDefaultNarrationMessage

Methods inherited from class java.lang.Object

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

Methods inherited from interface net.minecraft.client.gui.components.events.GuiEventListener

charTyped, getCurrentFocusPath, keyReleased, mouseMoved, mouseScrolled

Methods inherited from interface net.neoforged.neoforge.client.extensions.IAbstractWidgetExtension

onClick

Methods inherited from interface net.minecraft.client.gui.layouts.LayoutElement

setPosition

Constructor Details

ExtendedButton

public ExtendedButton(int xPos,
 int yPos,
 int width,
 int height,
 Component displayString,
 Button.OnPress handler)

ExtendedButton

public ExtendedButton(int xPos,
 int yPos,
 int width,
 int height,
 Component displayString,
 Button.OnPress handler,
 Button.CreateNarration createNarration)

ExtendedButton

public ExtendedButton(Button.Builder builder)

Method Details

renderWidget

public void renderWidget(GuiGraphics guiGraphics,
 int mouseX,
 int mouseY,
 float partialTick)

Draws this button to the screen.

Overrides:

renderWidget in class AbstractButton