Package io.github.thecsdev.tcdcommons.api.client.gui

Class TElement

java.lang.Object

io.github.thecsdev.tcdcommons.api.client.gui.TElement

All Implemented Interfaces:

TParentElement, ITooltipProvider, IEnableStateProvider

Direct Known Subclasses:

TBlankElement, TClickableWidget, TMenuPanelSeparator, TPanelElement

public abstract class TElement
extends Object
implements TParentElement, ITooltipProvider

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	TElement.TElementEvent_ChildAR
static interface	TElement.TElementEvent_ContextMenu
static interface	TElement.TElementEvent_Moved
static interface	TElement.TElementEvent_ParentChanged
static interface	TElement.TElementEvent_Resized

Field Summary

Fields

Modifier and Type	Field	Description
protected float	alpha
final TEvent<TElement.TElementEvent_ChildAR>	eChildAdded
final TEvent<TElement.TElementEvent_ChildAR>	eChildRemoved
final TEvent<TElement.TElementEvent_ContextMenu>	eContextMenu
final TEvent<TElement.TElementEvent_Moved>	eMoved
final TEvent<TElement.TElementEvent_ParentChanged>	eParentChanged
final TEvent<TElement.TElementEvent_Resized>	eResized
protected int	height
static final int	SP_ALL	A setPosition(int, int, boolean) flag containing all flags.
static final int	SP_INVOKE_EVENT	Makes setPosition(int, int, boolean) invoke the eMoved event.
static final int	SP_MOVE_CHILDREN	Makes setPosition(int, int, boolean) move the children alongside this element.
static final int	SP_RELATIVE	Makes setPosition(int, int, boolean) set the position relative to parent.
static final int	SP_UPDATE_TOPMOST	Makes setPosition(int, int, boolean) update the parent's topmost children.
static final int	SS_ALL	A setSize(int, int) flag containing all flags.
static final int	SS_INVOKE_EVENT	Makes setSize(int, int) invoke the eResized event.
static final int	SS_UPDATE_TOPMOST	Makes setSize(int, int) update the parent's topmost children.
protected @Nullable net.minecraft.client.gui.tooltip.Tooltip	tooltip
protected @Nullable net.minecraft.client.gui.tooltip.TooltipPositioner	tooltipPositioner
protected int	width
protected int	x
protected int	y
protected float	zOffset

Fields inherited from interface io.github.thecsdev.tcdcommons.api.client.gui.TParentElement

MAX_CHILD_NESTING_DEPTH

Constructor Summary

Constructors

Constructor	Description
TElement(int x, int y, int width, int height)

Method Summary

Modifier and Type	Method	Description
boolean	canBeAddedTo(TParentElement futureParent)	Returns true if this TElement is okay with being added to a given TParentElement.
@Nullable TContextMenuPanel	createContextMenu()	A utility method that creates and returns a new TContextMenuPanel instance for this TElement.
final float	getAlpha()
final TElementList	getChildren()	Returns the TElementList containing the list of all children for this TElement.
boolean	getEnabled()	Returns true if this Object is enabled.
final int	getHeight()
final net.minecraft.client.render.item.ItemRenderer	getItemRenderer()
final @Nullable TParentElement	getParent()	Returns the parent TParentElement of this TElement.
final @Nullable TElement	getParentTElement()	If getParent() is a TElement, the TParentElement will be returned as a TElement.
final @Nullable TScreen	getParentTScreen()	If getParent() is a TScreen, that TScreen will be returned. If however, getParent() is a TElement, then that TElement's TScreen reference will be returned. This allows nested children to access their root TScreen parent through their TElement parent.
final net.minecraft.client.font.TextRenderer	getTextRenderer()
final @Nullable net.minecraft.client.gui.tooltip.Tooltip	getTooltip()
final net.minecraft.client.gui.tooltip.TooltipPositioner	getTooltipPositioner()
final int	getWidth()
final int	getX()
final int	getY()
final float	getZIndex()	Returns the sum of getZOffset() for this TElement, while also taking into account any TParentElements.
final float	getZOffset()
boolean	input(TInputContext inputContext)	An input handler that handles inputs on the TInputContext.InputDiscoveryPhase.MAIN input phase.
final boolean	isDragging()
final boolean	isEnabled()	Returns true if TParentElement.getEnabled() returns true, and TParentElement.getParent()'s TParentElement.isEnabled() also returns true.
final boolean	isEnabledAndVisible()
boolean	isFocusable()
final boolean	isFocused()
final boolean	isFocusedOrHovered()
boolean	isHoverable()
final boolean	isHovered()
final boolean	isVisible()
final void	move(int deltaX, int deltaY)
final void	moveChildren(int dX, int dY)
final @Nullable TElement	next()	Returns the TElement that comes after this one in the hierarchy of parent/child relations.
void	postRender(TDrawContext pencil)
final @Nullable TElement	previous()	Returns the TElement that comes before this one in the hierarchy of parent/child relations.
abstract void	render(TDrawContext pencil)	Renders this GUI element on the screen.
final void	setAlpha(float alpha)
final void	setPosition(int x, int y, boolean relativeToParent)
void	setPosition(int x, int y, int flags)
final void	setSize(int width, int height)
void	setSize(int width, int height, int flags)
void	setTooltip(@Nullable net.minecraft.client.gui.tooltip.Tooltip tooltip)
void	setZOffset(float zOffset)
void	tick()	Used for periodic updates for this TElement.
String	toString()

