me.shedaniel.rei.api.widgets

Class Label

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

All Implemented Interfaces:

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

Direct Known Subclasses:

LabelWidget

public abstract class Label
extends WidgetWithBounds

Field Summary

Fields

Modifier and Type	Field and Description
static int	CENTER
static int	LEFT_ALIGNED
static int	RIGHT_ALIGNED

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
Label()

Method Summary

Modifier and Type	Method and Description
@NotNull Label	centered()
@NotNull Label	clickable() Sets the label as clickable, ignores if onClick is set.
@NotNull Label	clickable(boolean clickable) Sets whether the label is clickable, ignores if onClick is set.
@NotNull Label	color(int color)
@NotNull Label	color(int lightModeColor, int darkModeColor)
@NotNull Label	focusable(boolean focusable) Sets whether the label is focusable by pressing tab, ignored if not clickable.
abstract int	getColor()
abstract int	getHorizontalAlignment() Gets the horizontal alignment of the label, defaulted as centered.
abstract int	getHoveredColor()
abstract net.minecraft.util.text.ITextProperties	getMessage()
abstract @Nullable java.util.function.Consumer<Label>	getOnClick()
abstract @Nullable java.util.function.BiConsumer<com.mojang.blaze3d.matrix.MatrixStack,Label>	getOnRender()
abstract @NotNull me.shedaniel.math.Point	getPoint()
@NotNull net.minecraft.util.text.ITextComponent	getText() Deprecated.
abstract @Nullable java.lang.String	getTooltip()
int	getX()
int	getY()
abstract boolean	hasShadow()
Label	horizontalAlignment(int horizontalAlignment)
@NotNull Label	hoveredColor(int color)
@NotNull Label	hoveredColor(int lightModeColor, int darkModeColor)
abstract boolean	isClickable()
abstract boolean	isFocusable()
@NotNull Label	leftAligned()
@NotNull Label	message(@NotNull net.minecraft.util.text.ITextProperties message)
@NotNull Label	noShadow()
@NotNull Label	onClick(@Nullable java.util.function.Consumer<Label> onClick) Sets the on click consumer, only applicable if the label is clickable.
@NotNull Label	onRender(@Nullable java.util.function.BiConsumer<com.mojang.blaze3d.matrix.MatrixStack,Label> onRender) Sets the consumer before render.
@NotNull Label	point(@NotNull me.shedaniel.math.Point point)
@NotNull Label	rainbow(boolean rainbow)
@NotNull Label	rightAligned()
abstract void	setClickable(boolean clickable) Sets whether the label is clickable, ignores if onClick is set.
abstract void	setColor(int color)
abstract void	setFocusable(boolean focusable) Sets whether the label is focusable by pressing tab, ignored if not clickable.
abstract void	setHorizontalAlignment(int horizontalAlignment)
abstract void	setHoveredColor(int hoveredColor)
abstract void	setMessage(@NotNull net.minecraft.util.text.ITextProperties message)
abstract void	setOnClick(@Nullable java.util.function.Consumer<Label> onClick) Sets the on click consumer, only applicable if the label is clickable.
abstract void	setOnRender(@Nullable java.util.function.BiConsumer<com.mojang.blaze3d.matrix.MatrixStack,Label> onRender) Sets the consumer before render.
abstract void	setPoint(@NotNull me.shedaniel.math.Point point)
abstract void	setRainbow(boolean rainbow)
abstract void	setShadow(boolean hasShadow)
void	setText(@NotNull net.minecraft.util.text.ITextComponent text)
abstract void	setTooltip(@Nullable java.util.function.Function<Label,java.lang.String> tooltip) Sets the tooltip function used to get the tooltip.
@NotNull Label	shadow()
@NotNull Label	shadow(boolean hasShadow)
@NotNull Label	text(@NotNull net.minecraft.util.text.ITextComponent text)
@NotNull Label	tooltipLine(@Nullable java.lang.String tooltip) Sets the tooltip.
@NotNull Label	tooltipLines(java.lang.String... tooltip) Sets the tooltip.
@NotNull Label	tooltipSupplier(@Nullable java.util.function.Function<Label,java.lang.String> tooltip) Sets the tooltip function.

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

containsMouse, 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

Field Detail

LEFT_ALIGNED

public static final int LEFT_ALIGNED

See Also:

Constant Field Values

CENTER

public static final int CENTER

See Also:

Constant Field Values

RIGHT_ALIGNED

public static final int RIGHT_ALIGNED

See Also:

Constant Field Values

Constructor Detail

Label

public Label()

Method Detail

isClickable

