buildcraft.lib.gui

Interface IContainingElement

All Superinterfaces:

IGuiArea, IGuiElement, IGuiPosition, IHelpElement, IInteractionElement, ITooltipElement

All Known Implementing Classes:

GuiElementContainer2, GuiElementContainerResizing, GuiElementContainerScissor, Ledger_Neptune, LedgerEngine, LedgerHelp, LedgerOwnership, LedgerTablePower, ScrollWindow

public interface IContainingElement
extends IInteractionElement

Method Summary

Modifier and Type	Method and Description
default void	addHelpElements(java.util.List<ElementHelpInfo.HelpPosition> elements)
default void	addToolTips(java.util.List<ToolTip> tooltips) Called to add tooltips to the list of existing tool tips.
default void	calculateSizes() Called after getChildElements() is added to, possibly last (so it might not be called after every addition).
default IGuiPosition	getChildElementPosition()
java.util.List<IGuiElement>	getChildElements()
default java.util.List<IGuiElement>	getThisAndChildrenAt(double x, double y)
default boolean	onKeyPress(char typedChar, int keyCode) This is called EVEN IF the mouse is not inside your width and height!
default void	onMouseClicked(int button) This is called EVEN IF the mouse is not inside your width and height!
default void	onMouseDragged(int button, long ticksSinceClick) This is called EVEN IF the mouse is not inside your width and height!
default void	onMouseReleased(int button) This is called EVEN IF the mouse is not inside your width and height!

Methods inherited from interface buildcraft.lib.gui.IGuiElement

drawBackground, drawForeground, getDebugInfo, tick

Methods inherited from interface buildcraft.lib.gui.pos.IGuiArea

asImmutable, contains, contains, contains, create, create, create, expand, expand, expand, expand, getCenter, getCenterTop, getCenterX, getCenterY, getEnd, getEndX, getEndY, getHeight, getPosition, getWidth, offset, offset, offset, offset, offset, offsetToOrigin, rectangleToString, resize, resize

Methods inherited from interface buildcraft.lib.gui.pos.IGuiPosition

getX, getY

Method Detail

getChildElements

java.util.List<IGuiElement> getChildElements()

Returns:

The backing list of the contained elements. Must be modifiable, and changes must be reflected by future calls.

getChildElementPosition

default IGuiPosition getChildElementPosition()

calculateSizes

default void calculateSizes()

Called after getChildElements() is added to, possibly last (so it might not be called after every addition).

addToolTips

default void addToolTips(java.util.List<ToolTip> tooltips)

Description copied from interface: IGuiElement

Called to add tooltips to the list of existing tool tips. You MUST refresh the Tooltips if they need to be refreshed.

This is called EVEN IF the mouse is not inside your width and height!

Specified by:

addToolTips in interface IGuiElement

Specified by:

addToolTips in interface ITooltipElement

addHelpElements

default void addHelpElements(java.util.List<ElementHelpInfo.HelpPosition> elements)

Specified by:

addHelpElements in interface IGuiElement

Specified by:

addHelpElements in interface IHelpElement

getThisAndChildrenAt

default java.util.List<IGuiElement> getThisAndChildrenAt(double x,
                                                         double y)

Specified by:

getThisAndChildrenAt in interface IGuiElement

onMouseClicked

default void onMouseClicked(int button)

Description copied from interface: IInteractionElement

This is called EVEN IF the mouse is not inside your width and height!

Specified by:

onMouseClicked in interface IInteractionElement

onMouseReleased

default void onMouseReleased(int button)

Description copied from interface: IInteractionElement

This is called EVEN IF the mouse is not inside your width and height!

Specified by:

onMouseReleased in interface IInteractionElement

onMouseDragged

default void onMouseDragged(int button,
                            long ticksSinceClick)

Description copied from interface: IInteractionElement

This is called EVEN IF the mouse is not inside your width and height!

Specified by:

onMouseDragged in interface IInteractionElement

onKeyPress

default boolean onKeyPress(char typedChar,
                           int keyCode)

Description copied from interface: IInteractionElement

This is called EVEN IF the mouse is not inside your width and height!

Specified by:

onKeyPress in interface IInteractionElement

Returns:

True if this element handled the press, false otherwise. If this returns true then the normal gui interaction events won't happen (for example if the player presses escape and this returns true then the gui won't be closed). It is highly recommended that you close something if escape is pressed.