Class ToggleSwitchComponent

java.lang.Object

com.render.api.gui.GuiComponent<ContainerComponent>

com.render.api.gui.ContainerComponent

com.render.api.gui.PressableComponent<ToggleSwitchComponent>

com.render.api.gui.ToggleSwitchComponent

public class ToggleSwitchComponent
extends PressableComponent<ToggleSwitchComponent>

Animated on/off toggle switch with configurable track and knob styling.

Constructor Summary

Constructors

Constructor	Description
ToggleSwitchComponent()

Method Summary

Modifier and Type	Method	Description
protected void	activate()
ContainerComponent	add(GuiComponent<?> child)
ContainerComponent	alignContent(GuiAlignment alignment)
ContainerComponent	alignItems(GuiAlignment alignment)
ContainerComponent	alignSelf(GuiAlignment alignment)
ContainerComponent	anchor(GuiAnchor anchor)
ContainerComponent	anchorName(String name)
ContainerComponent	anchorPlacement(GuiAnchorPlacement placement)
ContainerComponent	animatedBorder(GuiAnimatedBorder animatedBorder)	Sets the animated border decoration.
ContainerComponent	animation(String name, GuiKeyframes keyframes)
ContainerComponent	applyStyle(GuiStylePreset preset)	Applies a reusable sparse style preset.
ContainerComponent	aspectRatio(GuiAspectRatio aspectRatio)
ContainerComponent	autoHeight()
ContainerComponent	autoSize()
ContainerComponent	autoWidth()
ContainerComponent	backdropFilters(GuiFilterChain filters)	Sets filters applied to the game and retained GUI content already painted behind this component.
ContainerComponent	backfaceVisibility(GuiBackfaceVisibility visibility)	Selects whether a transformed back face remains visible.
ContainerComponent	backgroundColor(RenderColor color)
ContainerComponent	backgroundLayer(GuiBackgroundLayer layer)
ContainerComponent	backgroundLayers(GuiBackgroundLayer... layers)
ContainerComponent	backgroundLayers(List<GuiBackgroundLayer> layers)	Replaces the ordered modern background-image layer list.
ContainerComponent	border(GuiBorder border)	Sets the typed per-side border.
ContainerComponent	borderCollapse(GuiBorderCollapse collapse)
ContainerComponent	borderColor(RenderColor color)
ContainerComponent	borderSpacing(float spacing)
ContainerComponent	borderWidth(float borderWidth)
ContainerComponent	boxDecorationBreak(GuiBoxDecorationBreak behavior)
ContainerComponent	boxGlow(GuiGlow glow)	Sets the glow painted around this component's box.
ContainerComponent	boxShadow(GuiShadow shadow)	Sets the drop shadow painted behind this component's box.
ContainerComponent	boxShadows(GuiBoxShadow... shadows)
ContainerComponent	boxShadows(List<GuiBoxShadow> shadows)
ContainerComponent	boxSizing(GuiBoxSizing boxSizing)
ContainerComponent	breakAfter(GuiBreakValue value)
ContainerComponent	breakBefore(GuiBreakValue value)
ContainerComponent	breakInside(GuiBreakValue value)
ContainerComponent	cancel(String name)
ContainerComponent	captionSide(GuiCaptionSide side)
ContainerComponent	caretStyle(GuiCaretStyle caretStyle)	Sets the editable-text caret appearance inherited by the CARET pseudo-element.
ContainerComponent	centered()
List<GuiComponent<?>>	children()
ContainerComponent	clearChildren()
ContainerComponent	clipChildren(boolean clipChildren)	Sets whether child content is clipped to this component's content bounds.
ContainerComponent	clipPath(GuiClipPath path)	Sets the component clip path, or null to remove it.
ContainerComponent	color(RenderColor color)
ContainerComponent	columnCount(int count)
ContainerComponent	columnFill(GuiColumnFill fill)
ContainerComponent	columnGap(GuiLength gap)
ContainerComponent	columnRule(GuiBorderSide rule)
ContainerComponent	columnSpan(GuiColumnSpan span)
ContainerComponent	columnWidth(GuiLength width)
final Optional<GuiComputedStyle>	computedStyle()	Returns the latest computed modern style.
ContainerComponent	contextMenu(ContextMenuComponent contextMenu)
ContainerComponent	cornerRadius(float cornerRadius)
protected final void	defaultDisplay(GuiDisplay display)	Defines the formatting role supplied by a component type before authored styles and fluent inline declarations are applied.
protected void	defineModernDefaults(GuiStyleBuilder defaults)	Adds stylesheet-overridable defaults for this component type.
final Set<GuiDirtyCategory>	dirtyCategories()	Returns current modern invalidation categories.
ContainerComponent	disabled(Consumer<ContainerComponent> consumer)
ContainerComponent	display(GuiDisplay display)
ContainerComponent	emptyCells(GuiEmptyCells value)
boolean	enabled()
ContainerComponent	enabled(boolean enabled)
ContainerComponent	filters(GuiFilterChain filters)	Sets the ordered foreground filter chain.
final Optional<GuiComponent<?>>	findById(String id)	Finds the uniquely identified component in this retained subtree.
final <C extends GuiComponent<?>> Optional<C>	findById(String id, Class<C> componentType)	Finds and type-checks a uniquely identified component in this retained subtree.
ContainerComponent	flexBasis(GuiLength basis)
ContainerComponent	flexDirection(GuiFlexDirection direction)
ContainerComponent	flexGrow(float grow)
ContainerComponent	flexShrink(float shrink)
ContainerComponent	flexWrap(GuiFlexWrap wrap)
boolean	focused()	Returns whether this component currently owns keyboard focus.
ContainerComponent	focused(Consumer<ContainerComponent> consumer)
final GuiFragmentTree	fragmentTree()	Returns the latest page/column fragment projection rooted at this component.
ContainerComponent	glow(GuiGlow glow)
ContainerComponent	gradient(GuiGradient gradient)
ContainerComponent	gridAutoFlow(GuiGridAutoFlow flow)
ContainerComponent	gridPlacement(GuiGridPlacement placement)
ContainerComponent	gridTemplate(GuiGridTemplate template)
float	height()
ContainerComponent	height(float height)
ContainerComponent	height(GuiLength height)	Sets a typed modern height.
ContainerComponent	hovered(Consumer<ContainerComponent> consumer)
String	id()	Returns this component's optional stable identifier.
ContainerComponent	id(String id)	Assigns this component's optional stable identifier.
final boolean	indeterminate()
ToggleSwitchComponent	indeterminate(boolean indeterminate)	Configures this switch as a tri-state mixed value for :indeterminate.
ToggleSwitchComponent	initialValue(boolean value)	Sets the value and immediately snaps the visual knob/track state without playing the value animation.
ContainerComponent	inlineStyle(Consumer<GuiStyleBuilder> declarations)	Adds typed high-priority inline declarations for modern mode.
ContainerComponent	inset(GuiLength all)
ContainerComponent	inset(GuiLength top, GuiLength right, GuiLength bottom, GuiLength left)
final GuiIntrinsicSize	intrinsicSize()	Returns intrinsic contributions from the latest modern measure pass.
protected final void	invalidateModernDefaults()	Invalidates cached declarations after state used by defineModernDefaults(GuiStyleBuilder) changes.
protected final void	invalidateModernLayout(String reason)
boolean	isClippingChildren()	Returns whether child content is clipped to this component's content bounds.
ContainerComponent	justifyContent(GuiAlignment alignment)
ContainerComponent	justifyItems(GuiAlignment alignment)
ContainerComponent	justifySelf(GuiAlignment alignment)
ToggleSwitchComponent	knobColor(RenderColor knobColor)
ToggleSwitchComponent	knobColors(RenderColor offColor, RenderColor onColor)
ToggleSwitchComponent	knobRadius(float knobRadius)
final String	lastInvalidationReason()	Returns the latest invalidation reason for devtools.
final List<GuiLayoutFragment>	layoutFragments()	Returns final modern layout fragments.
ContainerComponent	listStyleImage(GuiListMarkerImage image)	Replaces the automatic text marker with an explicitly sized image.
ContainerComponent	listStylePosition(GuiListStylePosition position)	Places the automatic marker inside the first line or in an outside marker column.
ContainerComponent	listStyleType(GuiCounterStyle style)	Selects the list counter style used by an automatic ::marker.
ContainerComponent	margin(float all)
ContainerComponent	margin(float vertical, float horizontal)
ContainerComponent	margin(float top, float right, float bottom, float left)
ContainerComponent	marginBreak(GuiMarginBreak value)
ContainerComponent	markerGap(float gap)	Sets the space between an outside marker and the principal box.
ContainerComponent	markerSide(GuiMarkerSide side)	Selects which writing direction determines the outside marker side.
ContainerComponent	maskLayers(GuiMaskLayer... layers)	Replaces the ordered mask-layer list.
ContainerComponent	maskLayers(List<GuiMaskLayer> layers)	Replaces the ordered mask-layer list.
final boolean	matchesStyleState(GuiStyleState state)	Tests a standard or custom modern selector state.
ContainerComponent	maxHeight(GuiLength height)
ContainerComponent	maxWidth(GuiLength width)
ContainerComponent	minHeight(GuiLength height)
ContainerComponent	minWidth(GuiLength width)
ContainerComponent	motionPath(GuiMotionPath path)	Sets the post-layout path followed by this component.
ToggleSwitchComponent	onChange(Consumer<Boolean> onChange)
ContainerComponent	opacity(float opacity)
ContainerComponent	order(int order)
ContainerComponent	orphans(int lines)
ContainerComponent	outline(GuiOutline outline)
ContainerComponent	padding(float all)
ContainerComponent	padding(float vertical, float horizontal)
ContainerComponent	padding(float top, float right, float bottom, float left)
ContainerComponent	pageName(String name)
GuiComponent<?>	parent()
ContainerComponent	pause(String name)
ContainerComponent	play(String name)
ContainerComponent	position(float x, float y)
ContainerComponent	position(GuiPositionType positionType)
ContainerComponent	pressed(Consumer<ContainerComponent> consumer)
final Optional<GuiPseudoElementComponent>	pseudoElementBox(GuiPseudoElement pseudoElement)	Returns a stable generated pseudo-element box for BEFORE, AFTER, or MARKER after a matching modern rule has resolved.
final Optional<GuiComputedStyle>	pseudoElementStyle(GuiPseudoElement pseudoElement)	Returns a paint-only or generated pseudo-element's computed style.
ContainerComponent	quotes(GuiQuotePairs quotes)	Selects generated open/close quote pairs.
final GuiRangeState	rangeState()
ContainerComponent	rangeState(GuiRangeState rangeState)	Sets the optional range pseudo-state for numeric and custom controls.
final boolean	readOnly()
ContainerComponent	readOnly(boolean readOnly)	Makes this control read-only for selector and interaction semantics.
ContainerComponent	remove(GuiComponent<?> child)
ContainerComponent	removeStyleClass(String styleClass)	Removes a selector-visible style class.
protected final void	renderChildren(com.render.api.gui.GuiRenderContext context)
protected void	renderSelf(com.render.api.gui.GuiRenderContext context)
ContainerComponent	replaceChildren(GuiComponent<?>... replacements)	Varargs form of replaceChildren(List).
ContainerComponent	replaceChildren(List<? extends GuiComponent<?>> replacements)	Replaces source children while treating an identical retained identity/order sequence as a no-op.
ContainerComponent	requestFocus()
final boolean	required()
ContainerComponent	required(boolean required)	Sets whether this component participates in required/optional form styling.
ContainerComponent	resume(String name)
ContainerComponent	rowGap(GuiLength gap)
ContainerComponent	scrollMargin(float all)	Sets a uniform snap-area expansion.
ContainerComponent	scrollMargin(GuiScrollInsets margin)	Sets the target's snap-area expansion.
ContainerComponent	scrollSnapStop(GuiScrollSnapStop stop)	Selects whether a snap operation may pass this target.
protected final ContainerComponent	self()
ContainerComponent	shadow(GuiShadow shadow)
ContainerComponent	size(float width, float height)
ContainerComponent	size(GuiLength width, GuiLength height)
ContainerComponent	startingStyle(Consumer<GuiStyleBuilder> declarations)	Defines typed values used when this component first enters the styled tree.
ContainerComponent	stateProvider(GuiStateProvider provider)	Adds a dynamic state provider.
<V> Optional<V>	styleAttribute(GuiStyleAttribute<V> attribute)	Reads a typed style attribute.
<V> ContainerComponent	styleAttribute(GuiStyleAttribute<V> attribute, V value)	Sets a typed selector-visible component attribute.
ContainerComponent	styleClass(String... classes)	Adds one or more selector-visible style classes.
Set<String>	styleClasses()	Returns immutable selector-visible style classes.
final Set<GuiPseudoElement>	styledPseudoElements()	Returns pseudo-elements with a currently matched modern rule.
protected boolean	styleOpen()	Allows controls with retained popup/expansion state to implement :open.
ContainerComponent	styleState(GuiPseudoClass pseudoClass, boolean active)	Sets an explicit standard pseudo-class value.
ContainerComponent	styleState(String state, boolean active)	Sets a component-defined selector state.
int	tabIndex()	Returns this component's sequential focus index.
ContainerComponent	tabIndex(int tabIndex)	Sets this component's sequential keyboard-focus order.
ContainerComponent	tableLayout(GuiTableLayout layout)
protected void	tick()
ContainerComponent	tooltip(TooltipComponent tooltip)
ToggleSwitchComponent	trackBorderColors(RenderColor offColor, RenderColor onColor)
ToggleSwitchComponent	trackOffColor(RenderColor trackOffColor)
ToggleSwitchComponent	trackOnColor(RenderColor trackOnColor)
ContainerComponent	transform(GuiTransform transform)	Sets the immutable post-layout transform list for this component subtree.
ContainerComponent	transformBox(GuiTransformBox box)	Selects the component box used to resolve transforms.
ContainerComponent	transformOrigin(GuiTransformOrigin origin)	Sets the normalized origin around which transforms are applied.
ContainerComponent	transformStyle(GuiTransformStyle transformStyle)	Selects flat or preserve-3D descendant transform behavior.
ContainerComponent	transition(double durationSeconds, double delaySeconds, GuiEasing easing, GuiProperty<?>... properties)
ContainerComponent	transition(double durationSeconds, double delaySeconds, GuiEasing easing, GuiPropertyGroup... groups)
ContainerComponent	transition(double durationSeconds, double delaySeconds, GuiEasing easing, GuiTransitionBehavior behavior, GuiStyleProperty<?>... properties)	Transitions selected typed modern properties.
ContainerComponent	transition(double durationSeconds, GuiEasing easing, GuiProperty<?>... properties)
ContainerComponent	transition(double durationSeconds, GuiEasing easing, GuiPropertyGroup... groups)
ContainerComponent	transition(double durationSeconds, GuiEasing easing, GuiTransitionBehavior behavior, GuiStyleProperty<?>... properties)
ContainerComponent	transitionAll(double durationSeconds, double delaySeconds, GuiEasing easing)
ContainerComponent	transitionAll(double durationSeconds, double delaySeconds, GuiEasing easing, GuiTransitionBehavior behavior)	Transitions every modern property, optionally including discrete values.
ContainerComponent	transitionAll(double durationSeconds, GuiEasing easing)
ContainerComponent	translate(float translateX, float translateY)
ContainerComponent	translateX(float translateX)
ContainerComponent	translateY(float translateY)
ContainerComponent	updateWhenChanged(String channel, long revision, Consumer<ContainerComponent> updater)	Allocation-free steady-state revision overload of updateWhenChanged(String, Object, Consumer).
ContainerComponent	updateWhenChanged(String channel, Object snapshot, Consumer<ContainerComponent> updater)	Runs a retained update only when its immutable equality snapshot changes.
final GuiValidity	validity()
ContainerComponent	validity(GuiValidity validity)	Sets semantic validity independently of edit-time input filtering.
boolean	value()
ToggleSwitchComponent	value(boolean value)
ContainerComponent	verticalAlign(GuiVerticalAlign verticalAlign)
final String	viewTransitionName()	Returns this component's explicit view-transition name.
ContainerComponent	viewTransitionName(String name)	Assigns the stable name used to pair this component's old and new view-transition snapshots.
boolean	visible()
ContainerComponent	visible(boolean visible)
ContainerComponent	widows(int lines)
float	width()
ContainerComponent	width(float width)
ContainerComponent	width(GuiLength width)	Sets a typed modern width.
protected final <V> void	writeModernInline(GuiStyleProperty<V> property, V value)
float	x()
ContainerComponent	x(float x)
float	y()
ContainerComponent	y(float y)
ContainerComponent	zIndex(int zIndex)

