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

Class TPanelElement

java.lang.Object

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

io.github.thecsdev.tcdcommons.api.client.gui.panel.TPanelElement

All Implemented Interfaces:

TParentElement, ITooltipProvider, IEnableStateProvider

Direct Known Subclasses:

TMenuPanel, TRefreshablePanelElement

public class TPanelElement
extends TElement

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	TPanelElement.TPanelElementEvent_Scrolled

Nested classes/interfaces inherited from class io.github.thecsdev.tcdcommons.api.client.gui.TElement

TElement.TElementEvent_ChildAR, TElement.TElementEvent_ContextMenu, TElement.TElementEvent_Moved, TElement.TElementEvent_ParentChanged, TElement.TElementEvent_Resized

Field Summary

Fields

Modifier and Type	Field	Description
protected int	backgroundColor
static final int	COLOR_BACKGROUND
static final int	COLOR_OUTLINE
static final int	COLOR_OUTLINE_FOCUSED
final TEvent<TPanelElement.TPanelElementEvent_Scrolled>	eScrolledHorizontally
final TEvent<TPanelElement.TPanelElementEvent_Scrolled>	eScrolledVertically
protected int	outlineColor
static final int	SCROLL_BOTH	A scroll flag used to define the scrolling behavior for setScrollFlags(int).
static final int	SCROLL_HORIZONTAL	A scroll flag used to define the scrolling behavior for setScrollFlags(int).
static final int	SCROLL_VERTICAL	A scroll flag used to define the scrolling behavior for setScrollFlags(int).
protected double	scrollDragX	Used by TInputContext.InputType.MOUSE_DRAG inputs to keep track of decimal scroll drag values.
protected double	scrollDragY	Used by TInputContext.InputType.MOUSE_DRAG inputs to keep track of decimal scroll drag values.
protected int	scrollFlags	Defines the scroll behavior for this TPanelElement. 2nd bit - SCROLL_HORIZONTAL 3rd bit - SCROLL_VERTICAL
protected int	scrollPadding
protected int	scrollSensitivity	Defines how sensitive scrolling input from mouse and keyboard is going to be.
protected double	scrollVelocityX	Used by the smooth scrolling feature to smoothly scroll this panel.
protected double	scrollVelocityY	Used by the smooth scrolling feature to smoothly scroll this panel.
protected boolean	smoothScroll
protected float	smoothScrollSpeed
protected final Tuple4<TElement,TElement,TElement,TElement>	topmosts	A shortcut for the topmost elements of this TPanelElement. See TElementList.getTopmostElements().

Fields inherited from class io.github.thecsdev.tcdcommons.api.client.gui.TElement

alpha, eChildAdded, eChildRemoved, eContextMenu, eMoved, eParentChanged, eResized, height, SP_ALL, SP_INVOKE_EVENT, SP_MOVE_CHILDREN, SP_RELATIVE, SP_UPDATE_TOPMOST, SS_ALL, SS_INVOKE_EVENT, SS_UPDATE_TOPMOST, tooltip, tooltipPositioner, width, x, y, zOffset

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

