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()
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.
ToggleSwitchComponent	knobColor(int knobArgb)	Deprecated. Use knobColor(RenderColor).
ToggleSwitchComponent	knobColor(RenderColor knobColor)
ToggleSwitchComponent	knobColors(RenderColor offColor, RenderColor onColor)
ToggleSwitchComponent	knobRadius(float knobRadius)
ToggleSwitchComponent	onChange(Consumer<Boolean> onChange)
protected void	renderSelf(com.render.api.gui.GuiRenderContext context)
protected void	tick()
ToggleSwitchComponent	trackBorderColors(RenderColor offColor, RenderColor onColor)
ToggleSwitchComponent	trackOffColor(int trackOffArgb)	Deprecated. Use trackOffColor(RenderColor).
ToggleSwitchComponent	trackOffColor(RenderColor trackOffColor)
ToggleSwitchComponent	trackOnColor(int trackOnArgb)	Deprecated. Use trackOnColor(RenderColor).
ToggleSwitchComponent	trackOnColor(RenderColor trackOnColor)
boolean	value()
ToggleSwitchComponent	value(boolean value)

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, add, alignContent, alignItems, alignSelf, anchor, anchorName, anchorPlacement, animatedBorder, animation, applyStyle, aspectRatio, autoHeight, autoSize, autoWidth, backdropFilters, backfaceVisibility, backgroundColor, backgroundColor, backgroundLayer, backgroundLayers, backgroundLayers, border, borderCollapse, borderColor, borderColor, borderSpacing, borderWidth, boxDecorationBreak, boxGlow, boxShadow, boxShadows, boxShadows, boxSizing, breakAfter, breakBefore, breakInside, cancel, captionSide, caretStyle, centered, childGap, childLayoutViewport, childOffsetX, childOffsetY, children, clearChildren, clipChildren, clipPath, clipsChildren, color, color, columnCount, columnFill, columnGap, columnRule, columnSpan, columnWidth, computedStyle, containsChildClipPoint, contextMenu, cornerRadius, defaultDisplay, dirtyCategories, disabled, display, emptyCells, enabled, enabled, filters, findById, findById, flexBasis, flexDirection, flexGrow, flexShrink, flexWrap, focused, focused, fragmentTree, glow, gradient, gridAutoFlow, gridPlacement, gridTemplate, handlesMouseScroll, height, height, height, hovered, id, id, indeterminate, inlineStyle, inset, inset, intrinsicSize, invalidateModernLayout, isClippingChildren, justifyContent, justifyItems, justifySelf, lastInvalidationReason, layoutChildren, layoutFragments, listStyleImage, listStylePosition, listStyleType, margin, margin, margin, marginBreak, markerGap, markerSide, maskLayers, maskLayers, matchesStyleState, maxHeight, maxWidth, minHeight, minWidth, motionPath, onCharTyped, onFocusChanged, onModernLayoutComplete, onMouseDragged, onMouseScrolled, opacity, order, orphans, outline, padding, padding, padding, pageName, paint, parent, pause, play, position, position, preferredHeightForWidth, pressed, pseudoElementBox, pseudoElementStyle, quotes, rangeState, rangeState, readOnly, readOnly, remove, removeStyleClass, renderChildren, renderClippedChildren, renderOverlay, requestFocus, required, required, resume, rowGap, scrollMargin, scrollMargin, scrollSnapStop, self, shadow, shouldRouteToChildren, size, size, startingStyle, stateProvider, styleAttribute, styleAttribute, styleClass, styleClasses, styledPseudoElements, styleOpen, styleState, styleState, tabIndex, tabIndex, tableLayout, tooltip, transform, transformBox, transformOrigin, transformStyle, transition, transition, transition, transition, transition, transition, transitionAll, transitionAll, transitionAll, translate, translateX, translateY, validity, validity, verticalAlign, viewTransitionName, viewTransitionName, visible, visible, widows, width, width, width, writeModernInline, writeTextShadow, writingState, x, x, y, y, zIndex

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.

Overrides:

indeterminate in class GuiComponent<ContainerComponent>

Parameters:

indeterminate - mixed state

Returns:

this component

onChange

public ToggleSwitchComponent onChange(Consumer<Boolean> onChange)

trackOffColor

public ToggleSwitchComponent trackOffColor(RenderColor trackOffColor)

trackOffColor

@Deprecated(forRemoval=false)
public ToggleSwitchComponent trackOffColor(int trackOffArgb)

Deprecated.

Use trackOffColor(RenderColor).

trackOnColor

public ToggleSwitchComponent trackOnColor(RenderColor trackOnColor)

trackOnColor

@Deprecated(forRemoval=false)
public ToggleSwitchComponent trackOnColor(int trackOnArgb)

Deprecated.

Use trackOnColor(RenderColor).

trackBorderColors

public ToggleSwitchComponent trackBorderColors(RenderColor offColor,
 RenderColor onColor)

knobColor

public ToggleSwitchComponent knobColor(RenderColor knobColor)

knobColor

@Deprecated(forRemoval=false)
public ToggleSwitchComponent knobColor(int knobArgb)

Deprecated.

Use knobColor(RenderColor).

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