Methods inherited from class PressableComponent

handlesMouseClick, isFocusable, onKeyPressed, onMouseClicked, onMouseReleased, onPress, selfTyped

Methods inherited from class ContainerComponent

childLayout, flowColumn, flowRow, gap, layout, preferredHeight, preferredWidth, resolveBaseProperties, stack

Methods inherited from class GuiComponent

activeStateStyle, childGap, childLayoutViewport, childOffsetX, childOffsetY, clipsChildren, containsChildClipPoint, framePreparationRequired, handlesMouseScroll, layoutChildren, onCharTyped, onFocusChanged, onModernLayoutComplete, onMouseDragged, onMouseScrolled, paint, preferredHeightForWidth, renderClippedChildren, renderOverlay, shouldRouteToChildren, writeTextShadow, writingState

Methods inherited from class Object

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

Constructor Details

ToggleSwitchComponent

public ToggleSwitchComponent()

Method Details

value

public ToggleSwitchComponent value(boolean value)

initialValue

public ToggleSwitchComponent initialValue(boolean value)

Sets the value and immediately snaps the visual knob/track state without playing the value animation.

Parameters:

value - new value

Returns:

this component

value

public boolean value()

indeterminate

public ToggleSwitchComponent indeterminate(boolean indeterminate)

Configures this switch as a tri-state mixed value for :indeterminate.

