forestry.core.gui.elements

Class GuiElement

java.lang.Object

net.minecraft.client.gui.Gui

forestry.core.gui.elements.GuiElement

All Implemented Interfaces:

ICroppable, IGuiElement

Direct Known Subclasses:

AbstractItemElement, ButtonElement, ClimateBarElement, DrawableElement, ElementGroup, LabelElement, MultiblockElement, SpeciesSelectionElement, SplitTextElement, TankElement, TextDataElement, TextEditElement

public class GuiElement
extends net.minecraft.client.gui.Gui
implements IGuiElement

Field Summary

Fields

Modifier and Type	Field and Description
protected IGuiElement	cropElement
protected int	cropHeight
protected int	cropWidth
protected int	cropX
protected int	cropY
protected int	height
protected IGuiElement	parent
protected boolean	visible
protected int	width
protected int	xOffset
protected int	xPos
protected int	yOffset
protected int	yPos

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

ICONS, OPTIONS_BACKGROUND, STAT_ICONS, zLevel

Constructor Summary

Constructors

Constructor and Description
GuiElement(int width, int height)
GuiElement(int xPos, int yPos, int width, int height)

Method Summary

Modifier and Type	Method and Description
<E extends GuiElementEvent> void	addEventHandler(java.util.function.Consumer<E> eventHandler) Adds an event handler that handles events that this element receives with IGuiElement.receiveEvent(GuiElementEvent).
IGuiElement	addTooltip(java.util.Collection<java.lang.String> lines) Adds an additional tooltip to the current tooltip of the element.
IGuiElement	addTooltip(ITooltipSupplier supplier)
IGuiElement	addTooltip(java.lang.String line) Adds an additional tooltip to the current tooltip of the element.
void	clearTooltip() Clears the tooltips that were added with IGuiElement.addTooltip(String) and IGuiElement.addTooltip(Collection).
void	draw(int mouseX, int mouseY) Draws the element and his children.
void	drawElement(int mouseX, int mouseY) Draws the element itself at the current position.
int	getAbsoluteX()
int	getAbsoluteY()
GuiElementAlignment	getAlign() The alignment of the IGuiElement defines the position of the element relative to the position of its parent.
IGuiElement	getCropElement()
int	getCropHeight()
int	getCropWidth()
int	getCropX()
int	getCropY()
int	getHeight()
IGuiElement	getParent() The position of this element is relative to the position of its parent.
java.util.List<java.lang.String>	getTooltip()
java.util.List<java.lang.String>	getTooltip(int mouseX, int mouseY) Returns the tooltip that this element provides at the given mouse position.
int	getWidth()
IWindowElement	getWindow() The root of the containment hierarchy that this element is part of.
int	getX()
int	getY()
boolean	hasTooltip()
void	hide() Hides this element.
boolean	isCropped()
boolean	isEnabled() The most elements are enabled by default.
boolean	isMouseOver()
boolean	isMouseOver(int mouseX, int mouseY)
boolean	isVisible() The element can be hided with IGuiElement.hide() and be made visible again with IGuiElement.show().
void	onCreation() Called at IElementGroup.add(IGuiElement) after the element was added to the group and IGuiElement.setParent(IGuiElement) was called at the element.
void	onDeletion() Called at IElementGroup.remove(IGuiElement...) after the element was removed from the group.
protected void	onUpdateClient() Called if this element get updated on the client side.
void	receiveEvent(GuiElementEvent event) Receives an event and distributes them to the event handlers of this element.
IGuiElement	setAlign(GuiElementAlignment align) Sets the alignment of this element.
IGuiElement	setBounds(int xPos, int yPos, int width, int height) Sets the dimensions and position of this element.
void	setCroppedZone(IGuiElement cropElement, int cropX, int cropY, int cropWidth, int cropHeight) Sets the cropped zone of this element and the element the zone is relative to.
void	setHeight(int height)
IGuiElement	setLocation(int xPos, int yPos) Sets the position of this element.
IGuiElement	setOffset(int xOffset, int yOffset)
IGuiElement	setParent(IGuiElement parent) Sets the parent of this element.
IGuiElement	setSize(int width, int height) Sets the dimensions of this element.
void	setWidth(int width)
void	setXPosition(int xPos) Sets the x position of this element relative to the position of its parent.
void	setYPosition(int yPos) Sets the y position of this element relative to the position of its parent.
void	show() Makes this element visible again.
java.lang.String	toString()
void	updateClient() Updates the element.

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

drawCenteredString, drawGradientRect, drawHorizontalLine, drawModalRectWithCustomSizedTexture, drawRect, drawScaledCustomSizeModalRect, drawString, drawTexturedModalRect, drawTexturedModalRect, drawTexturedModalRect, drawVerticalLine

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface forestry.api.gui.IGuiElement

addEventHandler, addEventHandler, addSelfEventHandler, canFocus, canMouseOver, postEvent, postEvent

Field Detail

xPos

protected int xPos

yPos

protected int yPos

xOffset

protected int xOffset

yOffset

protected int yOffset

width

protected int width

height

protected int height

cropX

protected int cropX

cropY

protected int cropY

cropWidth

