me.shedaniel.rei.api.widgets

Class Button

java.lang.Object

net.minecraft.client.gui.AbstractGui

net.minecraft.client.gui.FocusableGui

me.shedaniel.rei.gui.widget.Widget

me.shedaniel.rei.gui.widget.WidgetWithBounds

me.shedaniel.rei.api.widgets.BaseWidget<Button>

me.shedaniel.rei.api.widgets.Button

All Implemented Interfaces:

net.minecraft.client.gui.IGuiEventListener, net.minecraft.client.gui.INestedGuiEventHandler, net.minecraft.client.gui.IRenderable

Direct Known Subclasses:

ButtonWidget

public abstract class Button
extends BaseWidget<Button>

Field Summary

Fields inherited from class me.shedaniel.rei.gui.widget.Widget

font, minecraft

Fields inherited from class net.minecraft.client.gui.AbstractGui

BACKGROUND_LOCATION, GUI_ICONS_LOCATION, STATS_ICON_LOCATION

Constructor Summary

Constructors

Constructor and Description
Button()

Method Summary

Modifier and Type	Method and Description
Button	enabled(boolean enabled)
@NotNull Button	focusable(boolean focusable) Sets whether the button is focusable by pressing tab, ignored if not clickable.
abstract @Nullable java.util.function.Consumer<Button>	getOnClick()
abstract @Nullable java.util.function.BiConsumer<com.mojang.blaze3d.matrix.MatrixStack,Button>	getOnRender()
abstract @NotNull net.minecraft.util.text.ITextComponent	getText()
abstract int	getTextColor(me.shedaniel.math.Point mouse)
abstract int	getTextureId(me.shedaniel.math.Point mouse)
abstract java.util.OptionalInt	getTint()
abstract @Nullable java.lang.String	getTooltip()
abstract boolean	isEnabled()
abstract boolean	isFocusable()
abstract boolean	isFocused()
abstract void	onClick()
@NotNull Button	onClick(@Nullable java.util.function.Consumer<Button> onClick)
@NotNull Button	onRender(@Nullable java.util.function.BiConsumer<com.mojang.blaze3d.matrix.MatrixStack,Button> onRender)
abstract void	removeTint()
abstract void	setEnabled(boolean enabled)
abstract void	setFocusable(boolean focusable) Sets whether the button is focusable by pressing tab, ignored if not clickable.
abstract void	setOnClick(@Nullable java.util.function.Consumer<Button> onClick)
abstract void	setOnRender(@Nullable java.util.function.BiConsumer<com.mojang.blaze3d.matrix.MatrixStack,Button> onRender)
abstract void	setText(@NotNull net.minecraft.util.text.ITextComponent text)
abstract void	setTextColor(@Nullable java.util.function.BiFunction<Button,me.shedaniel.math.Point,java.lang.Integer> textColorFunction)
abstract void	setTextureId(@Nullable java.util.function.BiFunction<Button,me.shedaniel.math.Point,java.lang.Integer> textureIdFunction)
abstract void	setTint(int tint)
abstract void	setTooltip(@Nullable java.util.function.Function<Button,java.lang.String> tooltip) Sets the tooltip function used to get the tooltip.
@NotNull Button	text(@NotNull net.minecraft.util.text.ITextComponent text)
Button	textColor(@Nullable java.util.function.BiFunction<Button,me.shedaniel.math.Point,java.lang.Integer> textColorFunction)
Button	textureId(@Nullable java.util.function.BiFunction<Button,me.shedaniel.math.Point,java.lang.Integer> textureIdFunction)
Button	tint(@Nullable java.lang.Integer tint)
@NotNull Button	tooltipLine(@Nullable java.lang.String tooltip) Sets the tooltip.
@NotNull Button	tooltipLines(java.lang.String... tooltip) Sets the tooltip.
@NotNull Button	tooltipSupplier(@Nullable java.util.function.Function<Button,java.lang.String> tooltip) Sets the tooltip function.

Methods inherited from class me.shedaniel.rei.api.widgets.BaseWidget

containsMouse, containsMousePredicate, setContainsMousePredicate

Methods inherited from class me.shedaniel.rei.gui.widget.WidgetWithBounds

getBounds

Methods inherited from class me.shedaniel.rei.gui.widget.Widget

containsMouse, containsMouse, getZ, isMouseOver, setZ

Methods inherited from class net.minecraft.client.gui.FocusableGui

getFocused, isDragging, setDragging, setFocused

Methods inherited from class net.minecraft.client.gui.AbstractGui

blit, blit, blit, blit, blit, blitOutlineBlack, drawCenteredString, drawCenteredString, drawString, drawString, fill, fillGradient, fillGradient, getBlitOffset, hLine, innerBlit, setBlitOffset, vLine

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.IRenderable

render

Methods inherited from interface net.minecraft.client.gui.INestedGuiEventHandler