Parameters:

indeterminate - mixed state

Returns:

this component

onChange

public ToggleSwitchComponent onChange(Consumer<Boolean> onChange)

trackOffColor

public ToggleSwitchComponent trackOffColor(RenderColor trackOffColor)

trackOnColor

public ToggleSwitchComponent trackOnColor(RenderColor trackOnColor)

trackBorderColors

public ToggleSwitchComponent trackBorderColors(RenderColor offColor,
 RenderColor onColor)

knobColor

public ToggleSwitchComponent knobColor(RenderColor knobColor)

knobColors

public ToggleSwitchComponent knobColors(RenderColor offColor,
 RenderColor onColor)

knobRadius

public ToggleSwitchComponent knobRadius(float knobRadius)

activate

protected void activate()

Overrides:

activate in class PressableComponent<ToggleSwitchComponent>

tick

protected void tick()

Overrides:

tick in class GuiComponent<ContainerComponent>

renderSelf

protected void renderSelf(com.render.api.gui.GuiRenderContext context)

Overrides:

renderSelf in class ContainerComponent

add

public ContainerComponent add(GuiComponent<?> child)

remove

public ContainerComponent remove(GuiComponent<?> child)

clearChildren

public ContainerComponent clearChildren()

replaceChildren

public ContainerComponent replaceChildren(List<? extends GuiComponent<?>> replacements)

