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

Class NavigationBar

java.lang.Object

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

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

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

io.github.thecsdev.tcdcommons.api.client.gui.panel.explorer.NavigationBar

All Implemented Interfaces:

TParentElement, ITooltipProvider, IEnableStateProvider

@Experimental
public class NavigationBar
extends TRefreshablePanelElement

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	NavigationBar.NavigationBarProxy	An interface that provides valuable methods that define what happens when given events take place within the NavigationBar.

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

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
static final int	HEIGHT	The default NavigationBar height.
protected final NavigationBar.NavigationBarProxy	proxy

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

eRefreshed

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

backgroundColor, COLOR_BACKGROUND, COLOR_OUTLINE, COLOR_OUTLINE_FOCUSED, eScrolledHorizontally, eScrolledVertically, outlineColor, SCROLL_BOTH, SCROLL_HORIZONTAL, SCROLL_VERTICAL, scrollDragX, scrollDragY, scrollFlags, scrollPadding, scrollSensitivity, scrollVelocityX, scrollVelocityY, smoothScroll, smoothScrollSpeed, topmosts

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
NavigationBar(int x, int y, int width, int height, NavigationBar.NavigationBarProxy proxy)
NavigationBar(int x, int y, int width, NavigationBar.NavigationBarProxy proxy)

Method Summary

Modifier and Type	Method	Description
final NavigationBar.NavigationBarProxy	getProxy()	Returns the NavigationBar.NavigationBarProxy associated with this NavigationBar.
protected void	init()	Initializes this TRefreshablePanelElement.
boolean	input(TInputContext inputContext)	An input handler that handles inputs on the TInputContext.InputDiscoveryPhase.MAIN input phase.
protected final boolean	TRefreshablePanelElement_super_input(TInputContext inputContext)

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

refresh

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

__getHorizontalSeCnvElm, __getVerticalSeCnvElm, applyScrollDrag, getBackgroundColor, getHorizontalScrollAmount, getHorizontalScrollKnobSize01, getOutlineColor, getScrollFlags, getScrollPadding, getScrollSensitivity, getSmoothScroll, getVerticalScrollAmount, getVerticalScrollKnobSize01, hasScrollFlag, input, inputHorizontalScroll, inputScroll, inputScroll, inputSmoothScroll, inputSmoothScroll, inputVerticalScroll, isScrollable, postRender, render, renderSmoothScroll, scrollToChild, setBackgroundColor, setHorizontalScrollAmount, setOutlineColor, setScrollFlags, setScrollPadding, setScrollSensitivity, setSmoothScroll, setVerticalScrollAmount

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

HEIGHT

public static final int HEIGHT

The default NavigationBar height.

See Also:

• Constant Field Values

proxy

protected final NavigationBar.NavigationBarProxy proxy

Constructor Details

NavigationBar

public NavigationBar(int x,
 int y,
 int width,
 NavigationBar.NavigationBarProxy proxy)

NavigationBar

public NavigationBar(int x,
 int y,
 int width,
 int height,
 NavigationBar.NavigationBarProxy proxy)

Method Details

getProxy

public final NavigationBar.NavigationBarProxy getProxy()

Returns the NavigationBar.NavigationBarProxy associated with this NavigationBar.

TRefreshablePanelElement_super_input

protected final boolean TRefreshablePanelElement_super_input(TInputContext inputContext)

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 TPanelElement

Parameters:

inputContext - The TInputContext containing information about a given input.

See Also:

• TParentElement.input(TInputContext, TInputContext.InputDiscoveryPhase)

init

protected void init()

Description copied from class: TRefreshablePanelElement

Initializes this TRefreshablePanelElement.

Specified by:

init in class TRefreshablePanelElement