net.minecraft.client.gui.components.Checkbox

All Implemented Interfaces:: GuiEventListener, Renderable, TabOrderedElement, LayoutElement, NarratableEntry, NarrationSupplier, IAbstractWidgetExtension

public class Checkbox extends AbstractButton

Nested Class Summary

Nested Classes

Modifier and Type

Class

Description

static class

Checkbox.Builder

static interface

Checkbox.OnValueChange

Nested classes/interfaces inherited from interface net.minecraft.client.gui.narration.NarratableEntry
NarratableEntry.NarrationPriority
Field Summary

Fields

Modifier and Type

Field

Description

private static final int

BOX_PADDING

private static final ResourceLocation

CHECKBOX_HIGHLIGHTED_SPRITE

private static final ResourceLocation

CHECKBOX_SELECTED_HIGHLIGHTED_SPRITE

private static final ResourceLocation

CHECKBOX_SELECTED_SPRITE

private static final ResourceLocation

CHECKBOX_SPRITE

private final Checkbox.OnValueChange

onValueChange

private boolean

selected

private static final int

SPACING

private static final int

TEXT_COLOR

private final MultiLineTextWidget

textWidget

Fields inherited from class net.minecraft.client.gui.components.AbstractButton
SPRITES, TEXT_MARGIN

Fields inherited from class net.minecraft.client.gui.components.AbstractWidget
active, alpha, height, isHovered, packedFGColor, UNSET_FG_COLOR, visible, width

Fields inherited from interface net.minecraft.client.gui.components.events.GuiEventListener
DOUBLE_CLICK_THRESHOLD_MS
Constructor Summary

Constructors

Constructor

Description

Checkbox(int x, int y, int maxWidth, Component message, Font font, boolean selected, Checkbox.OnValueChange onValueChange)
Method Summary

Modifier and Type

Method

Description

static Checkbox.Builder

builder(Component message, Font font)

private int

getAdjustedHeight(Font font)

private int

getAdjustedWidth(int maxWidth, Component message, Font font)

static int

getBoxSize(Font font)

(package private) static int

getDefaultWidth(Component message, Font font)

void

onPress()

void

renderWidget(GuiGraphics guiGraphics, int mouseX, int mouseY, float partialTick)

boolean

selected()

void

updateWidgetNarration(NarrationElementOutput narrationElementOutput)

Methods inherited from class net.minecraft.client.gui.components.AbstractButton
keyPressed, onClick, renderString

Methods inherited from class net.minecraft.client.gui.components.AbstractWidget
clearFGColor, clicked, createNarrationMessage, defaultButtonNarrationText, getBottom, getFGColor, getHeight, getMessage, getRectangle, getRight, getTabOrderGroup, getTooltip, getWidth, getX, getY, isActive, isFocused, isHovered, isHoveredOrFocused, isMouseOver, isValidClickButton, mouseClicked, mouseDragged, mouseReleased, narrationPriority, nextFocusPath, onDrag, onRelease, playDownSound, render, renderScrollingString, renderScrollingString, renderScrollingString, setAlpha, setFGColor, setFocused, setHeight, setMessage, setRectangle, setSize, setTabOrderGroup, setTooltip, setTooltipDelay, setWidth, setX, setY, updateNarration, visitWidgets, wrapDefaultNarrationMessage

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface net.minecraft.client.gui.components.events.GuiEventListener
charTyped, getCurrentFocusPath, keyReleased, mouseMoved, mouseScrolled

Methods inherited from interface net.neoforged.neoforge.client.extensions.IAbstractWidgetExtension
onClick

Methods inherited from interface net.minecraft.client.gui.layouts.LayoutElement
setPosition

Field Details
- CHECKBOX_SELECTED_HIGHLIGHTED_SPRITE
  
  private static final ResourceLocation CHECKBOX_SELECTED_HIGHLIGHTED_SPRITE
- CHECKBOX_SELECTED_SPRITE
  
  private static final ResourceLocation CHECKBOX_SELECTED_SPRITE
- CHECKBOX_HIGHLIGHTED_SPRITE
  
  private static final ResourceLocation CHECKBOX_HIGHLIGHTED_SPRITE
- CHECKBOX_SPRITE
  
  private static final ResourceLocation CHECKBOX_SPRITE
- TEXT_COLOR
  
  private static final int TEXT_COLOR
  See Also:
  
  Constant Field Values
- SPACING
  
  private static final int SPACING
  See Also:
  
  Constant Field Values
- BOX_PADDING
  
  private static final int BOX_PADDING
  See Also:
  
  Constant Field Values
- selected
  
  private boolean selected
- onValueChange
  
  private final Checkbox.OnValueChange onValueChange
- textWidget
  
  private final MultiLineTextWidget textWidget
Constructor Details
- Checkbox
  
  Checkbox(int x, int y, int maxWidth, Component message, Font font, boolean selected, Checkbox.OnValueChange onValueChange)
Method Details
- getAdjustedWidth
  
  private int getAdjustedWidth(int maxWidth, Component message, Font font)
- getAdjustedHeight
  
  private int getAdjustedHeight(Font font)
- getDefaultWidth
  
  static int getDefaultWidth(Component message, Font font)
- builder
  
  public static Checkbox.Builder builder(Component message, Font font)
- getBoxSize
  
  public static int getBoxSize(Font font)
- onPress
  
  public void onPress()
  
  Specified by:
  
  onPress in class AbstractButton
- selected
  
  public boolean selected()
- updateWidgetNarration
  
  public void updateWidgetNarration(NarrationElementOutput narrationElementOutput)
  
  Specified by:
  
  updateWidgetNarration in class AbstractWidget
- renderWidget
  
  public void renderWidget(GuiGraphics guiGraphics, int mouseX, int mouseY, float partialTick)
  
  Overrides:
  
  renderWidget in class AbstractButton

Class Checkbox

Nested Class Summary

Nested classes/interfaces inherited from interface net.minecraft.client.gui.narration.NarratableEntry

Field Summary

Fields inherited from class net.minecraft.client.gui.components.AbstractButton

Fields inherited from class net.minecraft.client.gui.components.AbstractWidget

Fields inherited from interface net.minecraft.client.gui.components.events.GuiEventListener

Constructor Summary

Method Summary

Methods inherited from class net.minecraft.client.gui.components.AbstractButton

Methods inherited from class net.minecraft.client.gui.components.AbstractWidget

Methods inherited from class java.lang.Object

Methods inherited from interface net.minecraft.client.gui.components.events.GuiEventListener

Methods inherited from interface net.neoforged.neoforge.client.extensions.IAbstractWidgetExtension

Methods inherited from interface net.minecraft.client.gui.layouts.LayoutElement

Field Details

CHECKBOX_SELECTED_HIGHLIGHTED_SPRITE

CHECKBOX_SELECTED_SPRITE

CHECKBOX_HIGHLIGHTED_SPRITE

CHECKBOX_SPRITE

TEXT_COLOR

SPACING

BOX_PADDING

selected

onValueChange

textWidget

Constructor Details

Checkbox

Method Details

getAdjustedWidth

getAdjustedHeight

getDefaultWidth

builder

getBoxSize

onPress

selected

updateWidgetNarration

renderWidget