Replaces source children while treating an identical retained identity/order sequence as a no-op.

Reuse component instances. Newly allocated look-alikes are intentionally considered different because callbacks, focus, animation, and resource ownership cannot be compared safely.

Parameters:

replacements - desired source children in paint order

Returns:

this component

replaceChildren

public ContainerComponent replaceChildren(GuiComponent<?>... replacements)

Varargs form of replaceChildren(List).

Parameters:

replacements - desired source children in paint order

Returns:

this component

updateWhenChanged

public ContainerComponent updateWhenChanged(String channel,
 Object snapshot,
 Consumer<ContainerComponent> updater)

Runs a retained update only when its immutable equality snapshot changes.

Use this around coarse synchronization code that would otherwise clear/rebuild a subtree every tick. Prefer direct setters for individual values. Channels are component-local and limited to 32 retained snapshots; the oldest is discarded when the limit is exceeded. Snapshots should be immutable scalars, strings, records, or immutable lists.

Parameters:

channel - stable name for this update source

snapshot - immutable equality value representing the input state

updater - update executed only after a changed snapshot

Returns:

this component

updateWhenChanged

public ContainerComponent updateWhenChanged(String channel,
 long revision,
 Consumer<ContainerComponent> updater)

Allocation-free steady-state revision overload of updateWhenChanged(String, Object, Consumer).

Parameters:

channel - stable name for this update source

revision - monotonically changing model or content revision

updater - update executed only after a changed revision

Returns:

this component

children

public List<GuiComponent<?>> children()

parent

public GuiComponent<?> parent()

x

public float x()

y

public float y()

width

public float width()

height

public float height()

visible

public boolean visible()

enabled

public boolean enabled()

focused

public boolean focused()

Returns whether this component currently owns keyboard focus.

Returns:

true when focused

readOnly

public ContainerComponent readOnly(boolean readOnly)

Makes this control read-only for selector and interaction semantics.

Parameters:

readOnly - read-only state

Returns:

this component

readOnly

public final boolean readOnly()

required

public ContainerComponent required(boolean required)

Sets whether this component participates in required/optional form styling.

Parameters:

required - required state

Returns:

this component

required

public final boolean required()

validity

public ContainerComponent validity(GuiValidity validity)

Sets semantic validity independently of edit-time input filtering.

Parameters:

validity - validation state

Returns:

this component

validity

public final GuiValidity validity()

rangeState

