Class TWindowElement

java.lang.Object

com.thecsdev.common.scene.Node<TElement>

com.thecsdev.commonmc.api.client.gui.TElement

com.thecsdev.commonmc.api.client.gui.panel.window.TWindowElement

All Implemented Interfaces:

INode<TElement>, INodeBounded<TElement,Bounds2i>, INodeRenderable<TElement, TGuiGraphics>, Iterable<TElement>, Collection<TElement>

@Environment(CLIENT)
public abstract class TWindowElement
extends TElement

TElement implementation that has the visual appearance to that of a "window", featuring a title-bar that has a title label and control buttons like [X].

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static enum	TWindowElement.CloseOperation	Constants used to define what happens when close() is called.

Field Summary

Fields inherited from class TElement

eInitialized

Constructor Summary

Constructors

Constructor	Description
TWindowElement()

Method Summary

Modifier and Type	Method	Description
final IntegerProperty	backgroundColorProperty()	IntegerProperty that holds the background color of this window.
final void	close()	Invokes the TWindowElement.CloseOperation that is assigned to this TWindowElement.
final NotNullProperty<TWindowElement.CloseOperation>	closeOperationProperty()	NotNullProperty that controls what happens when close() is called.
protected abstract void	initBodyCallback(@NotNull TElement body)	Similar to initCallback(), except elements are initialized onto the provided "body" TElement.
protected final void	initCallback()	Callback method that is invoked when this TElement is initializing.
final boolean	inputCallback(TInputContext.InputDiscoveryPhase phase, @NotNull TInputContext context)	A callback method that is invoked when the user makes an input.
final BooleanProperty	maximizedProperty()	BooleanProperty that controls whether this window is maximized or not.
final void	postRenderCallback(@NotNull TGuiGraphics pencil)	Callback method that is invoked after this Node and all of their children have been rendered.
void	renderCallback(@NotNull TGuiGraphics pencil)	Callback method that is invoked when this Node is being rendered.
final NotNullProperty<Bounds2i>	restoredBoundsProperty()	NotNullProperty that holds the preferred bounds of this window, that are used when not maximized.
final NotNullProperty<net.minecraft.network.chat.Component>	titleProperty()	NotNullProperty holding the title of this window, that is shown in the title-bar.

Methods inherited from class TElement

addRel, boundsProperty, clearAndInit, clipsDescendantsProperty, contextMenuProperty, dragEndCallback, dragStartCallback, findElementAt, focusableProperty, focusGainedCallback, focusLostCallback, forEachVisible, getBaseType, getBounds, getClient, getContentBounds, getCursor, getSelf, getTooltip, hoverableProperty, hoverGainedCallback, hoverLostCallback, invalidateTooltipCache, isFocusable, isFocused, isHoverable, isHovered, isHoveredOrFocused, isVisible, move, moveChildren, moveTo, removeRel, screenProperty, setBounds, setBounds, setBounds, showContextMenu, tickCallback, tooltipProperty, toString, visibleProperty

Methods inherited from class Node

add, addAll, childAddedCallback, childRemovedCallback, clear, contains, containsAll, equals, findChild, findParent, findSibling, forEach, get, getFirst, getLast, getParent, hashCode, indexOf, isEmpty, iterator, parentProperty, remove, remove, remove, removeAll, retainAll, rootProperty, size, toArray, toArray

Methods inherited from class Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface Collection

add, addAll, clear, contains, containsAll, equals, hashCode, isEmpty, iterator, parallelStream, remove, removeAll, removeIf, retainAll, size, spliterator, stream, toArray, toArray, toArray

Methods inherited from interface Iterable

forEach

Constructor Details

TWindowElement

public TWindowElement()

Method Details

titleProperty

public final NotNullProperty<net.minecraft.network.chat.Component> titleProperty()

NotNullProperty holding the title of this window, that is shown in the title-bar.

closeOperationProperty

public final NotNullProperty<TWindowElement.CloseOperation> closeOperationProperty()

NotNullProperty that controls what happens when close() is called.

maximizedProperty

public final BooleanProperty maximizedProperty()

BooleanProperty that controls whether this window is maximized or not.

When setting this to true, it is highly advised to set the value of restoredBoundsProperty() if you haven't already - specifically if this TWindowElement is maximized from the beginning of its lifespan (as in, you maximized it the moment you created it).

restoredBoundsProperty

public final NotNullProperty<Bounds2i> restoredBoundsProperty()

NotNullProperty that holds the preferred bounds of this window, that are used when not maximized. Specifically, when restoring-down - the window will return to these bounds.

The value of this property is automatically updated whenever the value of maximizedProperty() is set to true.

This value will be overridden when maximizing this TWindowElement.

See Also:

• maximizedProperty()

backgroundColorProperty

public final IntegerProperty backgroundColorProperty()

IntegerProperty that holds the background color of this window.

initCallback

protected final void initCallback()

Description copied from class: TElement

Callback method that is invoked when this TElement is initializing. You may override this method to create and add child TElements.

Overrides:

initCallback in class TElement

See Also:

• TElement.clearAndInit()

renderCallback

@Virtual
public void renderCallback(@NotNull
 @NotNull TGuiGraphics pencil)

Description copied from interface: INodeRenderable

Callback method that is invoked when this Node is being rendered.

Specified by:

renderCallback in interface INodeRenderable<TElement, TGuiGraphics>

Overrides:

renderCallback in class TElement

Parameters:

pencil - The rendering context.

postRenderCallback

public final void postRenderCallback(@NotNull
 @NotNull TGuiGraphics pencil)

Description copied from interface: INodeRenderable

Callback method that is invoked after this Node and all of their children have been rendered.

Specified by:

postRenderCallback in interface INodeRenderable<TElement, TGuiGraphics>

Overrides:

postRenderCallback in class TElement

Parameters:

pencil - The rendering context.

inputCallback

public final boolean inputCallback(@NotNull
 TInputContext.InputDiscoveryPhase phase,
 @NotNull
 @NotNull TInputContext context)
                            throws NullPointerException

Description copied from class: TElement

A callback method that is invoked when the user makes an input.

Overrides:

inputCallback in class TElement

Parameters:

phase - The input discovery phase.

context - Information about the user's input.

Returns:

true if this TElement handled the input.

Throws:

NullPointerException - If an argument is null.

initBodyCallback

protected abstract void initBodyCallback(@NotNull
 @NotNull TElement body)

Similar to initCallback(), except elements are initialized onto the provided "body" TElement.

Parameters:

body - The parent element where the GUI is to be initialized.

close

public final void close()

Invokes the TWindowElement.CloseOperation that is assigned to this TWindowElement.

See Also:

• closeOperationProperty()