IGuiElement (ForestryMC 5.8.2.427 API)

All Superinterfaces:

ICroppable

All Known Subinterfaces:

IDatabaseElement, IElementGroup, IElementLayout, IGeneticAnalyzer, IItemElement, ILabelElement, ITextElement, IValueElement<V>, IWindowElement

All Known Implementing Classes:

AbstractElementLayout, AbstractItemElement, ButtonElement, CarpenterElement, ClimateBarElement, CraftingElement, DatabaseElement, DrawableElement, ElementGroup, ElementList, FabricatorElement, GeneticAnalyzer, GeneticAnalyzerTabs, GuiElement, HabitatFormerButton, HabitatSelectionElement, HorizontalLayout, IndexElement, IngredientElement, ItemElement, LabelElement, MultiblockElement, MutationElement, PaneLayout, ScrollableElement, ScrollBarElement, SelectionElement, SpeciesSelectionElement, SplitTextElement, TankElement, TextDataElement, TextEditElement, VerticalLayout, Window
```
public interface IGuiElement
extends ICroppable
```
A gui element is an object having a graphical representation that can be displayed on the screen and that can interact with the user.
The interface the most gui elements of forestry implement. You must place the element a containment hierarchy whose root is a top-level IWindowElement.

Method Summary

All Methods Instance Methods Abstract Methods Default Methods
Modifier and Type	Method and Description
`default <E extends GuiElementEvent> void`	`addEventHandler(java.lang.Class<? super E> eventClass, java.util.function.Consumer<E> eventHandler)` Adds an event handler that handles events that this element receives with `receiveEvent(GuiElementEvent)`.
`default <E extends GuiElementEvent> void`	`addEventHandler(java.lang.Class<? super E> eventClass, GuiEventOrigin origin, IGuiElement relative, java.util.function.Consumer<E> eventHandler)` Adds an event handler that handles events that this element receives with `receiveEvent(GuiElementEvent)`.
`<E extends GuiElementEvent> void`	`addEventHandler(java.util.function.Consumer<E> eventHandler)` Adds an event handler that handles events that this element receives with `receiveEvent(GuiElementEvent)`.
`default <E extends GuiElementEvent> void`	`addSelfEventHandler(java.lang.Class<? super E> eventClass, java.util.function.Consumer<E> eventHandler)` Adds an event handler that handles events that this element receives with `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.
`default boolean`	`canFocus()`
`default boolean`	`canMouseOver()`
`void`	`clearTooltip()` Clears the tooltips that were added with `addTooltip(String)` and `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.
`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`	`isEnabled()` The most elements are enabled by default.
`boolean`	`isMouseOver()`
`boolean`	`isMouseOver(int mouseX, int mouseY)`
`boolean`	`isVisible()` The element can be hided with `hide()` and be made visible again with `show()`.
`void`	`onCreation()` Called at `IElementGroup.add(IGuiElement)` after the element was added to the group and `setParent(IGuiElement)` was called at the element.
`void`	`onDeletion()` Called at `IElementGroup.remove(IGuiElement...)` after the element was removed from the group.
`default void`	`postEvent(GuiElementEvent event)`
`default void`	`postEvent(GuiElementEvent event, GuiEventDestination destination)` Distributes the event to the elements that are defined by the `GuiEventDestination`.
`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`	`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.
`void`	`updateClient()` Updates the element.

Methods inherited from interface forestry.api.gui.ICroppable
getCropElement, getCropHeight, getCropWidth, getCropX, getCropY, isCropped, setCroppedZone

- Method Detail
  - getX
```
int getX()
```
    Returns:
    
    the x position of this element relative to the position of its parent.
  - getY
```
int getY()
```
    Returns:
    
    the y position of this element relative to the position of its parent.
  - setAlign
```
IGuiElement setAlign(GuiElementAlignment align)
```
    Sets the alignment of this element.
  - getAlign
```
GuiElementAlignment getAlign()
```
    The alignment of the IGuiElement defines the position of the element relative to the position of its parent.
  - getWindow
```
IWindowElement getWindow()
```
    The root of the containment hierarchy that this element is part of.
  - getAbsoluteX
```
int getAbsoluteX()
```
    Returns:
    
    the x position of this element relative to the gui.
  - getAbsoluteY
```
int getAbsoluteY()
```
    Returns:
    
    the y position of this element relative to the gui.
  - getWidth
```
int getWidth()
```
    Returns:
    
    the size of the element on the x-axis.
  - setWidth
```
void setWidth(int width)
```
  - getHeight
```
int getHeight()
```
    Returns:
    
    the size of the element on the y-axis.
  - setHeight
```
void setHeight(int height)
```
  - setSize
```
IGuiElement setSize(int width,
                    int height)
```
    Sets the dimensions of this element.
    
    Parameters:
    
    width - the size of the element on the x-axis.
    
    height - the size of the element on the y-axis.
  - setLocation
```
IGuiElement setLocation(int xPos,
                        int yPos)
```
    Sets the position of this element.
    
    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.
  - setOffset
```
IGuiElement setOffset(int xOffset,
                      int yOffset)
```
  - setBounds
```
IGuiElement setBounds(int xPos,
                      int yPos,
                      int width,
                      int height)