public ContainerComponent rangeState(GuiRangeState rangeState)

Sets the optional range pseudo-state for numeric and custom controls.

Parameters:

rangeState - range state

Returns:

this component

rangeState

public final GuiRangeState rangeState()

indeterminate

public final boolean indeterminate()

matchesStyleState

public final boolean matchesStyleState(GuiStyleState state)

Tests a standard or custom modern selector state.

Parameters:

state - state query

Returns:

active flag

computedStyle

public final Optional<GuiComputedStyle> computedStyle()

Returns the latest computed modern style.

Returns:

computed style when this component has been resolved by a modern host

intrinsicSize

public final GuiIntrinsicSize intrinsicSize()

Returns intrinsic contributions from the latest modern measure pass.

Returns:

immutable intrinsic metrics

layoutFragments

public final List<GuiLayoutFragment> layoutFragments()

Returns final modern layout fragments. Modern layout normally produces one fragment per box; display:contents and display:none produce none.

Returns:

immutable fragment list

fragmentTree

public final GuiFragmentTree fragmentTree()

Returns the latest page/column fragment projection rooted at this component.

Returns:

immutable fragment tree, or an empty tree outside fragmentation

pseudoElementStyle

public final Optional<GuiComputedStyle> pseudoElementStyle(GuiPseudoElement pseudoElement)

Returns a paint-only or generated pseudo-element's computed style.

Parameters:

pseudoElement - pseudo-element

Returns:

computed style when a matching rule exists

styledPseudoElements

public final Set<GuiPseudoElement> styledPseudoElements()

Returns pseudo-elements with a currently matched modern rule.

Returns:

immutable pseudo-element set

pseudoElementBox

public final Optional<GuiPseudoElementComponent> pseudoElementBox(GuiPseudoElement pseudoElement)

Returns a stable generated pseudo-element box for BEFORE, AFTER, or MARKER after a matching modern rule has resolved.

Parameters:

pseudoElement - tree-abiding pseudo-element

Returns:

generated box when present

dirtyCategories

public final Set<GuiDirtyCategory> dirtyCategories()

Returns current modern invalidation categories.

Returns:

immutable dirty-category set

lastInvalidationReason

public final String lastInvalidationReason()

Returns the latest invalidation reason for devtools.

Returns:

reason

margin

public ContainerComponent margin(float all)

margin

public ContainerComponent margin(float vertical,
 float horizontal)

margin

public ContainerComponent margin(float top,
 float right,
 float bottom,
 float left)

padding

public ContainerComponent padding(float all)

padding

public ContainerComponent padding(float vertical,
 float horizontal)

padding

public ContainerComponent padding(float top,
 float right,
 float bottom,
 float left)

color

public ContainerComponent color(RenderColor color)

backgroundColor

public ContainerComponent backgroundColor(RenderColor color)

borderColor

public ContainerComponent borderColor(RenderColor color)

borderWidth

public ContainerComponent borderWidth(float borderWidth)

cornerRadius

public ContainerComponent cornerRadius(float cornerRadius)

opacity

public ContainerComponent opacity(float opacity)

shadow

public ContainerComponent shadow(GuiShadow shadow)

boxShadow

public ContainerComponent boxShadow(GuiShadow shadow)

Sets the drop shadow painted behind this component's box.

Parameters:

shadow - box shadow, or null

Returns:

this component

glow

public ContainerComponent glow(GuiGlow glow)

boxGlow

public ContainerComponent boxGlow(GuiGlow glow)

Sets the glow painted around this component's box.

Parameters:

glow - box glow, or null

Returns:

this component

gradient

public ContainerComponent gradient(GuiGradient gradient)

animatedBorder

public ContainerComponent animatedBorder(GuiAnimatedBorder animatedBorder)

Sets the animated border decoration.

The moving ring follows the border edge and its glow may extend outside this component's own clip path. Ancestor clips still constrain the decoration.

Parameters:

animatedBorder - animated border, or null

Returns:

this component

visible

public ContainerComponent visible(boolean visible)

caretStyle

public ContainerComponent caretStyle(GuiCaretStyle caretStyle)

Sets the editable-text caret appearance inherited by the CARET pseudo-element.

Parameters:

caretStyle - caret appearance

Returns:

this component

backgroundLayers

public ContainerComponent backgroundLayers(List<GuiBackgroundLayer> layers)

Replaces the ordered modern background-image layer list. The background color is painted below every layer.

Parameters:

layers - ordered bottom-to-top layers

Returns:

this component

backgroundLayers

public ContainerComponent backgroundLayers(GuiBackgroundLayer... layers)

backgroundLayer

public ContainerComponent backgroundLayer(GuiBackgroundLayer layer)

border

public ContainerComponent border(GuiBorder border)

Sets the typed per-side border. Later legacy border setters clear this value.

Parameters:

border - border value, or null

Returns:

this component

outline

public ContainerComponent outline(GuiOutline outline)

boxDecorationBreak

public ContainerComponent boxDecorationBreak(GuiBoxDecorationBreak behavior)

boxShadows

public ContainerComponent boxShadows(List<GuiBoxShadow> shadows)

boxShadows

public ContainerComponent boxShadows(GuiBoxShadow... shadows)

transform

public ContainerComponent transform(GuiTransform transform)

Sets the immutable post-layout transform list for this component subtree.

Parameters:

transform - ordered transform list

Returns:

this component

transformOrigin

public ContainerComponent transformOrigin(GuiTransformOrigin origin)

Sets the normalized origin around which transforms are applied.

Parameters:

origin - transform origin

Returns:

