common/io.github.notenoughupdates.moulconfig.gui.component/SwitchComponent

SwitchComponent

open class SwitchComponent : GuiComponent(source)

A gui element displaying a switch to represent a boolean value.

Constructors

SwitchComponent

constructor(value: GetSetter<Boolean>, timeToReachTarget: Int)

Functions

blur

open fun blur()

Unfocus this element only if this element is selected.

foldChildren

open fun <T> foldChildren(initial: T, @NotNull visitor: @NotNull BiFunction<@NotNull GuiComponent, T, T>): T

Walk over the direct children of this element.

foldRecursive

fun <T> foldRecursive(initial: T, @NotNull visitor: @NotNull BiFunction<@NotNull GuiComponent, T, T>): T

Walk the scene tree of this gui element, including children of children.

getHeight

open fun getHeight(): Int

Get the requested y size for this element.

getWidth

open fun getWidth(): Int

Get the requested x size for this element.

isFocused

open fun isFocused(): Boolean

Test if this element is focused.

isInFocus

open fun isInFocus(): Boolean

Test if this element is focused, or has a focused child.

keyboardEvent

open fun keyboardEvent(@NotNull event: @NotNull KeyboardEvent, @NotNull context: @NotNull GuiImmediateContext): Boolean

Called by the parent renderer.

mouseEvent

open fun mouseEvent(event: MouseEvent, context: GuiImmediateContext): Boolean

Called by the parent renderer.

onGainedFocus

open fun onGainedFocus()

This method is called by the gui context when an element gains focus.

onLostFocus

open fun onLostFocus()

This method is called by the gui context when an element loses focus.

render

open fun render(context: GuiImmediateContext)

Called by the parent renderer.

requestFocus

open fun requestFocus()

Call this method to request focus in the current gui context.

setContext

open fun setContext(context: GuiContext)

setFocus

open fun setFocus(shouldFocus: Boolean)

Focuses or blurs this element depending on shouldFocus