Package space.maxus.flare.ui.compose

Class RootReferencing

java.lang.Object

space.maxus.flare.ui.compose.RootReferencing

All Implemented Interfaces:

Composable, ComposableLike

public abstract class RootReferencing
extends Object
implements Composable

An abstract class for component implementations that automatically handles root frame injection

Field Summary

Fields

Modifier and Type	Field	Description
protected final AtomicReference<Frame>	root	The root frame

Constructor Summary

Constructors

Constructor	Description
RootReferencing()

Method Summary

Modifier and Type	Method	Description
void	injectRoot(Frame root)	Injects frame into this component, the frame can then be retrieved from Composable.root()
@NotNull PackedComposable	inside(@NotNull ComposableSpace space)	Fits this composable inside the provided space, essentially returning a pair of this component and the space in the form of a PackedComposable.
void	markDirty()	Marks this component dirty, meaning its area will be redrawn next tick.
Frame	root()	Returns the frame this component belongs to

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface space.maxus.flare.ui.Composable

asComposable, bind, click, context, contextOrNull, destroy, drag, into, leftClick, renderAt, restore, rightClick, shiftFrom, shiftInto, viewer

Field Details

root

protected final AtomicReference<Frame> root

The root frame

Constructor Details

RootReferencing

public RootReferencing()

Method Details

root

public Frame root()

Description copied from interface: Composable

Returns the frame this component belongs to

Specified by:

root in interface Composable

Returns:

The frame this component belongs to

injectRoot

public void injectRoot(Frame root)

Description copied from interface: Composable

Injects frame into this component, the frame can then be retrieved from Composable.root()

Specified by:

injectRoot in interface Composable

Parameters:

root - Frame to be injected

inside

@NotNull
public @NotNull PackedComposable inside(@NotNull
 @NotNull ComposableSpace space)

Description copied from interface: Composable

Fits this composable inside the provided space, essentially returning a pair of this component and the space in the form of a PackedComposable.

Specified by:

inside in interface Composable

Specified by:

inside in interface ComposableLike

Parameters:

space - Space to fit inside

Returns:

A pair of this component and the space in the form of a PackedComposable

markDirty

public void markDirty()

Description copied from interface: Composable

Marks this component dirty, meaning its area will be redrawn next tick.

Specified by:

markDirty in interface Composable