this component

transformBox

public ContainerComponent transformBox(GuiTransformBox box)

Selects the component box used to resolve transforms.

Parameters:

box - transform reference box

Returns:

this component

transformStyle

public ContainerComponent transformStyle(GuiTransformStyle transformStyle)

Selects flat or preserve-3D descendant transform behavior.

Parameters:

transformStyle - descendant transform behavior

Returns:

this component

backfaceVisibility

public ContainerComponent backfaceVisibility(GuiBackfaceVisibility visibility)

Selects whether a transformed back face remains visible.

Parameters:

visibility - back-face behavior

Returns:

this component

motionPath

public ContainerComponent motionPath(GuiMotionPath path)

Sets the post-layout path followed by this component.

Parameters:

path - motion-path declaration

Returns:

this component

clipPath

public ContainerComponent clipPath(GuiClipPath path)

Sets the component clip path, or null to remove it.

Parameters:

path - clip path

Returns:

this component

maskLayers

public ContainerComponent maskLayers(List<GuiMaskLayer> layers)

Replaces the ordered mask-layer list.

Parameters:

layers - mask layers in paint order

Returns:

this component

maskLayers

public ContainerComponent maskLayers(GuiMaskLayer... layers)

Replaces the ordered mask-layer list.

Parameters:

layers - mask layers in paint order

Returns:

this component

filters

public ContainerComponent filters(GuiFilterChain filters)

Sets the ordered foreground filter chain.

Parameters:

filters - foreground filters

Returns:

this component

backdropFilters

public ContainerComponent backdropFilters(GuiFilterChain filters)

Sets filters applied to the game and retained GUI content already painted behind this component. The component's own fill, border, and descendants are painted sharply after the clipped backdrop pass.

Parameters:

filters - backdrop filters

Returns:

this component

enabled

public ContainerComponent enabled(boolean enabled)

clipChildren

public ContainerComponent clipChildren(boolean clipChildren)

Sets whether child content is clipped to this component's content bounds.

Parameters:

clipChildren - whether to clip child content

Returns:

this component

isClippingChildren

public boolean isClippingChildren()

Returns whether child content is clipped to this component's content bounds.

Returns:

whether child content is clipped

requestFocus

public ContainerComponent requestFocus()

tooltip

public ContainerComponent tooltip(TooltipComponent tooltip)

contextMenu

public ContainerComponent contextMenu(ContextMenuComponent contextMenu)

applyStyle

public ContainerComponent applyStyle(GuiStylePreset preset)

Applies a reusable sparse style preset.

Parameters:

preset - preset to apply

Returns:

this component

inlineStyle

public ContainerComponent inlineStyle(Consumer<GuiStyleBuilder> declarations)

Adds typed high-priority inline declarations for modern mode.

Existing fluent setters write to the same precedence level. Cascade-wide INITIAL, INHERIT, and UNSET values are available through GuiStyleBuilder.set(GuiStyleProperty, T).

Parameters:

declarations - declaration callback

Returns:

this component

transitionAll

public ContainerComponent transitionAll(double durationSeconds,
 GuiEasing easing)

transitionAll

public ContainerComponent transitionAll(double durationSeconds,
 double delaySeconds,
 GuiEasing easing)

transitionAll

public ContainerComponent transitionAll(double durationSeconds,
 double delaySeconds,
 GuiEasing easing,
 GuiTransitionBehavior behavior)

Transitions every modern property, optionally including discrete values.

Parameters:

durationSeconds - duration in seconds

delaySeconds - non-negative delay

easing - timing function

behavior - discrete transition policy

Returns:

this component

transition

public ContainerComponent transition(double durationSeconds,
 double delaySeconds,
 GuiEasing easing,
 GuiTransitionBehavior behavior,
 GuiStyleProperty<?>... properties)

Transitions selected typed modern properties.

Parameters:

durationSeconds - duration in seconds

delaySeconds - non-negative delay

easing - timing function

behavior - discrete transition policy

properties - modern properties

Returns:

this component

transition

public ContainerComponent transition(double durationSeconds,
 GuiEasing easing,
 GuiTransitionBehavior behavior,
 GuiStyleProperty<?>... properties)

startingStyle

public ContainerComponent startingStyle(Consumer<GuiStyleBuilder> declarations)

Defines typed values used when this component first enters the styled tree.

Parameters:

declarations - starting declaration callback

Returns:

this component

transition

public ContainerComponent transition(double durationSeconds,
 GuiEasing easing,
 GuiProperty<?>... properties)

transition

public ContainerComponent transition(double durationSeconds,
 double delaySeconds,
 GuiEasing easing,
 GuiProperty<?>... properties)

transition

public ContainerComponent transition(double durationSeconds,
 GuiEasing easing,
 GuiPropertyGroup... groups)

transition

public ContainerComponent transition(double durationSeconds,
 double delaySeconds,
 GuiEasing easing,
 GuiPropertyGroup... groups)

hovered

public ContainerComponent hovered(Consumer<ContainerComponent> consumer)

pressed

public ContainerComponent pressed(Consumer<ContainerComponent> consumer)

focused

public ContainerComponent focused(Consumer<ContainerComponent> consumer)

disabled

public ContainerComponent disabled(Consumer<ContainerComponent> consumer)

animation

public ContainerComponent animation(String name,
 GuiKeyframes keyframes)

play

public ContainerComponent play(String name)

pause

public ContainerComponent pause(String name)

resume

public ContainerComponent resume(String name)

cancel

public ContainerComponent cancel(String name)

id

public ContainerComponent id(String id)

