Class TClickableWidget

java.lang.Object

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

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

com.thecsdev.commonmc.api.client.gui.widget.TClickableWidget

All Implemented Interfaces:

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

Direct Known Subclasses:

TButtonWidget, TCheckboxWidget, TSimpleTextFieldWidget

@Environment(CLIENT)
@Virtual
public class TClickableWidget
extends TElement

A TElement that can be clicked via mouse or keyboard inputs.

Field Summary

Fields

Modifier and Type	Field	Description
final Event<Consumer<TClickableWidget>>	eClicked	An Event that is invoked whenever this TClickableWidget is clicked.
protected static final Consumer<TClickableWidget>	ONCLICK_SOUND	Default event handler that plays a GUI click sound whenever this TClickableWidget is clicked.

Fields inherited from class TElement

eInitialized

Constructor Summary

Constructors

Constructor	Description
TClickableWidget()

Method Summary

Modifier and Type	Method	Description
final void	click()	Calls clickCallback() and invokes the eClicked event.
protected void	clickCallback()	Callback method that is invoked whenever this TClickableWidget is clicked.
protected void	dragEndCallback()	A callback method that is invoked whenever this TElement stops being dragged.
protected void	dragStartCallback()	A callback method that is invoked whenever this TElement starts being dragged.
final BooleanProperty	enabledProperty()	Returns a BooleanProperty that holds a Boolean value representing the "enabled" state of this TClickableWidget.
protected void	focusLostCallback()	A callback method that is invoked whenever this TElement loses focus.
@NotNull CursorType	getCursor()	Returns CursorType that represents the visual look the user's mouse cursor should have when this TElement is hovered.
protected void	hoverGainedCallback()	A callback method that is invoked whenever this TElement becomes hovered.
boolean	inputCallback(@NotNull TInputContext.InputDiscoveryPhase phase, @NotNull TInputContext context)	A callback method that is invoked when the user makes an input.
boolean	isFocusable()	Returns true if this TElement should be receiving focus via user input such as mouse and keyboard.
void	postRenderCallback(@NotNull TGuiGraphics pencil)	Callback method that is invoked after this Node and all of their children have been rendered.
final BooleanProperty	pressedProperty()	Returns a BooleanProperty that holds a Boolean value representing whether this TClickableWidget is currently being pressed.

Methods inherited from class TElement

addRel, boundsProperty, clearAndInit, clipsDescendantsProperty, contextMenuProperty, findElementAt, focusableProperty, focusGainedCallback, forEachVisible, getBaseType, getBounds, getClient, getContentBounds, getSelf, getTooltip, hoverableProperty, hoverLostCallback, initCallback, invalidateTooltipCache, isFocused, isHoverable, isHovered, isHoveredOrFocused, isVisible, move, moveChildren, moveTo, removeRel, renderCallback, 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

Field Details

eClicked

public final Event<Consumer<TClickableWidget>> eClicked

An Event that is invoked whenever this TClickableWidget is clicked. Usually via LMB or the Enter key.

The Consumer provides an instance of this for convenience.

ONCLICK_SOUND

protected static final Consumer<TClickableWidget> ONCLICK_SOUND

Default event handler that plays a GUI click sound whenever this TClickableWidget is clicked. If you do not prefer this, you may remove this handler via Event.removeListener(Object).

See Also:

• eClicked

Constructor Details

TClickableWidget

public TClickableWidget()

Method Details

enabledProperty

public final BooleanProperty enabledProperty()

Returns a BooleanProperty that holds a Boolean value representing the "enabled" state of this TClickableWidget. When "disabled", this TClickableWidget will not handle click-related inputs.

pressedProperty

public final BooleanProperty pressedProperty()

Returns a BooleanProperty that holds a Boolean value representing whether this TClickableWidget is currently being pressed.

click

public final void click()

Calls clickCallback() and invokes the eClicked event.

clickCallback

@Virtual
protected void clickCallback()

Callback method that is invoked whenever this TClickableWidget is clicked.

API Note:

Remember to call super when overriding this method!

getCursor

@Virtual
@NotNull
public @NotNull CursorType getCursor()

Description copied from class: TElement

Returns CursorType that represents the visual look the user's mouse cursor should have when this TElement is hovered.

Overrides:

getCursor in class TElement

isFocusable

@Virtual
public boolean isFocusable()

Description copied from class: TElement

Returns true if this TElement should be receiving focus via user input such as mouse and keyboard.

Overrides:

isFocusable in class TElement

See Also:

• TElement.focusableProperty()

hoverGainedCallback

@Virtual
protected void hoverGainedCallback()

Description copied from class: TElement

A callback method that is invoked whenever this TElement becomes hovered.

Overrides:

hoverGainedCallback in class TElement

See Also:

• TElement.isHovered()

dragStartCallback

@Virtual
protected void dragStartCallback()

Description copied from class: TElement

A callback method that is invoked whenever this TElement starts being dragged.

Overrides:

dragStartCallback in class TElement

See Also:

• TElement.isFocused()

dragEndCallback

@Virtual
protected void dragEndCallback()

Description copied from class: TElement

A callback method that is invoked whenever this TElement stops being dragged.

Overrides:

dragEndCallback in class TElement

See Also:

• TElement.isFocused()

focusLostCallback

@Virtual
protected void focusLostCallback()

Description copied from class: TElement

A callback method that is invoked whenever this TElement loses focus.

Overrides:

focusLostCallback in class TElement

See Also:

• TElement.isFocused()

inputCallback

@Virtual
public boolean inputCallback(@NotNull
 @NotNull TInputContext.InputDiscoveryPhase phase,
 @NotNull
 @NotNull TInputContext context)

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.

postRenderCallback

@Virtual
public 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.