Class ExtendedButton

java.lang.Object

net.minecraft.client.gui.components.AbstractWidget

net.minecraft.client.gui.components.AbstractWidget.WithInactiveMessage

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

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.

Nested Class Summary

Nested classes/interfaces inherited from class Button

Button.Builder, Button.CreateNarration, Button.OnPress, Button.Plain

Nested classes/interfaces inherited from class AbstractWidget

AbstractWidget.WithInactiveMessage

Nested classes/interfaces inherited from interface NarratableEntry

NarratableEntry.NarrationPriority

Field Summary

Fields inherited from class Button

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

Fields inherited from class AbstractButton

SPRITES, TEXT_MARGIN

Fields inherited from class AbstractWidget

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

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	renderContents(GuiGraphics guiGraphics, int mouseX, int mouseY, float partialTick)	Draws this button to the screen.

Methods inherited from class Button

builder, createNarrationMessage, onPress, updateWidgetNarration

Methods inherited from class AbstractButton

keyPressed, onClick, renderDefaultLabel, renderDefaultSprite, renderWidget, setOverrideRenderHighlightedSprite

Methods inherited from class AbstractWidget.WithInactiveMessage

defaultInactiveMessage, getMessage, setMessage

Methods inherited from class AbstractWidget

clearFGColor, defaultButtonNarrationText, getAlpha, getBottom, getFGColor, getHeight, getRectangle, getRight, getTabOrderGroup, getWidth, getX, getY, handleCursor, isActive, isFocused, isHovered, isHoveredOrFocused, isMouseOver, isValidClickButton, mouseClicked, mouseDragged, mouseReleased, narrationPriority, nextFocusPath, onDrag, onRelease, playButtonClickSound, playDownSound, render, renderScrollingStringOverContents, setAlpha, setFGColor, setFocused, setHeight, setRectangle, setSize, setTabOrderGroup, setTooltip, setTooltipDelay, setWidth, setX, setY, updateNarration, 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, keyReleased, mouseMoved, mouseScrolled, shouldTakeFocusAfterInteraction

Methods inherited from interface LayoutElement

setPosition

Methods inherited from interface NarratableEntry

getNarratables

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

renderContents

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

Draws this button to the screen.

Specified by:

renderContents in class AbstractButton