me.desht.pneumaticcraft.client.gui.widget

Class WidgetButtonExtended

java.lang.Object

net.minecraft.client.gui.AbstractGui

net.minecraft.client.gui.widget.Widget

net.minecraft.client.gui.widget.button.AbstractButton

net.minecraft.client.gui.widget.button.Button

net.minecraftforge.fml.client.gui.widget.ExtendedButton

me.desht.pneumaticcraft.client.gui.widget.WidgetButtonExtended

All Implemented Interfaces:

ITaggedWidget, ITooltipProvider, net.minecraft.client.gui.IGuiEventListener, net.minecraft.client.gui.IRenderable

Direct Known Subclasses:

KeybindingButton, WidgetColorSelector, WidgetRangeToggleButton

public class WidgetButtonExtended
extends net.minecraftforge.fml.client.gui.widget.ExtendedButton
implements ITaggedWidget, ITooltipProvider

Extension of GuiButtonExt that add: 1) a string tag which is sent to the server when clicked (PacketGuiButton), 2) ability to draw itemstack or textured icons & 3) can render its area when invisible

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	WidgetButtonExtended.IconPosition

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

net.minecraft.client.gui.widget.button.Button.IPressable, net.minecraft.client.gui.widget.button.Button.ITooltip

Field Summary

Fields inherited from class net.minecraft.client.gui.widget.button.Button

NO_TOOLTIP, onPress, onTooltip

Fields inherited from class net.minecraft.client.gui.widget.Widget

active, alpha, height, isHovered, nextNarration, packedFGColor, UNSET_FG_COLOR, visible, WIDGETS_LOCATION, width, x, y

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

BACKGROUND_LOCATION, GUI_ICONS_LOCATION, STATS_ICON_LOCATION

Constructor Summary

Constructors

Constructor and Description
WidgetButtonExtended(int startX, int startY, int xSize, int ySize)
WidgetButtonExtended(int startX, int startY, int xSize, int ySize, net.minecraft.util.text.ITextComponent buttonText)
WidgetButtonExtended(int startX, int startY, int xSize, int ySize, net.minecraft.util.text.ITextComponent buttonText, net.minecraft.client.gui.widget.button.Button.IPressable pressable)
WidgetButtonExtended(int startX, int startY, int xSize, int ySize, java.lang.String buttonText)
WidgetButtonExtended(int startX, int startY, int xSize, int ySize, java.lang.String buttonText, net.minecraft.client.gui.widget.button.Button.IPressable pressable)

Method Summary

Modifier and Type	Method and Description
void	addTooltip(double mouseX, double mouseY, java.util.List<net.minecraft.util.text.ITextComponent> curTip, boolean shift)
int	getHeight()
java.lang.String	getTag() Get the data to send to the server.
java.util.List<net.minecraft.util.text.ITextComponent>	getTooltip()
int	getWidth()
boolean	hasTooltip()
void	onPress()
void	renderButton(com.mojang.blaze3d.matrix.MatrixStack matrixStack, int x, int y, float partialTicks)
WidgetButtonExtended	setIconPosition(WidgetButtonExtended.IconPosition iconPosition)
WidgetButtonExtended	setIconSpacing(int spacing)
WidgetButtonExtended	setInvisibleHoverColor(int color)
WidgetButtonExtended	setRenderedIcon(net.minecraft.util.ResourceLocation resLoc)
WidgetButtonExtended	setRenderStacks(net.minecraft.item.ItemStack... renderedStacks)
WidgetButtonExtended	setTexture(java.lang.Object texture)
WidgetButtonExtended	setTooltipKey(java.lang.String key, java.lang.Object... params)
WidgetButtonExtended	setTooltipText(net.minecraft.util.text.ITextComponent tooltip)
WidgetButtonExtended	setTooltipText(java.util.List<net.minecraft.util.text.ITextComponent> tooltip)
WidgetButtonExtended	setVisible(boolean visible)
WidgetButtonExtended	withTag(java.lang.String tag) Added a string tag to the button.

Methods inherited from class net.minecraft.client.gui.widget.button.Button

renderToolTip

Methods inherited from class net.minecraft.client.gui.widget.button.AbstractButton

keyPressed, onClick

Methods inherited from class net.minecraft.client.gui.widget.Widget