```
    Sets the dimensions and position of this element.
    
    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.
  - setXPosition
```
void setXPosition(int xPos)
```
    Sets the x position of this element relative to the position of its parent.
  - setYPosition
```
void setYPosition(int yPos)
```
    Sets the y position of this element relative to the position of its parent.
  - getParent
```
@Nullable
IGuiElement getParent()
```
    The position of this element is relative to the position of its parent.
    
    Returns:
    
    the parent element of this element.
  - setParent
```
IGuiElement setParent(@Nullable
                      IGuiElement parent)
```
    Sets the parent of this element.
  - onCreation
```
void onCreation()
```
    Called at IElementGroup.add(IGuiElement) after the element was added to the group and setParent(IGuiElement) was called at the element.
    Can be used to add other element to the element if the element is an IElementGroup.
  - onDeletion
```
void onDeletion()
```
    Called at IElementGroup.remove(IGuiElement...) after the element was removed from the group.
  - draw
```
void draw(int mouseX,
          int mouseY)
```
    Draws the element and his children.
    
    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
```
void drawElement(int mouseX,
                 int mouseY)
```
    Draws the element itself at the current position.
    
    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.
  - isMouseOver
```
boolean isMouseOver(int mouseX,
                    int mouseY)
```
    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
```
boolean isMouseOver()
```
    Returns:
    
    True if the mouse is currently over the element.
  - canMouseOver
```
default boolean canMouseOver()
```
  - updateClient
```
void updateClient()
```
    Updates the element. Called at GuiScreen.updateScreen().
  - canFocus
```
default boolean canFocus()
```
    Returns:
    
    True if this element can be focused and processes keys.
  - isVisible
```
boolean isVisible()
```
    The element can be hided with hide() and be made visible again with show().
    
    Returns:
    
    True of this element is currently visible.
  - show
```
void show()
```
    Makes this element visible again.
  - hide
```
void hide()
```
    Hides this element.
  - isEnabled
```
boolean isEnabled()
```
    The most elements are enabled by default. Only a few elements are disabled at a certain time like buttons.
    
    Returns:
    
    True if this element is enabled.
  - addTooltip
```
IGuiElement addTooltip(java.lang.String line)
```
    Adds an additional tooltip to the current tooltip of the element.
  - addTooltip
```
IGuiElement addTooltip(java.util.Collection<java.lang.String> lines)
```
    Adds an additional tooltip to the current tooltip of the element.
  - addTooltip
```
IGuiElement addTooltip(ITooltipSupplier supplier)
```
  - hasTooltip
```
boolean hasTooltip()
```
    Returns:
    
    True if this element currently has a tooltip.
  - clearTooltip
```
void clearTooltip()
```
    Clears the tooltips that were added with addTooltip(String) and 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.
  - getTooltip
```
java.util.List<java.lang.String> getTooltip(int mouseX,
                                            int mouseY)
```
    Returns the tooltip that this element provides at the given mouse position.
    
    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.
  - getTooltip
```
java.util.List<java.lang.String> getTooltip()
```
    Returns:
    
    Returns the tooltips that were added with addTooltip(String) and addTooltip(Collection).
  - addEventHandler
```
<E extends GuiElementEvent> void addEventHandler(java.util.function.Consumer<E> eventHandler)
```
    Adds an event handler that handles events that this element receives with receiveEvent(GuiElementEvent).
  - addEventHandler
```
default <E extends GuiElementEvent> void addEventHandler(java.lang.Class<? super E> eventClass,
                                                         java.util.function.Consumer<E> eventHandler)
```
    Adds an event handler that handles events that this element receives with receiveEvent(GuiElementEvent).
  - addEventHandler
```
default <E extends GuiElementEvent> void addEventHandler(java.lang.Class<? super E> eventClass,
                                                         GuiEventOrigin origin,
                                                         IGuiElement relative,
                                                         java.util.function.Consumer<E> eventHandler)
```
    Adds an event handler that handles events that this element receives with receiveEvent(GuiElementEvent).
  - addSelfEventHandler
```
default <E extends GuiElementEvent> void addSelfEventHandler(java.lang.Class<? super E> eventClass,
                                                             java.util.function.Consumer<E> eventHandler)
```
    Adds an event handler that handles events that this element receives with receiveEvent(GuiElementEvent).
  - postEvent
```
default void postEvent(GuiElementEvent event,
                       GuiEventDestination destination)
```
    Distributes the event to the elements that are defined by the GuiEventDestination.
  - postEvent
```
default void postEvent(GuiElementEvent event)
```
  - receiveEvent
```
void receiveEvent(GuiElementEvent event)
```
    Receives an event and distributes them to the event handlers of this element.

Interface IGuiElement

Method Summary

Methods inherited from interface forestry.api.gui.ICroppable

Method Detail

getX

getY

setAlign

getAlign

getWindow

getAbsoluteX

getAbsoluteY

getWidth

setWidth

getHeight

setHeight

setSize

setLocation

setOffset

setBounds

setXPosition

setYPosition

getParent

setParent

onCreation

onDeletion

draw

drawElement

isMouseOver

isMouseOver

canMouseOver

updateClient

canFocus

isVisible

show

hide

isEnabled

addTooltip

addTooltip

addTooltip

hasTooltip

clearTooltip

getTooltip

getTooltip

addEventHandler

addEventHandler

addEventHandler

addSelfEventHandler

postEvent

postEvent

receiveEvent