protected int cropWidth

cropHeight

protected int cropHeight

cropElement

@Nullable
protected IGuiElement cropElement

visible

protected boolean visible

parent

@Nullable
protected IGuiElement parent

Constructor Detail

GuiElement

public GuiElement(int width,
                  int height)

GuiElement

public GuiElement(int xPos,
                  int yPos,
                  int width,
                  int height)

Method Detail

onCreation

public void onCreation()

Description copied from interface: IGuiElement

Called at IElementGroup.add(IGuiElement) after the element was added to the group and IGuiElement.setParent(IGuiElement) was called at the element.

Can be used to add other element to the element if the element is an IElementGroup.

Specified by:

onCreation in interface IGuiElement

onDeletion

public void onDeletion()

Description copied from interface: IGuiElement

Called at IElementGroup.remove(IGuiElement...) after the element was removed from the group.

Specified by:

onDeletion in interface IGuiElement

getX

public final int getX()

Specified by:

getX in interface IGuiElement

Returns:

the x position of this element relative to the position of its parent.

getY

public final int getY()

Specified by:

getY in interface IGuiElement

Returns:

the y position of this element relative to the position of its parent.

getAbsoluteX

public final int getAbsoluteX()

Specified by:

getAbsoluteX in interface IGuiElement

Returns:

the x position of this element relative to the gui.

getAbsoluteY

public final int getAbsoluteY()

Specified by:

getAbsoluteY in interface IGuiElement

Returns:

the y position of this element relative to the gui.

draw

public final void draw(int mouseX,
                       int mouseY)

Description copied from interface: IGuiElement

Draws the element and his children.

Specified by:

draw in interface IGuiElement

Parameters:

mouseX - The x position of the mouse relative to the parent of the element.

mouseY - The y position of the mouse relative to the parent of the element.

drawElement

public void drawElement(int mouseX,
                        int mouseY)

Description copied from interface: IGuiElement

Draws the element itself at the current position.

Specified by:

drawElement in interface IGuiElement

Parameters:

mouseX - The x position of the mouse relative to the parent of the element.

mouseY - The y position of the mouse relative to the parent of the element.

getWidth

public int getWidth()

Specified by:

getWidth in interface IGuiElement

Returns:

the size of the element on the x-axis.

getHeight

public int getHeight()

Specified by:

getHeight in interface IGuiElement

Returns:

the size of the element on the y-axis.

setHeight

public void setHeight(int height)

Specified by:

setHeight in interface IGuiElement

setWidth

public void setWidth(int width)

Specified by:

setWidth in interface IGuiElement

setSize

public IGuiElement setSize(int width,
                           int height)

Description copied from interface: IGuiElement

Sets the dimensions of this element.

Specified by:

setSize in interface IGuiElement

Parameters:

width - the size of the element on the x-axis.

height - the size of the element on the y-axis.

setOffset

public IGuiElement setOffset(int xOffset,
                             int yOffset)

Specified by:

setOffset in interface IGuiElement

setXPosition

public void setXPosition(int xPos)

Description copied from interface: IGuiElement

Sets the x position of this element relative to the position of its parent.

Specified by:

setXPosition in interface IGuiElement

setYPosition

public void setYPosition(int yPos)

Description copied from interface: IGuiElement

Sets the y position of this element relative to the position of its parent.

Specified by:

setYPosition in interface IGuiElement

setLocation

public IGuiElement setLocation(int xPos,
                               int yPos)

Description copied from interface: IGuiElement

Sets the position of this element.

Specified by:

setLocation in interface IGuiElement

Parameters:

xPos - the x position of this element relative to the position of its parent.

yPos - the y position of this element relative to the position of its parent.

setBounds

public IGuiElement setBounds(int xPos,
                             int yPos,
                             int width,
                             int height)

Description copied from interface: IGuiElement

Sets the dimensions and position of this element.

Specified by:

setBounds in interface IGuiElement

Parameters:

xPos - the x position of this element relative to the position of its parent.

yPos - the y position of this element relative to the position of its parent.

width - the size of the element on the x-axis.

height - the size of the element on the y-axis.

setAlign

public IGuiElement setAlign(GuiElementAlignment align)

Description copied from interface: IGuiElement

Sets the alignment of this element.

Specified by:

setAlign in interface IGuiElement

getAlign

public GuiElementAlignment getAlign()

Description copied from interface: IGuiElement

The alignment of the IGuiElement defines the position of the element relative to the position of its parent.

Specified by:

getAlign in interface IGuiElement

setCroppedZone

public void setCroppedZone(@Nullable
                           IGuiElement cropElement,
                           int cropX,
                           int cropY,
                           int cropWidth,
                           int cropHeight)

Description copied from interface: ICroppable

Sets the cropped zone of this element and the element the zone is relative to.

Specified by:

setCroppedZone in interface ICroppable

Parameters:

cropElement - The element the zone is relative to.

cropX - The x start coordinate of the zone.

cropY - The y start coordinate of the zone.

cropWidth - The width of the zone.

cropHeight - The height of the zone.

getCropElement

@Nullable
public IGuiElement getCropElement()

Specified by:

getCropElement in interface ICroppable