Assigns this component's optional stable identifier.

The identifier is visible to typed ID selectors, retained-tree lookup, devtools, and view-transition pairing. Recreating a component with the same ID morphs it from the old bounds to the new bounds. A null or blank value removes the identifier.

Parameters:

id - stable identifier, or null

Returns:

this component

id

public String id()

Returns this component's optional stable identifier.

Returns:

identifier, or null

findById

public final Optional<GuiComponent<?>> findById(String id)

Finds the uniquely identified component in this retained subtree.

The search includes this component. Duplicate IDs are rejected because lookup and morph-transition ownership would otherwise be ambiguous.

Parameters:

id - identifier to find

Returns:

matching component, when present

Throws:

IllegalStateException - when the subtree contains the ID more than once

findById

public final <C extends GuiComponent<?>>
Optional<C> findById(String id,
 Class<C> componentType)

Finds and type-checks a uniquely identified component in this retained subtree.

Type Parameters:

C - component type

Parameters:

id - identifier to find

componentType - required component type

Returns:

matching typed component, when present

Throws:

IllegalStateException - when the ID is duplicated

ClassCastException - when the matching component has another type

viewTransitionName

public ContainerComponent viewTransitionName(String name)

Assigns the stable name used to pair this component's old and new view-transition snapshots. This overrides the component ID for transition pairing. A null or blank name returns pairing to retained identity or ID.

Parameters:

name - transition name

Returns:

this component

viewTransitionName

public final String viewTransitionName()

Returns this component's explicit view-transition name.

Returns:

transition name, or null

styleClass

public ContainerComponent styleClass(String... classes)

Adds one or more selector-visible style classes.

Parameters:

classes - class names

Returns:

this component

removeStyleClass

public ContainerComponent removeStyleClass(String styleClass)

Removes a selector-visible style class.

Parameters:

styleClass - class name

Returns:

this component

styleClasses

public Set<String> styleClasses()

Returns immutable selector-visible style classes.

Returns:

style classes

styleAttribute

public <V> ContainerComponent styleAttribute(GuiStyleAttribute<V> attribute,
 V value)

Sets a typed selector-visible component attribute.

Type Parameters:

V - value type

Parameters:

attribute - attribute key

value - value, or null to remove

Returns:

this component

styleAttribute

public <V> Optional<V> styleAttribute(GuiStyleAttribute<V> attribute)

Reads a typed style attribute.

Type Parameters:

V - value type

Parameters:

attribute - attribute key

Returns:

value when present

styleState

public ContainerComponent styleState(GuiPseudoClass pseudoClass,
 boolean active)

Sets an explicit standard pseudo-class value.

Use this for semantic states such as checked, required, valid, or open. Pointer, focus, enabled, root, empty, and structural states are maintained by the runtime.

Parameters:

pseudoClass - pseudo-class

active - active flag

Returns:

this component

styleState

public ContainerComponent styleState(String state,
 boolean active)

Sets a component-defined selector state.

Parameters:

state - state name

active - active flag

Returns:

this component

stateProvider

public ContainerComponent stateProvider(GuiStateProvider provider)

Adds a dynamic state provider.

Parameters:

provider - provider

Returns:

this component

x

public ContainerComponent x(float x)

y

public ContainerComponent y(float y)

position

public ContainerComponent position(float x,
 float y)

translateX

public ContainerComponent translateX(float translateX)

translateY

public ContainerComponent translateY(float translateY)

translate

public ContainerComponent translate(float translateX,
 float translateY)

width

public ContainerComponent width(float width)

height

public ContainerComponent height(float height)

size

public ContainerComponent size(float width,
 float height)

autoWidth

public ContainerComponent autoWidth()

autoHeight

public ContainerComponent autoHeight()

autoSize

public ContainerComponent autoSize()

width

public ContainerComponent width(GuiLength width)

Sets a typed modern width. This declaration is used only by a modern host.

Parameters:

width - typed width

Returns:

this component

height

public ContainerComponent height(GuiLength height)

Sets a typed modern height.

Parameters:

height - typed height

Returns:

this component

size

public ContainerComponent size(GuiLength width,
 GuiLength height)

minWidth

public ContainerComponent minWidth(GuiLength width)

maxWidth

public ContainerComponent maxWidth(GuiLength width)

minHeight

public ContainerComponent minHeight(GuiLength height)

maxHeight

public ContainerComponent maxHeight(GuiLength height)

boxSizing

public ContainerComponent boxSizing(GuiBoxSizing boxSizing)

aspectRatio

public ContainerComponent aspectRatio(GuiAspectRatio aspectRatio)

display

public ContainerComponent display(GuiDisplay display)

defaultDisplay

protected final void defaultDisplay(GuiDisplay display)

Defines the formatting role supplied by a component type before authored styles and fluent inline declarations are applied.

This is intended for component constructors. Calling display(GuiDisplay) after construction still creates the higher-priority inline declaration.

Parameters:

display - default formatting role

defineModernDefaults

protected void defineModernDefaults(GuiStyleBuilder defaults)

Adds stylesheet-overridable defaults for this component type.

Fluent setters, including calls made by constructors, are inline declarations. Subclasses should override this hook when a value is a component default rather than an authored inline value.

Parameters:

defaults - builder receiving component defaults

invalidateModernDefaults

protected final void invalidateModernDefaults()

Invalidates cached declarations after state used by defineModernDefaults(GuiStyleBuilder) changes.

listStyleType

public ContainerComponent listStyleType(GuiCounterStyle style)