Methods inherited from class java.lang.Object

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

Methods inherited from interface io.github.thecsdev.tcdcommons.api.client.gui.TParentElement

addChild, addChild, clearChildren, findChild, findLastChild, findParent, findParentTElement, forEachChild, getEndX, getEndY, input, removeChild, removeChild

Field Details

SP_RELATIVE

public static final int SP_RELATIVE

Makes setPosition(int, int, boolean) set the position relative to parent.

See Also:

• Constant Field Values

SP_MOVE_CHILDREN

public static final int SP_MOVE_CHILDREN

Makes setPosition(int, int, boolean) move the children alongside this element.

See Also:

• Constant Field Values

SP_UPDATE_TOPMOST

public static final int SP_UPDATE_TOPMOST

Makes setPosition(int, int, boolean) update the parent's topmost children.

See Also:

• Constant Field Values

SP_INVOKE_EVENT

public static final int SP_INVOKE_EVENT

Makes setPosition(int, int, boolean) invoke the eMoved event.

See Also:

• Constant Field Values

SP_ALL

public static final int SP_ALL

A setPosition(int, int, boolean) flag containing all flags.

See Also:

• Constant Field Values

SS_UPDATE_TOPMOST

public static final int SS_UPDATE_TOPMOST

Makes setSize(int, int) update the parent's topmost children.

See Also:

• Constant Field Values

SS_INVOKE_EVENT

public static final int SS_INVOKE_EVENT

Makes setSize(int, int) invoke the eResized event.

See Also:

• Constant Field Values

SS_ALL

public static final int SS_ALL

A setSize(int, int) flag containing all flags.

See Also:

• Constant Field Values

x

protected int x

y

protected int y

width

protected int width

height

protected int height

alpha

protected float alpha

zOffset

protected float zOffset

tooltip

@Nullable
protected @Nullable net.minecraft.client.gui.tooltip.Tooltip tooltip

tooltipPositioner

@Nullable
protected @Nullable net.minecraft.client.gui.tooltip.TooltipPositioner tooltipPositioner

eMoved

public final TEvent<TElement.TElementEvent_Moved> eMoved

eResized

public final TEvent<TElement.TElementEvent_Resized> eResized

eChildAdded

public final TEvent<TElement.TElementEvent_ChildAR> eChildAdded

eChildRemoved

public final TEvent<TElement.TElementEvent_ChildAR> eChildRemoved

eParentChanged

public final TEvent<TElement.TElementEvent_ParentChanged> eParentChanged

eContextMenu

public final TEvent<TElement.TElementEvent_ContextMenu> eContextMenu

Constructor Details

TElement

public TElement(int x,
 int y,
 int width,
 int height)

Method Details

getChildren

public final TElementList getChildren()

Returns the TElementList containing the list of all children for this TElement.

Specified by:

getChildren in interface TParentElement

getParent

@Nullable
public final @Nullable TParentElement getParent()

Returns the parent TParentElement of this TElement.

Specified by:

getParent in interface TParentElement

getParentTElement

@Nullable
public final @Nullable TElement getParentTElement()

If getParent() is a TElement, the TParentElement will be returned as a TElement. Null is returned otherwise.

getParentTScreen

@Nullable
public final @Nullable TScreen getParentTScreen()

If getParent() is a TScreen, that TScreen will be returned.
If however, getParent() is a TElement, then that TElement's TScreen reference will be returned.
This allows nested children to access their root TScreen parent through their TElement parent.

