Class SpriteIconButton

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.minecraft.client.gui.components.SpriteIconButton

All Implemented Interfaces:

GuiEventListener, Renderable, TabOrderedElement, LayoutElement, NarratableEntry, NarrationSupplier

Direct Known Subclasses:

SpriteIconButton.CenteredIcon, SpriteIconButton.TextAndIcon

public abstract class SpriteIconButton
extends Button

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	SpriteIconButton.Builder
static class	SpriteIconButton.CenteredIcon
static class	SpriteIconButton.TextAndIcon

Nested classes/interfaces inherited from class Button

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

Modifier and Type	Field	Description
private static final Identifier	BUTTON_DISABLED_SPRITE
private final @Nullable Tooltip	defaultTooltip
private boolean	loading
private static final Identifier	LOADING_SPRITE
private static final int	LOADING_SPRITE_H
private static final int	LOADING_SPRITE_W
private static final Tooltip	LOADING_TOOLTIP
protected final WidgetSprites	sprite
protected final int	spriteHeight
protected final int	spriteOffsetX
protected final int	spriteOffsetY
protected final int	spriteWidth
private final boolean	switchToLoadingAfterPress

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

Modifier	Constructor	Description
private	SpriteIconButton(int width, int height, Component message, int spriteWidth, int spriteHeight, int spriteOffsetX, int spriteOffsetY, WidgetSprites sprite, Button.OnPress onPress, @Nullable Component tooltip, @Nullable Button.CreateNarration narration, boolean switchToLoadingAfterPress)

Method Summary

Modifier and Type	Method	Description
static SpriteIconButton.Builder	builder(Component message, Button.OnPress onPress, boolean iconOnly)
protected boolean	extractLoadingStateIfLoading(GuiGraphicsExtractor graphics)
protected void	extractSprite(GuiGraphicsExtractor graphics, int x, int y)
boolean	isActive()
void	onPress(InputWithModifiers input)
void	setLoading(boolean loading)
void	setLoading(boolean loading, Tooltip loadingTooltip)

Methods inherited from class Button

builder, createNarrationMessage, updateWidgetNarration

Methods inherited from class AbstractButton

extractContents, extractDefaultLabel, extractDefaultSprite, extractWidgetRenderState, keyPressed, onClick, setOverrideRenderHighlightedSprite

Methods inherited from class AbstractWidget.WithInactiveMessage

defaultInactiveMessage, getMessage, setMessage

Methods inherited from class AbstractWidget

clearFGColor, defaultButtonNarrationText, extractRenderState, extractScrollingStringOverContents, extractTooltipForNextRenderPass, getAlpha, getBottom, getFGColor, getHeight, getRectangle, getRight, getTabOrderGroup, getWidth, getX, getY, handleCursor, isFocused, isHovered, isHoveredOrFocused, isMouseOver, isValidClickButton, mouseClicked, mouseDragged, mouseReleased, narrationPriority, nextFocusPath, onDrag, onRelease, playButtonClickSound, playDownSound, 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, preeditUpdated, shouldTakeFocusAfterInteraction

Methods inherited from interface LayoutElement

setPosition

Methods inherited from interface NarratableEntry

getNarratables

Field Details

BUTTON_DISABLED_SPRITE

private static final Identifier BUTTON_DISABLED_SPRITE

LOADING_SPRITE

private static final Identifier LOADING_SPRITE

LOADING_TOOLTIP

private static final Tooltip LOADING_TOOLTIP

LOADING_SPRITE_W

private static final int LOADING_SPRITE_W

See Also:

• Constant Field Values

LOADING_SPRITE_H

private static final int LOADING_SPRITE_H

See Also:

• Constant Field Values

sprite

protected final WidgetSprites sprite

spriteWidth

protected final int spriteWidth

spriteHeight

protected final int spriteHeight

spriteOffsetX

protected final int spriteOffsetX

spriteOffsetY

protected final int spriteOffsetY

switchToLoadingAfterPress

private final boolean switchToLoadingAfterPress

defaultTooltip

private final @Nullable Tooltip defaultTooltip

loading

private boolean loading

Constructor Details

SpriteIconButton

private SpriteIconButton(int width,
 int height,
 Component message,
 int spriteWidth,
 int spriteHeight,
 int spriteOffsetX,
 int spriteOffsetY,
 WidgetSprites sprite,
 Button.OnPress onPress,
 @Nullable Component tooltip,
 @Nullable Button.CreateNarration narration,
 boolean switchToLoadingAfterPress)

Method Details

setLoading

public void setLoading(boolean loading)

setLoading

public void setLoading(boolean loading,
 Tooltip loadingTooltip)

isActive

public boolean isActive()

Specified by:

isActive in interface NarratableEntry

Overrides:

isActive in class AbstractWidget

onPress

public void onPress(InputWithModifiers input)

Overrides:

onPress in class Button

extractSprite

protected void extractSprite(GuiGraphicsExtractor graphics,
 int x,
 int y)

extractLoadingStateIfLoading

protected boolean extractLoadingStateIfLoading(GuiGraphicsExtractor graphics)

builder

public static SpriteIconButton.Builder builder(Component message,
 Button.OnPress onPress,
 boolean iconOnly)