Class TSeparatorElement

java.lang.Object

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

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

com.thecsdev.commonmc.api.client.gui.misc.TSeparatorElement

All Implemented Interfaces:

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

@Virtual
public class TSeparatorElement
extends TElement

Simple TElement that draws a solid-colored line either horizontally or vertically.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static enum	TSeparatorElement.Direction	The direction in which TSeparatorElement will draw its line.

Field Summary

Fields inherited from class TElement

eInitialized

Constructor Summary

Constructors

Constructor	Description
TSeparatorElement()

Method Summary

Modifier and Type	Method	Description
final IntegerProperty	colorProperty()	The color of the separator line, in ARGB format.
final NotNullProperty<TSeparatorElement.Direction>	directionProperty()	The direction in which TSeparatorElement will draw its line.
static final @NotNull TSeparatorElement	init(@NotNull TPanelElement target, int size, @NotNull TSeparatorElement.Direction direction, int thickness, int color)	Creates and initializes a TSeparatorElement element and then adds it to a given TPanelElement and returns it.
static final @NotNull TSeparatorElement	initH(@NotNull TPanelElement target, int size, int thickness, int color)	Same as #init, but with TSeparatorElement.Direction.HORIZONTAL.
static final @NotNull TSeparatorElement	initV(@NotNull TPanelElement target, int size, int thickness, int color)	Same as #init, but with TSeparatorElement.Direction.VERTICAL.
void	renderCallback(@NotNull TGuiGraphics pencil)	Callback method that is invoked when this Node is being rendered.
final IntegerProperty	thicknessProperty()	The thickness of the separator line, in Screen-space units.

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, initCallback, inputCallback, invalidateTooltipCache, isFocusable, isFocused, isHoverable, isHovered, isHoveredOrFocused, isVisible, move, moveChildren, moveTo, postRenderCallback, 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

TSeparatorElement

public TSeparatorElement()

Method Details

thicknessProperty

public final IntegerProperty thicknessProperty()

The thickness of the separator line, in Screen-space units.

directionProperty

public final NotNullProperty<TSeparatorElement.Direction> directionProperty()

The direction in which TSeparatorElement will draw its line.

colorProperty

public final IntegerProperty colorProperty()

The color of the separator line, in ARGB format.

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.

init

@NotNull
public static final @NotNull TSeparatorElement init(@NotNull
 @NotNull TPanelElement target,
 int size,
 @NotNull
 @NotNull TSeparatorElement.Direction direction,
 int thickness,
 int color)
                                             throws NullPointerException

Creates and initializes a TSeparatorElement element and then adds it to a given TPanelElement and returns it.

Parameters:

target - The TPanelElement to which the new TSeparatorElement will be added.

size - The width or height of the separator, depending on direction.

direction - The direction in which the separator will be drawn.

thickness - The thickness of the separator line, in Screen-space units.

color - The color of the separator line, in ARGB format.

Returns:

The created and initialized TSeparatorElement.

Throws:

NullPointerException - If a NotNull argument is null.

initH

@NotNull
public static final @NotNull TSeparatorElement initH(@NotNull
 @NotNull TPanelElement target,
 int size,
 int thickness,
 int color)
                                              throws NullPointerException

Same as #init, but with TSeparatorElement.Direction.HORIZONTAL.

Parameters:

target - The TPanelElement to which the new TSeparatorElement will be added.

size - The width or height of the separator, depending on direction.

thickness - The thickness of the separator line, in Screen-space units.

color - The color of the separator line, in ARGB format.

Returns:

The created and initialized TSeparatorElement.

Throws:

NullPointerException - If a NotNull argument is null.

See Also:

• init(TPanelElement, int, Direction, int, int)

initV

@NotNull
public static final @NotNull TSeparatorElement initV(@NotNull
 @NotNull TPanelElement target,
 int size,
 int thickness,
 int color)
                                              throws NullPointerException

Same as #init, but with TSeparatorElement.Direction.VERTICAL.

Parameters:

target - The TPanelElement to which the new TSeparatorElement will be added.

size - The width or height of the separator, depending on direction.

thickness - The thickness of the separator line, in Screen-space units.

color - The color of the separator line, in ARGB format.

Returns:

The created and initialized TSeparatorElement.

Throws:

NullPointerException - If a NotNull argument is null.

See Also:

• init(TPanelElement, int, Direction, int, int)