MAX_CHILD_NESTING_DEPTH

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
protected final @Nullable Tuple2<Point,Point>	__getHorizontalSeCnvElm()	Get horizontal start-end Points of canvas and elements bounding boxes. Used for scroll calculations.
protected final @Nullable Tuple2<Point,Point>	__getVerticalSeCnvElm()	Get vertical start-end Points of canvas and elements bounding boxes. Used for scroll calculations.
protected final boolean	applyScrollDrag()	Applies scroll values from scrollDragX and scrollDragY.
final int	getBackgroundColor()
final double	getHorizontalScrollAmount()	Calculates and returns the horizontal scroll amount.
final double	getHorizontalScrollKnobSize01()	Returns what should be the new knob size for a horizontal TScrollBarWidget.
final int	getOutlineColor()
final int	getScrollFlags()	Returns the scroll behavior for this TPanelElement. See scrollFlags.
final int	getScrollPadding()
final int	getScrollSensitivity()	Returns the input scrollSensitivity. See scrollSensitivity.
final boolean	getSmoothScroll()	When true, the mouse scrolling will be smooth.
final double	getVerticalScrollAmount()	Calculates and returns the vertical scroll amount.
final double	getVerticalScrollKnobSize01()	Returns what should be the new knob size for a vertical TScrollBarWidget.
final boolean	hasScrollFlag(int flagToCheck)	Used to quickly check for a scroll flag in scrollFlags.
boolean	input(TInputContext inputContext)	An input handler that handles inputs on the TInputContext.InputDiscoveryPhase.MAIN input phase.
boolean	input(TInputContext inputContext, TInputContext.InputDiscoveryPhase inputPhase)	An input handler that handles inputs on all possible TInputContext.InputDiscoveryPhases.
final boolean	inputHorizontalScroll(int scrollAmount)	Scrolls the TPanelElement horizontally.
final boolean	inputScroll(int scrollAmount)	Used for inputting scroll input from a mouse wheel.
final boolean	inputScroll(int xScrollAmount, int yScrollAmount)	Used for inputting scroll input from a mouse drag.
final boolean	inputSmoothScroll(int scrollAmount)	Same as inputScroll(int), but smooth.
final boolean	inputSmoothScroll(int scrollAmountX, int scrollAmountY)	Same as inputScroll(int, int), but smooth.
final boolean	inputVerticalScroll(int scrollAmount)	Scrolls the TPanelElement vertically.
final boolean	isScrollable()	Returns true if this TPanelElement has scrolling enabled.
void	postRender(TDrawContext pencil)
void	render(TDrawContext pencil)	Renders this GUI element on the screen.
protected final void	renderSmoothScroll(float deltaTime)	Handles smooth scrolling.
final void	scrollToChild(TElement child)	Input enough horizontal and vertical scroll to make a specific child TElement visible on the viewport.
void	setBackgroundColor(int color)
final void	setHorizontalScrollAmount(double amount01)	Sets the horizontal scroll amount.
void	setOutlineColor(int color)
void	setScrollFlags(int flags)	Defines the scroll behavior for this TPanelElement. See scrollFlags.
void	setScrollPadding(int scrollPadding)
void	setScrollSensitivity(int value)	Sets the input scrollSensitivity. See scrollSensitivity.
void	setSmoothScroll(boolean smoothScroll)	Sets getSmoothScroll().
final void	setVerticalScrollAmount(double amount01)	Sets the vertical scroll amount.

Methods inherited from class io.github.thecsdev.tcdcommons.api.client.gui.TElement

canBeAddedTo, createContextMenu, getAlpha, getChildren, getEnabled, getHeight, getItemRenderer, getParent, getParentTElement, getParentTScreen, getTextRenderer, getTooltip, getTooltipPositioner, getWidth, getX, getY, getZIndex, getZOffset, isDragging, isEnabled, isEnabledAndVisible, isFocusable, isFocused, isFocusedOrHovered, isHoverable, isHovered, isVisible, move, moveChildren, next, previous, setAlpha, setPosition, setPosition, setSize, setSize, setTooltip, setZOffset, tick, 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, removeChild, removeChild

Field Details

COLOR_OUTLINE

public static final int COLOR_OUTLINE

See Also:

• Constant Field Values

COLOR_OUTLINE_FOCUSED

public static final int COLOR_OUTLINE_FOCUSED

See Also:

• Constant Field Values

COLOR_BACKGROUND

public static final int COLOR_BACKGROUND

See Also:

• Constant Field Values

SCROLL_HORIZONTAL

public static final int SCROLL_HORIZONTAL

A scroll flag used to define the scrolling behavior for setScrollFlags(int).

See Also:

• Constant Field Values

SCROLL_VERTICAL

public static final int SCROLL_VERTICAL

A scroll flag used to define the scrolling behavior for setScrollFlags(int).

See Also:

• Constant Field Values

SCROLL_BOTH

public static final int SCROLL_BOTH

A scroll flag used to define the scrolling behavior for setScrollFlags(int).

See Also:

• Constant Field Values

topmosts

protected final Tuple4<TElement,TElement,TElement,TElement> topmosts

A shortcut for the topmost elements of this TPanelElement.
See TElementList.getTopmostElements().

scrollFlags

protected int scrollFlags

Defines the scroll behavior for this TPanelElement.
2nd bit - SCROLL_HORIZONTAL
3rd bit - SCROLL_VERTICAL

scrollSensitivity

protected int scrollSensitivity

Defines how sensitive scrolling input from mouse and keyboard is going to be.

scrollPadding

protected int scrollPadding

smoothScroll

protected boolean smoothScroll

smoothScrollSpeed

protected float smoothScrollSpeed

scrollDragX

protected double scrollDragX

Used by TInputContext.InputType.MOUSE_DRAG inputs to keep track of decimal scroll drag values.

scrollDragY

protected double scrollDragY

Used by TInputContext.InputType.MOUSE_DRAG inputs to keep track of decimal scroll drag values.

scrollVelocityX

protected double scrollVelocityX

Used by the smooth scrolling feature to smoothly scroll this panel.

scrollVelocityY

protected double scrollVelocityY

Used by the smooth scrolling feature to smoothly scroll this panel.

backgroundColor

protected int backgroundColor

outlineColor

protected int outlineColor

eScrolledHorizontally

public final TEvent<TPanelElement.TPanelElementEvent_Scrolled> eScrolledHorizontally

eScrolledVertically

public final TEvent<TPanelElement.TPanelElementEvent_Scrolled> eScrolledVertically

Constructor Details

TPanelElement

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

Method Details

getBackgroundColor

public final int getBackgroundColor()

setBackgroundColor

public void setBackgroundColor(int color)

getOutlineColor

public final int getOutlineColor()

setOutlineColor

public void setOutlineColor(int color)

render

public void render(TDrawContext pencil)

Description copied from interface: TParentElement

Renders this GUI element on the screen.

Specified by:

render in interface TParentElement

Specified by:

render in class TElement

Parameters:

pencil - The TDrawContext.

postRender

public void postRender(TDrawContext pencil)

Overrides:

postRender in class TElement

renderSmoothScroll

protected final void renderSmoothScroll(float deltaTime)

Handles smooth scrolling. Needs to be called once every frame from render(TDrawContext).

Parameters:

deltaTime - The time elapsed since the last frame.

hasScrollFlag

public final boolean hasScrollFlag(int flagToCheck)

Used to quickly check for a scroll flag in scrollFlags.

Parameters:

flagToCheck - For example SCROLL_HORIZONTAL.

isScrollable

public final boolean isScrollable()

Returns true if this TPanelElement has scrolling enabled.

getScrollFlags

public final int getScrollFlags()

Returns the scroll behavior for this TPanelElement.
See scrollFlags.

setScrollFlags

public void setScrollFlags(int flags)

Defines the scroll behavior for this TPanelElement.
See scrollFlags.

Parameters:

flags - The scroll settings.

getScrollSensitivity

public final int getScrollSensitivity()

Returns the input scrollSensitivity.
See scrollSensitivity.

setScrollSensitivity

public void setScrollSensitivity(int value)

Sets the input scrollSensitivity.
See scrollSensitivity.

Parameters:

value - The sensitivity value.

getSmoothScroll

public final boolean getSmoothScroll()

When true, the mouse scrolling will be smooth.

setSmoothScroll

public void setSmoothScroll(boolean smoothScroll)

Sets getSmoothScroll().

Parameters:

smoothScroll - Whether or not scrolling will be smooth.

getScrollPadding

@Beta
public final int getScrollPadding()

setScrollPadding

@Beta
public void setScrollPadding(int scrollPadding)

getHorizontalScrollAmount

public final double getHorizontalScrollAmount()

Calculates and returns the horizontal scroll amount.

getVerticalScrollAmount

public final double getVerticalScrollAmount()

Calculates and returns the vertical scroll amount.

__getHorizontalSeCnvElm

@Internal
@Nullable
protected final @Nullable Tuple2<Point,Point> __getHorizontalSeCnvElm()