getX

public final int getX()

Specified by:

getX in interface TParentElement

getY

public final int getY()

Specified by:

getY in interface TParentElement

getWidth

public final int getWidth()

Specified by:

getWidth in interface TParentElement

getHeight

public final int getHeight()

Specified by:

getHeight in interface TParentElement

move

public final void move(int deltaX,
 int deltaY)

moveChildren

public final void moveChildren(int dX,
 int dY)

setPosition

public final void setPosition(int x,
 int y,
 boolean relativeToParent)

setPosition

public void setPosition(int x,
 int y,
 int flags)

setSize

public final void setSize(int width,
 int height)

setSize

public void setSize(int width,
 int height,
 int flags)

getAlpha

public final float getAlpha()

setAlpha

public final void setAlpha(float alpha)

isVisible

public final boolean isVisible()

isEnabledAndVisible

public final boolean isEnabledAndVisible()

getTextRenderer

public final net.minecraft.client.font.TextRenderer getTextRenderer()

getItemRenderer

public final net.minecraft.client.render.item.ItemRenderer getItemRenderer()

getZIndex

public final float getZIndex()

Returns the sum of getZOffset() for this TElement, while also taking into account any TParentElements.

Please use setZOffset(float) to modify the z-offset for this TElement.

Specified by:

getZIndex in interface TParentElement

See Also:

• getZOffset()
• setZOffset(float)

getZOffset

public final float getZOffset()

setZOffset

public void setZOffset(float zOffset)

isEnabled

public final boolean isEnabled()

Description copied from interface: TParentElement

Returns true if TParentElement.getEnabled() returns true, and TParentElement.getParent()'s TParentElement.isEnabled() also returns true.

In other words, this will return true if both this element and all of its TParentElements are enabled.

Specified by:

isEnabled in interface TParentElement

getEnabled

public boolean getEnabled()

Description copied from interface: IEnableStateProvider

Returns true if this Object is enabled.

Specified by:

getEnabled in interface IEnableStateProvider

Specified by:

getEnabled in interface TParentElement

isFocusable

public boolean isFocusable()

isHoverable

public boolean isHoverable()

isHovered

public final boolean isHovered()

isFocused

public final boolean isFocused()

isDragging

public final boolean isDragging()

isFocusedOrHovered

public final boolean isFocusedOrHovered()

createContextMenu

@Nullable
public @Nullable TContextMenuPanel createContextMenu()

A utility method that creates and returns a new TContextMenuPanel instance for this TElement. Use this to create your own custom context menus for this TElement.

Returns:

A TContextMenuPanel for this TElement, or null if this TElement does not support context menus.

tick

public void tick()

Used for periodic updates for this TElement.

render

public abstract void render(TDrawContext pencil)

Description copied from interface: TParentElement

Renders this GUI element on the screen.

Specified by:

render in interface TParentElement

Parameters:

pencil - The TDrawContext.

postRender

public void postRender(TDrawContext pencil)

input

public boolean input(TInputContext inputContext)

Description copied from interface: TParentElement

An input handler that handles inputs on the TInputContext.InputDiscoveryPhase.MAIN input phase.

Specified by:

input in interface TParentElement

Parameters:

inputContext - The TInputContext containing information about a given input.

See Also:

• TParentElement.input(TInputContext, TInputContext.InputDiscoveryPhase)

getTooltip

@Nullable
public final @Nullable net.minecraft.client.gui.tooltip.Tooltip getTooltip()

Specified by:

getTooltip in interface ITooltipProvider

setTooltip

public void setTooltip(@Nullable
 @Nullable net.minecraft.client.gui.tooltip.Tooltip tooltip)

getTooltipPositioner

public final net.minecraft.client.gui.tooltip.TooltipPositioner getTooltipPositioner()

previous

@Nullable
public final @Nullable TElement previous()

Returns the TElement that comes before this one in the hierarchy of parent/child relations.

Primarily used for "tab navigation".

next

@Nullable
public final @Nullable TElement next()

Returns the TElement that comes after this one in the hierarchy of parent/child relations.

Primarily used for "tab navigation".

toString

public String toString()

Overrides:

toString in class Object

canBeAddedTo

public boolean canBeAddedTo(TParentElement futureParent)

Returns true if this TElement is okay with being added to a given TParentElement.

Parameters:

futureParent - The TParentElement that is being checked.