Class THoverScrollElement<E extends TElement>

java.lang.Object

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

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

com.thecsdev.commonmc.api.client.gui.misc.THoverScrollElement<E>

All Implemented Interfaces:

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

Direct Known Subclasses:

THoverScrollElement.Panel

@Environment(CLIENT)
@Virtual
public class THoverScrollElement<E extends TElement>
extends TElement

TElement that when hovered, sends simulated mouse-scroll input to its target TElement.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	THoverScrollElement.Panel

Field Summary

Fields inherited from class TElement

eInitialized

Constructor Summary

Constructors

Constructor	Description
THoverScrollElement()
THoverScrollElement(E target)

Method Summary

Modifier and Type	Method	Description
final @NotNull NotNullProperty<CompassDirection>	directionProperty()	NotNullProperty that holds the scroll direction.
boolean	shouldBeVisible()	Each tick, tickCallback() sets TElement.visibleProperty() value to be the return value of this method.
final @NotNull ObjectProperty<E>	targetProperty()	ObjectProperty that holds the target TElement.
protected void	tickCallback()	Callback method that is invoked automatically every GUI tick, if and after Node.getParent() ticks.

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, renderCallback, screenProperty, setBounds, setBounds, setBounds, showContextMenu, 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

THoverScrollElement

public THoverScrollElement()

THoverScrollElement

public THoverScrollElement(@NotNull
 E target)

Method Details

targetProperty

@NotNull
public final @NotNull ObjectProperty<E> targetProperty()

ObjectProperty that holds the target TElement.

directionProperty

@NotNull
public final @NotNull NotNullProperty<CompassDirection> directionProperty()

NotNullProperty that holds the scroll direction.

tickCallback

@Virtual
protected void tickCallback()

Description copied from class: TElement

Callback method that is invoked automatically every GUI tick, if and after Node.getParent() ticks.

For performance optimization reasons, this is invoked if this element is contained within its parent's TElement.getBounds().

Note that this is regardless of what TElement.isVisible() returns. The only requirements are the element being "within parent bounds" and the parent having ticked.

Overrides:

tickCallback in class TElement

shouldBeVisible

@Virtual
public boolean shouldBeVisible()

Each tick, tickCallback() sets TElement.visibleProperty() value to be the return value of this method.