changeFocus, clearFGColor, clicked, createNarrationMessage, getFGColor, getMessage, getYImage, isFocused, isHovered, isMouseOver, isValidClickButton, mouseClicked, mouseDragged, mouseReleased, narrate, onDrag, onFocusedChanged, onRelease, playDownSound, queueNarration, render, renderBg, setAlpha, setFGColor, setFocused, setHeight, setMessage, setWidth

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

blit, blit, blit, blit, blit, blitOutlineBlack, drawCenteredString, drawCenteredString, drawString, drawString, fill, fillGradient, fillGradient, getBlitOffset, hLine, 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.IGuiEventListener

charTyped, keyReleased, mouseMoved, mouseScrolled

Constructor Detail

WidgetButtonExtended

public WidgetButtonExtended(int startX,
                            int startY,
                            int xSize,
                            int ySize,
                            net.minecraft.util.text.ITextComponent buttonText,
                            net.minecraft.client.gui.widget.button.Button.IPressable pressable)

WidgetButtonExtended

public WidgetButtonExtended(int startX,
                            int startY,
                            int xSize,
                            int ySize,
                            net.minecraft.util.text.ITextComponent buttonText)

WidgetButtonExtended

public WidgetButtonExtended(int startX,
                            int startY,
                            int xSize,
                            int ySize,
                            java.lang.String buttonText,
                            net.minecraft.client.gui.widget.button.Button.IPressable pressable)

WidgetButtonExtended

public WidgetButtonExtended(int startX,
                            int startY,
                            int xSize,
                            int ySize,
                            java.lang.String buttonText)

WidgetButtonExtended

public WidgetButtonExtended(int startX,
                            int startY,
                            int xSize,
                            int ySize)

Method Detail

withTag

public WidgetButtonExtended withTag(java.lang.String tag)

Added a string tag to the button. This will be sent to the server as the payload of a PacketGuiButton packet when the button is clicked.

Parameters:

tag - a string tag containing any arbitrary information

Returns:

the button, for fluency

onPress

public void onPress()

Overrides:

onPress in class net.minecraft.client.gui.widget.button.Button

getTag

public java.lang.String getTag()

Description copied from interface: ITaggedWidget

Get the data to send to the server. This is just some arbitrary string data which will be processed by the server-side container.

Specified by:

getTag in interface ITaggedWidget

Returns:

a string tag containing any arbitrary information

setVisible

public WidgetButtonExtended setVisible(boolean visible)

setInvisibleHoverColor

public WidgetButtonExtended setInvisibleHoverColor(int color)

setIconPosition

public WidgetButtonExtended setIconPosition(WidgetButtonExtended.IconPosition iconPosition)

setRenderStacks

public WidgetButtonExtended setRenderStacks(net.minecraft.item.ItemStack... renderedStacks)

setRenderedIcon

public WidgetButtonExtended setRenderedIcon(net.minecraft.util.ResourceLocation resLoc)

setIconSpacing

public WidgetButtonExtended setIconSpacing(int spacing)

setTexture

public WidgetButtonExtended setTexture(java.lang.Object texture)

setTooltipKey

public WidgetButtonExtended setTooltipKey(java.lang.String key,
                                          java.lang.Object... params)

setTooltipText

public WidgetButtonExtended setTooltipText(net.minecraft.util.text.ITextComponent tooltip)

setTooltipText

public WidgetButtonExtended setTooltipText(java.util.List<net.minecraft.util.text.ITextComponent> tooltip)

addTooltip

public void addTooltip(double mouseX,
                       double mouseY,
                       java.util.List<net.minecraft.util.text.ITextComponent> curTip,
                       boolean shift)

Specified by:

addTooltip in interface ITooltipProvider

hasTooltip

public boolean hasTooltip()

getTooltip

public java.util.List<net.minecraft.util.text.ITextComponent> getTooltip()

getWidth

public int getWidth()

Overrides:

getWidth in class net.minecraft.client.gui.widget.Widget

getHeight

public int getHeight()

Overrides:

getHeight in class net.minecraft.client.gui.widget.Widget

renderButton

public void renderButton(com.mojang.blaze3d.matrix.MatrixStack matrixStack,
                         int x,
                         int y,
                         float partialTicks)

Overrides:

renderButton in class net.minecraftforge.fml.client.gui.widget.ExtendedButton