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

MetaComponent

class MetaComponent(val beforeClose: Supplier<CloseEventListener.CloseAction>? = null, val afterClose: Runnable? = null, val requestClose: GetSetter<Runnable>? = null) : GuiComponent, CloseEventListener(source)

Component providing XML wrappers and such the ability to wrap meta operations that operate on the entire screen. This component should be permanently mounted and does not impact layouting or rendering.

Constructors

MetaComponent

constructor(beforeClose: Supplier<CloseEventListener.CloseAction>? = null, afterClose: Runnable? = null, requestClose: GetSetter<Runnable>? = null)

Properties

afterClose

val afterClose: Runnable? = null

beforeClose

val beforeClose: Supplier<CloseEventListener.CloseAction>? = null

requestClose

val requestClose: GetSetter<Runnable>? = null

Functions

blur

open fun blur()

Unfocus this element only if this element is selected.

foldChildren

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

Walk over the direct children of this element. A gui element that composites other gui elements should override this method. By default, the initial element is returned without change.

foldRecursive

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

Walk the scene tree of this gui element, including children of children. By default, the visitor is called with only this element.

getHeight

open override fun getHeight(): Int

Get the requested y size for this element. This is opposed to the actual size given in the context. Giving this element less space than this may result in misaligned or overlapping rendering.

getWidth

open override fun getWidth(): Int

Get the requested x size for this element. This is opposed to the actual size given in the context. Giving this element less space than this may result in misaligned or overlapping rendering.

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(@NotNull mouseEvent: @NotNull MouseEvent, @NotNull context: @NotNull GuiImmediateContext): Boolean

Called by the parent renderer.

onAfterClose

open override fun onAfterClose()

Called after the gui has been closed, both by the component gui, or by other actors, such as a teleport packet.

onBeforeClose

open override fun onBeforeClose(): CloseEventListener.CloseAction

Called just before a voluntary close. Return CloseAction.DENY_CLOSE to override the close. Make sure to update your state such that the user can close the gui afterward.

onGainedFocus

open fun onGainedFocus()

This method is called by the gui context when an element gains focus. This does only get called if this element specifically is being focused.

onLostFocus

open fun onLostFocus()

This method is called by the gui context when an element loses focus. This does only get called if this element specifically was focused.

render

open override fun render(context: GuiImmediateContext)

Called by the parent renderer. The GL matrix stack is pre-transformed, so rendering can begin at (0, 0) and should not render beyond what the context says is available.

requestFocus

open fun requestFocus()

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

setContext

open override fun setContext(context: GuiContext?)

setFocus

open fun setFocus(shouldFocus: Boolean)

Focuses or blurs this element depending on shouldFocus