Selects the list counter style used by an automatic ::marker.

Parameters:

style - counter style

Returns:

this component

listStylePosition

public ContainerComponent listStylePosition(GuiListStylePosition position)

Places the automatic marker inside the first line or in an outside marker column.

Parameters:

position - marker position

Returns:

this component

listStyleImage

public ContainerComponent listStyleImage(GuiListMarkerImage image)

Replaces the automatic text marker with an explicitly sized image.

Parameters:

image - marker image, or null for generated counter text

Returns:

this component

markerSide

public ContainerComponent markerSide(GuiMarkerSide side)

Selects which writing direction determines the outside marker side.

Parameters:

side - marker-side policy

Returns:

this component

markerGap

public ContainerComponent markerGap(float gap)

Sets the space between an outside marker and the principal box.

Parameters:

gap - non-negative design-space gap

Returns:

this component

quotes

public ContainerComponent quotes(GuiQuotePairs quotes)

Selects generated open/close quote pairs.

Parameters:

quotes - quote pairs

Returns:

this component

scrollMargin

public ContainerComponent scrollMargin(GuiScrollInsets margin)

Sets the target's snap-area expansion.

Parameters:

margin - scroll margin

Returns:

this component

scrollMargin

public ContainerComponent scrollMargin(float all)

Sets a uniform snap-area expansion.

Parameters:

all - margin on every side

Returns:

this component

scrollSnapStop

public ContainerComponent scrollSnapStop(GuiScrollSnapStop stop)

Selects whether a snap operation may pass this target.

Parameters:

stop - stop policy

Returns:

this component

position

public ContainerComponent position(GuiPositionType positionType)

inset

public ContainerComponent inset(GuiLength all)

inset

public ContainerComponent inset(GuiLength top,
 GuiLength right,
 GuiLength bottom,
 GuiLength left)

verticalAlign

public ContainerComponent verticalAlign(GuiVerticalAlign verticalAlign)

flexDirection

public ContainerComponent flexDirection(GuiFlexDirection direction)

flexWrap

public ContainerComponent flexWrap(GuiFlexWrap wrap)

flexGrow

public ContainerComponent flexGrow(float grow)

flexShrink

public ContainerComponent flexShrink(float shrink)

flexBasis

public ContainerComponent flexBasis(GuiLength basis)

order

public ContainerComponent order(int order)

justifyContent

public ContainerComponent justifyContent(GuiAlignment alignment)

alignItems

public ContainerComponent alignItems(GuiAlignment alignment)

alignSelf

public ContainerComponent alignSelf(GuiAlignment alignment)

alignContent

public ContainerComponent alignContent(GuiAlignment alignment)

rowGap

public ContainerComponent rowGap(GuiLength gap)

columnGap

public ContainerComponent columnGap(GuiLength gap)

gridTemplate

public ContainerComponent gridTemplate(GuiGridTemplate template)

gridPlacement

public ContainerComponent gridPlacement(GuiGridPlacement placement)

gridAutoFlow

public ContainerComponent gridAutoFlow(GuiGridAutoFlow flow)

justifyItems

public ContainerComponent justifyItems(GuiAlignment alignment)

justifySelf

public ContainerComponent justifySelf(GuiAlignment alignment)

tableLayout

public ContainerComponent tableLayout(GuiTableLayout layout)

borderCollapse

public ContainerComponent borderCollapse(GuiBorderCollapse collapse)

borderSpacing

public ContainerComponent borderSpacing(float spacing)

captionSide

public ContainerComponent captionSide(GuiCaptionSide side)

emptyCells

public ContainerComponent emptyCells(GuiEmptyCells value)

columnCount

public ContainerComponent columnCount(int count)

columnWidth

public ContainerComponent columnWidth(GuiLength width)

columnFill

public ContainerComponent columnFill(GuiColumnFill fill)

columnRule

public ContainerComponent columnRule(GuiBorderSide rule)

columnSpan

public ContainerComponent columnSpan(GuiColumnSpan span)

breakBefore

public ContainerComponent breakBefore(GuiBreakValue value)

breakAfter

public ContainerComponent breakAfter(GuiBreakValue value)

breakInside

public ContainerComponent breakInside(GuiBreakValue value)

widows

public ContainerComponent widows(int lines)

orphans

public ContainerComponent orphans(int lines)

marginBreak

public ContainerComponent marginBreak(GuiMarginBreak value)

pageName

public ContainerComponent pageName(String name)

anchorName

public ContainerComponent anchorName(String name)

anchorPlacement

public ContainerComponent anchorPlacement(GuiAnchorPlacement placement)

anchor

public ContainerComponent anchor(GuiAnchor anchor)

centered

public ContainerComponent centered()

zIndex

public ContainerComponent zIndex(int zIndex)

tabIndex

public ContainerComponent tabIndex(int tabIndex)

Sets this component's sequential keyboard-focus order.

Positive values are visited first in ascending order, zero follows retained-tree order, and negative values opt out of Tab traversal while preserving mouse and programmatic focus.

Parameters:

tabIndex - sequential focus index

Returns:

this component

tabIndex

public int tabIndex()

Returns this component's sequential focus index.

Returns:

focus index

writeModernInline

protected final <V> void writeModernInline(GuiStyleProperty<V> property,
 V value)

invalidateModernLayout

protected final void invalidateModernLayout(String reason)

styleOpen

protected boolean styleOpen()

Allows controls with retained popup/expansion state to implement :open.

self

protected final ContainerComponent self()

renderChildren

protected final void renderChildren(com.render.api.gui.GuiRenderContext context)