public abstract boolean isClickable()

Returns:

whether the label is clickable, ignores if onClick is set.

setClickable

public abstract void setClickable(boolean clickable)

Sets whether the label is clickable, ignores if onClick is set.

Parameters:

clickable - whether the label is clickable.

clickable

@NotNull
public final @NotNull Label clickable()

Sets the label as clickable, ignores if onClick is set.

Returns:

the label itself.

clickable

@NotNull
public final @NotNull Label clickable(boolean clickable)

Sets whether the label is clickable, ignores if onClick is set.

Parameters:

clickable - whether the label is clickable.

Returns:

the label itself.

getOnClick

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

Returns:

the consumer on click, only applicable if the label is clickable, null if not set.

setOnClick

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

Sets the on click consumer, only applicable if the label is clickable.

Parameters:

onClick - the on click consumer, only applicable if the label is clickable.

onClick

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

Sets the on click consumer, only applicable if the label is clickable.

Parameters:

onClick - the on click consumer, only applicable if the label is clickable.

Returns:

the label itself.

getOnRender

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

Returns:

the consumer before render, null if not set.

setOnRender

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

Sets the consumer before render.

Parameters:

onRender - the consumer before render.

onRender

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

Sets the consumer before render.

Parameters:

onRender - the consumer before render.

Returns:

the label itself.

isFocusable

public abstract boolean isFocusable()

Returns:

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

setFocusable

public abstract void setFocusable(boolean focusable)

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

Parameters:

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

focusable

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

Sets whether the label 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 label 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<Label,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 Label tooltipLines(@NotNull
                                                  java.lang.String... tooltip)

Sets the tooltip.

Parameters:

tooltip - the lines of tooltip.

Returns:

the label itself.

tooltipLine

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

Sets the tooltip.

Parameters:

tooltip - the line of tooltip.

Returns:

the label itself.

tooltipSupplier

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

Sets the tooltip function.

Parameters:

tooltip - the tooltip function used to get the tooltip.

Returns:

the label itself.

getHorizontalAlignment

public abstract int getHorizontalAlignment()

Gets the horizontal alignment of the label, defaulted as centered.

Returns:

LEFT_ALIGNED if left aligned, CENTER if centered or RIGHT_ALIGNED if right aligned}.

centered

@NotNull
public final @NotNull Label centered()

leftAligned

@NotNull
public final @NotNull Label leftAligned()

rightAligned

@NotNull
public final @NotNull Label rightAligned()

setHorizontalAlignment

public abstract void setHorizontalAlignment(int horizontalAlignment)

horizontalAlignment

public final Label horizontalAlignment(int horizontalAlignment)

hasShadow

public abstract boolean hasShadow()

noShadow

@NotNull
public final @NotNull Label noShadow()

shadow

@NotNull
public final @NotNull Label shadow()

setShadow

public abstract void setShadow(boolean hasShadow)

shadow

@NotNull
public final @NotNull Label shadow(boolean hasShadow)

getColor

public abstract int getColor()

setColor

public abstract void setColor(int color)

color

@NotNull
public final @NotNull Label color(int lightModeColor,
                                           int darkModeColor)

color

@NotNull
public final @NotNull Label color(int color)

getHoveredColor

public abstract int getHoveredColor()

setHoveredColor

public abstract void setHoveredColor(int hoveredColor)

hoveredColor

@NotNull
public final @NotNull Label hoveredColor(int lightModeColor,
                                                  int darkModeColor)

hoveredColor

@NotNull
public final @NotNull Label hoveredColor(int color)

getPoint

@NotNull
public abstract @NotNull me.shedaniel.math.Point getPoint()

getX

public final int getX()

getY

public final int getY()

setPoint

public abstract void setPoint(@NotNull
                              @NotNull me.shedaniel.math.Point point)

point

@NotNull
public final @NotNull Label point(@NotNull
                                           @NotNull me.shedaniel.math.Point point)

getText

@NotNull
 @ApiStatus.ScheduledForRemoval
 @Deprecated
public @NotNull net.minecraft.util.text.ITextComponent getText()

Deprecated.

getMessage

public abstract net.minecraft.util.text.ITextProperties getMessage()

setText

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

setMessage

public abstract void setMessage(@NotNull
                                @NotNull net.minecraft.util.text.ITextProperties message)

setRainbow

public abstract void setRainbow(boolean rainbow)

text

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

message

@NotNull
public final @NotNull Label message(@NotNull
                                             @NotNull net.minecraft.util.text.ITextProperties message)

rainbow

@NotNull
public final @NotNull Label rainbow(boolean rainbow)