Returns:

The element the cropped zone is relative to.

getCropX

public int getCropX()

Specified by:

getCropX in interface ICroppable

Returns:

The x start coordinate of the cropped zone.

getCropY

public int getCropY()

Specified by:

getCropY in interface ICroppable

Returns:

The y start coordinate of the cropped zone.

getCropWidth

public int getCropWidth()

Specified by:

getCropWidth in interface ICroppable

Returns:

The width of the cropped zone.

getCropHeight

public int getCropHeight()

Specified by:

getCropHeight in interface ICroppable

Returns:

The height of the cropped zone.

isCropped

public boolean isCropped()

Specified by:

isCropped in interface ICroppable

Returns:

True if ICroppable.setCroppedZone(IGuiElement, int, int, int, int) was ever called on this element.

getWindow

public IWindowElement getWindow()

Description copied from interface: IGuiElement

The root of the containment hierarchy that this element is part of.

Specified by:

getWindow in interface IGuiElement

isMouseOver

public boolean isMouseOver(int mouseX,
                           int mouseY)

Specified by:

isMouseOver in interface IGuiElement

Parameters:

mouseX - The x position of the mouse relative to the parent of the element.

mouseY - The y position of the mouse relative to the parent of the element.

Returns:

True if the mouse is currently over the element.

isMouseOver

public final boolean isMouseOver()

Specified by:

isMouseOver in interface IGuiElement

Returns:

True if the mouse is currently over the element.

onUpdateClient

protected void onUpdateClient()

Called if this element get updated on the client side.

updateClient

public void updateClient()

Description copied from interface: IGuiElement

Updates the element. Called at GuiScreen.updateScreen().

Specified by:

updateClient in interface IGuiElement

isVisible

public boolean isVisible()

Description copied from interface: IGuiElement

The element can be hided with IGuiElement.hide() and be made visible again with IGuiElement.show().

Specified by:

isVisible in interface IGuiElement

Returns:

True of this element is currently visible.

show

public void show()

Description copied from interface: IGuiElement

Makes this element visible again.

Specified by:

show in interface IGuiElement

hide

public void hide()

Description copied from interface: IGuiElement

Hides this element.

Specified by:

hide in interface IGuiElement

isEnabled

public boolean isEnabled()

Description copied from interface: IGuiElement

The most elements are enabled by default. Only a few elements are disabled at a certain time like buttons.

Specified by:

isEnabled in interface IGuiElement

Returns:

True if this element is enabled.

getParent

@Nullable
public IGuiElement getParent()

Description copied from interface: IGuiElement

The position of this element is relative to the position of its parent.

Specified by:

getParent in interface IGuiElement

Returns:

the parent element of this element.

setParent

public IGuiElement setParent(@Nullable
                             IGuiElement parent)

Description copied from interface: IGuiElement

Sets the parent of this element.

Specified by:

setParent in interface IGuiElement

getTooltip

public java.util.List<java.lang.String> getTooltip(int mouseX,
                                                   int mouseY)

Description copied from interface: IGuiElement

Returns the tooltip that this element provides at the given mouse position.

Specified by:

getTooltip in interface IGuiElement

Parameters:

mouseX - The x position of the mouse relative to the parent of the element.

mouseY - The y position of the mouse relative to the parent of the element.

addTooltip

public IGuiElement addTooltip(java.lang.String line)

Description copied from interface: IGuiElement

Adds an additional tooltip to the current tooltip of the element.

Specified by:

addTooltip in interface IGuiElement

addTooltip

public IGuiElement addTooltip(java.util.Collection<java.lang.String> lines)

Description copied from interface: IGuiElement

Adds an additional tooltip to the current tooltip of the element.

Specified by:

addTooltip in interface IGuiElement

addTooltip

public IGuiElement addTooltip(ITooltipSupplier supplier)

Specified by:

addTooltip in interface IGuiElement

hasTooltip

public boolean hasTooltip()

Specified by:

hasTooltip in interface IGuiElement

Returns:

True if this element currently has a tooltip.

clearTooltip

public void clearTooltip()

Description copied from interface: IGuiElement

Clears the tooltips that were added with IGuiElement.addTooltip(String) and IGuiElement.addTooltip(Collection). It does not remove default tooltips of an element like the fluid information of a tank or the item information of an slot element.

Specified by:

clearTooltip in interface IGuiElement

getTooltip

public java.util.List<java.lang.String> getTooltip()

Specified by:

getTooltip in interface IGuiElement

Returns:

Returns the tooltips that were added with IGuiElement.addTooltip(String) and IGuiElement.addTooltip(Collection).

addEventHandler

public <E extends GuiElementEvent> void addEventHandler(java.util.function.Consumer<E> eventHandler)

Description copied from interface: IGuiElement

Adds an event handler that handles events that this element receives with IGuiElement.receiveEvent(GuiElementEvent).

Specified by:

addEventHandler in interface IGuiElement

receiveEvent

public void receiveEvent(GuiElementEvent event)

Description copied from interface: IGuiElement

Receives an event and distributes them to the event handlers of this element.

Specified by:

receiveEvent in interface IGuiElement

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object