Get horizontal start-end Points of canvas and elements bounding boxes.
Used for scroll calculations.

Returns:

The bounding-box start-end Points for the canvas and its elements.

__getVerticalSeCnvElm

@Internal
@Nullable
protected final @Nullable Tuple2<Point,Point> __getVerticalSeCnvElm()

Get vertical start-end Points of canvas and elements bounding boxes.
Used for scroll calculations.

Returns:

The bounding-box start-end Points for the canvas and its elements.

setHorizontalScrollAmount

public final void setHorizontalScrollAmount(double amount01)

Sets the horizontal scroll amount.

Parameters:

amount01 - The scroll amount in ranging from 0 to 1.

See Also:

• getHorizontalScrollAmount()

setVerticalScrollAmount

public final void setVerticalScrollAmount(double amount01)

Sets the vertical scroll amount.

Parameters:

amount01 - The scroll amount in ranging from 0 to 1.

See Also:

• getVerticalScrollAmount()

getHorizontalScrollKnobSize01

public final double getHorizontalScrollKnobSize01()

Returns what should be the new knob size for a horizontal TScrollBarWidget.
Ranges from 0 to 1, one being the maximum knob size.

getVerticalScrollKnobSize01

public final double getVerticalScrollKnobSize01()

Returns what should be the new knob size for a vertical TScrollBarWidget.
Ranges from 0 to 1, one being the maximum knob size.

scrollToChild

public final void scrollToChild(TElement child)

Input enough horizontal and vertical scroll to make a specific child TElement visible on the viewport.

Parameters:

child - The child TElement to scroll to.

applyScrollDrag

protected final boolean applyScrollDrag()

Applies scroll values from scrollDragX and scrollDragY.

Returns:

True if the scroll drag values had any scroll to apply, and were then applied.

input

public boolean input(TInputContext inputContext,
 TInputContext.InputDiscoveryPhase inputPhase)

Description copied from interface: TParentElement

An input handler that handles inputs on all possible TInputContext.InputDiscoveryPhases.

Parameters:

inputContext - The TInputContext containing information about a given input.

inputPhase - The current TInputContext.InputDiscoveryPhase.

See Also:

• TInputContext.InputDiscoveryPhase

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

Overrides:

input in class TElement

Parameters:

inputContext - The TInputContext containing information about a given input.

See Also:

• TParentElement.input(TInputContext, TInputContext.InputDiscoveryPhase)

inputSmoothScroll

public final boolean inputSmoothScroll(int scrollAmount)

Same as inputScroll(int), but smooth.

Parameters:

scrollAmount - The input scroll amount.

inputSmoothScroll

public final boolean inputSmoothScroll(int scrollAmountX,
 int scrollAmountY)

Same as inputScroll(int, int), but smooth.

Parameters:

scrollAmountX - The horizontal input scroll amount.

scrollAmountY - The vertical input scroll amount.

inputScroll

public final boolean inputScroll(int scrollAmount)

Used for inputting scroll input from a mouse wheel.

Note: Unaffected by getScrollSensitivity(). That only applies to input(TInputContext).

Parameters:

scrollAmount - The input scroll amount.

inputScroll

public final boolean inputScroll(int xScrollAmount,
 int yScrollAmount)

Used for inputting scroll input from a mouse drag.

Note: Unaffected by getScrollSensitivity(). That only applies to input(TInputContext).

Parameters:

xScrollAmount - The X scroll amount.

yScrollAmount - The Y scroll amount.

inputHorizontalScroll

public final boolean inputHorizontalScroll(int scrollAmount)

Scrolls the TPanelElement horizontally.

Note: Unaffected by getScrollSensitivity(). That only applies to input(TInputContext).

Parameters:

scrollAmount - The scroll amount.

inputVerticalScroll

public final boolean inputVerticalScroll(int scrollAmount)

Scrolls the TPanelElement vertically.

Note: Unaffected by getScrollSensitivity(). That only applies to input(TInputContext).

Parameters:

scrollAmount - The scroll amount.