changeFocus, charTyped, children, getChildAt, keyPressed, keyReleased, magicalSpecialHackyFocus, mouseClicked, mouseDragged, mouseReleased, mouseScrolled, setInitialFocus

Methods inherited from interface net.minecraft.client.gui.IGuiEventListener

mouseMoved

Constructor Detail

Button

public Button()

Method Detail

setTextColor

public abstract void setTextColor(@Nullable
                                  @Nullable java.util.function.BiFunction<Button,me.shedaniel.math.Point,java.lang.Integer> textColorFunction)

textColor

public final Button textColor(@Nullable
                              @Nullable java.util.function.BiFunction<Button,me.shedaniel.math.Point,java.lang.Integer> textColorFunction)

getTextColor

public abstract int getTextColor(me.shedaniel.math.Point mouse)

setTextureId

public abstract void setTextureId(@Nullable
                                  @Nullable java.util.function.BiFunction<Button,me.shedaniel.math.Point,java.lang.Integer> textureIdFunction)

textureId

public final Button textureId(@Nullable
                              @Nullable java.util.function.BiFunction<Button,me.shedaniel.math.Point,java.lang.Integer> textureIdFunction)

getTextureId

public abstract int getTextureId(me.shedaniel.math.Point mouse)

onClick

public abstract void onClick()

isEnabled

public abstract boolean isEnabled()

setEnabled

public abstract void setEnabled(boolean enabled)

enabled

public final Button enabled(boolean enabled)

getTint

public abstract java.util.OptionalInt getTint()

setTint

public abstract void setTint(int tint)

removeTint

public abstract void removeTint()

tint

public final Button tint(@Nullable
                         @Nullable java.lang.Integer tint)

getText

@NotNull
public abstract @NotNull net.minecraft.util.text.ITextComponent getText()

setText

public abstract void setText(@NotNull
                             @NotNull net.minecraft.util.text.ITextComponent text)

text

@NotNull
public final @NotNull Button text(@NotNull
                                           @NotNull net.minecraft.util.text.ITextComponent text)

getOnClick

@Nullable
public abstract @Nullable java.util.function.Consumer<Button> getOnClick()

setOnClick

public abstract void setOnClick(@Nullable
                                @Nullable java.util.function.Consumer<Button> onClick)

onClick

@NotNull
public final @NotNull Button onClick(@Nullable
                                              @Nullable java.util.function.Consumer<Button> onClick)

getOnRender

@Nullable
public abstract @Nullable java.util.function.BiConsumer<com.mojang.blaze3d.matrix.MatrixStack,Button> getOnRender()

setOnRender

public abstract void setOnRender(@Nullable
                                 @Nullable java.util.function.BiConsumer<com.mojang.blaze3d.matrix.MatrixStack,Button> onRender)

onRender

@NotNull
public final @NotNull Button onRender(@Nullable
                                               @Nullable java.util.function.BiConsumer<com.mojang.blaze3d.matrix.MatrixStack,Button> onRender)

isFocusable

public abstract boolean isFocusable()

Returns:

whether the button is focusable by pressing tab, ignored if not clickable.

setFocusable

public abstract void setFocusable(boolean focusable)

Sets whether the button is focusable by pressing tab, ignored if not clickable.

Parameters:

focusable - whether the button is focusable by pressing tab, ignored if not clickable.

focusable

@NotNull
public final @NotNull Button focusable(boolean focusable)

Sets whether the button is focusable by pressing tab, ignored if not clickable.

Parameters:

focusable - whether the label is focusable by pressing tab, ignored if not clickable.

Returns:

the button itself.

getTooltip

@Nullable
public abstract @Nullable java.lang.String getTooltip()

Returns:

the tooltip from the current tooltip function, null if no tooltip.

setTooltip

public abstract void setTooltip(@Nullable
                                @Nullable java.util.function.Function<Button,java.lang.String> tooltip)

Sets the tooltip function used to get the tooltip.

Parameters:

tooltip - the tooltip function used to get the tooltip.

tooltipLines

@NotNull
public final @NotNull Button tooltipLines(@NotNull
                                                   java.lang.String... tooltip)

Sets the tooltip.

Parameters:

tooltip - the lines of tooltip.

Returns:

the button itself.

tooltipLine

@NotNull
public final @NotNull Button tooltipLine(@Nullable
                                                  @Nullable java.lang.String tooltip)

Sets the tooltip.

Parameters:

tooltip - the line of tooltip.

Returns:

the button itself.

tooltipSupplier

@NotNull
public final @NotNull Button tooltipSupplier(@Nullable
                                                      @Nullable java.util.function.Function<Button,java.lang.String> tooltip)

Sets the tooltip function.

Parameters:

tooltip - the tooltip function used to get the tooltip.

Returns:

the button itself.

isFocused

public abstract boolean isFocused()