Index

A B C D E F G H I J K L M N O P Q R S T U V W X Y 
All Classes and Interfaces|All Packages|Constant Field Values

A

A body that scrolls itself (7.3.0) - Section in class com.trevlar.menukit.api.element.Tabs
 
AbstractPanelElement - Class in com.trevlar.menukit.api.element
Base of MenuKit's own elements: built once by a builder, immutable after.
AbstractPanelElement() - Constructor for class com.trevlar.menukit.api.element.AbstractPanelElement
For a consumer's custom element without a builder: at (0, 0), no size, always shown, never disabled, solid, no tooltip.
AbstractPanelElement(AbstractPanelElement.Builder) - Constructor for class com.trevlar.menukit.api.element.AbstractPanelElement
Builds from b: position, size and the shared vocabulary.
AbstractPanelElement.Builder<E,B> - Class in com.trevlar.menukit.api.element
The builder every MenuKit element's builder extends: the shared vocabulary, in one place, with the same names everywhere.
acknowledgeLabel(Component) - Method in class com.trevlar.menukit.api.dialog.AlertDialog.Builder
The acknowledge button's label.
action(Component, Runnable) - Method in class com.trevlar.menukit.api.element.MenuButton.Builder
Adds a row that runs action.
Action(Component, Runnable, boolean) - Constructor for record class com.trevlar.menukit.api.element.MenuButton.Action
Creates an instance of a Action record class.
activeOverlay(List, InputContext) - Static method in class com.trevlar.menukit.api.element.ChildDispatch
The first shown child's open overlay, whether or not it contains the point; null when none is open.
add(PanelElement) - Method in class com.trevlar.menukit.api.element.Flow.Builder
Adds a child (or a Flow.spacer()).
add(PanelElement) - Method in class com.trevlar.menukit.api.element.Section.Builder
Adds a child, positioned from the content area's top-left.
add(PanelElement) - Method in class com.trevlar.menukit.api.layout.Column.Builder
Appends an element that is already built, including under CrossAlign.FILL.
add(PanelElement) - Method in class com.trevlar.menukit.api.layout.Row.Builder
Appends an element that is already built.
add(PanelElement) - Method in class com.trevlar.menukit.api.panel.Panel.Builder
Appends an element.
add(PanelElement...) - Method in class com.trevlar.menukit.api.panel.Contribution.Builder
Appends elements, laid out in the panel's flow in this order.
add(ElementSpec) - Method in class com.trevlar.menukit.api.layout.Column.Builder
Appends an element.
add(ElementSpec) - Method in class com.trevlar.menukit.api.layout.Row.Builder
Appends an element.
add(Panel, int) - Method in class com.trevlar.menukit.api.host.OwnHost
Adds a panel by its own placements (Panel.placements(), 7.4.0), one per mode scope; each frame it takes the current mode's, else its BOTH one.
add(Panel, PanelPosition, int) - Method in class com.trevlar.menukit.api.host.OwnHost
Deprecated, for removal: This API element is subject to removal in a future version.
Replaced in 7.4.0 by OwnHost.add(Panel, int), which reads where the panel goes in each mode from its placements; removed in 8.0.0. This is position in both modes, whatever placements the panel declares.
add(Component, Runnable) - Method in class com.trevlar.menukit.api.element.ListView.Builder
An add button whose action returns nothing: the list finds the key that appeared.
add(Component, Supplier) - Method in class com.trevlar.menukit.api.element.ListView.Builder
An add button in the toolbar, labeled label; call once per kind of item.
add(Component, Supplier, Runnable) - Method in class com.trevlar.menukit.api.element.ListView.Builder
ListView.Builder.add(Component, Runnable) with a hover tooltip read while hovered.
add(Component, Supplier, Supplier) - Method in class com.trevlar.menukit.api.element.ListView.Builder
ListView.Builder.add(Component, Supplier) with a hover tooltip read every frame while hovered, as Button.Builder.tooltip(Supplier): a null result shows none.
add(Component, Component, Runnable) - Method in class com.trevlar.menukit.api.element.ListView.Builder
ListView.Builder.add(Component, Runnable) with a fixed hover tooltip.
add(Component, Component, Supplier) - Method in class com.trevlar.menukit.api.element.ListView.Builder
ListView.Builder.add(Component, Supplier) with a hover tooltip saying what the kind is, as Button.Builder.tooltip(Component): a \n starts a new line.
addAll(List) - Method in class com.trevlar.menukit.api.element.Flow.Builder
Adds children, in order.
addColumn(Consumer) - Method in class com.trevlar.menukit.api.layout.Column.Builder
Appends a nested column.
addColumn(Consumer) - Method in class com.trevlar.menukit.api.layout.Row.Builder
Appends a nested column.
addDisabledWhen(BooleanSupplier) - Method in class com.trevlar.menukit.api.element.ListView.Builder
Grays every add button while condition holds, read every frame (a copy running, a cap reached).
added(PanelElement) - Method in class com.trevlar.menukit.api.element.Attachment
A child added after build: attached now when the container is, else at the next init.
addEnchant(Holder) - Method in class com.trevlar.menukit.api.element.ItemPicker
The add control of an enchantment not on the selected item.
addHosted(Screen, T, GuiEventListener) - Static method in class com.trevlar.menukit.api.panel.Focus
Adds standIn to the screen as Focus.addWidget(Screen, T) does, and also records hosted, the widget it stands in for, as MenuKit's: the hosted widget is not a child of the screen (the stand-in is), but it keeps its hover inside its panel and its focus is handled like the stand-in's (Focus.isManaged(Screen, GuiEventListener)).
addRow(Consumer) - Method in class com.trevlar.menukit.api.layout.Column.Builder
Appends a nested row.
addRow(Consumer) - Method in class com.trevlar.menukit.api.layout.Row.Builder
Appends a nested row.
addSpacer() - Method in class com.trevlar.menukit.api.layout.Row.Builder
A flexible gap that fills whatever Row.Builder.width(int) leaves after the other children and the spacing between them; this is how "Back" and "Reset" end up at opposite edges of one row.
addTo(Identifier, Tabs.TabSpec) - Static method in class com.trevlar.menukit.api.element.Tabs
Adds a tab to the menu named menu, from a mod that does not own it.
addTooltip(int) - Method in class com.trevlar.menukit.api.element.ListView
The tooltip on the add button of the kindth add(...), read now; null for none.
addWidget(Screen, T) - Static method in class com.trevlar.menukit.api.panel.Focus
Adds a widget to the screen for input and opts it into MenuKit's focus handling.
A filling child (7.3.0) - Section in class com.trevlar.menukit.api.element.Flow
 
after(String) - Method in class com.trevlar.menukit.api.element.Tabs.TabSpec
For a tab added with Tabs.addTo(Identifier, Tabs.TabSpec): place it right after the tab with this id.
A grid that scrolls when the frame doesn't fit (7.4.0) - Section in class com.trevlar.menukit.api.panel.ScreenFrames
 
A lane outside its width (7.4.0) - Section in class com.trevlar.menukit.api.element.ScrollContainer
 
AlertDialog - Class in com.trevlar.menukit.api.dialog
Builds a modal dialog with one acknowledge button.
AlertDialog.Builder - Class in com.trevlar.menukit.api.dialog
Builder for an AlertDialog Panel.
align(Tabs.Align) - Method in class com.trevlar.menukit.api.element.Tabs.Builder
Where tabs sit in a row.
all() - Static method in class com.trevlar.menukit.api.panel.ScreenMatcher
Every inventory screen: the default.
allExcept(Class...) - Static method in class com.trevlar.menukit.api.panel.ScreenMatcher
Every inventory screen except the named ones and their subclasses.
alpha(boolean) - Method in class com.trevlar.menukit.api.element.ColorField.Builder
Whether the value carries transparency (0xAARRGGBB).
alt() - Method in record class com.trevlar.menukit.api.element.Click
Returns the value of the alt record component.
anchor() - Method in record class com.trevlar.menukit.api.panel.Placement
Returns the value of the anchor record component.
anchor(String) - Static method in class com.trevlar.menukit.api.panel.ContainerRegion
The anchor for one section, by its id ("mymod:opened-shulker"): its rectangle on screen, across the whole list (scrollbar lane included), from the top of its title to the bottom of its content, moved by the scroll and cut at the list's viewport.
Anchor - Class in com.trevlar.menukit.api.panel
A rectangle a library names and supplies per screen, for panels to be placed around with an AnchorPanelAdapter: a slot group's box (SlotKit), the pause menu's button column, the title screen's buttons.
AnchorPanelAdapter - Class in com.trevlar.menukit.api.panel
Places a Panel on Anchors: rectangles another library names and supplies per screen (a slot group's box, the pause menu's button column).
AnchorPanelAdapter(Panel) - Constructor for class com.trevlar.menukit.api.panel.AnchorPanelAdapter
Declares the panel with its own interior padding (0 for PanelStyle.NONE, AnchorPanelAdapter.DEFAULT_PADDING otherwise).
AnchorPanelAdapter(Panel, int) - Constructor for class com.trevlar.menukit.api.panel.AnchorPanelAdapter
Declares the panel with explicit content padding.
Anchors - Section in class com.trevlar.menukit.api.panel.ContainerRegion
 
animation() - Method in record class com.trevlar.menukit.api.element.ItemAnimation.Frame
Returns the value of the animation record component.
An interactive host - Section in class com.trevlar.menukit.api.element.Flow
 
answerConfirm(boolean) - Method in class com.trevlar.menukit.api.element.ListView
As a click on the remove confirm's Remove (true) or Cancel.
anyFillsHeight(List) - Static method in class com.trevlar.menukit.api.element.ChildDispatch
Whether any shown child fills the height it is given (PanelElement.fillsHeight()).
apply(float) - Method in interface com.trevlar.menukit.api.element.Easing
Eased progress for linear progress t, which is between 0 and 1.
applyReflowedY(int) - Method in class com.trevlar.menukit.api.element.AbstractPanelElement
Sets the live Y to baseline plus the reflow push, leaving the baseline alone.
ARGB (26.2) - Section in class com.trevlar.menukit.api.element.TextLabel
 
around(Anchor, PanelPosition) - Static method in record class com.trevlar.menukit.api.panel.Placement
In the regions around anchor's box: region(OutsideRegion) stacks with its other panels there; center() and pixel(...) work as anywhere.
ARROW_WIDTH - Static variable in class com.trevlar.menukit.api.element.Tabs
Width reserved at each end of an overflowing side-scroll strip for its arrow.
AS_IS - Static variable in interface com.trevlar.menukit.api.element.ItemAnimation
The item as it is, at every t: for a look that only draws another stack in the slot's (ItemAnimation.swapped(UnaryOperator)), AS_IS.swapped(...).at(1) (7.5.0).
A section - Section in class com.trevlar.menukit.api.panel.ContainerRegion
 
A setting value, never a player's item - Section in class com.trevlar.menukit.api.element.ItemPicker
 
A shift-click lands in view - Section in class com.trevlar.menukit.api.element.SlotScroll
 
at(float) - Method in interface com.trevlar.menukit.api.element.ItemAnimation
This animation at t: what a slot's item draws as this frame.
at(float) - Method in interface com.trevlar.menukit.api.element.ItemAnimation.Posing
 
at(int, int) - Method in class com.trevlar.menukit.api.element.AbstractPanelElement.Builder
Panel-local position: where the element sits in its panel's content area.
at(int, int) - Method in record class com.trevlar.menukit.api.element.InputContext
The same event with the content origin moved: what a container hands its children.
at(int, int) - Method in record class com.trevlar.menukit.api.element.RenderContext
The same frame, with the content origin moved to (originX, originY): what a container hands the children it positions from its own top-left.
at(int, int) - Static method in class com.trevlar.menukit.api.layout.Column
Starts a column at a panel-local origin.
at(int, int) - Method in interface com.trevlar.menukit.api.layout.ElementSpec
The element positioned at the given panel-local coordinates.
at(int, int) - Static method in class com.trevlar.menukit.api.layout.Row
Starts a row at a panel-local origin.
at(int, int, int, BooleanSupplier) - Method in interface com.trevlar.menukit.api.element.SlotScroll.Cell
 
at(Anchor, int, int) - Static method in record class com.trevlar.menukit.api.panel.Placement
At anchor's box's top-left plus (dx, dy), at the panel's natural size: no stacking, no room budget, no keeping it on the screen.
A tab per key - Section in class com.trevlar.menukit.api.panel.ContainerTabs
 
At most so many in a column (7.5.0) - Section in class com.trevlar.menukit.api.element.Flow
 
attach() - Method in class com.trevlar.menukit.api.host.OwnHost
Joins MenuKit's claims and modals with this host and attaches its elements (a text field registers its vanilla widget).
attach(List, Screen) - Static method in class com.trevlar.menukit.api.element.ChildDispatch
Attaches every child, shown or not, as a hidden panel's elements are: a widget-wrapping child registers its vanilla widget once per screen.
attach(Screen, List) - Method in class com.trevlar.menukit.api.element.Attachment
The container's own onAttach: remembers screen and attaches every child.
Attachment - Class in com.trevlar.menukit.api.element
The screen a container's children are attached to, so a child added after build attaches the way a child present at the screen's init did (7.3.0).
Attachment() - Constructor for class com.trevlar.menukit.api.element.Attachment
 
authoredWidth - Variable in class com.trevlar.menukit.api.element.AbstractPanelElement
The authored width, the cap's target; re-authored by AbstractPanelElement.fillWidth(int).
autoFitMain(Predicate) - Method in class com.trevlar.menukit.api.host.OwnHost
Whether the main panel gets a height budget and scrolls when taller than the screen.
autoSize() - Method in class com.trevlar.menukit.api.hud.HudPanel.Builder
Sizes the panel to its content.
avoidCoverWhen(BooleanSupplier) - Static method in class com.trevlar.menukit.api.element.MKTooltip
Docks every tooltip vanilla places beside the cursor on every frame condition is true: it sits centered at the bottom of the screen, MKTooltip.EDGE above the edge, or centered at the top when the cursor is within MKTooltip.DOCK_MARGIN of where the bottom one would sit, not only directly over it.
axis() - Method in interface com.trevlar.menukit.api.hud.HudCycleStrip.Source
Which way this source's ring reads, alone or in the cross.

B

backdrop() - Method in class com.trevlar.menukit.api.hud.HudPanel.TextBuilder
 
backdrop(boolean) - Method in class com.trevlar.menukit.api.element.TextLabel.Builder
A translucent dark plate behind the text, for HUD text over the world.
background() - Method in class com.trevlar.menukit.api.panel.Panel.Builder
Makes the panel part of the screen's background (7.4.0): it draws right where the screen draws its own image, after the screen's dim, so everything else on the screen draws over it: vanilla's labels and slots, other mods' widgets and buttons, every other panel, tooltips.
BACKWARD - Enum constant in enum class com.trevlar.menukit.api.hud.HudCycleStrip.Direction
 
bandInsetX(ScreenKind, boolean) - Static method in class com.trevlar.menukit.api.element.ScrollContainer
The list band's inset from its left edge (and a Tabs page's from each side): ScrollContainer.DEFAULT_INSET_X in the Default look, ScrollContainer.DIALOG_INSET in a dialog there, none in the Panel look, which draws no band.
bandInsetY(ScreenKind, boolean) - Static method in class com.trevlar.menukit.api.element.ScrollContainer
The band's room above its first child and below its last, by the same rule as ScrollContainer.bandInsetX(ScreenKind, boolean).
bar(int, int, int, int) - Method in class com.trevlar.menukit.api.hud.HudPanel.Builder
Adds a progress bar and returns a BarBuilder to configure it.
before(String) - Method in class com.trevlar.menukit.api.element.Tabs.TabSpec
For a tab added with Tabs.addTo(Identifier, Tabs.TabSpec): place it right before the tab with this id.
begin() - Static method in class com.trevlar.menukit.api.hud.HudCycleStrip
Starts timing a slide now.
bgColor(int) - Method in class com.trevlar.menukit.api.element.ProgressBar.Builder
ARGB background color.
bgColor(int) - Method in class com.trevlar.menukit.api.hud.HudPanel.BarBuilder
 
block() - Method in record class com.trevlar.menukit.api.panel.ContainerRegion.Source
Returns the value of the block record component.
BLOCK - Static variable in record class com.trevlar.menukit.api.host.SlotHoverResult
Inside a shown slot panel but on a gap: blocked, the covered slot is inert.
blurOnOutsideBounds(Screen, double, double) - Static method in class com.trevlar.menukit.api.panel.Focus
Clears the screen's focus when the focused widget was registered through Focus.addWidget(Screen, T) and the click landed outside it.
Bodies - Section in class com.trevlar.menukit.api.element.Tabs
 
body(Supplier) - Method in class com.trevlar.menukit.api.element.Tabs.TabSpec
The body as a factory, run each time the menu is built, so the body's elements are fresh and read the current config.
body(Supplier) - Method in class com.trevlar.menukit.api.dialog.ConfirmDialog.Builder
Body text read every frame the dialog is shown (7.3.0).
body(List) - Method in class com.trevlar.menukit.api.element.Tabs.TabSpec
The body: elements positioned from the body's top-left.
body(Component) - Method in class com.trevlar.menukit.api.dialog.AlertDialog.Builder
Body text shown below the title.
body(Component) - Method in class com.trevlar.menukit.api.dialog.ConfirmDialog.Builder
Body text shown below the title.
BODY - Enum constant in enum class com.trevlar.menukit.api.element.TextRole
Ordinary text: a setting's name, a line of explanation.
BODY_GAP - Static variable in class com.trevlar.menukit.api.element.Tabs
Space between the strip and the body.
bodyClip() - Method in class com.trevlar.menukit.api.element.Tabs
For MenuKit's checks: where the shown tab's body is drawn and clipped, as {x, y, width, height} from the element's top-left, for the kind of screen it measures for.
bodyScroll(Function, BiConsumer) - Method in class com.trevlar.menukit.api.element.Tabs.Builder
The consumer owns each tab's body scroll, in pixels from the top, keyed by tab id, as ScrollContainer.Builder.state(DoubleSupplier, DoubleConsumer) owns a container's: get is read every frame (null, or a missing entry, is the top) and set receives each change.
bordered(boolean) - Method in class com.trevlar.menukit.api.element.TextField.Builder
Whether it draws vanilla's text-field frame.
BOTH - Enum constant in enum class com.trevlar.menukit.api.panel.ModeScope
Either mode, and no player at all.
BOTTOM - Enum constant in enum class com.trevlar.menukit.api.hud.HudNotification.SlideDirection
 
BOTTOM_ALIGN_LEFT - Enum constant in enum class com.trevlar.menukit.api.panel.OutsideRegion
 
BOTTOM_ALIGN_RIGHT - Enum constant in enum class com.trevlar.menukit.api.panel.OutsideRegion
 
BOTTOM_CENTER - Enum constant in enum class com.trevlar.menukit.api.panel.InsideRegion
 
BOTTOM_CENTER - Enum constant in enum class com.trevlar.menukit.api.panel.OutsideRegion
Below the menu's container frame, centered horizontally.
BOTTOM_LEFT - Enum constant in enum class com.trevlar.menukit.api.panel.InsideRegion
 
BOTTOM_RIGHT - Enum constant in enum class com.trevlar.menukit.api.panel.InsideRegion
 
BOTTOM_TO_TOP - Enum constant in enum class com.trevlar.menukit.api.element.ProgressBar.Direction
 
box(Screen) - Method in class com.trevlar.menukit.api.panel.Anchor
The anchor's rectangle on screen this frame, or null when it is not there.
Box(String, int, int, int, int, int, int, int, int) - Constructor for record class com.trevlar.menukit.api.element.ItemPicker.Box
Creates an instance of a Box record class.
BOX_GAP - Static variable in class com.trevlar.menukit.api.element.ElementConstants
Space between that square and its label.
BOX_PADDING - Static variable in class com.trevlar.menukit.api.element.Flow
Space between a boxed Flow's card edge and its children (Flow.Builder.boxed()).
BOX_SIZE - Static variable in class com.trevlar.menukit.api.element.Checkbox
Size of the checkbox square, in pixels.
BOX_SIZE - Static variable in class com.trevlar.menukit.api.element.ElementConstants
The square of a checkbox or radio button.
BOX_SIZE - Static variable in class com.trevlar.menukit.api.element.Radio
Size of the radio square, in pixels.
boxed() - Method in class com.trevlar.menukit.api.element.Flow.Builder
Draws a card behind the children: they sit Flow.BOX_PADDING inside it, a row Flow fills its width, the height hugs the content.
Boxed: a card - Section in class com.trevlar.menukit.api.element.Flow
 
build() - Method in class com.trevlar.menukit.api.dialog.AlertDialog.Builder
Builds the dialog Panel: modal through Panel.modal() (opaque, dimsBehind, tracksAsModal) and hidden until Panel.visibleWhen(BooleanSupplier) shows it.
build() - Method in class com.trevlar.menukit.api.dialog.ConfirmDialog.Builder
Builds the dialog Panel: a PanelStyle.RAISED background, Panel.modal() set (opaque, dimsBehind, tracksAsModal), and hidden until you show it with Panel.visibleWhen(java.util.function.BooleanSupplier).
build() - Method in class com.trevlar.menukit.api.dialog.EditDialog.Builder
Builds the dialog Panel, hidden until you show it with Panel.visibleWhen(java.util.function.BooleanSupplier).
build() - Method in class com.trevlar.menukit.api.element.AbstractPanelElement.Builder
Builds the element.
build() - Method in class com.trevlar.menukit.api.element.Button.Builder
 
build() - Method in class com.trevlar.menukit.api.element.Checkbox.Builder
 
build() - Method in class com.trevlar.menukit.api.element.ColorField.Builder
 
build() - Method in class com.trevlar.menukit.api.element.Divider.Builder
 
build() - Method in class com.trevlar.menukit.api.element.Dropdown.Builder
 
build() - Method in class com.trevlar.menukit.api.element.DropdownMulti.Builder
 
build() - Method in class com.trevlar.menukit.api.element.Flow.Builder
 
build() - Method in class com.trevlar.menukit.api.element.Icon.Builder
 
build() - Method in class com.trevlar.menukit.api.element.InfoBox.Builder
 
build() - Method in class com.trevlar.menukit.api.element.ItemDisplay.Builder
 
build() - Method in class com.trevlar.menukit.api.element.ItemPicker.Builder
 
build() - Method in class com.trevlar.menukit.api.element.ListView.Builder
 
build() - Method in class com.trevlar.menukit.api.element.MenuButton.Builder
 
build() - Method in class com.trevlar.menukit.api.element.ProgressBar.Builder
 
build() - Method in class com.trevlar.menukit.api.element.Radio.Builder
 
build() - Method in class com.trevlar.menukit.api.element.ScrollContainer.Builder
 
build() - Method in class com.trevlar.menukit.api.element.Section.Builder
 
build() - Method in class com.trevlar.menukit.api.element.Slider.Builder
 
build() - Method in class com.trevlar.menukit.api.element.SlotScroll.Builder
The grid: a ScrollContainer, so ScrollContainer.scrolls() says whether it scrolls now.
build() - Method in class com.trevlar.menukit.api.element.Tabs.Builder
 
build() - Method in class com.trevlar.menukit.api.element.TextField.Builder
 
build() - Method in class com.trevlar.menukit.api.element.TextLabel.Builder
 
build() - Method in class com.trevlar.menukit.api.element.Toggle.Builder
 
build() - Method in class com.trevlar.menukit.api.element.WidgetHost.Builder
 
build() - Method in class com.trevlar.menukit.api.hud.HudNotification.Builder
Builds and registers the notification template with MenuKit.
build() - Method in class com.trevlar.menukit.api.hud.HudPanel.Builder
Builds the HUD panel and registers it; from then on it renders every frame the in-game HUD draws (never with input: the HUD routes none).
build() - Method in class com.trevlar.menukit.api.layout.Column.Builder
Returns the children as a flat list, each with its childX and childY set.
build() - Method in class com.trevlar.menukit.api.layout.Row.Builder
Returns the children as a flat list, each with its childX and childY set.
build() - Method in class com.trevlar.menukit.api.panel.Contribution.Builder
Builds the contribution, to hand to SharedPanels.join(String, Contribution).
build() - Method in class com.trevlar.menukit.api.panel.Panel.Builder
Builds the configured Panel.
build(G, K, ContainerTabs.Builder) - Method in interface com.trevlar.menukit.api.panel.ContainerTabs.GroupTab
 
builder() - Static method in class com.trevlar.menukit.api.dialog.AlertDialog
Starts an AlertDialog builder.
builder() - Static method in class com.trevlar.menukit.api.dialog.ConfirmDialog
Starts a ConfirmDialog builder.
builder() - Static method in class com.trevlar.menukit.api.dialog.EditDialog
Starts an EditDialog builder.
builder() - Static method in class com.trevlar.menukit.api.element.Button
Starts a button.
builder() - Static method in class com.trevlar.menukit.api.element.Checkbox
 
builder() - Static method in class com.trevlar.menukit.api.element.ColorField
Starts a color field.
builder() - Static method in class com.trevlar.menukit.api.element.Dropdown
A dropdown over items you give it.
builder() - Static method in class com.trevlar.menukit.api.element.DropdownMulti
 
builder() - Static method in class com.trevlar.menukit.api.element.Flow
 
builder() - Static method in class com.trevlar.menukit.api.element.Icon
 
builder() - Static method in class com.trevlar.menukit.api.element.InfoBox
 
builder() - Static method in class com.trevlar.menukit.api.element.ItemDisplay
 
builder() - Static method in class com.trevlar.menukit.api.element.ItemPicker
Starts a picker.
builder() - Static method in class com.trevlar.menukit.api.element.ListView
Starts a list of T.
builder() - Static method in class com.trevlar.menukit.api.element.MenuButton
 
builder() - Static method in class com.trevlar.menukit.api.element.ProgressBar
 
builder() - Static method in class com.trevlar.menukit.api.element.ScrollContainer
 
builder() - Static method in class com.trevlar.menukit.api.element.Slider
A slider over a fraction, 0 to 1.
builder() - Static method in class com.trevlar.menukit.api.element.SlotScroll
 
builder() - Static method in class com.trevlar.menukit.api.element.Tabs
 
builder() - Static method in class com.trevlar.menukit.api.element.TextField
 
builder() - Static method in class com.trevlar.menukit.api.element.TextLabel
 
builder() - Static method in class com.trevlar.menukit.api.element.Toggle
 
builder() - Static method in class com.trevlar.menukit.api.element.WidgetHost
Starts a host.
builder(int, ModeScope) - Static method in class com.trevlar.menukit.api.panel.Contribution
Starts a contribution.
builder(RadioGroup, T) - Static method in class com.trevlar.menukit.api.element.Radio
Starts the Radio for value in group.
builder(String) - Static method in class com.trevlar.menukit.api.hud.HudNotification
Starts a notification builder.
builder(String) - Static method in class com.trevlar.menukit.api.hud.HudPanel
Deprecated, for removal: This API element is subject to removal in a future version.
Replaced in 7.4.0 by HudPanel.builder(String, ModeScope), which picks the mode scope; removed in 8.0.0. builder(name, ModeScope.BOTH) is this call.
builder(String) - Static method in class com.trevlar.menukit.api.panel.Panel
Starts a builder for a Panel with the given id.
builder(String, ModeScope) - Static method in class com.trevlar.menukit.api.hud.HudPanel
Starts a HUD panel builder for one mode scope (7.4.0): the panel shows only in that mode (ModeScope.BOTH for either), read every frame, so it comes and goes with /gamemode.
builder(Supplier) - Static method in class com.trevlar.menukit.api.element.Section
A section whose title is read every frame (7.3.0): a rename shows at once, on the same element.
builder(Component) - Static method in class com.trevlar.menukit.api.element.Section
A section with a fixed title.
Builder() - Constructor for class com.trevlar.menukit.api.element.AbstractPanelElement.Builder
 
Builder() - Constructor for class com.trevlar.menukit.api.element.Button.Builder
 
Builder() - Constructor for class com.trevlar.menukit.api.element.Checkbox.Builder
 
Builder() - Constructor for class com.trevlar.menukit.api.element.ColorField.Builder
 
Builder() - Constructor for class com.trevlar.menukit.api.element.Icon.Builder
 
Builder() - Constructor for class com.trevlar.menukit.api.element.InfoBox.Builder
 
Builder() - Constructor for class com.trevlar.menukit.api.element.ItemDisplay.Builder
 
Builder() - Constructor for class com.trevlar.menukit.api.element.ItemPicker.Builder
 
Builder() - Constructor for class com.trevlar.menukit.api.element.ProgressBar.Builder
 
Builder() - Constructor for class com.trevlar.menukit.api.element.ScrollContainer.Builder
 
Builder() - Constructor for class com.trevlar.menukit.api.element.TextField.Builder
 
Builder() - Constructor for class com.trevlar.menukit.api.element.TextLabel.Builder
 
Builder() - Constructor for class com.trevlar.menukit.api.element.Toggle.Builder
 
Builder(RadioGroup, T) - Constructor for class com.trevlar.menukit.api.element.Radio.Builder
 
button() - Method in record class com.trevlar.menukit.api.element.Click
Returns the value of the button record component.
Button - Class in com.trevlar.menukit.api.element
An interactive button within a Panel: a raised background with a centered label, an icon, or a consumer sprite as its whole face.
Button(Button.Builder) - Constructor for class com.trevlar.menukit.api.element.Button
Builds from b.
BUTTON_GAP - Static variable in class com.trevlar.menukit.api.dialog.ConfirmDialog
Horizontal gap between buttons in the button bar.
BUTTON_H - Static variable in class com.trevlar.menukit.api.dialog.AlertDialog
Default button height, matching vanilla's confirm-screen buttons.
BUTTON_H - Static variable in class com.trevlar.menukit.api.dialog.ConfirmDialog
Default button height, matching vanilla's confirm-screen buttons.
BUTTON_W - Static variable in class com.trevlar.menukit.api.dialog.AlertDialog
Default button width.
BUTTON_W - Static variable in class com.trevlar.menukit.api.dialog.ConfirmDialog
Default button width.
Button.Builder - Class in com.trevlar.menukit.api.element
 
Button.Look - Record Class in com.trevlar.menukit.api.element
The look this frame, handed to the render hooks.

C

cancel() - Method in class com.trevlar.menukit.api.element.ColorField
Cancel (and Escape): writes back the color from before the dialog opened, and closes it.
cancel() - Method in class com.trevlar.menukit.api.element.ItemPicker
Cancel (and Escape): writes back the value from before the dialog opened, and closes it.
cancelLabel(Component) - Method in class com.trevlar.menukit.api.dialog.ConfirmDialog.Builder
The Cancel button's label.
cancelLabel(Component) - Method in class com.trevlar.menukit.api.dialog.EditDialog.Builder
The Cancel button's label.
CELL - Static variable in class com.trevlar.menukit.api.element.SlotScroll
A slot's cell, and a row's height.
cells(int, SlotScroll.Cell) - Method in class com.trevlar.menukit.api.element.SlotScroll.Builder
Required: count cells, each made by cell, in row order.
center() - Static method in record class com.trevlar.menukit.api.panel.PanelPosition
Centered on the screen as an overlay, drawn on top: the placement for dialogs and popovers.
CENTER - Enum constant in enum class com.trevlar.menukit.api.element.Tabs.Align
 
CENTER - Enum constant in enum class com.trevlar.menukit.api.layout.CrossAlign
Center children on the cross axis.
CENTER - Enum constant in enum class com.trevlar.menukit.api.panel.InsideRegion
Centered horizontally and vertically.
CENTER - Enum constant in enum class com.trevlar.menukit.api.panel.OutsideRegion
Centered within the menu's container frame, the usual anchor for modal dialogs.
CENTER - Enum constant in enum class com.trevlar.menukit.api.panel.PanelPosition.Mode
Centered on the screen as an overlay and drawn on top.
CENTER_CROSSHAIR_CLEARANCE - Static variable in class com.trevlar.menukit.api.panel.RegionConstants
Extra downward offset for InsideRegion.CENTER on the HUD, so a centered HUD panel clears the crosshair.
centeredBlockY(int, int, int) - Static method in class com.trevlar.menukit.api.element.Text
Text.centeredTextY(int, int) for a block of lines lines, stacked at lineHeight: where the first line goes.
centeredTextY(int, int) - Static method in class com.trevlar.menukit.api.element.Text
Where to draw one line of text so it looks centered in the box from top to bottom: vanilla's rule, (top + bottom - lineHeight) / 2 + 1, the same arithmetic as its button labels and its scrolling-text helper (ActiveTextCollector.defaultScrollingHelper).
Checkbox - Class in com.trevlar.menukit.api.element
A boolean setting as a small square with a check mark and a label beside it: the settings-screen convention, and a lens onto the consumer's boolean.
Checkbox(Checkbox.Builder) - Constructor for class com.trevlar.menukit.api.element.Checkbox
 
Checkbox.Builder - Class in com.trevlar.menukit.api.element
 
checkColumnWidth() - Method in class com.trevlar.menukit.api.element.DropdownMulti
 
checkColumnWidth() - Method in class com.trevlar.menukit.api.element.Dropdown
Width kept at the left of each row for a check mark; default none.
checkColumnWidth() - Method in class com.trevlar.menukit.api.element.MenuButton
Width kept at the left of each row for a check mark; default none.
CHECKMARK_SPRITE - Static variable in class com.trevlar.menukit.api.element.Checkbox
Vanilla check-mark sprite used for the checked state (9x8 pixels).
CHEST - Static variable in class com.trevlar.menukit.api.panel.ContainerRegion
Vanilla's chest texture: the default look of a section, and of the list on a chest's screen.
chevron() - Method in class com.trevlar.menukit.api.element.MenuButton
 
chevron() - Method in class com.trevlar.menukit.api.element.Dropdown
Whether the trigger shows the open/closed arrow at its right; default yes.
chevron() - Method in class com.trevlar.menukit.api.element.DropdownMulti
Whether the trigger shows the open/closed arrow at its right; default yes.
childContext(RenderContext) - Method in class com.trevlar.menukit.api.element.AbstractPanelElement
The context a container hands its children: its own disabled state added to what it was given (the cascade).
ChildDispatch - Class in com.trevlar.menukit.api.element
The one way a list of elements is rendered and receives input.
childrenHeight(ScreenKind) - Method in class com.trevlar.menukit.api.element.ScrollContainer
The children's extent, read live: re-stacked first if one changed (ScrollContainer.reflow(ScreenKind)), then the lowest shown child's bottom.
childX - Variable in class com.trevlar.menukit.api.element.AbstractPanelElement
Element X within the panel content area.
childY - Variable in class com.trevlar.menukit.api.element.AbstractPanelElement
Element Y within the panel content area: the LIVE render Y, the baseline plus any push the panel's wrap reflow applied.
chooseMatch(ItemMatch.Match) - Method in class com.trevlar.menukit.api.element.ItemPicker
Picks the selected slot's match (the player's choice), as its radio does.
Claims - Section in class com.trevlar.menukit.api.panel.AnchorPanelAdapter
 
clampScroll(int, int, int, int) - Static method in class com.trevlar.menukit.api.element.MKTooltip
One axis of a scroll.
clampWhen(BooleanSupplier) - Static method in class com.trevlar.menukit.api.element.MKTooltip
Keeps every tooltip's top at least MKTooltip.EDGE below the top of the screen on every frame condition is true.
clear(Screen) - Static method in class com.trevlar.menukit.api.panel.Focus
Clears focus on the screen, the same as screen.setFocused(null).
clearAllRow(Component) - Method in class com.trevlar.menukit.api.element.DropdownMulti.Builder
A pinned row that chooses none.
Click - Record Class in com.trevlar.menukit.api.element
A mouse click as seen by a PanelElement: which button, plus the modifier keys held at the moment the click was dispatched.
Click(int, boolean, boolean, boolean) - Constructor for record class com.trevlar.menukit.api.element.Click
Creates an instance of a Click record class.
clickAdd(int) - Method in class com.trevlar.menukit.api.element.ListView
As a click on the add button of the kindth add(...), from 0.
clickMove(int) - Method in class com.trevlar.menukit.api.element.ListView
As a click on the toolbar's up (by -1) or down (+1); nothing while it is grayed.
clickRemove() - Method in class com.trevlar.menukit.api.element.ListView
As a click on the toolbar's remove: removes the selected row, or opens the confirm; nothing while it is grayed.
clickRemove(Object) - Method in class com.trevlar.menukit.api.element.ListView
As a click on the remove cross in the row of key (controlsInRows): removes, or opens the confirm; nothing while it is grayed.
clickRow(Object) - Method in class com.trevlar.menukit.api.element.ListView
As a click on the empty area of the row of key: selects it, and the list has the keyboard.
clipOf(Slot) - Static method in class com.trevlar.menukit.api.host.SlotClip
The rectangle slot is shown within, in screen space (GUI pixels), or null when nothing clips it (7.4.0): what SlotClip.shown(RenderContext, Slot) was handed, every clipping ancestor's scissor intersected.
close() - Method in class com.trevlar.menukit.api.element.Dropdown
Closes the popover (a single-select after a pick).
close() - Method in class com.trevlar.menukit.api.element.DropdownMulti
Closes the popover (a single-select after a pick).
close() - Method in class com.trevlar.menukit.api.element.MenuButton
Closes the popover (a single-select after a pick).
CODEC - Static variable in record class com.trevlar.menukit.api.element.ItemMatch
Saves a rule as {stack: <vanilla's stack>, match: "exact"}, plus ignoring: ["minecraft:damage"] and ignore_count: true when the rule has them (left out when it does not, so a rule saved before they existed loads as it was).
CODEC - Static variable in enum class com.trevlar.menukit.api.element.ItemMatch.Match
Saved as "item", "exact", "contains".
color(int) - Method in class com.trevlar.menukit.api.element.Divider.Builder
ARGB color, alpha byte included, in the Panel look.
color(int) - Method in class com.trevlar.menukit.api.element.TextLabel.Builder
A fixed ARGB color, alpha byte included, on every kind of screen: wins over the role.
color(int) - Method in class com.trevlar.menukit.api.hud.HudPanel.BarBuilder
 
color(int) - Method in class com.trevlar.menukit.api.hud.HudPanel.TextBuilder
 
COLOR_DARK - Static variable in class com.trevlar.menukit.api.element.TextLabel
Dark gray, no shadow: vanilla's container-label color on a light panel.
COLOR_LIGHT - Static variable in class com.trevlar.menukit.api.element.TextLabel
White, drawn with a shadow: readable on a dark panel.
Color: a role, or a value - Section in class com.trevlar.menukit.api.element.TextLabel
 
ColorField - Class in com.trevlar.menukit.api.element
A color setting: a swatch showing the color, and a lens onto it.
ColorField(ColorField.Builder) - Constructor for class com.trevlar.menukit.api.element.ColorField
 
ColorField.Builder - Class in com.trevlar.menukit.api.element
Builds a ColorField.
colors(int, int) - Method in class com.trevlar.menukit.api.element.Section.Builder
Fixed title and summary colors (ARGB), on every kind of screen.
Column - Class in com.trevlar.menukit.api.layout
Lays elements out top to bottom, the vertical counterpart of Row: it positions each child with even spacing and a horizontal alignment, and returns a flat list of positioned PanelElements.
COLUMN - Enum constant in enum class com.trevlar.menukit.api.hud.HudCycleStrip.Axis
One cell beside the hotbar holding the held stack, the rest of the ring above it.
Column.Builder - Class in com.trevlar.menukit.api.layout
Builds one column.
columns(int) - Method in class com.trevlar.menukit.api.element.ItemPicker.Builder
A list's slots to a row, fewer when the panel is narrower.
columns(int) - Method in class com.trevlar.menukit.api.element.SlotScroll.Builder
Cells a row, at least 2; 9 by default, a vanilla container's.
com.trevlar.menukit.api - package com.trevlar.menukit.api
 
com.trevlar.menukit.api.dialog - package com.trevlar.menukit.api.dialog
 
com.trevlar.menukit.api.element - package com.trevlar.menukit.api.element
 
com.trevlar.menukit.api.host - package com.trevlar.menukit.api.host
 
com.trevlar.menukit.api.hud - package com.trevlar.menukit.api.hud
 
com.trevlar.menukit.api.layout - package com.trevlar.menukit.api.layout
 
com.trevlar.menukit.api.panel - package com.trevlar.menukit.api.panel
 
component(Supplier) - Method in class com.trevlar.menukit.api.hud.HudPanel.TextBuilder
 
componentsError() - Method in class com.trevlar.menukit.api.element.ItemPicker
The components box's error, or null while its text is valid.
ConfirmDialog - Class in com.trevlar.menukit.api.dialog
Builds a modal confirm/cancel dialog.
ConfirmDialog.Builder - Class in com.trevlar.menukit.api.dialog
Builder for a ConfirmDialog Panel.
confirmLabel(Component) - Method in class com.trevlar.menukit.api.dialog.ConfirmDialog.Builder
The Confirm button's label.
confirmRemove(Function) - Method in class com.trevlar.menukit.api.element.ListView.Builder
Asks before a remove: a confirm dialog whose body is body of the item, read while it shows ("Delete Item 2? Its 3 locks move to Slot lock.").
confirmShowing() - Method in class com.trevlar.menukit.api.element.ListView
The remove confirm's body while it shows, read now; null while it is closed.
Consumer custom elements - Section in class com.trevlar.menukit.api.element.AbstractPanelElement
 
CONTAINER - Static variable in enum class com.trevlar.menukit.api.panel.ScreenKind
Deprecated, for removal: This API element is subject to removal in a future version.
Renamed ScreenKind.PANEL in 7.3.0; removed in 8.0.0.
ContainerRegion - Class in com.trevlar.menukit.api.panel
The container region (7.4.0): on a container screen, the player's inventory never scrolls, and everything above it is one column that scrolls together.
ContainerRegion.Builder - Class in com.trevlar.menukit.api.panel
Builds one section of the container region.
ContainerRegion.Sections<K> - Class in com.trevlar.menukit.api.panel
Builds one kind of section made per live key.
ContainerRegion.Source - Record Class in com.trevlar.menukit.api.panel
Where a section's items are: the container it shows.
CONTAINERS - Static variable in class com.trevlar.menukit.api.panel.ContainerRegion
The container list's rectangle on a screen the region is on, scrollbar lane included while it scrolls: for buttons that act on the containers.
CONTAINERS_BOTTOM - Enum constant in enum class com.trevlar.menukit.api.panel.ContainerTabs.Edge
Below the container list's bottom edge, in the gap above the inventory panel.
CONTAINERS_TOP - Enum constant in enum class com.trevlar.menukit.api.panel.ContainerTabs.Edge
Above the container list's top edge: the default.
Containers whose art a pack picks by block (OptiGUI) - Section in class com.trevlar.menukit.api.panel.ContainerRegion
 
ContainerTabs - Class in com.trevlar.menukit.api.panel
Tabs on the container screen's panels (7.4.0): a row of tabs, like the creative inventory's, on an edge of the container region's container list or inventory panel.
ContainerTabs.Builder - Class in com.trevlar.menukit.api.panel
Builds one tab.
ContainerTabs.Edge - Enum Class in com.trevlar.menukit.api.panel
The panel edge a tab's row stands on.
ContainerTabs.Groups<G,K> - Class in com.trevlar.menukit.api.panel
ContainerTabs.GroupTab<G,K> - Interface in com.trevlar.menukit.api.panel
What a list of groups' sub-tab is (ContainerTabs.Groups.tab): its group, its key, and the builder to set up.
ContainerTabs.Icon - Interface in com.trevlar.menukit.api.panel
What a tab's icon draws: the mod's own drawing, every frame, in the icon box at (x, y), width by height.
ContainerTabs.Keyed<K> - Class in com.trevlar.menukit.api.panel
contains(double, double) - Method in record class com.trevlar.menukit.api.host.OwnHost.Placement
Whether the point is inside the rectangle.
CONTAINS - Enum constant in enum class com.trevlar.menukit.api.element.ItemMatch.Match
The same item and at least the components set; none set means any variant.
CONTAINS compares as vanilla's item predicates do - Section in record class com.trevlar.menukit.api.element.ItemMatch
 
content(PanelElement) - Method in class com.trevlar.menukit.api.dialog.EditDialog.Builder
The controls, lenses onto your draft, shown under the title.
content(PanelElement) - Method in class com.trevlar.menukit.api.panel.ContainerRegion.Builder
Required: what the section shows, placed from the region's content edge.
content(List) - Method in class com.trevlar.menukit.api.element.ScrollContainer.Builder
Required: the children, positioned from the viewport's top-left.
content(List) - Method in class com.trevlar.menukit.api.element.Section.Builder
Adds children, each positioned from the content area's top-left.
Content - Section in class com.trevlar.menukit.api.element.Section
 
CONTENT_GAP - Static variable in class com.trevlar.menukit.api.element.Section
Space between the header and the content when open.
CONTENT_WIDTH - Static variable in class com.trevlar.menukit.api.panel.ContainerRegion
The width a section has before the scrollbar: nine slots.
contentHeight(int) - Method in class com.trevlar.menukit.api.element.ScrollContainer.Builder
The scrollable height, when not the children's extent (room past the end, say).
contentHeightOf(List) - Static method in class com.trevlar.menukit.api.panel.Panel
The max childY + height over the visible elements; shared with Tabs' bodies.
contentKey(Font, List) - Static method in class com.trevlar.menukit.api.element.MKTooltip
A hash of what a tooltip says, line by line, so "the hovered stack changed" reads as "the text changed" for any tooltip, item or not.
contentSize(Function) - Method in class com.trevlar.menukit.api.host.OwnHost
A panel's content size, {width, height} without padding, for panels whose own size does not cover everything they show (slots drawn in them, say).
Contribution - Class in com.trevlar.menukit.api.panel
One mod's part of a shared panel (SharedPanels, 7.4.0): its elements, its order in the panel, the mode it shows in and its own visibleWhen, plus the panel's own declaration (where it goes per mode, its style, its axis and gap, whether it is fixed, how many fit in a column per mode).
Contribution.Builder - Class in com.trevlar.menukit.api.panel
Builds a Contribution.
Controls in each row, for small lists - Section in class com.trevlar.menukit.api.element.ListView
 
controlsInRows() - Method in class com.trevlar.menukit.api.element.ListView.Builder
Up, down and a remove cross in each row instead of in the toolbar, for a small list where each row is its own thing to edit (a config list of text fields).
Coordinate contract - Section in interface com.trevlar.menukit.api.element.PanelElement
 
countIgnored() - Method in record class com.trevlar.menukit.api.element.ItemMatch
Returns the value of the countIgnored record component.
countIgnored() - Method in class com.trevlar.menukit.api.element.ItemPicker
Whether the setting leaves the count out of EXACT (ItemPicker.Builder.ignoringCount()): the Edit tab has no count.
covers(ModeScope) - Method in enum class com.trevlar.menukit.api.panel.ModeScope
Whether this scope covers mode (null: no player): ModeScope.BOTH always, otherwise mode is this one.
CREATIVE - Enum constant in enum class com.trevlar.menukit.api.panel.ModeScope
Creative: a player with infinite materials.
crossAlign(CrossAlign) - Method in class com.trevlar.menukit.api.element.Flow.Builder
Where each child sits on its row's line, in a row Flow.
crossAlign(CrossAlign) - Method in class com.trevlar.menukit.api.layout.Column.Builder
Horizontal alignment.
crossAlign(CrossAlign) - Method in class com.trevlar.menukit.api.layout.Row.Builder
Vertical alignment.
CrossAlign - Enum Class in com.trevlar.menukit.api.layout
Cross-axis alignment for Row and Column.
ctrl() - Method in record class com.trevlar.menukit.api.element.Click
Returns the value of the ctrl record component.
current() - Method in record class com.trevlar.menukit.api.hud.HudCycleStrip.View
Returns the value of the current record component.
custom(int, int, int, int, Consumer) - Method in class com.trevlar.menukit.api.hud.HudPanel.Builder
Adds a custom drawn area.
customName() - Method in record class com.trevlar.menukit.api.panel.ContainerRegion.Source
Returns the value of the customName record component.

D

danger() - Method in record class com.trevlar.menukit.api.element.MenuButton.Action
Returns the value of the danger record component.
danger(Component, Runnable) - Method in class com.trevlar.menukit.api.element.MenuButton.Builder
Adds a row that runs action, its label red: an action that destroys something.
DARK - Enum constant in enum class com.trevlar.menukit.api.panel.PanelStyle
Dark translucent panel, like the status effects background.
Declarations - Class in com.trevlar.menukit.api
Declarations freeze; state does not.
declare() - Method in class com.trevlar.menukit.api.panel.ContainerRegion.Builder
Declares the section.
declare() - Method in class com.trevlar.menukit.api.panel.ContainerRegion.Sections
Declares the kind.
declare() - Method in class com.trevlar.menukit.api.panel.ContainerTabs.Builder
Declares the tab.
declare() - Method in class com.trevlar.menukit.api.panel.ContainerTabs.Groups
Declares the list.
declare() - Method in class com.trevlar.menukit.api.panel.ContainerTabs.Keyed
Declares the list.
declare(String, SlotItemLooks.Look) - Static method in class com.trevlar.menukit.api.panel.SlotItemLooks
Declares a look, its id namespaced and unique ("mymod:open_boxes").
declId - Variable in class com.trevlar.menukit.api.element.AbstractPanelElement.Builder
 
declId() - Method in class com.trevlar.menukit.api.element.AbstractPanelElement
 
declId() - Method in interface com.trevlar.menukit.api.element.PanelElement
The element's explicit, stable declaration id within its panel, or null to use its registration position in the panel's element list (the window's address for the element).
declId(String) - Method in class com.trevlar.menukit.api.element.AbstractPanelElement.Builder
A stable id within the panel, for the window's address of this element, used instead of its position in the panel's element list.
decoration(OwnHost.Decoration) - Method in class com.trevlar.menukit.api.host.OwnHost
Drawn between each panel's background and its elements.
DEFAULT - Enum constant in enum class com.trevlar.menukit.api.panel.ScreenKind
The Default look: vanilla's Options, Controls, Create World and the like.
DEFAULT_BG_COLOR - Static variable in class com.trevlar.menukit.api.element.ProgressBar
 
DEFAULT_COLOR - Static variable in class com.trevlar.menukit.api.element.Divider
Default color: vanilla's container-label gray.
DEFAULT_COLUMNS - Static variable in class com.trevlar.menukit.api.element.ItemPicker
Slots in a list's row unless ItemPicker.Builder.columns says otherwise: a vanilla inventory row.
DEFAULT_DIRECTION - Static variable in class com.trevlar.menukit.api.element.ProgressBar
 
DEFAULT_FILL_COLOR - Static variable in class com.trevlar.menukit.api.element.ProgressBar
 
DEFAULT_GAP - Static variable in class com.trevlar.menukit.api.element.Flow
Default gap between children, on both axes.
DEFAULT_HEIGHT - Static variable in class com.trevlar.menukit.api.element.Button
Height when the builder is given no size: vanilla's button height.
DEFAULT_INSET_X - Static variable in class com.trevlar.menukit.api.element.ScrollContainer
In the Default look, how far in from the list band's left edge its content starts (and, in a Tabs page that does not scroll, how far from its right edge it ends): vanilla's gap between a list row's content and the list's scrollbar.
DEFAULT_INSET_Y - Static variable in class com.trevlar.menukit.api.element.ScrollContainer
In the Default look, the room above the band's first child and below its last: vanilla's list padding (AbstractSelectionList.getFirstEntryY() is the list's top + 2, contentHeight() the rows + 4) plus a row's Entry.CONTENT_PADDING (2), which is 4.
DEFAULT_MAX_WIDTH - Static variable in class com.trevlar.menukit.api.element.MKTooltip
The default maximum tooltip width, in GUI pixels: about seven average words.
DEFAULT_PADDING - Static variable in class com.trevlar.menukit.api.panel.AnchorPanelAdapter
Default content padding for styled panels.
DEFAULT_PADDING - Static variable in class com.trevlar.menukit.api.panel.ScreenPanelAdapter
Default content padding for styled panels.
DEFAULT_PADDING - Static variable in class com.trevlar.menukit.api.panel.VanillaScreenPanelAdapter
Default content padding for styled panels (ScreenPanelAdapter.DEFAULT_PADDING).
DEFAULT_PRIORITY - Static variable in record class com.trevlar.menukit.api.panel.PanelPosition
Default stacking priority.
DEFAULT_SIZE - Static variable in class com.trevlar.menukit.api.element.ColorField
The swatch's size unless size says otherwise: a vanilla control's height, square.
DEFAULT_SIZE - Static variable in class com.trevlar.menukit.api.element.ItemDisplay
Vanilla's item size.
DEFAULT_SIZE - Static variable in class com.trevlar.menukit.api.element.SlotRendering
Default slot size (18×18), 16px item area + 1px padding each side.
DEFAULT_SUMMARY_COLOR - Static variable in class com.trevlar.menukit.api.element.Section
The summary's color in the Panel look (TextRole.MUTED).
DEFAULT_THICKNESS - Static variable in class com.trevlar.menukit.api.element.Divider
Default thickness in pixels.
DEFAULT_TITLE_COLOR - Static variable in class com.trevlar.menukit.api.element.Section
The title's color in the Panel look (TextRole.HEADING): dark, for a raised panel.
describe() - Method in record class com.trevlar.menukit.api.panel.PanelPosition
A short human form for error messages: REGION(RIGHT_ALIGN_TOP) and so on.
detach() - Method in class com.trevlar.menukit.api.host.OwnHost
Detaches the elements.
detach(List, Screen) - Static method in class com.trevlar.menukit.api.element.ChildDispatch
Detaches every child.
detach(Screen, List) - Method in class com.trevlar.menukit.api.element.Attachment
The container's own onDetach: detaches every child and forgets the screen.
dialog() - Method in class com.trevlar.menukit.api.element.ColorField
The dialog's panel: a modal on the screen the field is on, open while ColorField.isDialogOpen().
dialog() - Method in class com.trevlar.menukit.api.element.ItemPicker
The dialog's panel: a modal on the screen the picker is on, open while ItemPicker.isDialogOpen().
DIALOG_INSET - Static variable in class com.trevlar.menukit.api.element.ScrollContainer
In a dialog in the Default look, the band's inset on every side it insets: DialogLayout.GAP, the room the dialog keeps between everything else.
dialogBoxes(ScreenKind) - Method in class com.trevlar.menukit.api.element.ItemPicker
Everything the dialog draws on the shown tab, laid out for kind, each with the box it must stay inside.
dialogCells() - Method in class com.trevlar.menukit.api.element.ColorField
What the dialog's shown tab draws, each {x, y, width, height} from the tab's body: every dye's slot with its ring (in ColorField.dyeRows() order), or the picker and the hex field.
dialogSlots() - Method in class com.trevlar.menukit.api.element.ItemPicker
The dialog's slots, empties included (a list's holes and the slot to add to), as the slot row shows them.
dimsBehind() - Method in class com.trevlar.menukit.api.panel.Panel
Whether this panel dims the screen behind it.
dimsBehind(boolean) - Method in class com.trevlar.menukit.api.panel.Panel
Sets whether the screen dims behind this panel while it is visible.
direction(ProgressBar.Direction) - Method in class com.trevlar.menukit.api.element.ProgressBar.Builder
Which way the fill grows.
direction(ProgressBar.Direction) - Method in class com.trevlar.menukit.api.hud.HudPanel.BarBuilder
 
disabled() - Method in record class com.trevlar.menukit.api.element.Button.Look
Returns the value of the disabled record component.
disabled() - Method in record class com.trevlar.menukit.api.element.InputContext
Returns the value of the disabled record component.
disabled() - Method in record class com.trevlar.menukit.api.element.RenderContext
Returns the value of the disabled record component.
disabled(InputContext) - Method in class com.trevlar.menukit.api.element.AbstractPanelElement
Whether this element should act disabled for this event: its own predicate, or its panel's or container's.
disabled(RenderContext) - Method in class com.trevlar.menukit.api.element.AbstractPanelElement
Whether this element should look disabled this frame: its own predicate, or its panel's or container's.
Disabled - Section in class com.trevlar.menukit.api.element.AbstractPanelElement
 
Disabled - Section in class com.trevlar.menukit.api.element.ChildDispatch
 
Disabled - Section in record class com.trevlar.menukit.api.element.InputContext
 
DISABLED - Enum constant in enum class com.trevlar.menukit.api.element.TextRole
Text of something that is off right now.
DISABLED_OVERLAY - Static variable in class com.trevlar.menukit.api.element.ElementConstants
Translucent black over a sprite-drawn control while it is disabled.
disabledIf(boolean) - Method in record class com.trevlar.menukit.api.element.InputContext
This context, disabled as well when alsoDisabled holds.
disabledIf(boolean) - Method in record class com.trevlar.menukit.api.element.RenderContext
This context, disabled as well when alsoDisabled holds: what a container with its own disabledWhen passes to its children.
Disabled look - Section in class com.trevlar.menukit.api.element.Section
 
Disabled look - Section in class com.trevlar.menukit.api.element.TextLabel
 
disabledReason(Component) - Method in class com.trevlar.menukit.api.element.ListView.Builder
Shown above the grayed rows while the list's disabledWhen holds: why it is grayed.
disabledWhen - Variable in class com.trevlar.menukit.api.element.AbstractPanelElement.Builder
 
disabledWhen(BooleanSupplier) - Method in class com.trevlar.menukit.api.panel.Panel
Disables the whole panel while condition holds, read every frame (pass null to clear).
disabledWhen(BooleanSupplier) - Method in class com.trevlar.menukit.api.element.AbstractPanelElement.Builder
Grayed and inert while condition holds, read every frame.
disabledWhen(BooleanSupplier) - Method in class com.trevlar.menukit.api.panel.ContainerTabs.Builder
Grayed and taking no click while this holds, read every frame.
disabledWhen(BooleanSupplier) - Method in class com.trevlar.menukit.api.panel.Panel.Builder
Disables the whole panel while condition holds, read every frame: every element draws grayed and takes no input.
Divider - Class in com.trevlar.menukit.api.element
A line between sections of a panel: a solid fill, no texture, no input.
Divider(Divider.Builder) - Constructor for class com.trevlar.menukit.api.element.Divider
 
Divider.Builder - Class in com.trevlar.menukit.api.element
 
DOCK_MARGIN - Static variable in class com.trevlar.menukit.api.element.MKTooltip
How far outside the bottom-docked tooltip's background the cursor still flips it to the top, in GUI pixels: a bit more than a slot.
docked(int, int, int, int, int, int) - Static method in class com.trevlar.menukit.api.element.MKTooltip
Where a docked tooltip's text starts, given the text's width and height as vanilla measures them (a positioner's arguments).
docks(ClientTooltipPositioner) - Static method in class com.trevlar.menukit.api.element.MKTooltip
True when a tooltip placed by positioner docks this frame: a registered MKTooltip.avoidCoverWhen(BooleanSupplier) predicate holds and vanilla places it beside the cursor (its default and menu positioners), not somewhere fixed.
done() - Method in class com.trevlar.menukit.api.element.ColorField
Done: keeps the color and closes the dialog.
done() - Method in class com.trevlar.menukit.api.element.ItemPicker
Done: keeps the value and closes the dialog.
done() - Method in class com.trevlar.menukit.api.hud.HudPanel.BarBuilder
 
done() - Method in class com.trevlar.menukit.api.hud.HudPanel.ItemBuilder
 
done() - Method in class com.trevlar.menukit.api.hud.HudPanel.SlotBuilder
 
done() - Method in class com.trevlar.menukit.api.hud.HudPanel.TextBuilder
 
draw(GuiGraphicsExtractor, int, int, int, int) - Method in interface com.trevlar.menukit.api.panel.ContainerTabs.Icon
 
draw(GuiGraphicsExtractor, OwnHost.Placement) - Method in interface com.trevlar.menukit.api.host.OwnHost.Decoration
 
draw(GuiGraphicsExtractor, AbstractContainerScreen, Slot, ItemStack, int, int) - Method in interface com.trevlar.menukit.api.panel.SlotDecorations.Decoration
Draws on slot this frame, or nothing.
draw(GuiGraphicsExtractor, ItemStack, int, int, float) - Method in interface com.trevlar.menukit.api.element.ItemAnimation
Draws stack in the 16 px box at (x, y), t of the way through.
drawCheck(GuiGraphicsExtractor, int, int) - Method in class com.trevlar.menukit.api.element.DropdownMulti
 
drawCheck(GuiGraphicsExtractor, int, int) - Method in class com.trevlar.menukit.api.element.Dropdown
Draws a selected row's check mark in the check column; default nothing.
drawCheck(GuiGraphicsExtractor, int, int) - Method in class com.trevlar.menukit.api.element.MenuButton
Draws a selected row's check mark in the check column; default nothing.
drawItemOutline(GuiGraphicsExtractor, ItemStack, int, int, int) - Static method in class com.trevlar.menukit.api.element.SlotRendering
Draws stack at (x, y) with a one-pixel outline of argb around the item's own silhouette, the shape of its sprite, not its 16x16 box.
drawnAt(long, int, int, int, int, int, int, HudNotification.SlideDirection, int, int, int) - Static method in class com.trevlar.menukit.api.hud.HudNotification
Where the panel, panelW x panelH with its place at x, y, is drawn elapsed ms into durationMs: sliding in from slideDistance px toward its edge from (eased out), then over the last outMs toward it again (eased in), until it is wholly off the screen.
drawSlotBackground(GuiGraphicsExtractor, int, int, int, boolean) - Static method in class com.trevlar.menukit.api.element.SlotRendering
Slot background.
drawWrapped(GuiGraphicsExtractor, Component, int, int, int, int, int, boolean) - Static method in class com.trevlar.menukit.api.element.Text
Draws text broken at wrapWidth, the first line at y, one line every lineHeight.
Dropdown<T> - Class in com.trevlar.menukit.api.element
A single-selection dropdown: a trigger showing the current choice, and a popover list to pick another from.
Dropdown.Builder<T> - Class in com.trevlar.menukit.api.element
 
DropdownMulti<T> - Class in com.trevlar.menukit.api.element
A multi-selection dropdown: a trigger summarizing the chosen set, and a popover list where each row toggles its item.
DropdownMulti.Builder<T> - Class in com.trevlar.menukit.api.element
 
duration(int) - Method in class com.trevlar.menukit.api.hud.HudNotification.Builder
Total display duration in milliseconds; includes the slide-out (default 3000).
dx() - Method in record class com.trevlar.menukit.api.panel.PanelPosition
Returns the value of the dx record component.
dy() - Method in record class com.trevlar.menukit.api.panel.PanelPosition
Returns the value of the dy record component.
dyeColor(DyeColor) - Static method in class com.trevlar.menukit.api.element.ColorField
A dye's color, opaque 0xAARRGGBB: vanilla's own for it (dyed leather, sheep, banners).
dyeName(DyeColor) - Static method in class com.trevlar.menukit.api.element.ColorField
A dye's tooltip: vanilla's translated color name.
dyeRows() - Static method in class com.trevlar.menukit.api.element.ColorField
The dye grid's rows, top to bottom.

E

Each section a slice of its own container's screen - Section in class com.trevlar.menukit.api.panel.ContainerRegion
 
eachWay(int, Easing) - Static method in class com.trevlar.menukit.api.element.Transition
A transition like Transition.of(int, Easing), but eased each way: back runs easing from where the key is toward 0 as forward runs it toward 1, rather than the forward curve backwards.
EASE_IN_OUT - Static variable in interface com.trevlar.menukit.api.element.Easing
Slow at both ends: a cubic ease-in-out.
EASE_OUT - Static variable in interface com.trevlar.menukit.api.element.Easing
Fast, then settling: a cubic ease-out.
EASE_OUT_BACK - Static variable in interface com.trevlar.menukit.api.element.Easing
Past the end and back, a small spring: the ease-out-back MenuKit's hotbar slides use.
Easing - Interface in com.trevlar.menukit.api.element
An easing curve (7.4.0): eased progress for a linear progress t, both from 0 to 1.
edge(ContainerTabs.Edge) - Method in class com.trevlar.menukit.api.panel.ContainerTabs.Builder
The edge its row stands on.
edge(ContainerTabs.Edge) - Method in class com.trevlar.menukit.api.panel.ContainerTabs.Groups
The edge their row stands on.
edge(ContainerTabs.Edge) - Method in class com.trevlar.menukit.api.panel.ContainerTabs.Keyed
The edge its row stands on.
EDGE - Static variable in class com.trevlar.menukit.api.element.MKTooltip
Gap kept between a scrolled tooltip and the screen edge, in GUI pixels (vanilla's own minimum).
EDGE_INSET - Static variable in class com.trevlar.menukit.api.panel.RegionConstants
Screen-edge inset (GUI-scaled pixels) for the HUD and vanilla-screen contexts, matching vanilla's F3 debug overlay.
Edge inset - Section in class com.trevlar.menukit.api.panel.RegionConstants
 
editable(boolean) - Method in class com.trevlar.menukit.api.element.TextField.Builder
Read-only when false: visible, selectable and copyable, but not changeable.
EditDialog - Class in com.trevlar.menukit.api.dialog
Builds a modal dialog that edits a copy of something and writes it back only on Save (7.3.0): a title, your controls, Cancel and Save.
EditDialog.Builder - Class in com.trevlar.menukit.api.dialog
Builder for an EditDialog Panel.
Editing (7.3.0) - Section in class com.trevlar.menukit.api.element.ListView
 
editText(String) - Method in class com.trevlar.menukit.api.element.ItemPicker
What a field of the Edit tab shows now.
element(PanelElement) - Method in class com.trevlar.menukit.api.hud.HudPanel.Builder
Adds any panel element, for mods that implement PanelElement themselves.
ElementConstants - Class in com.trevlar.menukit.api.element
The colors and spacings MenuKit's elements share.
elements(List) - Method in class com.trevlar.menukit.api.panel.Panel.Builder
Replaces the element list so far with the given one; later Panel.Builder.add(PanelElement) calls append to it.
ElementSpec - Interface in com.trevlar.menukit.api.layout
An element whose position a layout helper (Row, Column) computes: its size now, the element itself when ElementSpec.at(int, int) is called with the computed position.
empty(PanelElement) - Method in class com.trevlar.menukit.api.element.ListView.Builder
Shown in the list's place while there are no items.
Empty - Section in class com.trevlar.menukit.api.element.ListView
 
enchantChoices() - Method in class com.trevlar.menukit.api.element.ItemPicker
The selected slot's enchantment choices, as the Edit tab lists them (on it, then those that can be added).
END - Enum constant in enum class com.trevlar.menukit.api.layout.CrossAlign
Align children to the high edge of the cross axis.
endFrame(AbstractContainerScreen) - Method in interface com.trevlar.menukit.api.host.SlotScreenHook
Once per frame, after every panel on the screen has rendered.
Enter, Escape and focus - Section in class com.trevlar.menukit.api.element.TextField
 
equals(Object) - Method in record class com.trevlar.menukit.api.element.Button.Look
Indicates whether some other object is "equal to" this one.
equals(Object) - Method in record class com.trevlar.menukit.api.element.Click
Indicates whether some other object is "equal to" this one.
equals(Object) - Method in record class com.trevlar.menukit.api.element.InputContext
Indicates whether some other object is "equal to" this one.
equals(Object) - Method in record class com.trevlar.menukit.api.element.ItemAnimation.Frame
Indicates whether some other object is "equal to" this one.
equals(Object) - Method in record class com.trevlar.menukit.api.element.ItemAnimation.Pose
Indicates whether some other object is "equal to" this one.
equals(Object) - Method in record class com.trevlar.menukit.api.element.ItemMatch
Indicates whether some other object is "equal to" this one.
equals(Object) - Method in record class com.trevlar.menukit.api.element.ItemPicker.Box
Indicates whether some other object is "equal to" this one.
equals(Object) - Method in record class com.trevlar.menukit.api.element.ListView.Sort
Indicates whether some other object is "equal to" this one.
equals(Object) - Method in record class com.trevlar.menukit.api.element.MenuButton.Action
Indicates whether some other object is "equal to" this one.
equals(Object) - Method in record class com.trevlar.menukit.api.element.RenderContext
Indicates whether some other object is "equal to" this one.
equals(Object) - Method in record class com.trevlar.menukit.api.host.OwnHost.Layout
Indicates whether some other object is "equal to" this one.
equals(Object) - Method in record class com.trevlar.menukit.api.host.OwnHost.Placement
Indicates whether some other object is "equal to" this one.
equals(Object) - Method in record class com.trevlar.menukit.api.host.SlotHoverResult
Indicates whether some other object is "equal to" this one.
equals(Object) - Method in record class com.trevlar.menukit.api.hud.HudCycleStrip.View
Indicates whether some other object is "equal to" this one.
equals(Object) - Method in record class com.trevlar.menukit.api.panel.ContainerRegion.Source
Indicates whether some other object is "equal to" this one.
equals(Object) - Method in record class com.trevlar.menukit.api.panel.PanelPosition
Indicates whether some other object is "equal to" this one.
equals(Object) - Method in record class com.trevlar.menukit.api.panel.Placement
Indicates whether some other object is "equal to" this one.
equals(Object) - Method in record class com.trevlar.menukit.api.panel.Reference
Indicates whether some other object is "equal to" this one.
equals(Object) - Method in record class com.trevlar.menukit.api.panel.ScreenOrigin
Indicates whether some other object is "equal to" this one.
EXACT - Enum constant in enum class com.trevlar.menukit.api.element.ItemMatch.Match
The same item, count and components; no components set means a plain item.
expandedWhen(BooleanSupplier) - Method in class com.trevlar.menukit.api.panel.ContainerTabs.Keyed
When a group's sub-tabs are out, read every frame: always, only while one of them is selected, or whatever the mod's own rule is.
expandedWhen(Predicate) - Method in class com.trevlar.menukit.api.panel.ContainerTabs.Groups
When a group's sub-tabs are out, by group, read every frame, as ContainerTabs.Keyed.expandedWhen(BooleanSupplier) reads.
Extension points for consumer subclasses - Section in class com.trevlar.menukit.api.element.Button
 
extraLayoutHeight() - Method in class com.trevlar.menukit.api.element.Button
The extra height a wrapped label adds, so the panel pushes what is below down.
extraLayoutHeight() - Method in class com.trevlar.menukit.api.element.Checkbox
 
extraLayoutHeight() - Method in class com.trevlar.menukit.api.element.Flow
The extra height of the rows past the first: what a wrap adds.
extraLayoutHeight() - Method in class com.trevlar.menukit.api.element.InfoBox
 
extraLayoutHeight() - Method in class com.trevlar.menukit.api.element.ItemPicker
A list taller than one row pushes what is below it down.
extraLayoutHeight() - Method in class com.trevlar.menukit.api.element.ListView
All of it: a list's baseline is nothing, so the whole list (the toolbar it draws, the reason, the rows or what stands in for them) is what the container pushes the elements below it down by, read every frame.
extraLayoutHeight() - Method in interface com.trevlar.menukit.api.element.PanelElement
Extra vertical pixels this element occupies beyond its single-line / authored baseline because it wrapped or opened.
extraLayoutHeight() - Method in class com.trevlar.menukit.api.element.Dropdown
 
extraLayoutHeight() - Method in class com.trevlar.menukit.api.element.DropdownMulti
 
extraLayoutHeight() - Method in class com.trevlar.menukit.api.element.MenuButton
 
extraLayoutHeight() - Method in class com.trevlar.menukit.api.element.Radio
 
extraLayoutHeight() - Method in class com.trevlar.menukit.api.element.ScrollContainer
While its height follows its content (ScrollContainer.Builder.fitHeight(), or filling with no room given and no declared height), all of it, as a ListView reports (7.3.0): its baseline is nothing, so the container pushes the elements below it down by its whole height, read every frame, and they follow it as it grows toward its declared height and shrinks back.
extraLayoutHeight() - Method in class com.trevlar.menukit.api.element.Section
Everything below the header: the panel pushes later rows down by this much.
extraLayoutHeight() - Method in class com.trevlar.menukit.api.element.Tabs
At its natural height (no fixed size, no viewport to fill), what it has grown since it was placed: the panel pushes the rows below it down by this much, so a button row under a Tabs stays under it in either look.
extraLayoutHeight() - Method in class com.trevlar.menukit.api.element.TextLabel
The extra height of the lines past the first, so the panel pushes what is below down.
extraLayoutHeight() - Method in class com.trevlar.menukit.api.element.Toggle
 

F

Faces - Section in class com.trevlar.menukit.api.element.Toggle
 
fadeOut(int) - Method in class com.trevlar.menukit.api.hud.HudNotification.Builder
How long it takes to slide out, at the tail end of the total duration (default 500).
fill() - Method in class com.trevlar.menukit.api.element.TextField.Builder
As wide as the room its panel gives it (7.2.0); it asks for the size's width, or its hint's when that is wider.
fill() - Method in class com.trevlar.menukit.api.element.TextLabel.Builder
Asks its panel for no width and wraps to the room it is given (7.2.0).
FILL - Enum constant in enum class com.trevlar.menukit.api.element.Tabs.Align
 
FILL - Enum constant in enum class com.trevlar.menukit.api.layout.CrossAlign
Stretches every child that can fill to the column's width (the width of its widest child).
fillColor(int) - Method in class com.trevlar.menukit.api.element.ProgressBar.Builder
ARGB fill color.
fillHeight() - Method in class com.trevlar.menukit.api.element.ScrollContainer.Builder
Takes the height its container gives it (7.3.0): the room a panel's viewport leaves below it, what a vertical Flow has left after its other children, a Tabs page's height.
fillHeight(int) - Method in class com.trevlar.menukit.api.element.Flow
The height to share out to the filling children (Flow.giveFill()); -1 for none.
fillHeight(int) - Method in interface com.trevlar.menukit.api.element.PanelElement
The height this element should occupy, from its container, or -1 when the container has no height to give (back to its natural height).
fillHeight(int) - Method in class com.trevlar.menukit.api.element.ScrollContainer
The height its container gives it, -1 for none (back to its declared or content height).
fillHeight(int) - Method in class com.trevlar.menukit.api.element.Tabs
 
Filling - Section in class com.trevlar.menukit.api.element.Divider
 
Filling its container (7.3.0) - Section in class com.trevlar.menukit.api.element.ScrollContainer
 
fillsHeight() - Method in class com.trevlar.menukit.api.element.Flow
A vertical Flow fills when a child of it does (a header over a filling list).
fillsHeight() - Method in interface com.trevlar.menukit.api.element.PanelElement
Whether this element takes its height from its container (PanelElement.fillHeight(int)): the room left below it rather than its natural height.
fillsHeight() - Method in class com.trevlar.menukit.api.element.ScrollContainer
 
fillsHeight() - Method in class com.trevlar.menukit.api.element.Tabs
 
fillWidth(int) - Method in class com.trevlar.menukit.api.element.AbstractPanelElement
Column fill: the column's widest extent becomes this element's authored width.
fillWidth(int) - Method in class com.trevlar.menukit.api.element.Checkbox
Intrinsic: a column fill does not stretch a checkbox.
fillWidth(int) - Method in class com.trevlar.menukit.api.element.Divider
Column fill lengthens a horizontal divider; a vertical one would only thicken.
fillWidth(int) - Method in class com.trevlar.menukit.api.element.Flow
 
fillWidth(int) - Method in class com.trevlar.menukit.api.element.Icon
 
fillWidth(int) - Method in class com.trevlar.menukit.api.element.InfoBox
 
fillWidth(int) - Method in class com.trevlar.menukit.api.element.ItemDisplay
 
fillWidth(int) - Method in class com.trevlar.menukit.api.element.ItemPicker
 
fillWidth(int) - Method in class com.trevlar.menukit.api.element.ListView
 
fillWidth(int) - Method in interface com.trevlar.menukit.api.element.PanelElement
Stretches this element to fill the given content width (the CrossAlign.FILL column-fill primitive).
fillWidth(int) - Method in class com.trevlar.menukit.api.element.Radio
 
fillWidth(int) - Method in class com.trevlar.menukit.api.element.ScrollContainer
Column fill widens the viewport; floored so the scrollbar lane always fits.
fillWidth(int) - Method in class com.trevlar.menukit.api.element.Section
 
fillWidth(int) - Method in class com.trevlar.menukit.api.element.Tabs
 
fillWidth(int) - Method in class com.trevlar.menukit.api.element.TextLabel
 
fillWidth(int) - Method in class com.trevlar.menukit.api.element.Toggle
Column fill stretches a labeled bar; a switch or sprite would distort, so it keeps its size.
Filtering - Section in class com.trevlar.menukit.api.element.TextField
 
fitHeight() - Method in class com.trevlar.menukit.api.element.ScrollContainer.Builder
As tall as its content up to the declared height, scrolling past it.
fitRoom(int) - Method in class com.trevlar.menukit.api.element.ScrollContainer.Builder
As tall as its content while there is room, shorter by whole steps when there is not, never below the declared height (7.4.0): content shorter than that leaves the rest of the declared height empty, so the frame keeps its size as the content shrinks.
fitShownTab() - Method in class com.trevlar.menukit.api.element.Tabs.Builder
With no fixed size and no viewport to fill (a dialog, whose frame follows its content), be as wide and as tall as the shown tab rather than the widest and the tallest (7.2.0): switching tabs resizes it, and the panel resizes and moves the rows around it with it.
fitted(ModeScope, ScreenMatcher) - Static method in class com.trevlar.menukit.api.panel.ContainerRegion
The fitted frame for the screens screens takes, in scope's game mode (ModeScope.BOTH for either), read every frame: their list and inventory panel are one frame, as tall as the shown sections need (see "The fitted frame").
Fitting the room (7.4.0) - Section in class com.trevlar.menukit.api.element.ScrollContainer
 
fitWidth() - Method in class com.trevlar.menukit.api.element.ScrollContainer.Builder
As wide as its content instead of a declared width: the widest child, the band's inset in the Default look and the scrollbar lane.
fitX(int, int, int) - Static method in class com.trevlar.menukit.api.element.MKTooltip
Where a tooltip's text starts so its background stays MKTooltip.EDGE inside both sides of the screen.
fixed() - Method in class com.trevlar.menukit.api.hud.HudPanel.Builder
The player can't move this panel (7.4.0), as Panel.Builder.fixed(): for a panel whose place is part of what it shows, or one that draws from the window rather than from where it is placed.
fixed() - Method in class com.trevlar.menukit.api.panel.Contribution.Builder
The player can't move the panel (Panel.Builder.fixed()): part of the declaration, so the winning one decides.
fixed() - Method in class com.trevlar.menukit.api.panel.Panel.Builder
The player can't move this panel (7.4.0): it stays where its placements put it.
Flat cells - Section in class com.trevlar.menukit.api.element.SlotScroll
 
Flow - Class in com.trevlar.menukit.api.element
A run of elements laid out left to right at the panel's runtime width, wrapping onto new rows when it runs out of room: the runtime row.
Flow.Builder - Class in com.trevlar.menukit.api.element
 
focus() - Method in class com.trevlar.menukit.api.element.TextField
Starts editing from code (7.3.0): the field takes the keyboard, as a click on it does, its caret at the end of its text.
Focus - Class in com.trevlar.menukit.api.panel
Focus for widgets MenuKit places on a screen, and the "is this point covered by MenuKit" checks.
focusTarget() - Method in class com.trevlar.menukit.api.element.WidgetHost
The widget's stand-in among the screen's children: what holds vanilla's keyboard focus for it.
formatHex(int, boolean) - Static method in class com.trevlar.menukit.api.element.ColorField
#RRGGBB, or #AARRGGBB with alpha, in capitals.
For mods - Section in class com.trevlar.menukit.api.panel.Focus
 
FORWARD - Enum constant in enum class com.trevlar.menukit.api.hud.HudCycleStrip.Direction
 
Frame(ItemAnimation, float) - Constructor for record class com.trevlar.menukit.api.element.ItemAnimation.Frame
Creates an instance of a Frame record class.
frameExtra(ScreenKind) - Method in class com.trevlar.menukit.api.panel.Panel
How much thicker this panel's frame is on kind than the frame its padding is measured against: 3 px for a PanelStyle.RAISED panel on an Default-look screen (vanilla's popup frame, 6 px, against MenuKit's 3), else 0.
frameStarts() - Static method in class com.trevlar.menukit.api.element.MKTooltip
A screen frame is about to draw its tooltip, if any (GuiGraphicsExtractor.extractDeferredElements HEAD).
frameStaysWhen(ModeScope, ScreenMatcher, BooleanSupplier) - Static method in class com.trevlar.menukit.api.panel.ContainerTabs
Keeps the frame of the screens screens takes at vanilla's own place, its tab rows on its own frame standing in the margin around it, in scope's mode while when holds, read every frame (see "Where a row stands").
freeze(String) - Static method in class com.trevlar.menukit.api.Declarations
Freezes declarations.
frozen() - Static method in class com.trevlar.menukit.api.Declarations
Whether declarations have frozen.
Frozen after init - Section in class com.trevlar.menukit.api.panel.AnchorPanelAdapter
 
Frozen after init - Section in class com.trevlar.menukit.api.panel.ScreenPanelAdapter
 
Frozen after init - Section in class com.trevlar.menukit.api.panel.VanillaScreenPanelAdapter
 

G

gap() - Method in record class com.trevlar.menukit.api.panel.PanelPosition
Returns the value of the gap record component.
gap(int) - Method in class com.trevlar.menukit.api.element.Flow.Builder
The gap between children, both axes.
gap(int) - Method in class com.trevlar.menukit.api.element.ListView.Builder
Pixels between rows.
gap(int) - Method in class com.trevlar.menukit.api.hud.HudPanel.Builder
The space before this panel in its stack, in pixels (since 7.1.0): the PanelPosition.gap(int) of the panel's position.
gap(int) - Method in class com.trevlar.menukit.api.panel.Contribution.Builder
Pixels between neighboring elements, across contributions too.
gap(int) - Method in record class com.trevlar.menukit.api.panel.PanelPosition
This position with gap pixels before the panel in its stack (since 7.1.0).
gap(int, int) - Method in class com.trevlar.menukit.api.element.Flow.Builder
The gap between children in a row and between rows; in a vertical Flow, between columns and between children in a column.
GAP - Static variable in class com.trevlar.menukit.api.panel.ContainerRegion
The room between two sections, and from a section's grid to vanilla's "Inventory" below.
gapOr(int) - Method in record class com.trevlar.menukit.api.panel.PanelPosition
The gap before this panel: the one declared with PanelPosition.gap(int), or hostDefault when none was (since 7.1.0).
getActiveOverlayBounds(InputContext) - Method in class com.trevlar.menukit.api.element.Flow
 
getActiveOverlayBounds(InputContext) - Method in class com.trevlar.menukit.api.element.ListView
 
getActiveOverlayBounds(InputContext) - Method in interface com.trevlar.menukit.api.element.PanelElement
The screen-space bounds [x, y, width, height] of this element's active overlay (an open popover), or null when none is open.
getActiveOverlayBounds(InputContext) - Method in class com.trevlar.menukit.api.element.Dropdown
The open popover's bounds, where this element is placed in in; null when closed.
getActiveOverlayBounds(InputContext) - Method in class com.trevlar.menukit.api.element.DropdownMulti
The open popover's bounds, where this element is placed in in; null when closed.
getActiveOverlayBounds(InputContext) - Method in class com.trevlar.menukit.api.element.MenuButton
The open popover's bounds, where this element is placed in in; null when closed.
getActiveOverlayBounds(InputContext) - Method in class com.trevlar.menukit.api.element.ScrollContainer
 
getActiveOverlayBounds(InputContext) - Method in class com.trevlar.menukit.api.element.Section
 
getActiveOverlayBounds(InputContext) - Method in class com.trevlar.menukit.api.element.Tabs
 
getActiveOverlayBounds(InputContext) - Method in class com.trevlar.menukit.api.element.WidgetHost
While an overflowing widget's popup is open it may take a click anywhere: the whole screen.
getChildX() - Method in class com.trevlar.menukit.api.element.AbstractPanelElement
 
getChildX() - Method in interface com.trevlar.menukit.api.element.PanelElement
X position within the panel's content area.
getChildX() - Method in class com.trevlar.menukit.api.hud.HudIcon
 
getChildX() - Method in class com.trevlar.menukit.api.hud.HudSlot
 
getChildY() - Method in class com.trevlar.menukit.api.element.AbstractPanelElement
 
getChildY() - Method in interface com.trevlar.menukit.api.element.PanelElement
Y position within the panel's content area.
getChildY() - Method in class com.trevlar.menukit.api.hud.HudIcon
 
getChildY() - Method in class com.trevlar.menukit.api.hud.HudSlot
 
getColor() - Method in class com.trevlar.menukit.api.element.Divider
The divider's ARGB color.
getCurrentItem() - Method in class com.trevlar.menukit.api.element.ItemPicker
The first slot's item, the kind only (Items.AIR when empty): what a 6.1.0 picker shows.
getCurrentSprite() - Method in class com.trevlar.menukit.api.element.Icon
The sprite or texture the icon would draw right now.
getCurrentStack() - Method in class com.trevlar.menukit.api.element.ItemDisplay
The stack the display would draw right now.
getCurrentText() - Method in class com.trevlar.menukit.api.element.InfoBox
The text the box would draw right now.
getCurrentText() - Method in class com.trevlar.menukit.api.element.TextLabel
The text the label would draw right now.
getCurrentValue() - Method in class com.trevlar.menukit.api.element.ProgressBar
The fraction the bar would show right now, clamped to 0..1.
getDurationMs() - Method in class com.trevlar.menukit.api.hud.HudNotification
Total display duration in milliseconds (includes the slide-out).
getElements() - Method in class com.trevlar.menukit.api.panel.Panel
The elements to lay out, render and send input to.
getEscapeAction() - Method in class com.trevlar.menukit.api.panel.Panel
The action set with Panel.onEscape(Runnable), or null.
getHeight() - Method in class com.trevlar.menukit.api.element.AbstractPanelElement
 
getHeight() - Method in class com.trevlar.menukit.api.element.Button
 
getHeight() - Method in class com.trevlar.menukit.api.element.Checkbox
 
getHeight() - Method in class com.trevlar.menukit.api.element.Flow
 
getHeight() - Method in class com.trevlar.menukit.api.element.InfoBox
 
getHeight() - Method in class com.trevlar.menukit.api.element.ItemPicker
 
getHeight() - Method in class com.trevlar.menukit.api.element.ListView
 
getHeight() - Method in interface com.trevlar.menukit.api.element.PanelElement
Height in pixels.
getHeight() - Method in class com.trevlar.menukit.api.element.Dropdown
The trigger's height: the authored box, grown when its label wraps.
getHeight() - Method in class com.trevlar.menukit.api.element.DropdownMulti
The trigger's height: the authored box, grown when its label wraps.
getHeight() - Method in class com.trevlar.menukit.api.element.MenuButton
The trigger's height: the authored box, grown when its label wraps.
getHeight() - Method in class com.trevlar.menukit.api.element.Radio
 
getHeight() - Method in class com.trevlar.menukit.api.element.ScrollContainer
Fitting its content's height, as tall as it up to the declared height; else as declared.
getHeight() - Method in class com.trevlar.menukit.api.element.Section
The header plus, when open, the content.
getHeight() - Method in class com.trevlar.menukit.api.element.Tabs
 
getHeight() - Method in class com.trevlar.menukit.api.element.TextLabel
 
getHeight() - Method in class com.trevlar.menukit.api.element.Toggle
 
getHeight() - Method in class com.trevlar.menukit.api.hud.HudIcon
 
getHeight() - Method in class com.trevlar.menukit.api.hud.HudSlot
 
getHeight() - Method in class com.trevlar.menukit.api.panel.Panel
The panel's content height, worked out like Panel.getWidth().
getLabel() - Method in class com.trevlar.menukit.api.element.Button
The button's label.
getOrigin(AbstractContainerScreen) - Method in class com.trevlar.menukit.api.panel.ScreenPanelAdapter
The panel's outer top-left on screen this frame, or empty when it is hidden, not placed, or not on that screen.
getPadding() - Method in class com.trevlar.menukit.api.panel.AnchorPanelAdapter
The content padding inside the panel's edge.
getPadding() - Method in class com.trevlar.menukit.api.panel.ScreenPanelAdapter
The content padding inside the panel's edge.
getPadding() - Method in class com.trevlar.menukit.api.panel.VanillaScreenPanelAdapter
The content padding inside the panel's edge.
getPanel() - Method in class com.trevlar.menukit.api.panel.AnchorPanelAdapter
The panel this adapter declares.
getPanel() - Method in class com.trevlar.menukit.api.panel.ScreenPanelAdapter
The panel this adapter declares.
getPanel() - Method in class com.trevlar.menukit.api.panel.VanillaScreenPanelAdapter
The panel this adapter declares.
getPanels() - Method in class com.trevlar.menukit.api.panel.MKScreen
The panels in order, unmodifiable.
getPinnedHeight() - Method in class com.trevlar.menukit.api.panel.Panel
The height set with Panel.size(int,int) or Panel.pinnedHeight(int), or -1 if none.
getPinnedWidth() - Method in class com.trevlar.menukit.api.panel.Panel
The width set with Panel.size(int,int) or Panel.pinnedWidth(int), or -1 if none.
getPosition() - Method in class com.trevlar.menukit.api.panel.Panel
Where this panel sits now: the position of its placement for the current mode, else of its BOTH one (Panel.Builder.in(ModeScope, Placement)), read on every call so it follows the mode; PanelPosition.UNPLACED when it has none that applies (or none at all).
getRawElements() - Method in class com.trevlar.menukit.api.panel.Panel
The elements the panel was built with, never the auto-scroll wrapper.
getSerializedName() - Method in enum class com.trevlar.menukit.api.element.ItemMatch.Match
 
getStyle() - Method in class com.trevlar.menukit.api.panel.Panel
The panel's background style.
getTargets() - Method in class com.trevlar.menukit.api.panel.AnchorPanelAdapter
The anchors AnchorPanelAdapter.on(Anchor...) named, or null without it.
getTargets() - Method in class com.trevlar.menukit.api.panel.VanillaScreenPanelAdapter
The declared target classes, or null (none, or VanillaScreenPanelAdapter.onAny()).
getToggleKey() - Method in class com.trevlar.menukit.api.panel.Panel
The key code (InputConstants.KEY_*) that toggles this panel's visibility, or -1 for none.
getTooltipSupplier() - Method in class com.trevlar.menukit.api.panel.Panel
The tooltip supplier, or null.
getValue() - Method in class com.trevlar.menukit.api.element.Radio
This Radio's value.
getWidth() - Method in class com.trevlar.menukit.api.element.AbstractPanelElement
 
getWidth() - Method in class com.trevlar.menukit.api.element.Button
 
getWidth() - Method in class com.trevlar.menukit.api.element.Checkbox
 
getWidth() - Method in class com.trevlar.menukit.api.element.Flow
 
getWidth() - Method in class com.trevlar.menukit.api.element.InfoBox
 
getWidth() - Method in class com.trevlar.menukit.api.element.ListView
 
getWidth() - Method in interface com.trevlar.menukit.api.element.PanelElement
Width in pixels.
getWidth() - Method in class com.trevlar.menukit.api.element.Radio
 
getWidth() - Method in class com.trevlar.menukit.api.element.ScrollContainer
Fitting its content, as wide as it was laid out (its content's before then); else as declared, and the lane beside that while it shows for a lane outside.
getWidth() - Method in class com.trevlar.menukit.api.element.Section
 
getWidth() - Method in class com.trevlar.menukit.api.element.Tabs
 
getWidth() - Method in class com.trevlar.menukit.api.element.TextLabel
 
getWidth() - Method in class com.trevlar.menukit.api.element.Toggle
 
getWidth() - Method in class com.trevlar.menukit.api.hud.HudIcon
 
getWidth() - Method in class com.trevlar.menukit.api.hud.HudSlot
 
getWidth() - Method in class com.trevlar.menukit.api.panel.Panel
The panel's content width: the pinned width if one was set, otherwise the extent of the visible elements (the largest childX + width).
graphics() - Method in record class com.trevlar.menukit.api.element.RenderContext
Returns the value of the graphics record component.
groups(String, ModeScope, Supplier, Function) - Static method in class com.trevlar.menukit.api.panel.ContainerTabs
Starts a list of groups, its id namespaced and unique among tabs and lists ("mymod:boxes"), for one mode scope: one group per key groups gives, read every frame a container screen is open, in the order it gives them, and in each group one sub-tab per key keys gives for it, read every frame as a keyed list's are.
Groups - Section in class com.trevlar.menukit.api.panel.ContainerTabs
 
Groups that come and go - Section in class com.trevlar.menukit.api.panel.ContainerTabs
 

H

h() - Method in record class com.trevlar.menukit.api.element.ItemPicker.Box
Returns the value of the h record component.
handled() - Method in record class com.trevlar.menukit.api.host.SlotHoverResult
Returns the value of the handled record component.
hasAlpha() - Method in class com.trevlar.menukit.api.element.ColorField
Whether the value carries alpha (0xAARRGGBB).
hasEditTab() - Method in class com.trevlar.menukit.api.element.ItemPicker
Whether the dialog has an Edit tab: only when the match mode keeps more than the item.
hashCode() - Method in record class com.trevlar.menukit.api.element.Button.Look
Returns a hash code value for this object.
hashCode() - Method in record class com.trevlar.menukit.api.element.Click
Returns a hash code value for this object.
hashCode() - Method in record class com.trevlar.menukit.api.element.InputContext
Returns a hash code value for this object.
hashCode() - Method in record class com.trevlar.menukit.api.element.ItemAnimation.Frame
Returns a hash code value for this object.
hashCode() - Method in record class com.trevlar.menukit.api.element.ItemAnimation.Pose
Returns a hash code value for this object.
hashCode() - Method in record class com.trevlar.menukit.api.element.ItemMatch
Returns a hash code value for this object.
hashCode() - Method in record class com.trevlar.menukit.api.element.ItemPicker.Box
Returns a hash code value for this object.
hashCode() - Method in record class com.trevlar.menukit.api.element.ListView.Sort
Returns a hash code value for this object.
hashCode() - Method in record class com.trevlar.menukit.api.element.MenuButton.Action
Returns a hash code value for this object.
hashCode() - Method in record class com.trevlar.menukit.api.element.RenderContext
Returns a hash code value for this object.
hashCode() - Method in record class com.trevlar.menukit.api.host.OwnHost.Layout
Returns a hash code value for this object.
hashCode() - Method in record class com.trevlar.menukit.api.host.OwnHost.Placement
Returns a hash code value for this object.
hashCode() - Method in record class com.trevlar.menukit.api.host.SlotHoverResult
Returns a hash code value for this object.
hashCode() - Method in record class com.trevlar.menukit.api.hud.HudCycleStrip.View
Returns a hash code value for this object.
hashCode() - Method in record class com.trevlar.menukit.api.panel.ContainerRegion.Source
Returns a hash code value for this object.
hashCode() - Method in record class com.trevlar.menukit.api.panel.PanelPosition
Returns a hash code value for this object.
hashCode() - Method in record class com.trevlar.menukit.api.panel.Placement
Returns a hash code value for this object.
hashCode() - Method in record class com.trevlar.menukit.api.panel.Reference
Returns a hash code value for this object.
hashCode() - Method in record class com.trevlar.menukit.api.panel.ScreenOrigin
Returns a hash code value for this object.
hasKeyboard() - Method in class com.trevlar.menukit.api.element.ListView
Whether the list has the keyboard (after a click in it, until a click outside).
hasModal() - Method in class com.trevlar.menukit.api.host.OwnHost
Whether one of this host's modal panels is shown.
hasMouseInput() - Method in record class com.trevlar.menukit.api.element.RenderContext
Returns whether mouse input is present in this render pass.
hasReturnAction() - Method in class com.trevlar.menukit.api.panel.MKScreen
Whether a return action is set (Back chrome can branch on this).
header(PanelElement...) - Method in class com.trevlar.menukit.api.element.Tabs.Builder
Elements in a row across the whole element, above the strip (or the sidebar column) and the body, in every mode: a menu's title bar.
header(BiConsumer) - Method in class com.trevlar.menukit.api.panel.ContainerTabs.Groups
Required: each group's header tab, set up as ContainerTabs.Keyed.header sets one up, by group.
header(Consumer) - Method in class com.trevlar.menukit.api.panel.ContainerTabs.Keyed
Makes the list a group: build sets up its header tab, as a key's tab is set up, and the keys' tabs become its sub-tabs, standing after it.
Header - Section in class com.trevlar.menukit.api.element.Section
 
HEADER_GAP - Static variable in class com.trevlar.menukit.api.element.Tabs
Space between the full-width header and everything under it: the same gap as the sidebar header's.
HEADER_HEIGHT - Static variable in class com.trevlar.menukit.api.element.Section
Height of the header row.
HEADING - Enum constant in enum class com.trevlar.menukit.api.element.TextRole
A title or a section's name.
height - Variable in class com.trevlar.menukit.api.element.AbstractPanelElement.Builder
Authored size, or -1 when not given.
height - Variable in class com.trevlar.menukit.api.element.AbstractPanelElement
The authored height.
height() - Method in record class com.trevlar.menukit.api.host.OwnHost.Placement
Returns the value of the height record component.
height() - Method in interface com.trevlar.menukit.api.layout.ElementSpec
Height of the element in pixels (panel-local).
height(int) - Method in class com.trevlar.menukit.api.element.ScrollContainer.Builder
The viewport's height alone, for a container that fits its width to its content (ScrollContainer.Builder.fitWidth).
Height follows the rows - Section in class com.trevlar.menukit.api.element.ListView
 
hexText() - Method in class com.trevlar.menukit.api.element.ColorField
What the hex field shows: the color's hex, or what the player is typing.
hidden(MKTooltip.Kind) - Static method in class com.trevlar.menukit.api.element.MKTooltip
True when any registered MKTooltip.hideWhen(BooleanSupplier) predicate holds for a tooltip of kind this frame.
Hidden children - Section in class com.trevlar.menukit.api.element.Flow
 
Hidden sections - Section in class com.trevlar.menukit.api.panel.ContainerRegion
 
hideCount() - Method in class com.trevlar.menukit.api.element.ItemDisplay.Builder
Hides the count overlay.
hideCount() - Method in class com.trevlar.menukit.api.hud.HudPanel.ItemBuilder
 
hideCount() - Method in class com.trevlar.menukit.api.hud.HudPanel.SlotBuilder
 
hideDurability() - Method in class com.trevlar.menukit.api.element.ItemDisplay.Builder
Hides the durability bar.
hideDurability() - Method in class com.trevlar.menukit.api.hud.HudPanel.ItemBuilder
 
hideDurability() - Method in class com.trevlar.menukit.api.hud.HudPanel.SlotBuilder
 
hideTitle() - Method in class com.trevlar.menukit.api.panel.MKScreen
No title band: the title is not drawn and no room is kept for it, so the main panel can reach the top of the screen.
hideWhen(BooleanSupplier) - Static method in class com.trevlar.menukit.api.element.MKTooltip
Hides every tooltip in the game, on any screen and from any source (vanilla, MenuKit elements, other mods), on every frame condition is true: both kinds, as MKTooltip.hideWhen(Predicate) with a predicate that ignores the kind.
hideWhen(Predicate) - Static method in class com.trevlar.menukit.api.element.MKTooltip
Hides each tooltip for which condition holds, asked once per tooltip with its MKTooltip.Kind: kind -> kind == Kind.ITEM && hideItems() hides item tooltips only.
hint(Component) - Method in class com.trevlar.menukit.api.element.TextField.Builder
Gray text shown while it is empty and unfocused.
hitTest(InputContext) - Method in class com.trevlar.menukit.api.element.Flow
Wants an event only over a child, so the gaps between children claim nothing.
hitTest(InputContext) - Method in class com.trevlar.menukit.api.element.ListView
Over a row's whole width (its empty area selects it), over the empty element, or over the toolbar or the reason.
hitTest(InputContext) - Method in interface com.trevlar.menukit.api.element.PanelElement
Whether this element wants the input event at the context's mouse position.
hitTest(InputContext) - Method in class com.trevlar.menukit.api.element.Section
The header, and when open any child under the point.
hitTest(List, InputContext) - Static method in class com.trevlar.menukit.api.element.ChildDispatch
Whether any shown child wants an event at the context's point.
horizontal() - Static method in class com.trevlar.menukit.api.element.Divider
A horizontal divider.
HOST_GAP - Static variable in record class com.trevlar.menukit.api.panel.PanelPosition
The PanelPosition.gap() of a position that never called PanelPosition.gap(int): "the host's own spacing" (since 7.1.0).
HOVER_OVERLAY - Static variable in class com.trevlar.menukit.api.element.ElementConstants
Translucent white filled inside a control's border while hovered or focused.
hovered() - Method in record class com.trevlar.menukit.api.element.Button.Look
Returns the value of the hovered record component.
HudCycleStrip - Class in com.trevlar.menukit.api.hud
The cycle strip: a small hotbar drawn just right of the vanilla one, showing a ring of stacks that cycles through the held hotbar slot, with a spring slide each time the ring turns (since 7.1.0).
HudCycleStrip.Axis - Enum Class in com.trevlar.menukit.api.hud
Which way a ring reads on screen.
HudCycleStrip.Direction - Enum Class in com.trevlar.menukit.api.hud
Which way a ring turned.
HudCycleStrip.SlideStart - Class in com.trevlar.menukit.api.hud
A slide's start, from HudCycleStrip.begin().
HudCycleStrip.Source - Interface in com.trevlar.menukit.api.hud
What a mod registers: the ring it would draw for a hotbar slot, if any.
HudCycleStrip.View - Record Class in com.trevlar.menukit.api.hud
One ring, as a source sees it now.
HudIcon - Class in com.trevlar.menukit.api.hud
A HUD element that draws a sprite from the GUI atlas at a given size, using vanilla's blitSprite.
HudNotification - Class in com.trevlar.menukit.api.hud
A timed HUD popup that slides in, stays for a while, then slides back out past the screen edge it came from, as vanilla's toasts do.
HudNotification.Builder - Class in com.trevlar.menukit.api.hud
 
HudNotification.SlideDirection - Enum Class in com.trevlar.menukit.api.hud
Direction the notification slides in from.
HudPanel - Class in com.trevlar.menukit.api.hud
Builds HUD panels: panels drawn on the game's heads-up display.
HudPanel.BarBuilder - Class in com.trevlar.menukit.api.hud
Configures a progress bar element.
HudPanel.Builder - Class in com.trevlar.menukit.api.hud
 
HudPanel.ItemBuilder - Class in com.trevlar.menukit.api.hud
Configures an item display element.
HudPanel.SlotBuilder - Class in com.trevlar.menukit.api.hud
Configures a HUD slot element.
HudPanel.TextBuilder - Class in com.trevlar.menukit.api.hud
Configures a text element.
HudSlot - Class in com.trevlar.menukit.api.hud
A HUD element that draws an item in a hotbar slot.

I

icon(int, int, Identifier, int, int) - Method in class com.trevlar.menukit.api.hud.HudPanel.Builder
Adds a sprite icon.
icon(ContainerTabs.Icon) - Method in class com.trevlar.menukit.api.panel.ContainerTabs.Builder
The tab's icon, drawn by the mod every frame: anything at all (an item, a sprite, an animation, a model it turns itself), fitted to the box MenuKit gives it.
icon(Supplier, int, int) - Method in class com.trevlar.menukit.api.element.Tabs.TabSpec
An icon drawSize px square left of the label, Tabs.ICON_LABEL_GAP from it: a standalone square texture textureSize texels on a side (a mod's icon read from its jar into a DynamicTexture, say), drawn whole and scaled, as Icon.Builder.texture(Supplier, int) draws it.
icon(Supplier) - Method in class com.trevlar.menukit.api.element.Button.Builder
An icon button whose sprite is read every frame (a state shown by icon).
icon(Supplier) - Method in class com.trevlar.menukit.api.panel.ContainerTabs.Builder
The tab's icon, an item, read every frame, filling the icon box: 16 px on a full-size tab, smaller in proportion on a smaller one.
icon(Identifier) - Method in class com.trevlar.menukit.api.element.Button.Builder
An icon button: sprite centered, inset 2px.
icon(Identifier) - Method in class com.trevlar.menukit.api.panel.ContainerTabs.Builder
The tab's icon, a GUI sprite of the mod's own (mymod:tab/backpack, under textures/gui/sprites/), filling the icon box, where an item icon goes.
icon(Identifier, int) - Method in class com.trevlar.menukit.api.element.Tabs.TabSpec
Tabs.TabSpec.icon(Supplier, int, int) with a GUI-atlas sprite (textures/gui/sprites) for the picture.
Icon - Class in com.trevlar.menukit.api.element
A picture at a fixed size: the "show a picture" primitive.
Icon(Icon.Builder) - Constructor for class com.trevlar.menukit.api.element.Icon
 
ICON_LABEL_GAP - Static variable in class com.trevlar.menukit.api.element.Tabs
Space between a tab's icon (Tabs.TabSpec.icon) and its label.
Icon.Builder - Class in com.trevlar.menukit.api.element
 
id() - Method in class com.trevlar.menukit.api.element.Tabs.Tab
 
id() - Method in class com.trevlar.menukit.api.element.Tabs.TabSpec
 
id() - Method in class com.trevlar.menukit.api.hud.HudNotification
The unique key this notification was registered under.
id() - Method in class com.trevlar.menukit.api.panel.Anchor
The anchor's id.
id() - Method in class com.trevlar.menukit.api.panel.Panel
This panel's id, unique within the screen.
id(String) - Method in class com.trevlar.menukit.api.dialog.AlertDialog.Builder
The Panel's id.
id(String) - Method in class com.trevlar.menukit.api.dialog.ConfirmDialog.Builder
The Panel's id.
id(String) - Method in class com.trevlar.menukit.api.dialog.EditDialog.Builder
The Panel's id.
ignored() - Method in record class com.trevlar.menukit.api.element.ItemMatch
Returns the value of the ignored record component.
ignoring(DataComponentType...) - Method in record class com.trevlar.menukit.api.element.ItemMatch
This rule, also leaving types out of the comparison in EXACT and CONTAINS: neither the rule's value for them nor the candidate's is looked at.
ignoring(DataComponentType...) - Method in class com.trevlar.menukit.api.element.ItemPicker.Builder
Component types the setting leaves out of the comparison, in EXACT and CONTAINS (ItemMatch.ignoring(DataComponentType...)): every rule the picker writes ignores them.
Ignoring components, and the count - Section in record class com.trevlar.menukit.api.element.ItemMatch
 
ignoringCount() - Method in record class com.trevlar.menukit.api.element.ItemMatch
This rule, with EXACT also leaving the count out (the other modes never compare it).
ignoringCount() - Method in class com.trevlar.menukit.api.element.ItemPicker.Builder
The setting leaves the count out of EXACT (ItemMatch.ignoringCount()): every rule the picker writes ignores it, and the Edit tab has no count, so a slot holds one.
imageHeight() - Method in record class com.trevlar.menukit.api.panel.Reference
Returns the value of the imageHeight record component.
imageWidth() - Method in record class com.trevlar.menukit.api.panel.Reference
Returns the value of the imageWidth record component.
in(ModeScope, Placement) - Method in class com.trevlar.menukit.api.panel.Contribution.Builder
The panel's placement in scope, as Panel.Builder.in(ModeScope, Placement): once per scope.
in(ModeScope, Placement) - Method in class com.trevlar.menukit.api.panel.Panel.Builder
Where the panel goes in scope (7.4.0): ModeScope.SURVIVAL, ModeScope.CREATIVE or ModeScope.BOTH, once each.
IN_FRAME - Enum constant in enum class com.trevlar.menukit.api.host.OwnHost.TitleBand
Inside the frame, above the main content (a container screen's).
inBand(boolean) - Method in class com.trevlar.menukit.api.element.Flow
 
inBand(boolean) - Method in class com.trevlar.menukit.api.element.ListView
 
inBand(boolean) - Method in interface com.trevlar.menukit.api.element.PanelElement
Whether the element sits on a list band another element draws (7.3.0): a Tabs page whose body fills it (PanelElement.fillHeight(int)).
inBand(boolean) - Method in class com.trevlar.menukit.api.element.Dropdown
 
inBand(boolean) - Method in class com.trevlar.menukit.api.element.DropdownMulti
 
inBand(boolean) - Method in class com.trevlar.menukit.api.element.MenuButton
 
inBand(boolean) - Method in class com.trevlar.menukit.api.element.ScrollContainer
 
inBand(boolean) - Method in class com.trevlar.menukit.api.element.Section
 
inBand(List, boolean) - Static method in class com.trevlar.menukit.api.element.ChildDispatch
Tells every child, shown or not, whether it sits on a band another element draws (PanelElement.inBand(boolean)).
includes(Player) - Method in enum class com.trevlar.menukit.api.panel.ModeScope
Whether this scope covers player now: ModeScope.BOTH always, otherwise its mode is this one.
inDialog(boolean) - Method in class com.trevlar.menukit.api.element.Flow
 
inDialog(boolean) - Method in class com.trevlar.menukit.api.element.ListView
 
inDialog(boolean) - Method in interface com.trevlar.menukit.api.element.PanelElement
Whether the owning panel is a dialog (a modal, Panel.tracksAsModal) rather than part of the screen, handed down when that is set (7.2.0).
inDialog(boolean) - Method in class com.trevlar.menukit.api.element.Dropdown
 
inDialog(boolean) - Method in class com.trevlar.menukit.api.element.DropdownMulti
 
inDialog(boolean) - Method in class com.trevlar.menukit.api.element.MenuButton
 
inDialog(boolean) - Method in class com.trevlar.menukit.api.element.ScrollContainer
 
inDialog(boolean) - Method in class com.trevlar.menukit.api.element.Section
 
inDialog(boolean) - Method in class com.trevlar.menukit.api.element.Tabs
 
inDialog(List, boolean) - Static method in class com.trevlar.menukit.api.element.ChildDispatch
Tells every child, shown or not, whether it is in a dialog (PanelElement.inDialog(boolean)).
INDICATOR_COLOR - Static variable in class com.trevlar.menukit.api.element.Radio
Color of the selection dot (visible on the inset interior).
INDICATOR_SIZE - Static variable in class com.trevlar.menukit.api.element.Radio
Size of the selection dot inside the square.
Inert, disabled, kinds - Section in class com.trevlar.menukit.api.element.WidgetHost
 
InfoBox - Class in com.trevlar.menukit.api.element
A block of text on a raised background: an explanation or a notice inside a panel.
InfoBox(InfoBox.Builder) - Constructor for class com.trevlar.menukit.api.element.InfoBox
 
InfoBox.Builder - Class in com.trevlar.menukit.api.element
 
init() - Static method in class com.trevlar.menukit.api.panel.Focus
Registers the ScreenEvents.AFTER_INIT listener that adds the afterMouseClick focus check to every screen.
init() - Method in class com.trevlar.menukit.api.panel.MKScreen
 
initClient() - Static method in class com.trevlar.menukit.api.MK
Called from MenuKitClient.onInitializeClient(); only logs.
input() - Method in record class com.trevlar.menukit.api.element.RenderContext
The input context for the same origin, mouse and flag: the bridge for a render-time decision that needs an input question answered (whether an open popover sits under the mouse, say).
Input - Section in class com.trevlar.menukit.api.element.Button
 
Input - Section in class com.trevlar.menukit.api.element.ScrollContainer
 
Input - Section in class com.trevlar.menukit.api.element.Toggle
 
Input - Section in class com.trevlar.menukit.api.element.WidgetHost
 
Input - Section in class com.trevlar.menukit.api.panel.VanillaScreenPanelAdapter
 
InputContext - Record Class in com.trevlar.menukit.api.element
Input-time context passed to every PanelElement input method, the input twin of RenderContext: where the element's containing content origin is on screen, where the mouse is, and whether the element's surroundings are disabled.
InputContext(int, int, double, double, boolean) - Constructor for record class com.trevlar.menukit.api.element.InputContext
A context in the Panel look: the 6.0.0 shape.
InputContext(int, int, double, double, boolean, ScreenKind) - Constructor for record class com.trevlar.menukit.api.element.InputContext
Creates an instance of a InputContext record class.
Input receives its context - Section in interface com.trevlar.menukit.api.element.PanelElement
 
INSET - Enum constant in enum class com.trevlar.menukit.api.panel.PanelStyle
Inset: dark top and left edges, light bottom and right, like a pressed button.
inside() - Method in record class com.trevlar.menukit.api.element.ItemPicker.Box
 
InsideRegion - Enum Class in com.trevlar.menukit.api.panel
A region on a reference rectangle: one of nine spots, the four corners, the four edge midpoints, and the center, inset from the edge.
install(SlotScreenHook) - Static method in interface com.trevlar.menukit.api.host.SlotScreenHook
Installs the hook.
INTERIOR_PADDING - Static variable in class com.trevlar.menukit.api.panel.Panel
 
interiorPadding() - Method in class com.trevlar.menukit.api.panel.Panel
The padding, in pixels, between the panel's outer (background) bounds and where its elements start.
In the Default look - Section in class com.trevlar.menukit.api.element.ScrollContainer
 
In the Default look - Section in class com.trevlar.menukit.api.element.Tabs
 
In the Default look - Section in class com.trevlar.menukit.api.element.Toggle
 
INVENTORY - Static variable in class com.trevlar.menukit.api.panel.ContainerRegion
The inventory panel's rectangle on a screen the region is on: for buttons that act on the inventory.
INVENTORY_BOTTOM - Enum constant in enum class com.trevlar.menukit.api.panel.ContainerTabs.Edge
Below the inventory panel's bottom edge.
INVENTORY_TOP - Enum constant in enum class com.trevlar.menukit.api.panel.ContainerTabs.Edge
Above the inventory panel's top edge, in the gap below the container list.
isBackground() - Method in class com.trevlar.menukit.api.panel.Panel
Whether this panel is part of the screen's background (Panel.Builder.background()): it draws under everything else on the screen and claims nothing.
isCreated(Slot) - Method in interface com.trevlar.menukit.api.host.SlotScreenHook
Whether slot is a created slot.
isCursorCovered(double, double) - Static method in class com.trevlar.menukit.api.panel.Focus
Whether vanilla content at the point is covered by MenuKit, by ScreenPanelRegistry.claimAt(Screen, double, double): a shown modal claims everything; an opaque panel claims its whole rectangle; a transparent panel its solid elements; an open popover its area.
isCursorCoveredAtCursor() - Static method in class com.trevlar.menukit.api.panel.Focus
Focus.isCursorCovered(double, double) at the live cursor (GUI-scaled from MouseHandler).
isDialogOpen() - Method in class com.trevlar.menukit.api.element.ColorField
Whether the dialog is open.
isDialogOpen() - Method in class com.trevlar.menukit.api.element.ItemPicker
 
isDisabled() - Method in class com.trevlar.menukit.api.panel.Panel
Whether the panel is disabled right now.
isElementOpaque() - Method in class com.trevlar.menukit.api.element.AbstractPanelElement
 
isElementOpaque() - Method in interface com.trevlar.menukit.api.element.PanelElement
Whether this element is solid, which matters on a transparent panel: there a panel claims only its solid elements (shown, opaque and interactive).
isFixed() - Method in class com.trevlar.menukit.api.panel.Panel
Whether the player can't move this panel (Panel.Builder.fixed(), 7.4.0).
isHorizontalFlow() - Method in enum class com.trevlar.menukit.api.panel.OutsideRegion
Whether panels in this region stack along the X axis.
isHovered(int, int, int, int) - Method in record class com.trevlar.menukit.api.element.RenderContext
Tests whether the mouse is over a bounded region within this context's content origin.
isHovered(RenderContext) - Method in interface com.trevlar.menukit.api.element.PanelElement
Returns whether the mouse is over this element in this render pass, using the element's own bounds.
isInertUnderPanel(double, double) - Static method in class com.trevlar.menukit.api.panel.Focus
The inertness check every suppressor of screen content uses (widget hover, list hover, creative tabs, tooltips), so they all agree on whether a point is covered.
isInertUnderPanelAtCursor() - Static method in class com.trevlar.menukit.api.panel.Focus
isInside(int[]) - Method in record class com.trevlar.menukit.api.element.InputContext
Whether the mouse is inside a screen-space rectangle [x, y, w, h].
isInteractive() - Method in class com.trevlar.menukit.api.element.Button
 
isInteractive() - Method in class com.trevlar.menukit.api.element.Checkbox
 
isInteractive() - Method in class com.trevlar.menukit.api.element.ColorField
 
isInteractive() - Method in class com.trevlar.menukit.api.element.Flow
Interactive where a child is, so on a transparent panel it claims only its children.
isInteractive() - Method in class com.trevlar.menukit.api.element.ItemPicker
 
isInteractive() - Method in class com.trevlar.menukit.api.element.ListView
 
isInteractive() - Method in interface com.trevlar.menukit.api.element.PanelElement
Whether this element handles pointer input, so a point on it is a solid claim on a transparent panel.
isInteractive() - Method in class com.trevlar.menukit.api.element.Dropdown
 
isInteractive() - Method in class com.trevlar.menukit.api.element.DropdownMulti
 
isInteractive() - Method in class com.trevlar.menukit.api.element.MenuButton
 
isInteractive() - Method in class com.trevlar.menukit.api.element.Radio
 
isInteractive() - Method in class com.trevlar.menukit.api.element.ScrollContainer
 
isInteractive() - Method in class com.trevlar.menukit.api.element.Section
 
isInteractive() - Method in class com.trevlar.menukit.api.element.Slider
 
isInteractive() - Method in class com.trevlar.menukit.api.element.Tabs
 
isInteractive() - Method in class com.trevlar.menukit.api.element.TextField
 
isInteractive() - Method in class com.trevlar.menukit.api.element.Toggle
 
isInteractive() - Method in class com.trevlar.menukit.api.element.WidgetHost
 
isLeft() - Method in record class com.trevlar.menukit.api.element.Click
 
isList() - Method in class com.trevlar.menukit.api.element.ItemPicker
Whether the setting is a list (else one item).
isManaged(Screen, GuiEventListener) - Static method in class com.trevlar.menukit.api.panel.Focus
Whether the widget was registered on the screen through Focus.addWidget(Screen, T).
isMiddle() - Method in record class com.trevlar.menukit.api.element.Click
 
isOpaque() - Method in class com.trevlar.menukit.api.panel.Panel
Whether this panel takes all input over its bounds.
isOpen() - Method in class com.trevlar.menukit.api.element.Section
Whether the section is open right now.
isOver(int, int, int, int) - Method in record class com.trevlar.menukit.api.element.InputContext
Whether the mouse is inside the box at (childX, childY) of this origin.
isOver(PanelElement) - Method in record class com.trevlar.menukit.api.element.InputContext
Whether the mouse is inside element's layout bounds at this origin.
isOverlayPositioned() - Method in class com.trevlar.menukit.api.panel.Panel
Whether this panel is a screen-centered overlay rather than part of the normal layout: true when it declares PanelPosition.center(), or is Panel.dimsBehind() or Panel.tracksAsModal().
isPlaced() - Method in record class com.trevlar.menukit.api.panel.PanelPosition
Whether a placement was declared (anything but PanelPosition.Mode.UNPLACED).
isPopover() - Method in class com.trevlar.menukit.api.panel.Panel
Whether this panel is a popover (Panel.Builder.popover()): it draws and claims above every ordinary panel on the screen, below the modal overlay.
isRecipeBookOpen() - Static method in class com.trevlar.menukit.api.MK
Whether the recipe book is visible on the active screen.
isRight() - Method in record class com.trevlar.menukit.api.element.Click
 
isSecondary() - Method in record class com.trevlar.menukit.api.element.Click
Any button other than left.
isSelected(MenuButton.Action) - Method in class com.trevlar.menukit.api.element.MenuButton
Nothing in an action menu is selected.
isSelected(T) - Method in class com.trevlar.menukit.api.element.Dropdown
 
isSelected(T) - Method in class com.trevlar.menukit.api.element.DropdownMulti
 
isSelected(T) - Method in class com.trevlar.menukit.api.element.RadioGroup
Whether value is the selected one.
isShiftRight() - Method in record class com.trevlar.menukit.api.element.Click
Right-click with shift held, for example a "pin this mode" gesture.
isStandIn(String) - Method in class com.trevlar.menukit.api.element.Tabs
Whether the tab with this id is a stand-in nothing has replaced.
isTabVisible(String) - Method in class com.trevlar.menukit.api.element.Tabs
Whether the tab with this id shows on the strip right now (its visibleWhen, read once).
isTargetedAny() - Method in class com.trevlar.menukit.api.panel.VanillaScreenPanelAdapter
isTargetingDeclared() - Method in class com.trevlar.menukit.api.panel.AnchorPanelAdapter
isTargetingDeclared() - Method in class com.trevlar.menukit.api.panel.VanillaScreenPanelAdapter
isVisible() - Method in class com.trevlar.menukit.api.element.AbstractPanelElement
 
isVisible() - Method in interface com.trevlar.menukit.api.element.PanelElement
Returns whether this element is currently visible.
isVisible() - Method in class com.trevlar.menukit.api.panel.Panel
Whether this panel is visible: the supplier's value if one is set with Panel.visibleWhen(java.util.function.BooleanSupplier), otherwise what Panel.setVisible(boolean) last set.
item(int, int) - Method in class com.trevlar.menukit.api.hud.HudPanel.Builder
Adds an item icon and returns an ItemBuilder to configure it.
item(int, int, Supplier) - Method in class com.trevlar.menukit.api.hud.HudPanel.Builder
Adds a 16x16 item icon, with count and durability shown as vanilla shows them.
item(Supplier) - Method in class com.trevlar.menukit.api.element.ItemDisplay.Builder
Required: the stack, read every frame.
item(Supplier) - Method in class com.trevlar.menukit.api.hud.HudPanel.ItemBuilder
 
item(Supplier) - Method in class com.trevlar.menukit.api.hud.HudPanel.SlotBuilder
 
item(ItemStack) - Method in class com.trevlar.menukit.api.element.ItemDisplay.Builder
Required: the stack.
ITEM - Enum constant in enum class com.trevlar.menukit.api.element.ItemMatch.Match
The kind of item only.
ITEM - Enum constant in enum class com.trevlar.menukit.api.element.MKTooltip.Kind
An item stack's tooltip, from vanilla's item paths: a slot on any container screen (the inventory and creative menu included), the recipe book's buttons and ghost slots, an item in chat, a villager's trades, and any tooltip a mod queues with setTooltipForNextFrame(font, stack, x, y) or builds from Screen.getTooltipFromItem.
ITEM_INSET - Static variable in class com.trevlar.menukit.api.element.SlotRendering
Inset between slot edge and item area, where vanilla's Slot.x/y sits.
ItemAnimation - Interface in com.trevlar.menukit.api.element
How an item draws at a point in an animation (7.4.0): given the item, its 16 px box and the animation's progress t, from 0 to 1, it draws the item.
ItemAnimation.Frame - Record Class in com.trevlar.menukit.api.element
An animation at one point: animation drawn t of the way through.
ItemAnimation.Pose - Record Class in com.trevlar.menukit.api.element
How big an item draws, about its box's center (1 is as it is), and how far it moves, in GUI pixels.
ItemAnimation.Posing - Interface in com.trevlar.menukit.api.element
The ItemAnimation.Pose at each point of an animation.
ItemDisplay - Class in com.trevlar.menukit.api.element
An item drawn at a fixed size, with its count and durability bar, and optionally a colored outline.
ItemDisplay(ItemDisplay.Builder) - Constructor for class com.trevlar.menukit.api.element.ItemDisplay
 
ItemDisplay.Builder - Class in com.trevlar.menukit.api.element
 
ItemMatch - Record Class in com.trevlar.menukit.api.element
An item rule: a stack and how another stack has to match it.
ItemMatch(ItemStack, ItemMatch.Match) - Constructor for record class com.trevlar.menukit.api.element.ItemMatch
A rule that compares every component, and in EXACT the count.
ItemMatch(ItemStack, ItemMatch.Match, Set, boolean) - Constructor for record class com.trevlar.menukit.api.element.ItemMatch
Creates an instance of a ItemMatch record class.
ItemMatch.Match - Enum Class in com.trevlar.menukit.api.element
How a stack is compared with a rule's.
ItemPicker - Class in com.trevlar.menukit.api.element
A setting whose value is an item, or a list of items: slots showing the items the setting is about, and a lens onto them.
ItemPicker(ItemPicker.Builder, Supplier, Consumer) - Constructor for class com.trevlar.menukit.api.element.ItemPicker
 
ItemPicker.Box - Record Class in com.trevlar.menukit.api.element
Something the dialog draws, x, y, w, h in its content's coordinates, and the box px, py, pw, ph it must stay inside.
ItemPicker.Builder - Class in com.trevlar.menukit.api.element
Builds an ItemPicker.
items() - Method in class com.trevlar.menukit.api.element.Dropdown
The items now: the build-time list, or what the consumer's supplier returns this time.
items() - Method in class com.trevlar.menukit.api.element.DropdownMulti
The items now: the build-time list, or what the consumer's supplier returns this time.
items() - Method in class com.trevlar.menukit.api.element.MenuButton
The items now: the build-time list, or what the consumer's supplier returns this time.
items(Supplier) - Method in class com.trevlar.menukit.api.element.ListView.Builder
Required: the items, read every frame.
itemTooltipNext() - Static method in class com.trevlar.menukit.api.element.MKTooltip
An item path is about to queue its tooltip: the next one queued is MKTooltip.Kind.ITEM.
Its kind (6.1.0) - Section in class com.trevlar.menukit.api.panel.MKScreen
 
Its panels live in one host - Section in class com.trevlar.menukit.api.panel.MKScreen
 

J

join(String, Contribution) - Static method in class com.trevlar.menukit.api.panel.SharedPanels
Adds contribution to the shared panel id, for the calling mod.
joinLines(List) - Static method in class com.trevlar.menukit.api.element.MKTooltip
One tooltip text from several lines: each line in order, separated by a \n, each keeping its own style.

K

keepLast() - Method in class com.trevlar.menukit.api.element.Flow.Builder
In a vertical Flow that wraps, the last children keep the first column and the earliest step out into the next, to its right.
key(Function) - Method in class com.trevlar.menukit.api.element.ListView.Builder
Required: an item's stable identity (an id, not its index), compared with equals.
keyed(String, ModeScope, Supplier) - Static method in class com.trevlar.menukit.api.panel.ContainerTabs
Starts a keyed list of tabs, its id namespaced and unique among tabs and lists ("mymod:boxes"), for one mode scope: one tab per key keys gives, read every frame a container screen is open, in the order it gives them.
Keyed rows - Section in class com.trevlar.menukit.api.element.ListView
 
keyPressed(int, int, int) - Method in class com.trevlar.menukit.api.host.OwnHost
A key, offered to the panels' elements top down.
keyPressed(InputContext, int, int, int) - Method in class com.trevlar.menukit.api.element.Flow
 
keyPressed(InputContext, int, int, int) - Method in class com.trevlar.menukit.api.element.ListView
Keys go to the rows first (a focused field, an open popover).
keyPressed(InputContext, int, int, int) - Method in interface com.trevlar.menukit.api.element.PanelElement
A key press, offered to every shown element of an active panel until one consumes it (keys are not pointer-localised).
keyPressed(InputContext, int, int, int) - Method in class com.trevlar.menukit.api.element.Dropdown
The keyboard, while open: Up and Down move the highlighted row (the first press lands on the first selected row), Enter or Space picks it, Escape closes the popover without closing the screen.
keyPressed(InputContext, int, int, int) - Method in class com.trevlar.menukit.api.element.DropdownMulti
The keyboard, while open: Up and Down move the highlighted row (the first press lands on the first selected row), Enter or Space picks it, Escape closes the popover without closing the screen.
keyPressed(InputContext, int, int, int) - Method in class com.trevlar.menukit.api.element.MenuButton
The keyboard, while open: Up and Down move the highlighted row (the first press lands on the first selected row), Enter or Space picks it, Escape closes the popover without closing the screen.
keyPressed(InputContext, int, int, int) - Method in class com.trevlar.menukit.api.element.ScrollContainer
 
keyPressed(InputContext, int, int, int) - Method in class com.trevlar.menukit.api.element.Section
 
keyPressed(InputContext, int, int, int) - Method in class com.trevlar.menukit.api.element.Tabs
 
keyPressed(InputContext, int, int, int) - Method in class com.trevlar.menukit.api.element.TextField
Escape while editing cancels the edit: the text from when the field took focus goes back through set, focus goes, onCancel runs, and the key is consumed so the screen stays open.
keyPressed(List, InputContext, int, int, int) - Static method in class com.trevlar.menukit.api.element.ChildDispatch
Offers a key to each shown child until one consumes it.
keyPressed(KeyEvent) - Method in class com.trevlar.menukit.api.panel.MKScreen
 
kind() - Method in record class com.trevlar.menukit.api.element.InputContext
Returns the value of the kind record component.
kind() - Method in record class com.trevlar.menukit.api.element.RenderContext
Returns the value of the kind record component.

L

label - Variable in class com.trevlar.menukit.api.element.Dropdown
 
label - Variable in class com.trevlar.menukit.api.element.DropdownMulti
 
label - Variable in class com.trevlar.menukit.api.element.MenuButton
 
label() - Method in record class com.trevlar.menukit.api.element.MenuButton.Action
Returns the value of the label record component.
label() - Method in class com.trevlar.menukit.api.element.Tabs.Tab
 
label(Function) - Method in class com.trevlar.menukit.api.element.Slider.Builder
The text inside the track for a value; the narrator reads it too.
label(Supplier) - Method in class com.trevlar.menukit.api.element.Checkbox.Builder
A label read every frame.
label(Supplier) - Method in class com.trevlar.menukit.api.element.ProgressBar.Builder
Text centered on the bar, read every frame.
label(Supplier) - Method in class com.trevlar.menukit.api.element.Radio.Builder
A label read every frame.
label(Supplier) - Method in class com.trevlar.menukit.api.element.Toggle.Builder
A label read every frame ("On" / "Off", say).
label(Supplier) - Method in class com.trevlar.menukit.api.hud.HudPanel.BarBuilder
 
label(Component) - Method in class com.trevlar.menukit.api.element.Button.Builder
The text on the button.
label(Component) - Method in class com.trevlar.menukit.api.element.Checkbox.Builder
Required: the label beside the box.
label(Component) - Method in class com.trevlar.menukit.api.element.ColorField.Builder
What the setting is called: the dialog's title, and what the narrator reads.
label(Component) - Method in class com.trevlar.menukit.api.element.ItemPicker.Builder
The dialog's title, and what the narrator reads.
label(Component) - Method in class com.trevlar.menukit.api.element.MenuButton.Builder
The trigger's text.
label(Component) - Method in class com.trevlar.menukit.api.element.Radio.Builder
Required: the label beside the square.
label(Component) - Method in class com.trevlar.menukit.api.element.Tabs.TabSpec
 
label(Component) - Method in class com.trevlar.menukit.api.element.TextField.Builder
What the narrator calls the field.
label(Component) - Method in class com.trevlar.menukit.api.element.Toggle.Builder
A label on the bar: the toggle becomes a labeled bar, sized to it.
LABEL_GAP - Static variable in class com.trevlar.menukit.api.element.Checkbox
Horizontal gap between the square and the label.
LABEL_GAP - Static variable in class com.trevlar.menukit.api.element.Radio
Gap between the square and the label.
LABEL_PAD - Static variable in class com.trevlar.menukit.api.element.ElementConstants
Horizontal padding each side of a label drawn on a control (a button, a labeled toggle).
LABEL_PAD - Static variable in class com.trevlar.menukit.api.element.Tabs
Padding on each side of a label.
LABEL_VPAD - Static variable in class com.trevlar.menukit.api.element.ElementConstants
Vertical padding above and below a label that wrapped onto several lines.
laneOutside() - Method in class com.trevlar.menukit.api.element.ScrollContainer.Builder
The scrollbar lane beside the declared width rather than inside it (7.4.0): the content has the whole width, and the container is a lane wider only while the content overflows, so what holds it makes room for the scrollbar just then.
layout() - Method in class com.trevlar.menukit.api.host.OwnHost
This frame's placements and main rectangle.
Layout - Section in class com.trevlar.menukit.api.element.Tabs
 
Layout(List, Reference) - Constructor for record class com.trevlar.menukit.api.host.OwnHost.Layout
Creates an instance of a Layout record class.
layoutElementsWithin(List, int) - Static method in class com.trevlar.menukit.api.panel.Panel
Panel.layoutElementsWithin(int) over any element list; shared with Tabs' bodies.
layoutWithin(int) - Method in class com.trevlar.menukit.api.element.AbstractPanelElement
Caps the live width to the room the panel gives, reversibly.
layoutWithin(int) - Method in class com.trevlar.menukit.api.element.Button
Caps the button to the budget, then wraps its label when the capped box can't hold it on one line.
layoutWithin(int) - Method in class com.trevlar.menukit.api.element.Checkbox
Wraps the label into the room beside the box when it does not fit on one line.
layoutWithin(int) - Method in class com.trevlar.menukit.api.element.Divider
A filling divider takes the whole budget; a sized horizontal one caps to it; a vertical one keeps its size.
layoutWithin(int) - Method in class com.trevlar.menukit.api.element.Flow
Stores the room the panel gives the Flow: the width its rows wrap at.
layoutWithin(int) - Method in class com.trevlar.menukit.api.element.Icon
 
layoutWithin(int) - Method in class com.trevlar.menukit.api.element.InfoBox
 
layoutWithin(int) - Method in class com.trevlar.menukit.api.element.ItemDisplay
 
layoutWithin(int) - Method in class com.trevlar.menukit.api.element.ItemPicker
 
layoutWithin(int) - Method in class com.trevlar.menukit.api.element.ListView
Takes the width it is given and hands it to every row.
layoutWithin(int) - Method in interface com.trevlar.menukit.api.element.PanelElement
The owning Panel (or container) calls this every layout pass with the horizontal pixel budget available to this element.
layoutWithin(int) - Method in class com.trevlar.menukit.api.element.Radio
 
layoutWithin(int) - Method in class com.trevlar.menukit.api.element.ScrollContainer
A declared viewport: the panel does not narrow it.
layoutWithin(int) - Method in class com.trevlar.menukit.api.element.Section
As wide as the room its panel gives it.
layoutWithin(int) - Method in class com.trevlar.menukit.api.element.Tabs
Width flows down: a Tabs is as wide as the room its panel gives it.
layoutWithin(int) - Method in class com.trevlar.menukit.api.element.TextField
Capped to the room it is given; filling, it takes all of it.
layoutWithin(int) - Method in class com.trevlar.menukit.api.element.TextLabel
Wraps to the budget (converted to font space) when the text does not fit; a fixed wrap width stays.
layoutWithin(int) - Method in class com.trevlar.menukit.api.element.Toggle
A labeled bar caps to the budget and wraps its label inside; a switch keeps its size.
LEFT - Enum constant in enum class com.trevlar.menukit.api.element.Tabs.Align
 
LEFT - Enum constant in enum class com.trevlar.menukit.api.hud.HudNotification.SlideDirection
 
LEFT - Static variable in record class com.trevlar.menukit.api.element.Click
 
LEFT_ALIGN_BOTTOM - Enum constant in enum class com.trevlar.menukit.api.panel.OutsideRegion
 
LEFT_ALIGN_TOP - Enum constant in enum class com.trevlar.menukit.api.panel.OutsideRegion
 
LEFT_CENTER - Enum constant in enum class com.trevlar.menukit.api.panel.InsideRegion
 
LEFT_CENTER - Enum constant in enum class com.trevlar.menukit.api.panel.OutsideRegion
Left of the reference, centered vertically on it (since 7.4.0): a column beside a box, its middle level with the box's middle.
LEFT_TO_RIGHT - Enum constant in enum class com.trevlar.menukit.api.element.ProgressBar.Direction
 
leftPos() - Method in record class com.trevlar.menukit.api.panel.Reference
Returns the value of the leftPos record component.
Lifecycle - Section in class com.trevlar.menukit.api.element.Slider
 
Lifecycle - Section in class com.trevlar.menukit.api.element.TextField
 
Lifecycle - Section in class com.trevlar.menukit.api.element.WidgetHost
 
LINEAR - Static variable in interface com.trevlar.menukit.api.element.Easing
Even speed.
lineCount(Component, int) - Static method in class com.trevlar.menukit.api.element.Text
How many lines text takes at wrapWidth (at least 1).
lines(Font, Component, int) - Static method in class com.trevlar.menukit.api.element.MKTooltip
The lines a tooltip of text draws, as MKTooltip.queue(GuiGraphicsExtractor, Component, int, int) hands them to vanilla.
lines(Component, int) - Static method in class com.trevlar.menukit.api.element.Text
The lines text breaks into at wrapWidth; one line when wrapWidth <= 0.
ListView<T> - Class in com.trevlar.menukit.api.element
A list whose rows follow the consumer's data while the screen is open (7.3.0): one row element per item, added, removed and reordered as the items change, each row kept for as long as its item's key is in the list.
ListView.Builder<T,K> - Class in com.trevlar.menukit.api.element
Builds a ListView.
ListView.Sort - Record Class in com.trevlar.menukit.api.element
The sort in use (7.3.0): which ListView.Builder.sort(Component, Comparator) option, in the order they were given, and whether it runs backwards.
liveCount(IntSupplier) - Method in class com.trevlar.menukit.api.element.SlotScroll.Builder
How many cells are live, read once a frame: only the first that many show.
Live slots - Section in class com.trevlar.menukit.api.element.SlotScroll
 
LOGGER - Static variable in class com.trevlar.menukit.api.MK
MenuKit's own logger, independent of any consuming mod's logger.
look(AbstractContainerScreen, Slot, ItemStack) - Method in interface com.trevlar.menukit.api.panel.SlotItemLooks.Look
The animation and its progress slot's stack draws with this frame on screen, or null to leave it be.
Look(boolean, boolean, boolean) - Constructor for record class com.trevlar.menukit.api.element.Button.Look
Creates an instance of a Look record class.

M

main() - Method in record class com.trevlar.menukit.api.host.OwnHost.Layout
Returns the value of the main record component.
main() - Static method in record class com.trevlar.menukit.api.panel.PanelPosition
A standalone screen's main panel, its frame: centered on the screen window; every PanelPosition.region sibling anchors to its bounds.
MAIN - Enum constant in enum class com.trevlar.menukit.api.panel.PanelPosition.Mode
A standalone screen's frame, centered on the screen window: the reference every PanelPosition.Mode.REGION sibling resolves against.
match() - Method in record class com.trevlar.menukit.api.element.ItemMatch
Returns the value of the match record component.
match() - Method in class com.trevlar.menukit.api.element.ItemPicker
The declared match mode: every slot's, or a new slot's when the player chooses.
match(ItemMatch.Match) - Method in class com.trevlar.menukit.api.element.ItemPicker.Builder
How the setting compares stacks (ItemMatch): ItemMatch.Match.ITEM (the default) keeps the kind of item only and shows no Edit tab; ItemMatch.Match.EXACT and ItemMatch.Match.CONTAINS keep the whole stack and edit it.
matches(Class) - Method in class com.trevlar.menukit.api.panel.ScreenMatcher
Whether this matcher applies to an open screen's class.
matches(AbstractContainerScreen) - Method in class com.trevlar.menukit.api.panel.ScreenMatcher
Whether this matcher applies to an open screen: its class for the class forms, the screen itself for ScreenMatcher.where(Predicate).
matches(AbstractContainerScreen) - Method in class com.trevlar.menukit.api.panel.ScreenPanelAdapter
Whether this adapter's panel appears on screen.
matches(Screen) - Method in class com.trevlar.menukit.api.panel.VanillaScreenPanelAdapter
Whether this adapter's panel appears on screen.
matches(ItemStack) - Method in record class com.trevlar.menukit.api.element.ItemMatch
Whether candidate matches this rule.
matches(ItemStack, ItemMatch.Match, ItemStack) - Static method in record class com.trevlar.menukit.api.element.ItemMatch
Whether candidate matches the rule rule under match: the comparison ItemMatch describes, for a consumer that stores a plain stack and declares the mode itself.
maxLength(int) - Method in class com.trevlar.menukit.api.element.TextField.Builder
The longest text it takes.
maybeQueueTooltip(GuiGraphicsExtractor, int, int, int, int, int, int, boolean) - Method in class com.trevlar.menukit.api.panel.Panel
Queues the panel's tooltip, if it has one, when the cursor is inside the given outer rectangle.
menu(Identifier) - Method in class com.trevlar.menukit.api.element.Tabs.Builder
Names this menu so other mods can add tabs to it with Tabs.addTo(Identifier, Tabs.TabSpec).
MENU_STACK_GAP - Static variable in class com.trevlar.menukit.api.panel.RegionConstants
Stacking gap (GUI-scaled pixels) for the menu, anchor and HUD contexts.
MenuButton - Class in com.trevlar.menukit.api.element
A button that opens a menu of actions (7.3.0): a row's "more" button, with Duplicate and Delete in it.
MenuButton.Action - Record Class in com.trevlar.menukit.api.element
One row of the menu: its label, what it does, and whether it destroys something.
MenuButton.Builder - Class in com.trevlar.menukit.api.element
PopoverControl.Builder.size(int, int) and at least one action are required; MenuButton.Builder.label(Component) is the trigger's text.
MIDDLE - Static variable in record class com.trevlar.menukit.api.element.Click
 
MIN_SIZE - Static variable in class com.trevlar.menukit.api.panel.ContainerTabs
The smallest a tab can be, either way: its sprite's corners and edges, kept whole.
MIN_TAB_WIDTH - Static variable in class com.trevlar.menukit.api.element.Tabs
Narrowest a tab gets, whatever its label.
minRows(int) - Method in class com.trevlar.menukit.api.element.SlotScroll.Builder
The fewest rows it is ever as tall as, however few are live or short the window; 3 by default, a chest's.
MK - Class in com.trevlar.menukit.api
Mod entry point for MenuKit and the process-wide facade for HUD panels, notifications, and the recipe-book query.
MK() - Constructor for class com.trevlar.menukit.api.MK
 
MKScreen - Class in com.trevlar.menukit.api.panel
Base class for standalone screens built with MenuKit: full-screen, client-local, interactive UIs not tied to a container menu.
MKScreen(Component, ScreenKind, List) - Constructor for class com.trevlar.menukit.api.panel.MKScreen
A screen of the given kind: ScreenKind.DEFAULT for a settings screen in the pause-menu look, ScreenKind.PANEL for MenuKit's own.
MKScreen(Component, List) - Constructor for class com.trevlar.menukit.api.panel.MKScreen
A Panel-look screen (ScreenKind.PANEL): MenuKit's gray look, the look every standalone screen had before 6.1.0.
MKTooltip - Class in com.trevlar.menukit.api.element
The one place a hover tooltip is queued: every element tooltip and the panel tooltip go through MKTooltip.queue(GuiGraphicsExtractor, Component, int, int) instead of calling vanilla's setTooltipForNextFrame directly.
MKTooltip.Kind - Enum Class in com.trevlar.menukit.api.element
What a tooltip shows, as MKTooltip.hideWhen(Predicate) sees it.
MKTooltip.Wheel - Interface in com.trevlar.menukit.api.element
modal() - Method in class com.trevlar.menukit.api.panel.Panel
Sets all three modal flags, the same as opaque(true).dimsBehind(true).tracksAsModal(true): a real modal in one call.
mode() - Method in record class com.trevlar.menukit.api.panel.PanelPosition
Returns the value of the mode record component.
mode(Tabs.Mode) - Method in class com.trevlar.menukit.api.element.Tabs.Builder
ModeScope - Enum Class in com.trevlar.menukit.api.panel
Which game mode a declaration is for (7.4.0): ModeScope.SURVIVAL, ModeScope.CREATIVE or ModeScope.BOTH.
modId() - Method in class com.trevlar.menukit.api.panel.AnchorPanelAdapter
 
modId() - Method in class com.trevlar.menukit.api.panel.ScreenPanelAdapter
The registering mod (the tie-break after priority).
modId() - Method in class com.trevlar.menukit.api.panel.VanillaScreenPanelAdapter
 
mouseClicked(double, double, int) - Method in class com.trevlar.menukit.api.host.OwnHost
A press: the topmost panel under the point takes it.
mouseClicked(InputContext, int) - Method in class com.trevlar.menukit.api.element.Button
Left click presses (sound, then onClick); another button reaches onSecondaryClick, if set.
mouseClicked(InputContext, int) - Method in class com.trevlar.menukit.api.element.Checkbox
 
mouseClicked(InputContext, int) - Method in class com.trevlar.menukit.api.element.ColorField
Left click opens the dialog.
mouseClicked(InputContext, int) - Method in class com.trevlar.menukit.api.element.Flow
 
mouseClicked(InputContext, int) - Method in class com.trevlar.menukit.api.element.ItemPicker
Left click on a filled slot's remove button, or right click on any slot, empties it (a list drops it, the rest moving up); left click anywhere else opens the dialog at the slot.
mouseClicked(InputContext, int) - Method in class com.trevlar.menukit.api.element.ListView
 
mouseClicked(InputContext, int) - Method in interface com.trevlar.menukit.api.element.PanelElement
A mouse click on this element (the dispatcher hit-tested first).
mouseClicked(InputContext, int) - Method in class com.trevlar.menukit.api.element.Dropdown
Left click: in the open popover, a row (the dispatcher gave it to this element exclusively); on the trigger, open or close.
mouseClicked(InputContext, int) - Method in class com.trevlar.menukit.api.element.DropdownMulti
Left click: in the open popover, a row (the dispatcher gave it to this element exclusively); on the trigger, open or close.
mouseClicked(InputContext, int) - Method in class com.trevlar.menukit.api.element.MenuButton
Left click: in the open popover, a row (the dispatcher gave it to this element exclusively); on the trigger, open or close.
mouseClicked(InputContext, int) - Method in class com.trevlar.menukit.api.element.Radio
 
mouseClicked(InputContext, int) - Method in class com.trevlar.menukit.api.element.ScrollContainer
 
mouseClicked(InputContext, int) - Method in class com.trevlar.menukit.api.element.Section
 
mouseClicked(InputContext, int) - Method in class com.trevlar.menukit.api.element.Slider
 
mouseClicked(InputContext, int) - Method in class com.trevlar.menukit.api.element.Tabs
 
mouseClicked(InputContext, int) - Method in class com.trevlar.menukit.api.element.TextField
 
mouseClicked(InputContext, int) - Method in class com.trevlar.menukit.api.element.Toggle
 
mouseClicked(InputContext, int) - Method in class com.trevlar.menukit.api.element.WidgetHost
 
mouseClicked(List, InputContext, int) - Static method in class com.trevlar.menukit.api.element.ChildDispatch
Routes a click: an open overlay under the point takes it exclusively (it counts as consumed whatever the owner answers, so nothing behind a popover sees it), else the first hit-tested child that consumes it.
mouseClicked(AbstractContainerScreen, double, double, int) - Method in interface com.trevlar.menukit.api.host.SlotScreenHook
At mouseClicked: eats a click in a shown slot panel's empty space, so a carried item cannot drop through to the inert vanilla slot behind it.
mouseClicked(MouseButtonEvent, boolean) - Method in class com.trevlar.menukit.api.panel.MKScreen
 
mouseReleased(double, double, int) - Method in class com.trevlar.menukit.api.host.OwnHost
A release, offered to every element so a drag ends wherever the cursor is.
mouseReleased(InputContext, int) - Method in class com.trevlar.menukit.api.element.Button
Releases the press affordance, wherever the cursor now is.
mouseReleased(InputContext, int) - Method in class com.trevlar.menukit.api.element.Flow
 
mouseReleased(InputContext, int) - Method in class com.trevlar.menukit.api.element.ListView
 
mouseReleased(InputContext, int) - Method in interface com.trevlar.menukit.api.element.PanelElement
A mouse release anywhere on the screen, not hit-tested, so a drag that started on the element ends wherever the cursor now is.
mouseReleased(InputContext, int) - Method in class com.trevlar.menukit.api.element.ScrollContainer
 
mouseReleased(InputContext, int) - Method in class com.trevlar.menukit.api.element.Section
Broadcast even when closed, so a drag or capture begun before closing can end.
mouseReleased(InputContext, int) - Method in class com.trevlar.menukit.api.element.Slider
 
mouseReleased(InputContext, int) - Method in class com.trevlar.menukit.api.element.Tabs
 
mouseReleased(InputContext, int) - Method in class com.trevlar.menukit.api.element.TextField
 
mouseReleased(InputContext, int) - Method in class com.trevlar.menukit.api.element.WidgetHost
 
mouseReleased(List, InputContext, int) - Static method in class com.trevlar.menukit.api.element.ChildDispatch
Offers a release to every shown child, not hit-tested and not gated by disabled.
mouseReleased(AbstractContainerScreen, double, double, int) - Method in interface com.trevlar.menukit.api.host.SlotScreenHook
At mouseReleased: whether a drag over a slot region consumed it.
mouseReleased(MouseButtonEvent) - Method in class com.trevlar.menukit.api.panel.MKScreen
 
mouseScrolled(double, double, double, double) - Method in class com.trevlar.menukit.api.host.OwnHost
A scroll: the topmost panel under the point takes it.
mouseScrolled(double, double, double, double) - Method in class com.trevlar.menukit.api.panel.MKScreen
 
mouseScrolled(InputContext, double, double) - Method in class com.trevlar.menukit.api.element.Flow
 
mouseScrolled(InputContext, double, double) - Method in class com.trevlar.menukit.api.element.ListView
 
mouseScrolled(InputContext, double, double) - Method in interface com.trevlar.menukit.api.element.PanelElement
A wheel scroll over this element (hit-tested first).
mouseScrolled(InputContext, double, double) - Method in class com.trevlar.menukit.api.element.Dropdown
The wheel over the open popover scrolls its items one row per notch.
mouseScrolled(InputContext, double, double) - Method in class com.trevlar.menukit.api.element.DropdownMulti
The wheel over the open popover scrolls its items one row per notch.
mouseScrolled(InputContext, double, double) - Method in class com.trevlar.menukit.api.element.MenuButton
The wheel over the open popover scrolls its items one row per notch.
mouseScrolled(InputContext, double, double) - Method in class com.trevlar.menukit.api.element.ScrollContainer
 
mouseScrolled(InputContext, double, double) - Method in class com.trevlar.menukit.api.element.Section
 
mouseScrolled(InputContext, double, double) - Method in class com.trevlar.menukit.api.element.Slider
 
mouseScrolled(InputContext, double, double) - Method in class com.trevlar.menukit.api.element.Tabs
 
mouseScrolled(InputContext, double, double) - Method in class com.trevlar.menukit.api.element.TextField
 
mouseScrolled(InputContext, double, double) - Method in class com.trevlar.menukit.api.element.WidgetHost
 
mouseScrolled(List, InputContext, double, double) - Static method in class com.trevlar.menukit.api.element.ChildDispatch
Routes a wheel scroll, in the same order as ChildDispatch.mouseClicked(List, InputContext, int).
mouseScrolled(AbstractContainerScreen, double, double, double, double) - Method in interface com.trevlar.menukit.api.host.SlotScreenHook
At mouseScrolled: whether a slot region consumed the scroll.
mouseX() - Method in record class com.trevlar.menukit.api.element.InputContext
Returns the value of the mouseX record component.
mouseX() - Method in record class com.trevlar.menukit.api.element.RenderContext
Returns the value of the mouseX record component.
mouseY() - Method in record class com.trevlar.menukit.api.element.InputContext
Returns the value of the mouseY record component.
mouseY() - Method in record class com.trevlar.menukit.api.element.RenderContext
Returns the value of the mouseY record component.
move(BiConsumer) - Method in class com.trevlar.menukit.api.element.ListView.Builder
Up and down buttons in the toolbar, after remove, that move the selected row one place (with ListView.Builder.controlsInRows(), in each row): a click hands the row's key and the place it should go in items() to move.
moved(double, double) - Method in interface com.trevlar.menukit.api.element.MKTooltip.Wheel
 
moveLive(int) - Method in class com.trevlar.menukit.api.element.ListView
Whether the toolbar's up (by -1) or down (+1) is live.
Moving what is below it - Section in class com.trevlar.menukit.api.element.Section
 
Multi-line body - Section in class com.trevlar.menukit.api.dialog.ConfirmDialog
 
MUTED - Enum constant in enum class com.trevlar.menukit.api.element.TextRole
Secondary text: a summary, a hint, a note under a setting.

N

name(Supplier) - Method in class com.trevlar.menukit.api.panel.ContainerRegion.Builder
What the section is called while its ContainerRegion.Builder.title comes out blank and other sections show, read every frame, in place of its container's own name.
Narrowing or a lane outside - Section in class com.trevlar.menukit.api.element.SlotScroll
 
narrows() - Method in class com.trevlar.menukit.api.element.SlotScroll.Builder
One column fewer while it scrolls, the scrollbar in the column freed (a bundle), so it is never wider than its columns.
naturalWidth() - Method in class com.trevlar.menukit.api.element.AbstractPanelElement
The authored width: what the element asks for with room to spare.
naturalWidth() - Method in class com.trevlar.menukit.api.element.Button
 
naturalWidth() - Method in class com.trevlar.menukit.api.element.Checkbox
 
naturalWidth() - Method in class com.trevlar.menukit.api.element.Divider
A filling divider asks for no width, so it never widens its panel.
naturalWidth() - Method in class com.trevlar.menukit.api.element.Flow
Every child side by side (spacers take nothing), whatever is visible: a budget stable across reveals.
naturalWidth() - Method in class com.trevlar.menukit.api.element.InfoBox
 
naturalWidth() - Method in class com.trevlar.menukit.api.element.ListView
 
naturalWidth() - Method in interface com.trevlar.menukit.api.element.PanelElement
The element's natural (authored or intrinsic) width before any panel width constraint: what it wants when the panel has room.
naturalWidth() - Method in class com.trevlar.menukit.api.element.Radio
 
naturalWidth() - Method in class com.trevlar.menukit.api.element.ScrollContainer
Fitting its width: the widest child, the band's inset and the scrollbar lane.
naturalWidth() - Method in class com.trevlar.menukit.api.element.Section
The whole header on one line, or the widest child, whichever is wider.
naturalWidth() - Method in class com.trevlar.menukit.api.element.Tabs
What it wants with room to spare: every visible tab on one row, or the widest body, whichever is wider.
naturalWidth() - Method in class com.trevlar.menukit.api.element.TextField
Its size's width; filling, at least its hint's, so the hint is never cut off.
naturalWidth() - Method in class com.trevlar.menukit.api.element.TextLabel
 
naturalWidth() - Method in class com.trevlar.menukit.api.element.Toggle
The labeled bar's natural width: its label plus padding, at least the authored width.
Nesting - Section in class com.trevlar.menukit.api.layout.Row
 
NONE - Enum constant in enum class com.trevlar.menukit.api.host.OwnHost.TitleBand
Nowhere: no title and no room reserved.
NONE - Enum constant in enum class com.trevlar.menukit.api.panel.PanelStyle
No background.
NONE - Static variable in record class com.trevlar.menukit.api.element.ItemAnimation.Pose
As it is.
noShadow() - Method in class com.trevlar.menukit.api.hud.HudPanel.TextBuilder
 
notify(String, String) - Static method in class com.trevlar.menukit.api.MK
Triggers a notification by key.
notify(String, String, ItemStack) - Static method in class com.trevlar.menukit.api.MK
Triggers a notification with text and an item icon.
notify(String, String, Item) - Static method in class com.trevlar.menukit.api.MK
Triggers a notification with text and an item type.
notifyClickOutside(List, InputContext) - Static method in class com.trevlar.menukit.api.element.ChildDispatch
Tells every shown child about a click, so an open popover it fell outside of closes.
notifyClickOutsideOverlay(InputContext) - Method in class com.trevlar.menukit.api.element.Flow
 
notifyClickOutsideOverlay(InputContext) - Method in class com.trevlar.menukit.api.element.ListView
A click outside the list takes the keyboard from it; every row hears about it for its popovers.
notifyClickOutsideOverlay(InputContext) - Method in interface com.trevlar.menukit.api.element.PanelElement
Tells an element with transient open state (a popover) that a click landed somewhere it did not claim, so it can close.
notifyClickOutsideOverlay(InputContext) - Method in class com.trevlar.menukit.api.element.Dropdown
A click outside both the popover and the trigger closes it, as every native popup does.
notifyClickOutsideOverlay(InputContext) - Method in class com.trevlar.menukit.api.element.DropdownMulti
A click outside both the popover and the trigger closes it, as every native popup does.
notifyClickOutsideOverlay(InputContext) - Method in class com.trevlar.menukit.api.element.MenuButton
A click outside both the popover and the trigger closes it, as every native popup does.
notifyClickOutsideOverlay(InputContext) - Method in class com.trevlar.menukit.api.element.ScrollContainer
 
notifyClickOutsideOverlay(InputContext) - Method in class com.trevlar.menukit.api.element.Section
 
notifyClickOutsideOverlay(InputContext) - Method in class com.trevlar.menukit.api.element.Tabs
An outside click reaches the headers and the shown body, so an open popover there (a Dropdown) closes like one anywhere else.
notifyOutsideClick(double, double) - Method in class com.trevlar.menukit.api.host.OwnHost
Closes any open popover the click at the point fell outside of.

O

of(int) - Static method in record class com.trevlar.menukit.api.element.Click
Captures the click for button with the current modifier state.
of(int, Easing) - Static method in class com.trevlar.menukit.api.element.Transition
A transition that takes millis from one end to the other, eased by easing.
of(PanelElement) - Static method in interface com.trevlar.menukit.api.layout.ElementSpec
An already-built element as a spec: reports its live size and, at layout time, moves it with setChildPosition.
of(Screen) - Static method in enum class com.trevlar.menukit.api.panel.ScreenKind
The look of screen.
of(Screen, ScreenKind, OwnHost.TitleBand) - Static method in class com.trevlar.menukit.api.host.OwnHost
A host for screen's own panels, laid out against the screen's size each frame (so it may be made in the screen's constructor, before its size is set).
of(Identifier, Function) - Static method in class com.trevlar.menukit.api.panel.Anchor
Declares an anchor.
of(Player) - Static method in enum class com.trevlar.menukit.api.panel.ModeScope
The mode player is in now: ModeScope.CREATIVE while it has infinite materials, ModeScope.SURVIVAL otherwise, and null with no player.
of(Slot) - Static method in record class com.trevlar.menukit.api.host.SlotHoverResult
A shown slot wins the point.
of(ItemStack) - Static method in record class com.trevlar.menukit.api.panel.ContainerRegion.Source
A container opened from its item (a shulker box in the inventory): the item's block, so its dye, and the name the player gave it.
of(BlockEntity) - Static method in record class com.trevlar.menukit.api.panel.ContainerRegion.Source
A placed container: its block, its custom name, its position.
ofEnum(Class) - Static method in class com.trevlar.menukit.api.element.Dropdown
The enum lens: every constant of type, in declaration order.
ofEnum(Class) - Static method in class com.trevlar.menukit.api.element.Slider
A slider over an enum's constants, in declaration order (the enum lens).
offset(int, int) - Method in class com.trevlar.menukit.api.hud.HudNotification.Builder
A pixel nudge after placement (default 0, 6: 10px below the top edge).
offset(int, int) - Method in class com.trevlar.menukit.api.hud.HudPanel.Builder
A pixel nudge after placement (positive x right, positive y down).
offset(int, int) - Method in record class com.trevlar.menukit.api.panel.PanelPosition
This position nudged by (dx, dy) pixels after placement (positive x right, positive y down).
offsetX() - Method in record class com.trevlar.menukit.api.element.ItemAnimation.Pose
Returns the value of the offsetX record component.
offsetY() - Method in record class com.trevlar.menukit.api.element.ItemAnimation.Pose
Returns the value of the offsetY record component.
ofInts(int, int) - Static method in class com.trevlar.menukit.api.element.Dropdown
The integer lens: the whole numbers min to max inclusive, labeled with themselves.
ofInts(int, int) - Static method in class com.trevlar.menukit.api.element.Slider
A slider over the whole numbers min to max inclusive (the integer lens).
on(Anchor...) - Method in class com.trevlar.menukit.api.panel.AnchorPanelAdapter
Deprecated, for removal: This API element is subject to removal in a future version.
Replaced in 7.4.0 by Placement.around(Anchor, PanelPosition), the anchor in the placement; removed in 8.0.0. in(ModeScope.BOTH, Placement.around(anchor, position)) on the panel is position(position) with this call, and needs no on.
on(Class...) - Method in class com.trevlar.menukit.api.panel.ContainerRegion.Builder
The screens it is on.
on(Class...) - Method in class com.trevlar.menukit.api.panel.ContainerRegion.Sections
The screens it is on, and where keys is asked.
on(Class...) - Method in class com.trevlar.menukit.api.panel.ContainerTabs.Builder
The screens it is on.
on(Class...) - Method in class com.trevlar.menukit.api.panel.ContainerTabs.Groups
The screens their tabs are on.
on(Class...) - Method in class com.trevlar.menukit.api.panel.ContainerTabs.Keyed
The screens its tabs are on.
on(Class...) - Method in class com.trevlar.menukit.api.panel.ScreenPanelAdapter
Narrows the panel to screens that are instances of one of screenClasses (class ancestry: ChestScreen covers modded subclasses).
on(Class...) - Method in class com.trevlar.menukit.api.panel.VanillaScreenPanelAdapter
The screens this panel appears on, by class ancestry (OR across classes).
onAcknowledge(Runnable) - Method in class com.trevlar.menukit.api.dialog.AlertDialog.Builder
Runs when the player clicks the acknowledge button, or presses Escape.
onAny() - Method in class com.trevlar.menukit.api.panel.ScreenPanelAdapter
Every container screen, said explicitly.
onAny() - Method in class com.trevlar.menukit.api.panel.VanillaScreenPanelAdapter
Every non-container screen.
onAttach(Screen) - Method in class com.trevlar.menukit.api.element.Button
 
onAttach(Screen) - Method in class com.trevlar.menukit.api.element.Checkbox
 
onAttach(Screen) - Method in class com.trevlar.menukit.api.element.ColorField
Joins the screen: the swatch's stand-in, and the dialog on the screen's dialog host, so it can open over whatever screen the field is on.
onAttach(Screen) - Method in class com.trevlar.menukit.api.element.Flow
 
onAttach(Screen) - Method in class com.trevlar.menukit.api.element.ItemPicker
Joins the screen: the page's stand-in, and the dialog on the screen's dialog host, so it can open over whatever screen the picker is on.
onAttach(Screen) - Method in class com.trevlar.menukit.api.element.ListView
 
onAttach(Screen) - Method in interface com.trevlar.menukit.api.element.PanelElement
Screen-attach lifecycle hook, called when the containing screen reaches its init().
onAttach(Screen) - Method in class com.trevlar.menukit.api.element.Dropdown
 
onAttach(Screen) - Method in class com.trevlar.menukit.api.element.DropdownMulti
 
onAttach(Screen) - Method in class com.trevlar.menukit.api.element.MenuButton
 
onAttach(Screen) - Method in class com.trevlar.menukit.api.element.Radio
 
onAttach(Screen) - Method in class com.trevlar.menukit.api.element.ScrollContainer
 
onAttach(Screen) - Method in class com.trevlar.menukit.api.element.Section
Every child attaches, open or not, as a hidden panel's elements do.
onAttach(Screen) - Method in class com.trevlar.menukit.api.element.Slider
 
onAttach(Screen) - Method in class com.trevlar.menukit.api.element.Tabs
Every tab's body attaches, shown or not, as a hidden panel's elements do.
onAttach(Screen) - Method in class com.trevlar.menukit.api.element.TextField
 
onAttach(Screen) - Method in class com.trevlar.menukit.api.element.Toggle
 
onAttach(Screen) - Method in class com.trevlar.menukit.api.element.WidgetHost
 
onCancel(Runnable) - Method in class com.trevlar.menukit.api.dialog.ConfirmDialog.Builder
Runs when the player clicks Cancel, or presses Escape.
onCancel(Runnable) - Method in class com.trevlar.menukit.api.dialog.EditDialog.Builder
Runs on Cancel and on Escape: close the dialog, leaving the draft unwritten.
onCancel(Runnable) - Method in class com.trevlar.menukit.api.element.TextField.Builder
What Escape on the focused field does after it puts the text back and lets go of focus (7.3.0): a row leaving its rename mode, say.
onClick(Runnable) - Method in class com.trevlar.menukit.api.element.Button.Builder
What a left click (or Enter on the focused button) does.
onClick(Runnable) - Method in class com.trevlar.menukit.api.panel.ContainerTabs.Builder
What a left click on it does, with vanilla's click sound.
onClose() - Method in class com.trevlar.menukit.api.panel.MKScreen
 
onConfirm(Runnable) - Method in class com.trevlar.menukit.api.dialog.ConfirmDialog.Builder
Runs when the player clicks Confirm.
onDetach(Screen) - Method in class com.trevlar.menukit.api.element.Button
Leaving a screen ends the press: the button outlives the screen, its press does not.
onDetach(Screen) - Method in class com.trevlar.menukit.api.element.Checkbox
 
onDetach(Screen) - Method in class com.trevlar.menukit.api.element.ColorField
 
onDetach(Screen) - Method in class com.trevlar.menukit.api.element.Flow
 
onDetach(Screen) - Method in class com.trevlar.menukit.api.element.ItemPicker
 
onDetach(Screen) - Method in class com.trevlar.menukit.api.element.ListView
 
onDetach(Screen) - Method in interface com.trevlar.menukit.api.element.PanelElement
Screen-detach lifecycle hook, the mirror of PanelElement.onAttach(Screen).
onDetach(Screen) - Method in class com.trevlar.menukit.api.element.Dropdown
Leaving the screen (or a list that dropped its row) closes the popover.
onDetach(Screen) - Method in class com.trevlar.menukit.api.element.DropdownMulti
Leaving the screen (or a list that dropped its row) closes the popover.
onDetach(Screen) - Method in class com.trevlar.menukit.api.element.MenuButton
Leaving the screen (or a list that dropped its row) closes the popover.
onDetach(Screen) - Method in class com.trevlar.menukit.api.element.Radio
 
onDetach(Screen) - Method in class com.trevlar.menukit.api.element.ScrollContainer
Leaving a screen ends a scrollbar drag: its release may never reach this container.
onDetach(Screen) - Method in class com.trevlar.menukit.api.element.Section
 
onDetach(Screen) - Method in class com.trevlar.menukit.api.element.Slider
 
onDetach(Screen) - Method in class com.trevlar.menukit.api.element.Tabs
Leaving a screen ends a tab-column scrollbar drag: its release may never reach these tabs.
onDetach(Screen) - Method in class com.trevlar.menukit.api.element.TextField
 
onDetach(Screen) - Method in class com.trevlar.menukit.api.element.Toggle
 
onDetach(Screen) - Method in class com.trevlar.menukit.api.element.WidgetHost
 
One anchor per id - Section in class com.trevlar.menukit.api.panel.Anchor
 
onEscape(Runnable) - Method in class com.trevlar.menukit.api.panel.Panel
Sets the action run when the player presses Escape while this panel is the topmost visible modal.
One scroller - Section in class com.trevlar.menukit.api.element.ScrollContainer
 
One vocabulary - Section in class com.trevlar.menukit.api.element.AbstractPanelElement
 
onHiddenLanding(Runnable) - Method in class com.trevlar.menukit.api.panel.ContainerRegion.Builder
What happens when a quick move (a shift-click) lands an item in this section while it is hidden: the region scrolls to a slot only in a shown section, so this is the mod's chance to show it (pick its tab, say).
only(Class...) - Static method in class com.trevlar.menukit.api.panel.ScreenMatcher
Only the named screens and their subclasses, for a slot that belongs on a fixed set of screens rather than everywhere.
onMatching(ScreenMatcher) - Method in class com.trevlar.menukit.api.panel.ContainerRegion.Builder
The screens it is on, by a matcher.
onMatching(ScreenMatcher) - Method in class com.trevlar.menukit.api.panel.ContainerRegion.Sections
The screens it is on, by a matcher.
onMatching(ScreenMatcher) - Method in class com.trevlar.menukit.api.panel.ContainerTabs.Builder
The screens it is on, by a matcher.
onMatching(ScreenMatcher) - Method in class com.trevlar.menukit.api.panel.ContainerTabs.Groups
The screens their tabs are on, by a matcher.
onMatching(ScreenMatcher) - Method in class com.trevlar.menukit.api.panel.ContainerTabs.Keyed
The screens its tabs are on, by a matcher.
onMatching(ScreenMatcher) - Method in class com.trevlar.menukit.api.panel.ScreenPanelAdapter
Every screen a ScreenMatcher accepts, typically ScreenMatcher.all() or an allExcept opt-out, or a scope only known per screen (ScreenMatcher.where(Predicate), 7.3.0): a slot group's screens, so a mod's own panel of the group's slots shows on exactly the screens whose menus hold them.
onPlayerInventory() - Method in class com.trevlar.menukit.api.panel.ScreenPanelAdapter
The player inventory in both game modes: InventoryScreen and CreativeModeInventoryScreen are siblings, so .on(InventoryScreen.class) alone silently misses creative.
onRender(Runnable) - Method in class com.trevlar.menukit.api.element.TextLabel.Builder
Runs at the top of every render (a HUD counter or animation driver).
onRender(Runnable) - Method in class com.trevlar.menukit.api.hud.HudPanel.SlotBuilder
 
onRender(Runnable) - Method in class com.trevlar.menukit.api.hud.HudPanel.TextBuilder
 
onSave(Runnable) - Method in class com.trevlar.menukit.api.dialog.EditDialog.Builder
Runs on Save: write the draft back and change the state that shows the dialog.
onSecondaryClick(Consumer) - Method in class com.trevlar.menukit.api.element.Button.Builder
Handles every non-left mouse button (right, middle, shift+right, via the Click); those clicks are consumed instead of reaching vanilla.
onSecondaryClick(Consumer) - Method in class com.trevlar.menukit.api.element.Toggle.Builder
Handles every non-left mouse button; those clicks never flip the toggle.
onSubmit(Consumer) - Method in class com.trevlar.menukit.api.element.TextField.Builder
What Enter on the focused field does, with its text.
On the page - Section in class com.trevlar.menukit.api.element.ItemPicker
 
onWheel(MKTooltip.Wheel) - Static method in class com.trevlar.menukit.api.element.MKTooltip
Calls listener when the mouse wheel moves on a screen while a tooltip is shown.
opaque - Variable in class com.trevlar.menukit.api.element.AbstractPanelElement.Builder
 
opaque(boolean) - Method in class com.trevlar.menukit.api.element.AbstractPanelElement.Builder
Whether the element is solid on a transparent panel (Panel.opaque(false)): there only solid, interactive elements claim input, so a non-opaque one lets clicks, hover and tooltips through to what is behind it.
opaque(boolean) - Method in class com.trevlar.menukit.api.panel.Panel
Sets whether this panel takes all input over its bounds.
open(boolean) - Method in class com.trevlar.menukit.api.element.Section.Builder
Starts open (view state).
OPEN_LID - Static variable in interface com.trevlar.menukit.api.element.ItemAnimation
A box opening, its lid t open: the openness vanilla's own shulker box and chest renderers take, so a shulker box's lid lifts and twists open and a chest's (an ender chest's, a copper one's, a trapped one's) swings up, in whatever model and texture the resource pack gives them.
openDialog() - Method in class com.trevlar.menukit.api.element.ColorField
Opens the dialog, remembering the color to go back to.
openDialog(int) - Method in class com.trevlar.menukit.api.element.ItemPicker
Opens the dialog with slot slot selected.
openedOn() - Static method in class com.trevlar.menukit.api.panel.ContainerRegion
The container the open screen was opened on, the source its own sections (those with no source) take: the block under the crosshair as it opened, when it holds a container of the screen's size and title.
Open state: view state, or the consumer's - Section in class com.trevlar.menukit.api.element.Section
 
option() - Method in record class com.trevlar.menukit.api.element.ListView.Sort
Returns the value of the option record component.
OPTIONS - Static variable in enum class com.trevlar.menukit.api.panel.ScreenKind
Deprecated, for removal: This API element is subject to removal in a future version.
Renamed ScreenKind.DEFAULT in 7.3.0; removed in 8.0.0.
OPTIONS_INSET_X - Static variable in class com.trevlar.menukit.api.element.ScrollContainer
Deprecated, for removal: This API element is subject to removal in a future version.
Renamed ScrollContainer.DEFAULT_INSET_X in 7.3.0 (the Default look); removed in 8.0.0.
OPTIONS_INSET_Y - Static variable in class com.trevlar.menukit.api.element.ScrollContainer
Deprecated, for removal: This API element is subject to removal in a future version.
Renamed ScrollContainer.DEFAULT_INSET_Y in 7.3.0 (the Default look); removed in 8.0.0.
order(int) - Method in class com.trevlar.menukit.api.panel.ContainerRegion.Builder
Where it stacks: lower is higher up; ties go by id.
order(int) - Method in class com.trevlar.menukit.api.panel.ContainerTabs.Builder
Where it goes in its row: lower is further left; ties go by id.
order(int) - Method in class com.trevlar.menukit.api.panel.ContainerTabs.Groups
Where the groups go in their row, every tab of them together, in the group keys' order: lower is further left; ties go by id.
order(int) - Method in class com.trevlar.menukit.api.panel.ContainerTabs.Keyed
Where the list goes in its row, every tab of it together, in the keys' order: lower is further left; ties go by id.
originX() - Method in record class com.trevlar.menukit.api.element.InputContext
Returns the value of the originX record component.
originX() - Method in record class com.trevlar.menukit.api.element.RenderContext
Returns the value of the originX record component.
originY() - Method in record class com.trevlar.menukit.api.element.InputContext
Returns the value of the originY record component.
originY() - Method in record class com.trevlar.menukit.api.element.RenderContext
Returns the value of the originY record component.
OTHER - Enum constant in enum class com.trevlar.menukit.api.element.MKTooltip.Kind
Every other tooltip: a button, a tab, an effect, a MenuKit element, a panel.
outline(int) - Method in class com.trevlar.menukit.api.element.ItemDisplay.Builder
A one-pixel outline of this ARGB color around the item's silhouette.
outline(IntSupplier) - Method in class com.trevlar.menukit.api.element.ItemDisplay.Builder
An outline color read every frame; 0 draws none.
Outline - Section in class com.trevlar.menukit.api.element.ItemDisplay
 
OutsideRegion - Enum Class in com.trevlar.menukit.api.panel
A region outside a reference rectangle: pick a side, pick which end to align to, and stack away from that end.
over(String, SlotDecorations.Decoration) - Static method in class com.trevlar.menukit.api.panel.SlotDecorations
Declares a decoration drawn over the item, its count and its durability bar, its id namespaced and unique among every decoration ("mymod:padlock").
overflow() - Method in class com.trevlar.menukit.api.element.WidgetHost.Builder
Lets the widget draw past its rectangle while it holds focus (a dropdown's open list): on top of the screen's panels, taking clicks anywhere until a click it does not take ends its focus.
Overflow - Section in class com.trevlar.menukit.api.element.WidgetHost
 
overlayOwner(List, InputContext) - Static method in class com.trevlar.menukit.api.element.ChildDispatch
The shown child whose open overlay contains the point, or null.
ownDisabled() - Method in class com.trevlar.menukit.api.element.AbstractPanelElement
Whether this element's own disabledWhen holds (not the cascade).
OwnHost - Class in com.trevlar.menukit.api.host
The panel host of a library's own screen: a screen class a library ships (a custom container screen, say) that lays out its own panels the way MKScreen does, with the main panel as the frame, and joins MenuKit's claims, modals and draw order with them.
OwnHost.Decoration - Interface in com.trevlar.menukit.api.host
Drawn after a panel's background and before its elements (slot frames, say).
OwnHost.Layout - Record Class in com.trevlar.menukit.api.host
One frame's placements, bottom to top, and the main panel's rectangle (the screen's leftPos, topPos, imageWidth, imageHeight), or null when the screen has no shown main panel.
OwnHost.Placement - Record Class in com.trevlar.menukit.api.host
Where a panel landed this frame: its outer rectangle, padding included, in screen coordinates.
OwnHost.SlotOwnership - Interface in com.trevlar.menukit.api.host
Whether panel presents the live slot under the point (its claim then routes the point to that slot).
OwnHost.TitleBand - Enum Class in com.trevlar.menukit.api.host
Where the screen's title sits, which decides the room reserved for it.
ownsSlotAt(Panel, double, double) - Method in interface com.trevlar.menukit.api.host.OwnHost.SlotOwnership
 

P

padding(int) - Method in class com.trevlar.menukit.api.hud.HudNotification.Builder
Inner padding between panel edge and content (default 6).
padding(int) - Method in class com.trevlar.menukit.api.hud.HudPanel.Builder
Inner padding between the panel edge and its content.
Padding - Section in class com.trevlar.menukit.api.panel.ScreenPanelAdapter
 
PADDING - Static variable in class com.trevlar.menukit.api.dialog.AlertDialog
Room between the dialog's frame and its content, on every side and either kind of screen.
PADDING - Static variable in class com.trevlar.menukit.api.dialog.ConfirmDialog
Room between the dialog's frame and its content, on every side and either kind of screen.
PADDING - Static variable in class com.trevlar.menukit.api.element.InfoBox
Space between the background's edge and the text.
panel() - Method in record class com.trevlar.menukit.api.host.OwnHost.Placement
Returns the value of the panel record component.
Panel - Class in com.trevlar.menukit.api.panel
The basic unit of composition.
Panel(String, List) - Constructor for class com.trevlar.menukit.api.panel.Panel
A visible panel with the default style and position.
Panel(String, List, boolean) - Constructor for class com.trevlar.menukit.api.panel.Panel
Default style (RAISED), no position (PanelPosition.UNPLACED), no toggle key.
Panel(String, List, boolean, PanelStyle, PanelPosition, int) - Constructor for class com.trevlar.menukit.api.panel.Panel
The full constructor.
PANEL - Enum constant in enum class com.trevlar.menukit.api.panel.ScreenKind
The Panel look: inventories, chests, anything built on AbstractContainerScreen.
PANEL_PADDING - Static variable in class com.trevlar.menukit.api.panel.MKScreen
Padding inside each styled panel (pixels from panel edge to content).
Panel.Builder - Class in com.trevlar.menukit.api.panel
Builds a Panel.
PanelElement - Interface in com.trevlar.menukit.api.element
A visual or interactive element within a Panel.
PanelPosition - Record Class in com.trevlar.menukit.api.panel
Where a panel sits: the one placement declaration every host reads.
PanelPosition(PanelPosition.Mode, InsideRegion, OutsideRegion, Supplier, int, int, int, int) - Constructor for record class com.trevlar.menukit.api.panel.PanelPosition
Creates an instance of a PanelPosition record class.
PanelPosition.Mode - Enum Class in com.trevlar.menukit.api.panel
How a panel is positioned.
panelShowing(Slot) - Static method in class com.trevlar.menukit.api.host.SlotClip
Whether the panel that last showed slot (SlotClip.shown(RenderContext, Slot)) was drawn this frame (7.3.0).
PanelStyle - Enum Class in com.trevlar.menukit.api.panel
Visual style for a panel's background.
parseHex(String, boolean) - Static method in class com.trevlar.menukit.api.element.ColorField
The color in text, or null when it is not valid hex: six digits (RRGGBB, read as opaque with alpha), or with alpha eight (AARRGGBB); a leading # and surrounding spaces are allowed.
PASS - Static variable in record class com.trevlar.menukit.api.host.SlotHoverResult
No slot takes the point, so vanilla's resolution runs.
ph() - Method in record class com.trevlar.menukit.api.element.ItemPicker.Box
Returns the value of the ph record component.
pick(MenuButton.Action) - Method in class com.trevlar.menukit.api.element.MenuButton
Runs the action and closes the menu.
pick(T) - Method in class com.trevlar.menukit.api.element.Dropdown
Hands the pick to the consumer when it differs, and closes.
pick(T) - Method in class com.trevlar.menukit.api.element.DropdownMulti
Hands the consumer a new set with item toggled; the popover stays open.
pickDye(DyeColor) - Method in class com.trevlar.menukit.api.element.ColorField
A dye picked in the dialog: its color, opaque, through the lens.
pickEntry(ItemStack) - Method in class com.trevlar.menukit.api.element.ItemPicker
A click on a grid entry: one of it into the selected slot.
pickPinned(int) - Method in class com.trevlar.menukit.api.element.DropdownMulti
 
pickPinned(int) - Method in class com.trevlar.menukit.api.element.Dropdown
A pinned row picked by click: hands pinned(items)'s value at index to PopoverControl.pick(T).
pickPinned(int) - Method in class com.trevlar.menukit.api.element.MenuButton
A pinned row picked by click: hands pinned(items)'s value at index to PopoverControl.pick(T).
pinned(Predicate) - Method in class com.trevlar.menukit.api.element.ListView.Builder
Rows that stay put: they can't be removed or moved, and no other row moves past them.
pinnedHeight(int) - Method in class com.trevlar.menukit.api.panel.Panel
Pins only the height; the width still follows the content.
pinnedLabel(int) - Method in class com.trevlar.menukit.api.element.DropdownMulti
 
pinnedLabel(int) - Method in class com.trevlar.menukit.api.element.Dropdown
A pinned row's label: the shared label function, applied to pinned(items)'s value at index.
pinnedLabel(int) - Method in class com.trevlar.menukit.api.element.MenuButton
A pinned row's label: the shared label function, applied to pinned(items)'s value at index.
pinnedRowCount() - Method in class com.trevlar.menukit.api.element.DropdownMulti
 
pinnedRowCount() - Method in class com.trevlar.menukit.api.element.Dropdown
Rows pinned above the list: the builder's pinned(items) by default (see the class doc), none without it.
pinnedRowCount() - Method in class com.trevlar.menukit.api.element.MenuButton
Rows pinned above the list: the builder's pinned(items) by default (see the class doc), none without it.
pinnedSelected(int) - Method in class com.trevlar.menukit.api.element.Dropdown
Whether a pinned row shows the selected highlight a scrollable row does; default PopoverControl.isSelected(T) of pinned(items)'s value at index, so a pinned category reads as picked once it is.
pinnedSelected(int) - Method in class com.trevlar.menukit.api.element.DropdownMulti
Whether a pinned row shows the selected highlight a scrollable row does; default PopoverControl.isSelected(T) of pinned(items)'s value at index, so a pinned category reads as picked once it is.
pinnedSelected(int) - Method in class com.trevlar.menukit.api.element.MenuButton
Whether a pinned row shows the selected highlight a scrollable row does; default PopoverControl.isSelected(T) of pinned(items)'s value at index, so a pinned category reads as picked once it is.
pinnedWhen(BooleanSupplier) - Method in class com.trevlar.menukit.api.panel.ContainerTabs.Builder
Pinned while this holds, read every frame: as the row is paged past it, it stops at the end of the row it would leave by, still clickable, and the tabs beyond it go on behind it.
pinnedWidth(int) - Method in class com.trevlar.menukit.api.panel.Panel
Pins only the width; the height still follows the content.
pinsTitle(int) - Static method in class com.trevlar.menukit.api.element.MKTooltip
The title draws pinned at the top edge: scrolled vertically, and the tooltip's top is above the screen.
pixel(Supplier) - Static method in record class com.trevlar.menukit.api.panel.PanelPosition
Exact pixel placement: the panel's outer top-left (the background origin; elements render inside at origin + padding) is exactly what origin supplies, in absolute screen pixels, re-evaluated every frame.
PIXEL - Enum constant in enum class com.trevlar.menukit.api.panel.PanelPosition.Mode
Exact pixel placement: the outer origin comes from a consumer supplier, evaluated every frame, in absolute screen pixels.
pixelOrigin() - Method in record class com.trevlar.menukit.api.panel.PanelPosition
Returns the value of the pixelOrigin record component.
place(WidgetHost.Placer) - Method in class com.trevlar.menukit.api.element.WidgetHost.Builder
How to put the widget at the element's rectangle, for a widget that is not a vanilla LayoutElement (or to place one in your own way).
place(W, int, int, int, int) - Method in interface com.trevlar.menukit.api.element.WidgetHost.Placer
 
placed() - Method in record class com.trevlar.menukit.api.host.OwnHost.Layout
Returns the value of the placed record component.
placedBounds() - Method in class com.trevlar.menukit.api.panel.Panel
This panel's own rectangle on the current screen, in screen coordinates (outer box, padding included), or null when it is not placed anywhere right now: no screen open, the panel hidden, or nothing has placed it this frame.
Placement - Record Class in com.trevlar.menukit.api.panel
Where a panel goes in one mode (7.4.0): what it is placed against, and its position there.
Placement(Anchor, PanelPosition) - Constructor for record class com.trevlar.menukit.api.panel.Placement
A placement against anchor, or the host's own reference without one.
Placement(Panel, int, int, int, int) - Constructor for record class com.trevlar.menukit.api.host.OwnHost.Placement
Creates an instance of a Placement record class.
Placement is the panel's - Section in class com.trevlar.menukit.api.panel.AnchorPanelAdapter
 
Placement is the panel's - Section in class com.trevlar.menukit.api.panel.ScreenPanelAdapter
 
Placement is the panel's - Section in class com.trevlar.menukit.api.panel.VanillaScreenPanelAdapter
 
placementOf(Panel) - Method in class com.trevlar.menukit.api.panel.MKScreen
This frame's placement of panel on this screen, or null when it is not placed.
placements() - Method in class com.trevlar.menukit.api.panel.Panel
Where this panel goes in each mode it declared (7.4.0), unmodifiable; empty for none.
placeOnFirstRead(Runnable) - Method in class com.trevlar.menukit.api.element.AbstractPanelElement
Places this element on the first read of its position instead of now: the layout shared by every element of one Row/Column, run once.
playerChoosesMatch() - Method in class com.trevlar.menukit.api.element.ItemPicker.Builder
The player chooses each slot's match, "Any <item>" (ItemMatch.Match.CONTAINS) or "Exactly this" (ItemMatch.Match.EXACT), in the Edit tab; ItemPicker.Builder.match is a new slot's.
playerChoosesMatch() - Method in class com.trevlar.menukit.api.element.ItemPicker
Whether the player chooses each slot's match between Any and Exactly.
popover() - Method in class com.trevlar.menukit.api.panel.Panel.Builder
Makes the panel a popover: something that pops up over the screen while it is shown (a row of pockets over a hovered hotbar slot, a flyout from a button).
popoverWidth() - Method in class com.trevlar.menukit.api.element.MenuButton
As wide as its widest label.
popoverWidth() - Method in class com.trevlar.menukit.api.element.Dropdown
The popover's width; default the trigger's.
popoverWidth() - Method in class com.trevlar.menukit.api.element.DropdownMulti
The popover's width; default the trigger's.
pos() - Method in record class com.trevlar.menukit.api.panel.ContainerRegion.Source
Returns the value of the pos record component.
Pose(float, float, float) - Constructor for record class com.trevlar.menukit.api.element.ItemAnimation.Pose
Creates an instance of a Pose record class.
posed(ItemAnimation.Posing) - Method in interface com.trevlar.menukit.api.element.ItemAnimation
This animation moved and scaled as it plays: at each t, pose says how big the item draws (scaled about its box's center) and how far it moves, in GUI pixels.
position() - Method in record class com.trevlar.menukit.api.panel.Placement
Returns the value of the position record component.
position(PanelPosition) - Method in class com.trevlar.menukit.api.panel.Panel.Builder
Deprecated, for removal: This API element is subject to removal in a future version.
Replaced in 7.4.0 by Panel.Builder.in(ModeScope, Placement), which picks the mode scope; removed in 8.0.0. in(ModeScope.BOTH, Placement.screen(position)) is this call.
Precedence - Section in com.trevlar.menukit.api.panel.Panel.visibleWhen(BooleanSupplier)
 
presentsSlotAt(InputContext) - Method in class com.trevlar.menukit.api.element.Flow
 
presentsSlotAt(InputContext) - Method in class com.trevlar.menukit.api.element.ListView
 
presentsSlotAt(InputContext) - Method in interface com.trevlar.menukit.api.element.PanelElement
Whether this element presents a live menu slot under the event's point.
presentsSlotAt(InputContext) - Method in class com.trevlar.menukit.api.element.ScrollContainer
A slot among the children, only where the viewport shows it: the part of a slot past the viewport's edge is not drawn, so it is not there to hover or click.
presentsSlotAt(InputContext) - Method in class com.trevlar.menukit.api.element.Section
A slot in the content, while open.
presentsSlotAt(InputContext) - Method in class com.trevlar.menukit.api.element.Tabs
A slot in the shown tab's body, only where the body shows it: inside its scrolling viewport, or inside the rectangle it is clipped to.
presentsSlotAt(List, InputContext) - Static method in class com.trevlar.menukit.api.element.ChildDispatch
Whether a shown child presents a live menu slot under the point (PanelElement.presentsSlotAt(InputContext)), so an opaque panel's claim lets the point through to a slot nested in a container.
pressed() - Method in record class com.trevlar.menukit.api.element.Button.Look
Returns the value of the pressed record component.
priority() - Method in record class com.trevlar.menukit.api.panel.PanelPosition
Returns the value of the priority record component.
priority(int) - Method in class com.trevlar.menukit.api.hud.HudPanel.Builder
Stacking order among panels on the same spot (lower is nearer the spot's edge; around the hotbar, nearer the region's aligned end), and render order (lower draws first).
priority(int) - Method in record class com.trevlar.menukit.api.panel.PanelPosition
This position with stacking and z-order priority (lower goes first: nearer the anchor edge, and underneath).
ProgressBar - Class in com.trevlar.menukit.api.element
A bar filled to a fraction, read every frame: health, progress, a timer.
ProgressBar(ProgressBar.Builder) - Constructor for class com.trevlar.menukit.api.element.ProgressBar
 
ProgressBar.Builder - Class in com.trevlar.menukit.api.element
 
ProgressBar.Direction - Enum Class in com.trevlar.menukit.api.element
Which way the fill grows.
Pushing an element to the far edge - Section in class com.trevlar.menukit.api.layout.Row
 
pw() - Method in record class com.trevlar.menukit.api.element.ItemPicker.Box
Returns the value of the pw record component.
px() - Method in record class com.trevlar.menukit.api.element.ItemPicker.Box
Returns the value of the px record component.
py() - Method in record class com.trevlar.menukit.api.element.ItemPicker.Box
Returns the value of the py record component.

Q

queue(GuiGraphicsExtractor, Component, int, int) - Static method in class com.trevlar.menukit.api.element.MKTooltip
Queues a hover tooltip for end-of-frame draw at the mouse position, wrapping at the library-default max width (MKTooltip.DEFAULT_MAX_WIDTH).
queue(GuiGraphicsExtractor, Component, int, int, int) - Static method in class com.trevlar.menukit.api.element.MKTooltip
Queues a hover tooltip with its own maximum width instead of the default.
queueTooltip(RenderContext) - Method in interface com.trevlar.menukit.api.element.PanelElement
Queues this element's hover tooltip for the current frame when the cursor is over it.

R

Radio<T> - Class in com.trevlar.menukit.api.element
One choice of a single-selection set: a round button with a dot when its value is the RadioGroup's selection, and a label beside it.
Radio(Radio.Builder) - Constructor for class com.trevlar.menukit.api.element.Radio
 
Radio.Builder<T> - Class in com.trevlar.menukit.api.element
 
RadioGroup<T> - Class in com.trevlar.menukit.api.element
The lens a set of Radio buttons shares: which value is selected, read from the consumer every frame and written back when the player picks another.
RAISED - Enum constant in enum class com.trevlar.menukit.api.panel.PanelStyle
Raised, vanilla inventory panel look (9-slice sprite with rounded corners).
Reactive sizing - Section in class com.trevlar.menukit.api.element.Flow
 
Read where it is used - Section in enum class com.trevlar.menukit.api.panel.ModeScope
 
Reference - Record Class in com.trevlar.menukit.api.panel
The rectangle a panel is placed against, a reference.
Reference(int, int, int, int) - Constructor for record class com.trevlar.menukit.api.panel.Reference
Creates an instance of a Reference record class.
reflowBaselineY() - Method in class com.trevlar.menukit.api.element.AbstractPanelElement
The baseline Y the panel's reflow stacks from.
reflowForWrap(List) - Static method in class com.trevlar.menukit.api.panel.Panel
Panel.reflowForWrap() over any element list; shared with Tabs' bodies.
region() - Method in record class com.trevlar.menukit.api.panel.PanelPosition
Returns the value of the region record component.
region(InsideRegion) - Method in class com.trevlar.menukit.api.hud.HudNotification.Builder
Where it pops up: an InsideRegion spot of the game window, 4px in from the edges it touches (default TOP_CENTER).
region(InsideRegion) - Method in class com.trevlar.menukit.api.hud.HudPanel.Builder
Where on the game window the panel sits: one of the nine InsideRegion spots, 4px in from the edges it touches.
region(OutsideRegion) - Method in class com.trevlar.menukit.api.hud.HudPanel.Builder
Places the panel around the vanilla hotbar instead of on a window spot (since 7.1.0).
region(OutsideRegion) - Static method in record class com.trevlar.menukit.api.panel.PanelPosition
Outside the host's reference rectangle via region: to the right of the menu frame, below an anchor, above a standalone screen's main panel, left of the vanilla hotbar on the HUD (since 7.1.0, through RegionMath.resolveHud(OutsideRegion, Reference, HumanoidArm, int, int, int, int, int, int)), and so on.
REGION - Enum constant in enum class com.trevlar.menukit.api.panel.PanelPosition.Mode
Outside the host's reference rectangle, via an OutsideRegion.
RegionConstants - Class in com.trevlar.menukit.api.panel
The region layout constants, stacking gaps and edge insets, in one place.
register(HudCycleStrip.Source) - Static method in class com.trevlar.menukit.api.hud.HudCycleStrip
Registers a source.
registerHud(Panel, int) - Static method in class com.trevlar.menukit.api.MK
Registers a HUD panel into the HUD's host.
registerHudStatus(Panel, int) - Static method in class com.trevlar.menukit.api.MK
Registers a HUD panel in the status column (since 7.3.0).
registerNotification(HudNotification) - Static method in class com.trevlar.menukit.api.MK
Registers a notification definition.
remove(Consumer) - Method in class com.trevlar.menukit.api.element.ListView.Builder
A "- Remove item" button in the toolbar, right of the add buttons, that hands the selected row's key to remove; with ListView.Builder.controlsInRows(), a remove cross in each row instead.
remove(Component, Consumer) - Method in class com.trevlar.menukit.api.element.ListView.Builder
ListView.Builder.remove(Consumer), its toolbar button labeled label ("- Delete group").
remove(Component, Supplier, Consumer) - Method in class com.trevlar.menukit.api.element.ListView.Builder
ListView.Builder.remove(Component, Consumer) with a hover tooltip on the toolbar button, read while hovered.
remove(Component, Component, Consumer) - Method in class com.trevlar.menukit.api.element.ListView.Builder
ListView.Builder.remove(Component, Consumer) with a fixed hover tooltip on the toolbar button (the crosses of ListView.Builder.controlsInRows() keep theirs).
removed() - Method in class com.trevlar.menukit.api.panel.MKScreen
 
removed(PanelElement) - Method in class com.trevlar.menukit.api.element.Attachment
A child removed after build: detached now when the container is attached.
removeDisabledWhen(BooleanSupplier) - Method in class com.trevlar.menukit.api.element.ListView.Builder
Grays the remove while condition holds, read every frame: the toolbar's "- Remove item" and, with ListView.Builder.controlsInRows(), every row's cross (a config list at its minimum length).
removeEnchant(Holder) - Method in class com.trevlar.menukit.api.element.ItemPicker
The remove control of an enchantment on the selected item.
removeHosted(Screen, GuiEventListener, GuiEventListener) - Static method in class com.trevlar.menukit.api.panel.Focus
removeLive() - Method in class com.trevlar.menukit.api.element.ListView
Whether the toolbar's remove is live (not grayed by the selection or removeDisabledWhen; the list's own gray aside).
removeLive(Object) - Method in class com.trevlar.menukit.api.element.ListView
Whether the remove cross in the row of key (controlsInRows) is live: shown (not pinned) and not grayed.
removeSlot(int) - Method in class com.trevlar.menukit.api.element.ItemPicker
A click on the remove button of slot slot of the slot row.
removeWidget(Screen, GuiEventListener) - Static method in class com.trevlar.menukit.api.panel.Focus
Undoes Focus.addWidget(Screen, T): removes the widget from the screen's input and from focus tracking.
Renamed in 7.3.0 - Section in enum class com.trevlar.menukit.api.panel.ScreenKind
 
render(RenderContext) - Method in class com.trevlar.menukit.api.element.Button
Resolves this frame's look (hovered, pressed, disabled), paints background, tint and content through the hooks, keeps the vanilla widget current, and queues the tooltip.
render(RenderContext) - Method in class com.trevlar.menukit.api.element.Checkbox
 
render(RenderContext) - Method in class com.trevlar.menukit.api.element.ColorField
 
render(RenderContext) - Method in class com.trevlar.menukit.api.element.Divider
 
render(RenderContext) - Method in class com.trevlar.menukit.api.element.Flow
 
render(RenderContext) - Method in class com.trevlar.menukit.api.element.Icon
 
render(RenderContext) - Method in class com.trevlar.menukit.api.element.InfoBox
 
render(RenderContext) - Method in class com.trevlar.menukit.api.element.ItemDisplay
 
render(RenderContext) - Method in class com.trevlar.menukit.api.element.ItemPicker
 
render(RenderContext) - Method in class com.trevlar.menukit.api.element.ListView
 
render(RenderContext) - Method in interface com.trevlar.menukit.api.element.PanelElement
Renders this element at (ctx.originX() + getChildX(), ctx.originY() + getChildY()).
render(RenderContext) - Method in class com.trevlar.menukit.api.element.Dropdown
 
render(RenderContext) - Method in class com.trevlar.menukit.api.element.DropdownMulti
 
render(RenderContext) - Method in class com.trevlar.menukit.api.element.MenuButton
 
render(RenderContext) - Method in class com.trevlar.menukit.api.element.ProgressBar
 
render(RenderContext) - Method in class com.trevlar.menukit.api.element.Radio
 
render(RenderContext) - Method in class com.trevlar.menukit.api.element.ScrollContainer
 
render(RenderContext) - Method in class com.trevlar.menukit.api.element.Section
 
render(RenderContext) - Method in class com.trevlar.menukit.api.element.Slider
 
render(RenderContext) - Method in class com.trevlar.menukit.api.element.Tabs
 
render(RenderContext) - Method in class com.trevlar.menukit.api.element.TextField
 
render(RenderContext) - Method in class com.trevlar.menukit.api.element.TextLabel
 
render(RenderContext) - Method in class com.trevlar.menukit.api.element.Toggle
 
render(RenderContext) - Method in class com.trevlar.menukit.api.element.WidgetHost
 
render(RenderContext) - Method in class com.trevlar.menukit.api.hud.HudIcon
 
render(RenderContext) - Method in class com.trevlar.menukit.api.hud.HudSlot
 
render(List, RenderContext) - Static method in class com.trevlar.menukit.api.element.ChildDispatch
The base pass: renders every shown child, except one wholly outside the clip in play (7.4.0).
render(GuiGraphicsExtractor, DeltaTracker, int, int, long, String, ItemStack) - Method in class com.trevlar.menukit.api.hud.HudNotification
Draws this notification at its point in the animation.
render(GuiGraphicsExtractor, Component, TextAlignment, int, int, int, int, int, boolean) - Static method in class com.trevlar.menukit.api.element.Text
Draws text in the box from (x1, y1) to (x2, y2).
renderBackground(RenderContext, int, int, boolean, boolean, boolean) - Method in class com.trevlar.menukit.api.element.Toggle
Paints the toggle for this frame: a raised control, highlighted while hovered, its disabled face while disabled (ControlLook).
renderBackground(RenderContext, int, int, Button.Look) - Method in class com.trevlar.menukit.api.element.Button
Paints the background: a raised control, highlighted while hovered, pressed while held, its disabled face while disabled, from the look's set of sprites (vanilla's button in the Default look, MenuKit's control art in the Panel look or vanilla's where a pack restyled it; ControlLook).
renderCentered(GuiGraphicsExtractor, Component, int, int, int, int, int, boolean) - Static method in class com.trevlar.menukit.api.element.Text
Text.render(GuiGraphicsExtractor, Component, TextAlignment, int, int, int, int, int, boolean) centered in the box at (x, y) of width by height, the shape of a vanilla button label.
renderContent(RenderContext, int, int, Button.Look) - Method in class com.trevlar.menukit.api.element.Button
Paints the content: by default the label, centered; wrapped onto several centered lines when the panel narrowed the button below it, else on one line that scrolls if it still overflows.
RenderContext - Record Class in com.trevlar.menukit.api.element
Render-time context passed to every PanelElement.render(RenderContext).
RenderContext(GuiGraphicsExtractor, int, int, int, int) - Constructor for record class com.trevlar.menukit.api.element.RenderContext
A context with nothing around it disabled, in the Panel look: the common case, and the 5.x shape.
RenderContext(GuiGraphicsExtractor, int, int, int, int, boolean) - Constructor for record class com.trevlar.menukit.api.element.RenderContext
A context in the Panel look: the 6.0.0 shape.
RenderContext(GuiGraphicsExtractor, int, int, int, int, boolean, ScreenKind) - Constructor for record class com.trevlar.menukit.api.element.RenderContext
Creates an instance of a RenderContext record class.
renderCulled(RenderContext) - Method in class com.trevlar.menukit.api.element.Flow
 
renderCulled(RenderContext) - Method in class com.trevlar.menukit.api.element.ListView
 
renderCulled(RenderContext) - Method in interface com.trevlar.menukit.api.element.PanelElement
Called each frame instead of PanelElement.render(RenderContext) for a visible element that is skipped only because its box lies wholly outside the clip in play (7.4.0): a row scrolled out of a ScrollContainer, a list's row past its scroll area, a section of the container region out of view.
renderCulled(RenderContext) - Method in class com.trevlar.menukit.api.element.ScrollContainer
Culled itself: every shown child is held out of view with it.
renderCulled(RenderContext) - Method in class com.trevlar.menukit.api.element.Section
Culled while open: its content is held out of view with it.
renderCulled(RenderContext) - Method in class com.trevlar.menukit.api.element.Tabs
Culled itself: the headers and the shown tab's body are held out of view with it; the other tabs' bodies are hidden.
renderCulled(List, RenderContext) - Static method in class com.trevlar.menukit.api.element.ChildDispatch
The culled pass (7.4.0): every shown child's PanelElement.renderCulled(RenderContext).
renderFlow(GuiGraphicsExtractor, int, int) - Method in class com.trevlar.menukit.api.host.OwnHost
Draws the screen's ordinary (FLOW) panels, live where the pointer is theirs.
renderFromOpenTime(GuiGraphicsExtractor, Component, TextAlignment, int, int, int, int, int, boolean, long) - Static method in class com.trevlar.menukit.api.element.Text
Text.render(GuiGraphicsExtractor, Component, TextAlignment, int, int, int, int, int, boolean), with the scroll cycle starting at openTimeMillis: at that instant the text shows its beginning, then it scrolls to the end and back, repeating every max(scrollDistance * 0.5, 3.0) seconds (vanilla's cycle period).
renderHud(GuiGraphicsExtractor, DeltaTracker) - Static method in class com.trevlar.menukit.api.MK
Renders the HUD panels, then the active notifications.
renderLeft(GuiGraphicsExtractor, Component, int, int, int, int, boolean) - Static method in class com.trevlar.menukit.api.element.Text
Text.render(GuiGraphicsExtractor, Component, TextAlignment, int, int, int, int, int, boolean) left-aligned, with the text drawn at y and scrolling inside [x, x + width) when it overflows.
renderOverlay(RenderContext) - Method in class com.trevlar.menukit.api.element.Flow
 
renderOverlay(RenderContext) - Method in class com.trevlar.menukit.api.element.ListView
 
renderOverlay(RenderContext) - Method in interface com.trevlar.menukit.api.element.PanelElement
Second-pass render for transient overlays that draw outside the element's layout bounds (a Dropdown's popover).
renderOverlay(RenderContext) - Method in class com.trevlar.menukit.api.element.Dropdown
The popover, on the overlay pass: on top of every sibling whatever the declaration order.
renderOverlay(RenderContext) - Method in class com.trevlar.menukit.api.element.DropdownMulti
The popover, on the overlay pass: on top of every sibling whatever the declaration order.
renderOverlay(RenderContext) - Method in class com.trevlar.menukit.api.element.MenuButton
The popover, on the overlay pass: on top of every sibling whatever the declaration order.
renderOverlay(RenderContext) - Method in class com.trevlar.menukit.api.element.ScrollContainer
The children's overlays, unclipped, at their scrolled positions.
renderOverlay(RenderContext) - Method in class com.trevlar.menukit.api.element.Section
 
renderOverlay(RenderContext) - Method in class com.trevlar.menukit.api.element.Tabs
The headers' and the shown body's overlays (an open Dropdown popover), unclipped, after all base renders.
renderOverlay(List, RenderContext) - Static method in class com.trevlar.menukit.api.element.ChildDispatch
The overlay pass: every shown child's renderOverlay, after every base render.
require(boolean, String) - Method in class com.trevlar.menukit.api.element.AbstractPanelElement.Builder
Throws IllegalStateException naming the builder when ok is false.
requireOpen(String) - Static method in class com.trevlar.menukit.api.Declarations
Throws if declarations have frozen.
resetScroll() - Static method in class com.trevlar.menukit.api.element.MKTooltip
Puts the tooltip on screen now back where vanilla placed it.
resolveHover(AbstractContainerScreen, double, double) - Method in interface com.trevlar.menukit.api.host.SlotScreenHook
At getHoveredSlot, after MenuKit's claim (a panel over a slot makes it inert) let the point through: whether a shown panel-hosted slot takes the point, and which in-menu slot wins it (see SlotHoverResult).
Resource packs - Section in class com.trevlar.menukit.api.panel.ContainerRegion
 
reversed() - Method in record class com.trevlar.menukit.api.element.ListView.Sort
Returns the value of the reversed record component.
RIGHT - Enum constant in enum class com.trevlar.menukit.api.element.Tabs.Align
 
RIGHT - Enum constant in enum class com.trevlar.menukit.api.hud.HudNotification.SlideDirection
 
RIGHT - Static variable in record class com.trevlar.menukit.api.element.Click
 
RIGHT_ALIGN_BOTTOM - Enum constant in enum class com.trevlar.menukit.api.panel.OutsideRegion
 
RIGHT_ALIGN_TOP - Enum constant in enum class com.trevlar.menukit.api.panel.OutsideRegion
 
RIGHT_CENTER - Enum constant in enum class com.trevlar.menukit.api.panel.InsideRegion
 
RIGHT_CENTER - Enum constant in enum class com.trevlar.menukit.api.panel.OutsideRegion
Right of the reference, centered vertically on it (since 7.4.0).
RIGHT_TO_LEFT - Enum constant in enum class com.trevlar.menukit.api.element.ProgressBar.Direction
 
ring() - Method in record class com.trevlar.menukit.api.hud.HudCycleStrip.View
Returns the value of the ring record component.
role(TextRole) - Method in class com.trevlar.menukit.api.element.TextLabel.Builder
What the text is for: its color comes from the role on the kind of screen the label is on (ScreenKind.textColor(TextRole)).
row(Function) - Method in class com.trevlar.menukit.api.element.ListView.Builder
Required: one row element per item, made when its key first appears.
Row - Class in com.trevlar.menukit.api.layout
Lays elements out left to right: it positions each child with even spacing and a vertical alignment, and returns a flat list of positioned PanelElements.
ROW - Enum constant in enum class com.trevlar.menukit.api.hud.HudCycleStrip.Axis
A mini hotbar beside the vanilla one, at the same height.
Row.Builder - Class in com.trevlar.menukit.api.layout
Builds one row.
rowColor(MenuButton.Action) - Method in class com.trevlar.menukit.api.element.MenuButton
 
rowColor(T) - Method in class com.trevlar.menukit.api.element.Dropdown
The color of item's row text; default the light text every row has.
rowColor(T) - Method in class com.trevlar.menukit.api.element.DropdownMulti
The color of item's row text; default the light text every row has.
rowFor(Object) - Method in class com.trevlar.menukit.api.element.ListView
The row shown for key now (the one the factory made), or null.
Rows and columns - Section in class com.trevlar.menukit.api.hud.HudCycleStrip
 
Rows are ordinary elements - Section in class com.trevlar.menukit.api.element.ListView
 
rule(Supplier, Consumer) - Method in class com.trevlar.menukit.api.element.ItemPicker.Builder
One slot with its own match mode (set gets an empty stack for none).
rules(Supplier, Consumer) - Method in class com.trevlar.menukit.api.element.ItemPicker.Builder
A list of slots, each with its own match mode.
run() - Method in record class com.trevlar.menukit.api.element.MenuButton.Action
Returns the value of the run record component.
runReturnAction() - Method in class com.trevlar.menukit.api.panel.MKScreen
Runs the return action if one is set and returns true; otherwise false so the caller can fall back to its default navigation.

S

saveLabel(Component) - Method in class com.trevlar.menukit.api.dialog.EditDialog.Builder
The Save button's label.
scale() - Method in record class com.trevlar.menukit.api.element.ItemAnimation.Pose
Returns the value of the scale record component.
scale(float) - Method in class com.trevlar.menukit.api.element.TextLabel.Builder
A uniform scale (2 for a title).
scale(float) - Method in class com.trevlar.menukit.api.hud.HudPanel.SlotBuilder
Draws the slot, item and decorations together at scale (since 7.3.0), 1 by default.
scale(float) - Method in class com.trevlar.menukit.api.hud.HudPanel.TextBuilder
 
screen() - Method in class com.trevlar.menukit.api.element.Attachment
The screen the children are attached to now, or null when none is.
screen(PanelPosition) - Static method in record class com.trevlar.menukit.api.panel.Placement
Against the host's own reference: the menu frame, the screen, the HUD, a standalone screen's main panel.
SCREEN_ANCHOR - Enum constant in enum class com.trevlar.menukit.api.panel.PanelPosition.Mode
On one of the nine InsideRegion spots of the screen or window.
SCREEN_EDGE_MARGIN - Static variable in class com.trevlar.menukit.api.panel.RegionConstants
Safe margin (GUI-scaled pixels) from each screen edge.
SCREEN_STACK_GAP - Static variable in class com.trevlar.menukit.api.panel.RegionConstants
Stacking gap (GUI-scaled pixels) for vanilla screens that are not containers.
SCREEN_TOP - Enum constant in enum class com.trevlar.menukit.api.host.OwnHost.TitleBand
At the top of the screen, outside the frame.
screenAnchor() - Method in record class com.trevlar.menukit.api.panel.PanelPosition
Returns the value of the screenAnchor record component.
screenAnchor(InsideRegion) - Static method in record class com.trevlar.menukit.api.panel.PanelPosition
On a screen-edge spot: a TOP_LEFT back button, a TOP_CENTER title, a HUD panel at BOTTOM_RIGHT.
ScreenFrames - Class in com.trevlar.menukit.api.panel
A vanilla container screen made taller or shorter at a seam (7.4.0): its frame gains (or loses) by rows at row seam of its own layout, so screens of nearly one size can be made exactly one, and a tab row standing on their frames doesn't move as one opens in place of another.
screenFrameStarts() - Static method in class com.trevlar.menukit.api.element.MKTooltip
A screen frame starts (Screen.extractRenderStateWithTooltipAndSubtitles HEAD): a mark left from before it is dropped.
screenKind() - Method in class com.trevlar.menukit.api.panel.MKScreen
The kind of screen this is, as declared when it was created.
screenKind(ScreenKind) - Method in class com.trevlar.menukit.api.element.Flow
 
screenKind(ScreenKind) - Method in class com.trevlar.menukit.api.element.ListView
 
screenKind(ScreenKind) - Method in interface com.trevlar.menukit.api.element.PanelElement
The kind of screen the owning panel is on, handed down whenever it changes, before the next layout pass.
screenKind(ScreenKind) - Method in class com.trevlar.menukit.api.element.Dropdown
 
screenKind(ScreenKind) - Method in class com.trevlar.menukit.api.element.DropdownMulti
 
screenKind(ScreenKind) - Method in class com.trevlar.menukit.api.element.MenuButton
 
screenKind(ScreenKind) - Method in class com.trevlar.menukit.api.element.ScrollContainer
 
screenKind(ScreenKind) - Method in class com.trevlar.menukit.api.element.Section
 
screenKind(ScreenKind) - Method in class com.trevlar.menukit.api.element.Tabs
Kept for measuring, and handed on to every tab's body and the headers.
screenKind(List, ScreenKind) - Static method in class com.trevlar.menukit.api.element.ChildDispatch
Hands the kind of screen to every child, shown or not (PanelElement.screenKind(ScreenKind)).
ScreenKind - Enum Class in com.trevlar.menukit.api.panel
The look of the screen an element is on, which decides how it draws (6.1.0; renamed in 7.3.0).
ScreenMatcher - Class in com.trevlar.menukit.api.panel
Which screens a registered slot (or any feature meant for every inventory screen) applies to.
ScreenOrigin - Record Class in com.trevlar.menukit.api.panel
Screen-space top-left coordinates of a panel: what a pixel(...) placement supplies each frame, and what a panel host resolves every other placement to (RegionMath.resolveMenu / resolveInside).
ScreenOrigin(int, int) - Constructor for record class com.trevlar.menukit.api.panel.ScreenOrigin
Creates an instance of a ScreenOrigin record class.
ScreenPanelAdapter - Class in com.trevlar.menukit.api.panel
Puts a Panel on vanilla container screens.
ScreenPanelAdapter(Panel) - Constructor for class com.trevlar.menukit.api.panel.ScreenPanelAdapter
Declares the panel on container screens with the panel's own interior padding.
ScreenPanelAdapter(Panel, int) - Constructor for class com.trevlar.menukit.api.panel.ScreenPanelAdapter
Declares the panel on container screens with explicit content padding (0 for flush edges).
SCROLL_PIXELS_PER_TICK - Static variable in class com.trevlar.menukit.api.element.ScrollContainer
Pixels scrolled per wheel notch.
scrollBy(int, int) - Static method in class com.trevlar.menukit.api.element.MKTooltip
Moves the tooltip on screen now by dx, dy GUI pixels (positive y moves it down, bringing lines above the screen into view).
ScrollContainer - Class in com.trevlar.menukit.api.element
A clipped viewport over pre-positioned elements, scrolled vertically: the single primitive for "show content larger than its bounds".
ScrollContainer(ScrollContainer.Builder) - Constructor for class com.trevlar.menukit.api.element.ScrollContainer
 
ScrollContainer.Builder - Class in com.trevlar.menukit.api.element
 
scrolled(Vector2ic, int, int, int, int) - Static method in class com.trevlar.menukit.api.element.MKTooltip
Where the tooltip draws: vanilla's placement, pulled inside the sides while MKTooltip.wrapWhen(BooleanSupplier) holds and below the top edge while MKTooltip.clampWhen(BooleanSupplier) holds, plus the offset, clamped (and stored clamped) by MKTooltip.clampScroll(int, int, int, int) around that spot.
SCROLLER_DISABLED_SPRITE - Static variable in class com.trevlar.menukit.api.element.ScrollContainer
Vanilla's disabled scroller sprite (content fits, or disabled).
SCROLLER_GUTTER - Static variable in class com.trevlar.menukit.api.element.ScrollContainer
Space between the content and the scrollbar track.
SCROLLER_HEIGHT - Static variable in class com.trevlar.menukit.api.element.ScrollContainer
Height of the handle: a fixed-size handle, as vanilla's creative inventory.
SCROLLER_SPRITE - Static variable in class com.trevlar.menukit.api.element.ScrollContainer
Vanilla's scroller sprite.
SCROLLER_TRACK_PADDING - Static variable in class com.trevlar.menukit.api.element.ScrollContainer
Padding inside the track around the handle.
SCROLLER_WIDTH - Static variable in class com.trevlar.menukit.api.element.ScrollContainer
Width of the handle sprite: vanilla's creative-inventory scroller.
Scroll position: view state, or the consumer's - Section in class com.trevlar.menukit.api.element.ScrollContainer
 
scrolls() - Method in class com.trevlar.menukit.api.element.ScrollContainer
Whether it scrolls now: its content is taller than its viewport, so the scrollbar shows and the wheel over it is its own (7.4.0).
scrolls(Screen) - Static method in class com.trevlar.menukit.api.panel.ContainerRegion
Whether the container list on screen scrolls this frame, or a section's own grid in it does (a SlotScroll, or any scroll area that fits the room, giving rows back): true where the mouse wheel should go to the list rather than anything else a mod would otherwise do with it (switch tabs, say) while the cursor is over it.
Scroll stays put - Section in class com.trevlar.menukit.api.element.Tabs
 
scrollsWhenShort(ModeScope, ScreenMatcher) - Static method in class com.trevlar.menukit.api.panel.ScreenFrames
Lets the screens screens takes scroll their own container grid inside their frame while the frame wouldn't fit the window, in scope's game mode (ModeScope.BOTH for either), read every frame (see "A grid that scrolls when the frame doesn't fit").
search(Function) - Method in class com.trevlar.menukit.api.element.ListView.Builder
A search field in the toolbar: a row shows while its item's text holds the query, case-insensitive.
searchEntries(String) - Method in class com.trevlar.menukit.api.element.ItemPicker
The Search tab's entries for a query: the creative search contents, searched.
section(String, ModeScope) - Static method in class com.trevlar.menukit.api.panel.ContainerRegion
Starts a section, its id namespaced and unique ("mymod:opened-shulker"), for one mode scope: it shows only while the player is in that mode (ModeScope.BOTH for either), read every frame, as its ContainerRegion.Builder.visibleWhen is.
section(BiConsumer) - Method in class com.trevlar.menukit.api.panel.ContainerRegion.Sections
Required: each key's section, set up on a builder as a declared section is (its content, title, source, order, visibility), minus declare() and its screens, which are the kind's.
Section - Class in com.trevlar.menukit.api.element
A collapsible section: a header row that opens and closes the elements under it.
SECTION_GAP - Static variable in class com.trevlar.menukit.api.dialog.AlertDialog
Vertical gap between the title, body and button row.
SECTION_GAP - Static variable in class com.trevlar.menukit.api.dialog.ConfirmDialog
Vertical gap between the title, body and button row.
Section.Builder - Class in com.trevlar.menukit.api.element
 
sections(String, ModeScope, Function) - Static method in class com.trevlar.menukit.api.panel.ContainerRegion
Starts a kind of section with one section per live key, for what opens at runtime: as many boxes as the player opens, each its own section, for as long as it is open.
Sections for what opens at runtime - Section in class com.trevlar.menukit.api.panel.ContainerRegion
 
select(T) - Method in class com.trevlar.menukit.api.element.RadioGroup
Selects value: hands it to the consumer when it differs from the current selection.
selectAllRow(Component) - Method in class com.trevlar.menukit.api.element.DropdownMulti.Builder
A pinned row that chooses every item.
selected() - Method in class com.trevlar.menukit.api.element.ListView
The selected key now (the consumer's or the list's own), or null.
selected() - Method in class com.trevlar.menukit.api.element.RadioGroup
The currently selected value, read from the consumer.
selectedSlot() - Method in class com.trevlar.menukit.api.element.ItemPicker
The selected slot.
selectedWhen(BooleanSupplier) - Method in class com.trevlar.menukit.api.panel.ContainerTabs.Builder
Drawn selected, open into the frame, while this holds, read every frame.
selection(Supplier, Consumer) - Method in class com.trevlar.menukit.api.element.ListView.Builder
The selection, by key: get is read every frame (null for none); set receives a newly selected key, or null when the selected item is gone.
Selection: the consumer's, by key - Section in class com.trevlar.menukit.api.element.ListView
 
Selection is a lens - Section in class com.trevlar.menukit.api.element.Tabs
 
selectSlot(int) - Method in class com.trevlar.menukit.api.element.ItemPicker
Selects slot slot of the slot row, as a click on it does.
self() - Method in class com.trevlar.menukit.api.element.AbstractPanelElement.Builder
Returns this as the concrete builder.
self() - Method in class com.trevlar.menukit.api.element.Button.Builder
 
self() - Method in class com.trevlar.menukit.api.element.Checkbox.Builder
 
self() - Method in class com.trevlar.menukit.api.element.ColorField.Builder
 
self() - Method in class com.trevlar.menukit.api.element.Divider.Builder
 
self() - Method in class com.trevlar.menukit.api.element.Dropdown.Builder
 
self() - Method in class com.trevlar.menukit.api.element.DropdownMulti.Builder
 
self() - Method in class com.trevlar.menukit.api.element.Flow.Builder
 
self() - Method in class com.trevlar.menukit.api.element.Icon.Builder
 
self() - Method in class com.trevlar.menukit.api.element.InfoBox.Builder
 
self() - Method in class com.trevlar.menukit.api.element.ItemDisplay.Builder
 
self() - Method in class com.trevlar.menukit.api.element.ItemPicker.Builder
 
self() - Method in class com.trevlar.menukit.api.element.ListView.Builder
 
self() - Method in class com.trevlar.menukit.api.element.MenuButton.Builder
 
self() - Method in class com.trevlar.menukit.api.element.ProgressBar.Builder
 
self() - Method in class com.trevlar.menukit.api.element.Radio.Builder
 
self() - Method in class com.trevlar.menukit.api.element.ScrollContainer.Builder
 
self() - Method in class com.trevlar.menukit.api.element.Section.Builder
 
self() - Method in class com.trevlar.menukit.api.element.Slider.Builder
 
self() - Method in class com.trevlar.menukit.api.element.Tabs.Builder
 
self() - Method in class com.trevlar.menukit.api.element.TextField.Builder
 
self() - Method in class com.trevlar.menukit.api.element.TextLabel.Builder
 
self() - Method in class com.trevlar.menukit.api.element.Toggle.Builder
 
self() - Method in class com.trevlar.menukit.api.element.WidgetHost.Builder
 
seq() - Method in class com.trevlar.menukit.api.panel.AnchorPanelAdapter
 
seq() - Method in class com.trevlar.menukit.api.panel.ScreenPanelAdapter
The registration sequence (the last tie-break).
seq() - Method in class com.trevlar.menukit.api.panel.VanillaScreenPanelAdapter
 
setAvailableContentHeight(int) - Method in class com.trevlar.menukit.api.panel.Panel
Sets the content height the screen leaves this panel, the height counterpart of Panel.setAvailableContentWidth(int).
setAvailableContentWidth(int) - Method in class com.trevlar.menukit.api.panel.Panel
Sets the content width the screen leaves this panel.
setChildPosition(int, int) - Method in class com.trevlar.menukit.api.element.AbstractPanelElement
Moves this element (the container protocol): a Flow places its children with it every layout pass, and Row/Column place a built element with it.
setFrameHeight(int) - Method in class com.trevlar.menukit.api.panel.Panel
Sets the frame band: the content height from the panel's content top down to where the frame beside it ends, or -1 when no frame is beside it.
setRecipeBookOpen(boolean) - Static method in class com.trevlar.menukit.api.MK
Sets the recipe book's visibility on the active screen.
setReturnAction(Runnable) - Method in class com.trevlar.menukit.api.panel.MKScreen
Sets the action run when this screen closes via Escape (see MKScreen.returnAction).
setScreenKind(ScreenKind) - Method in class com.trevlar.menukit.api.panel.Panel
The kind of screen the panel is on, fed by its host before each layout (the host fixes it from its screen, ScreenKind.of(Screen)).
setVisible(boolean) - Method in class com.trevlar.menukit.api.panel.Panel
Sets this panel's visibility.
shadow(boolean) - Method in class com.trevlar.menukit.api.element.TextLabel.Builder
A fixed drop shadow, on every kind of screen.
SharedPanels - Class in com.trevlar.menukit.api.panel
Panels several mods share (7.4.0).
shift() - Method in record class com.trevlar.menukit.api.element.Click
Returns the value of the shift record component.
showDialogTab(String) - Method in class com.trevlar.menukit.api.element.ColorField
Shows a tab of the dialog ("basic" or "custom"), as a click on it does.
showDialogTab(String) - Method in class com.trevlar.menukit.api.element.ItemPicker
Shows a tab of the dialog ("search" or "edit"), as a click on it does.
shown(RenderContext, Slot) - Static method in class com.trevlar.menukit.api.host.SlotClip
Records that slot is placed this frame by an element rendering with ctx, under the clip that context draws in.
shownKeys() - Method in class com.trevlar.menukit.api.element.ListView
The keys of the rows shown now, top to bottom (the search and sort's view).
showsNothing() - Method in class com.trevlar.menukit.api.panel.Panel
Whether nothing of this panel would show this frame (7.3.0): it has elements, none of them is shown with any height, and it has no pinned size.
showsTitle() - Method in class com.trevlar.menukit.api.panel.MKScreen
Whether the title band shows (false after MKScreen.hideTitle()).
SHULKER_BOX - Static variable in class com.trevlar.menukit.api.panel.ContainerRegion
Vanilla's shulker box texture: for a section that shows a shulker box.
SIDE_SCROLL - Enum constant in enum class com.trevlar.menukit.api.element.Tabs.Mode
Stay one row and scroll horizontally.
SIDEBAR - Enum constant in enum class com.trevlar.menukit.api.element.Tabs.Mode
A column down the left, the body to its right; scrolls vertically when too tall.
SIDEBAR_HEADER_GAP - Static variable in class com.trevlar.menukit.api.element.Tabs
Space between the sidebar header and the tabs under it.
sidebarHeader(PanelElement...) - Method in class com.trevlar.menukit.api.element.Tabs.Builder
Elements above the sidebar's tab column (a Back button, say), positioned from the column's top-left and laid out to its width the way a panel lays out its own elements.
Single responsibility - Section in class com.trevlar.menukit.api.element.ScrollContainer
 
size(int) - Method in class com.trevlar.menukit.api.hud.HudPanel.ItemBuilder
 
size(int, int) - Method in class com.trevlar.menukit.api.element.AbstractPanelElement.Builder
The element's size in pixels.
size(int, int) - Method in class com.trevlar.menukit.api.element.Button.Builder
Size in pixels.
size(int, int) - Method in class com.trevlar.menukit.api.element.ColorField.Builder
The swatch's size in pixels.
size(int, int) - Method in class com.trevlar.menukit.api.element.Divider.Builder
The raw extent: (length, thickness) for a horizontal divider, (thickness, length) for a vertical one.
size(int, int) - Method in class com.trevlar.menukit.api.element.Icon.Builder
Required: size in pixels.
size(int, int) - Method in class com.trevlar.menukit.api.element.ItemDisplay.Builder
Size in pixels; the item scales to the smaller side.
size(int, int) - Method in class com.trevlar.menukit.api.element.ProgressBar.Builder
Required: size in pixels.
size(int, int) - Method in class com.trevlar.menukit.api.element.ScrollContainer.Builder
Required: the outer size, scrollbar lane included.
size(int, int) - Method in class com.trevlar.menukit.api.element.Slider.Builder
Required: size in pixels.
size(int, int) - Method in class com.trevlar.menukit.api.element.Tabs.Builder
A fixed box instead of filling the panel, for a panel with no height budget (a panel on a vanilla screen, say).
size(int, int) - Method in class com.trevlar.menukit.api.element.TextField.Builder
Required: size in pixels.
size(int, int) - Method in class com.trevlar.menukit.api.element.Toggle.Builder
Size in pixels.
size(int, int) - Method in class com.trevlar.menukit.api.element.WidgetHost.Builder
Required: the rectangle the widget gets, in pixels.
size(int, int) - Method in class com.trevlar.menukit.api.hud.HudNotification.Builder
Explicit panel size; if 0, auto-sized from content.
size(int, int) - Method in class com.trevlar.menukit.api.hud.HudPanel.Builder
Sets an explicit outer panel size, padding included.
size(int, int) - Method in class com.trevlar.menukit.api.panel.ContainerTabs.Builder
The tab's size: width across and height out from the frame, each at least 8.
size(int, int) - Method in class com.trevlar.menukit.api.panel.Panel
Pins this panel's width and height, overriding the size Panel.getWidth() and Panel.getHeight() would compute from the elements.
Size - Section in class com.trevlar.menukit.api.element.Tabs
 
SIZE - Static variable in class com.trevlar.menukit.api.element.ItemPicker
A slot's size: 16 px of item and a 1 px frame each side.
Size and icons - Section in class com.trevlar.menukit.api.panel.ContainerTabs
 
Sized to its content (7.2.0) - Section in class com.trevlar.menukit.api.element.ScrollContainer
 
Sizing - Section in class com.trevlar.menukit.api.element.SlotScroll
 
slide(HudCycleStrip.Source, int, HudCycleStrip.Direction) - Static method in class com.trevlar.menukit.api.hud.HudCycleStrip
Slides source's ring on hotbarSlot one step in direction.
SLIDE_MILLIS - Static variable in class com.trevlar.menukit.api.hud.HudCycleStrip
How long one slide takes, in milliseconds.
SLIDE_MILLIS - Static variable in class com.trevlar.menukit.api.panel.ContainerTabs
How long a group's sub-tabs take to slide open or closed, in ms.
slideChanged(int, HudCycleStrip.Direction, Map) - Static method in class com.trevlar.menukit.api.hud.HudCycleStrip
Slides the held cell of every ring on hotbarSlot whose contents differ from before (a HudCycleStrip.snapshot(int) taken before the change).
slideDistance(int) - Method in class com.trevlar.menukit.api.hud.HudNotification.Builder
Slide-in animation distance in pixels (default 20).
slideDone(long) - Static method in class com.trevlar.menukit.api.hud.HudCycleStrip
Deprecated, for removal: This API element is subject to removal in a future version.
slideDone(HudCycleStrip.SlideStart) - Static method in class com.trevlar.menukit.api.hud.HudCycleStrip
Whether slide has finished.
slideFrom(HudNotification.SlideDirection) - Method in class com.trevlar.menukit.api.hud.HudNotification.Builder
Direction the notification slides in from (default TOP).
slideProgress(long) - Static method in class com.trevlar.menukit.api.hud.HudCycleStrip
Deprecated, for removal: This API element is subject to removal in a future version.
startMillis must be Util.getMillis(); a value from another clock (vanilla's System.currentTimeMillis(), for one) silently never reports done, since the two clocks measure from a different zero. Use HudCycleStrip.begin() and HudCycleStrip.slideProgress(SlideStart) instead, which cannot take the wrong clock. Kept through MenuKit 7.x; removed in 8.0.0.
slideProgress(HudCycleStrip.SlideStart) - Static method in class com.trevlar.menukit.api.hud.HudCycleStrip
The strip's eased progress since slide began: 0 at the start, exactly 1 at rest, with the spring's overshoot to about 1.1 just before it settles.
Slider<V> - Class in com.trevlar.menukit.api.element
A slider: vanilla's AbstractSliderButton, laid out and lensed by MenuKit.
Slider(Slider.Builder) - Constructor for class com.trevlar.menukit.api.element.Slider
 
Slider.Builder<V> - Class in com.trevlar.menukit.api.element
 
slot() - Method in record class com.trevlar.menukit.api.host.SlotHoverResult
Returns the value of the slot record component.
slot(int, int) - Method in class com.trevlar.menukit.api.hud.HudPanel.Builder
Adds a hotbar slot and returns a SlotBuilder to configure it.
slot(int, int, Supplier) - Method in class com.trevlar.menukit.api.hud.HudPanel.Builder
Adds a hotbar slot, drawn with vanilla's hotbar sprite, holding an item.
SLOT_HEIGHT - Static variable in class com.trevlar.menukit.api.hud.HudSlot
 
SLOT_WIDTH - Static variable in class com.trevlar.menukit.api.hud.HudSlot
 
SlotClip - Class in com.trevlar.menukit.api.host
Part of the created-slot contract, beside SlotScreenHook: a slot library tells MenuKit when an element places a slot, so the slot is clipped to what its panel shows of it (7.2.0).
SlotDecorations - Class in com.trevlar.menukit.api.panel
What a mod draws on a container screen's slots (7.5.0), under the item or over it, so no mod mixes into the slot's draw.
SlotDecorations.Decoration - Interface in com.trevlar.menukit.api.panel
What one mod draws on a slot, and the tooltip it answers there.
SlotHoverResult - Record Class in com.trevlar.menukit.api.host
SlotHoverResult(boolean, Slot) - Constructor for record class com.trevlar.menukit.api.host.SlotHoverResult
Creates an instance of a SlotHoverResult record class.
SlotItemLooks - Class in com.trevlar.menukit.api.panel
What a slot's item draws as on a container screen (7.4.0): a mod says, per slot and per frame, which ItemAnimation the item draws with and how far through it is, and the slot draws that in place of the item.
SlotItemLooks.Look - Interface in com.trevlar.menukit.api.panel
What one mod draws a slot's item as.
slotOwnership(OwnHost.SlotOwnership) - Method in class com.trevlar.menukit.api.host.OwnHost
Which live slots each panel presents (see OwnHost.SlotOwnership).
SlotRendering - Class in com.trevlar.menukit.api.element
The recessed 18×18 slot frame for registered slots that live outside a vanilla container texture, the one piece of a created slot's presentation that is panel chrome rather than the slot itself.
Slots (7.2.0) - Section in class com.trevlar.menukit.api.element.ScrollContainer
 
SlotScreenHook - Interface in com.trevlar.menukit.api.host
The plug a slot library fills so its panel-hosted slots (created slots, drawn inside MenuKit panels) take hover and clicks through MenuKit's own container-screen dispatch, without MenuKit naming a slot type.
SlotScroll - Class in com.trevlar.menukit.api.element
A grid of slots that scrolls inside its panel when it doesn't fit (7.4.0): as tall as its live rows while there is room, shorter by whole rows when there isn't, never under its minimum rows, scrolling past what shows.
SlotScroll.Builder - Class in com.trevlar.menukit.api.element
Builds a SlotScroll.
SlotScroll.Cell - Interface in com.trevlar.menukit.api.element
Makes cell index: an element at (x, y) in the grid, shown while shown holds (on top of whatever hides it on its own).
snapshot(int) - Static method in class com.trevlar.menukit.api.hud.HudCycleStrip
Every registered source's view of hotbarSlot right now, for a later HudCycleStrip.slideChanged(int, HudCycleStrip.Direction, Map).
sort(Component, Comparator) - Method in class com.trevlar.menukit.api.element.ListView.Builder
A way to sort the rows, labeled label in the sort picker; call once per way.
Sort(int, boolean) - Constructor for record class com.trevlar.menukit.api.element.ListView.Sort
Creates an instance of a Sort record class.
sortState(Supplier, Consumer) - Method in class com.trevlar.menukit.api.element.ListView.Builder
Keeps the sort choice yours (a lens), so it is remembered; otherwise it is the list's view state.
source(Supplier) - Method in class com.trevlar.menukit.api.panel.ContainerRegion.Builder
The container this section shows, read every frame.
Source(Identifier, String, BlockPos) - Constructor for record class com.trevlar.menukit.api.panel.ContainerRegion.Source
Creates an instance of a Source record class.
spacer() - Static method in class com.trevlar.menukit.api.element.Flow
A flexible gap: takes the row's leftover width, shared with the row's other spacers.
Spacers: label left, control right - Section in class com.trevlar.menukit.api.element.Flow
 
spacing(int) - Method in class com.trevlar.menukit.api.layout.Column.Builder
Pixels between adjacent children.
spacing(int) - Method in class com.trevlar.menukit.api.layout.Row.Builder
Pixels between adjacent children.
sprite(Supplier) - Method in class com.trevlar.menukit.api.element.Button.Builder
A sprite button whose sprite is read every frame.
sprite(Supplier) - Method in class com.trevlar.menukit.api.element.Icon.Builder
The sprite, read every frame.
sprite(Supplier) - Method in class com.trevlar.menukit.api.element.Toggle.Builder
A sprite face read every frame (different art per state, say).
sprite(Identifier) - Method in class com.trevlar.menukit.api.element.Button.Builder
A sprite button: sprite is the whole button, frame included.
sprite(Identifier) - Method in class com.trevlar.menukit.api.element.Icon.Builder
The picture, from the GUI sprite atlas.
sprite(Identifier) - Method in class com.trevlar.menukit.api.element.Toggle.Builder
A sprite face: the sprite as-is when off, lightness-inverted when on.
stack() - Method in record class com.trevlar.menukit.api.element.ItemMatch
Returns the value of the stack record component.
stack(Supplier, Consumer) - Method in class com.trevlar.menukit.api.element.ItemPicker.Builder
One stack: get read every frame, set handed every change (ItemStack.EMPTY for none).
stacks(Supplier, Consumer) - Method in class com.trevlar.menukit.api.element.ItemPicker.Builder
A list of stacks, in the player's order: set gets a new list with no empty entries.
STANDALONE_STACK_GAP - Static variable in record class com.trevlar.menukit.api.panel.PanelPosition
The gap between panels a standalone screen stacks by default (the old BODY column's 14px, which leaves room for a container's "Inventory" label).
standaloneDefaults(List) - Static method in record class com.trevlar.menukit.api.panel.PanelPosition
The standalone-screen default for unplaced panels, keeping the look of the old BODY column: the first unplaced panel becomes PanelPosition.main() (unless one is declared), and each later one region(BOTTOM_CENTER), offset so it sits PanelPosition.STANDALONE_STACK_GAP below the one before, through its PanelPosition.gap(int).
standIn() - Method in class com.trevlar.menukit.api.element.Tabs.TabSpec
Owner only: this tab stands in for one another mod may add.
START - Enum constant in enum class com.trevlar.menukit.api.layout.CrossAlign
Align children to the low edge of the cross axis.
state(BooleanSupplier, Consumer) - Method in class com.trevlar.menukit.api.element.Checkbox.Builder
Required: the lens.
state(BooleanSupplier, Consumer) - Method in class com.trevlar.menukit.api.element.Section.Builder
The consumer owns whether it is open: get is read every frame, and a header click hands the new value to set.
state(BooleanSupplier, Consumer) - Method in class com.trevlar.menukit.api.element.Toggle.Builder
Required: the lens.
state(DoubleSupplier, DoubleConsumer) - Method in class com.trevlar.menukit.api.element.ScrollContainer.Builder
The consumer owns the scroll, in pixels from the top: get is read every frame, set receives each change.
state(IntSupplier, IntConsumer) - Method in class com.trevlar.menukit.api.element.ColorField.Builder
Required: the lens onto the color.
state(Supplier, Consumer) - Method in class com.trevlar.menukit.api.element.Dropdown.Builder
Required: the lens.
state(Supplier, Consumer) - Method in class com.trevlar.menukit.api.element.Tabs.Builder
Required: the selection lens.
state(Supplier, Consumer) - Method in class com.trevlar.menukit.api.element.TextField.Builder
Required: the lens.
state(Supplier, Consumer) - Method in class com.trevlar.menukit.api.element.DropdownMulti.Builder
Required: the lens over the chosen set.
state(Supplier, Consumer) - Method in class com.trevlar.menukit.api.element.ItemPicker.Builder
The 6.1.0 lens: one item, the kind only (ItemMatch.Match.ITEM).
state(Supplier, Consumer) - Static method in class com.trevlar.menukit.api.element.RadioGroup
The group's lens: get is read every frame by each Radio to draw itself; set receives the value of a Radio the player picks, only when it differs from the current selection.
state(Supplier, Consumer) - Method in class com.trevlar.menukit.api.element.Slider.Builder
Required: the lens.
State is the consumer's - Section in class com.trevlar.menukit.api.element.Toggle
 
STATUS_SCALE - Static variable in class com.trevlar.menukit.api.hud.HudPanel
The scale for a scaled hotbar slot in the status column (since 7.3.0): 6/11, so the 20 x 22 slot takes 11 x 12 and its item is about a heart's size.
statusColumn() - Method in class com.trevlar.menukit.api.hud.HudPanel.Builder
Places the panel in the status column (since 7.3.0): the 20 px gap between the hearts and the hunger bar, centered on the hotbar, from a fixed origin pinned to it: the lowest panel rests right on the XP level number, level with the hearts and armor rows.
statusColumnClearance(int, int, int) - Static method in class com.trevlar.menukit.api.MK
How far something on the HUD must move up this frame to clear the status column, in GUI pixels: by how much the column's top rises above bottom, the thing's own bottom edge, provided the column and the span left..right overlap across.
stepEnchant(Holder, int) - Method in class com.trevlar.menukit.api.element.ItemPicker
The minus (by -1) or plus (1) control of an enchantment on the selected item.
stretch(Class, int, int) - Static method in class com.trevlar.menukit.api.panel.ScreenFrames
Stretches every screen by by rows at row seam of its frame (negative to shrink it, leaving out rows seam to seam - by - 1).
style(PanelStyle) - Method in class com.trevlar.menukit.api.hud.HudNotification.Builder
Background style (default RAISED).
style(PanelStyle) - Method in class com.trevlar.menukit.api.hud.HudPanel.Builder
Sets the panel background style (RAISED, DARK, INSET, NONE).
style(PanelStyle) - Method in class com.trevlar.menukit.api.panel.Contribution.Builder
The panel's style.
style(PanelStyle) - Method in class com.trevlar.menukit.api.panel.Panel.Builder
Sets the panel's visual background style.
SUB_HEIGHT - Static variable in class com.trevlar.menukit.api.panel.ContainerTabs
A group's sub-tabs by default: about two-thirds of a tab, on the same line.
SUB_WIDTH - Static variable in class com.trevlar.menukit.api.panel.ContainerTabs
A group's sub-tabs by default: about two-thirds of a tab, on the same line.
summary(Supplier) - Method in class com.trevlar.menukit.api.element.Section.Builder
The gray text after the title, read every frame.
Supplier text and layout - Section in class com.trevlar.menukit.api.element.TextLabel
 
SURVIVAL - Enum constant in enum class com.trevlar.menukit.api.panel.ModeScope
Survival, adventure and spectator: a player without infinite materials.
swapped(UnaryOperator) - Method in interface com.trevlar.menukit.api.element.ItemAnimation
This animation drawing swap's stack in place of the one it is given: another model, another item (7.5.0).
swatch(int) - Method in class com.trevlar.menukit.api.element.Section.Builder
An 8x8 color swatch after the arrow (ARGB).
swatch(IntSupplier) - Method in class com.trevlar.menukit.api.element.Section.Builder
An 8x8 color swatch after the arrow (ARGB), read every frame (7.3.0): a recolor shows at once.
Sync - Section in com.trevlar.menukit.api.panel.Panel.visibleWhen(BooleanSupplier)
 

T

t() - Method in record class com.trevlar.menukit.api.element.ItemAnimation.Frame
Returns the value of the t record component.
tab(Tabs.TabSpec) - Method in class com.trevlar.menukit.api.element.Tabs.Builder
Adds a tab built with Tabs.tab(String).
tab(ContainerTabs.GroupTab) - Method in class com.trevlar.menukit.api.panel.ContainerTabs.Groups
Required: each key's sub-tab in a group, set up as ContainerTabs.Keyed.tab sets one up, by group and key.
tab(String) - Static method in class com.trevlar.menukit.api.element.Tabs
Starts a tab with an id; give it a label and a body.
tab(String, ModeScope) - Static method in class com.trevlar.menukit.api.panel.ContainerTabs
Starts a tab, its id namespaced and unique ("mymod:backpack"), for one mode scope: it shows only while the player is in that mode (ModeScope.BOTH for either), read every frame, as its ContainerTabs.Builder.visibleWhen is.
tab(String, Component, List) - Method in class com.trevlar.menukit.api.element.Tabs.Builder
Adds a tab that is always shown.
tab(BiConsumer) - Method in class com.trevlar.menukit.api.panel.ContainerTabs.Keyed
Required: each key's tab, set up on a builder as a declared tab is (its icon, tooltip, what a click does, when it shows, draws selected or is disabled), minus declare(), its screens, order and edge, which are the list's: setting those on it throws.
TAB_HEIGHT - Static variable in class com.trevlar.menukit.api.element.Tabs
Height of one row of tabs.
TAB_HEIGHT - Static variable in class com.trevlar.menukit.api.panel.ContainerTabs
A tab's default height beyond the frame edge it stands on: vanilla's creative top tab stands 28 px above its frame, these 25, room for a full-size icon inside an unpicked tab with two rows clear above and below it.
TAB_WIDTH - Static variable in class com.trevlar.menukit.api.panel.ContainerTabs
A tab's default width: vanilla's 26 px tab.
tabColumn(boolean) - Method in class com.trevlar.menukit.api.element.Tabs.Builder
Whether the sidebar draws its tab column.
tabIds() - Method in class com.trevlar.menukit.api.element.Tabs
The ids of this element's tabs, in strip order, hidden ones included.
Tabs - Class in com.trevlar.menukit.api.element
A tab strip and the area below it that shows the selected tab's body.
Tabs.Align - Enum Class in com.trevlar.menukit.api.element
Where tabs sit within a row; in Tabs.Mode.SIDEBAR, where the label sits within its tab.
Tabs.Builder - Class in com.trevlar.menukit.api.element
 
Tabs.Mode - Enum Class in com.trevlar.menukit.api.element
How the strip lays out when the tabs don't fit one row.
Tabs.Tab - Class in com.trevlar.menukit.api.element
One tab: an id, a label, a body, and whether it shows.
Tabs.TabSpec - Class in com.trevlar.menukit.api.element
A tab under construction.
Tabs from other mods - Section in class com.trevlar.menukit.api.element.Tabs
 
tabSize(int, int) - Method in class com.trevlar.menukit.api.panel.ContainerTabs.Groups
Every sub-tab's size, as ContainerTabs.Keyed.tabSize(int, int) takes it.
tabSize(int, int) - Method in class com.trevlar.menukit.api.panel.ContainerTabs.Keyed
Every key's tab's size, as ContainerTabs.Builder.size(int, int) takes it, before a key's own size.
takeKind() - Static method in class com.trevlar.menukit.api.element.MKTooltip
The kind of the tooltip being queued now, clearing the mark: ITEM once after MKTooltip.itemTooltipNext(), else OTHER.
takeRevealRequest() - Method in class com.trevlar.menukit.api.element.Flow
A child's request to be scrolled into view, passed on (the children share the Flow's origin).
takeRevealRequest() - Method in class com.trevlar.menukit.api.element.ListView
Once, the place of a row to scroll into view: one an add made or a move moved, or the selected row when the selection changed other than by a click.
takeRevealRequest() - Method in interface com.trevlar.menukit.api.element.PanelElement
A rectangle this element asks the scroll area around it to bring into view (7.3.0): {y, height} in the panel's content coordinates (the space of PanelElement.getChildY()), or null for none.
takeRevealRequest(List) - Static method in class com.trevlar.menukit.api.element.ChildDispatch
The first child's request to be scrolled into view (PanelElement.takeRevealRequest()), or null.
Targeting - Section in class com.trevlar.menukit.api.panel.AnchorPanelAdapter
 
Targeting - Section in class com.trevlar.menukit.api.panel.ScreenPanelAdapter
 
Targeting is required - Section in class com.trevlar.menukit.api.panel.VanillaScreenPanelAdapter
 
text(int, int) - Method in class com.trevlar.menukit.api.hud.HudPanel.Builder
Adds a text element and returns a TextBuilder to configure it.
text(int, int, Supplier) - Method in class com.trevlar.menukit.api.hud.HudPanel.Builder
Adds a text element with default styling (white, shadow, 1x scale).
text(Supplier) - Method in class com.trevlar.menukit.api.hud.HudPanel.TextBuilder
 
text(Supplier) - Method in class com.trevlar.menukit.api.element.InfoBox.Builder
Required: the text, read every frame.
text(Supplier) - Method in class com.trevlar.menukit.api.element.TextLabel.Builder
Required: the text, read every frame.
text(Component) - Method in class com.trevlar.menukit.api.element.InfoBox.Builder
Required: the text.
text(Component) - Method in class com.trevlar.menukit.api.element.TextLabel.Builder
Required: the text.
Text - Class in com.trevlar.menukit.api.element
Text drawing shared by MenuKit's elements: one line in a bounded width, and wrapped text.
TEXT_DARK - Static variable in class com.trevlar.menukit.api.element.ElementConstants
Dark gray text, no shadow: vanilla's container-label color on a light panel.
TEXT_DISABLED - Static variable in class com.trevlar.menukit.api.element.ElementConstants
Text of a disabled element, and all text inside a disabled panel or container.
TEXT_LIGHT - Static variable in class com.trevlar.menukit.api.element.ElementConstants
White text, drawn with a shadow: on a dark panel, a button, a HUD.
TEXT_MUTED - Static variable in class com.trevlar.menukit.api.element.ElementConstants
Secondary text on a light panel (a section's summary): TextRole.MUTED in the Panel look.
textColor(RenderContext, TextRole) - Method in class com.trevlar.menukit.api.element.AbstractPanelElement
The color of text in role on the kind of screen this element is on this frame, the TextRole.DISABLED color while it is disabled.
textColor(TextRole) - Method in enum class com.trevlar.menukit.api.panel.ScreenKind
The color of text in role in this look.
TextField - Class in com.trevlar.menukit.api.element
A single-line text field: vanilla's EditBox, laid out and lensed by MenuKit.
TextField(TextField.Builder) - Constructor for class com.trevlar.menukit.api.element.TextField
 
TextField.Builder - Class in com.trevlar.menukit.api.element
 
TextLabel - Class in com.trevlar.menukit.api.element
A line of text in a Panel, fixed or read every frame.
TextLabel(TextLabel.Builder) - Constructor for class com.trevlar.menukit.api.element.TextLabel
 
TextLabel.Builder - Class in com.trevlar.menukit.api.element
 
TextRole - Enum Class in com.trevlar.menukit.api.element
What a piece of text is for, so the kind of screen decides its color (6.1.0).
textShadow() - Method in enum class com.trevlar.menukit.api.panel.ScreenKind
Whether text in this look has a drop shadow: the Default look's does (vanilla's menu text), the Panel look's does not (vanilla's container labels).
Text that changes (7.3.0) - Section in class com.trevlar.menukit.api.dialog.ConfirmDialog
 
texture(Supplier, int) - Method in class com.trevlar.menukit.api.element.Icon.Builder
The texture, read every frame; null draws nothing (a texture not loaded yet).
texture(Identifier) - Method in class com.trevlar.menukit.api.panel.ContainerRegion.Builder
The container texture this section stands for where no block says so, a full texture path (ContainerRegion.CHEST, ContainerRegion.SHULKER_BOX, or a mod's own container texture laid out like vanilla's): under a resource pack that restyles it, the section's slot frames and its part of the list take its look.
texture(Identifier, int) - Method in class com.trevlar.menukit.api.element.Icon.Builder
The picture, a standalone square texture textureSize texels on a side (a DynamicTexture registered at runtime, say), drawn whole, scaled to the icon's size.
The axis is vanilla's own switch - Section in enum class com.trevlar.menukit.api.panel.ModeScope
 
The box - Section in class com.trevlar.menukit.api.panel.Anchor
 
The dialog - Section in class com.trevlar.menukit.api.element.ItemPicker
 
The disabled cascade - Section in record class com.trevlar.menukit.api.element.RenderContext
 
The fitted frame - Section in class com.trevlar.menukit.api.panel.ContainerRegion
 
The hex field - Section in class com.trevlar.menukit.api.element.ColorField
 
The kind of screen - Section in class com.trevlar.menukit.api.element.ColorField
 
The kind of screen (6.1.0) - Section in record class com.trevlar.menukit.api.element.InputContext
 
The kind of screen (6.1.0) - Section in record class com.trevlar.menukit.api.element.RenderContext
 
The lens - Section in class com.trevlar.menukit.api.element.Dropdown
 
The lens - Section in class com.trevlar.menukit.api.element.DropdownMulti
 
The lens - Section in class com.trevlar.menukit.api.element.TextField
 
The match mode - Section in class com.trevlar.menukit.api.element.ItemPicker
 
The menu - Section in class com.trevlar.menukit.api.element.MenuButton
 
The one width-cap helper - Section in class com.trevlar.menukit.api.element.AbstractPanelElement
 
The order - Section in class com.trevlar.menukit.api.element.ChildDispatch
 
The popover - Section in class com.trevlar.menukit.api.element.Dropdown
 
The row - Section in class com.trevlar.menukit.api.panel.ContainerTabs
 
The row is yours - Section in class com.trevlar.menukit.api.element.ListView
 
The screen's bounds - Section in class com.trevlar.menukit.api.panel.ContainerRegion
 
The scrollbar shows only while there is something to scroll (7.3.0) - Section in class com.trevlar.menukit.api.element.ScrollContainer
 
The slide - Section in class com.trevlar.menukit.api.hud.HudCycleStrip
 
The three modes - Section in record class com.trevlar.menukit.api.element.ItemMatch
 
The toolbar - Section in class com.trevlar.menukit.api.element.ListView
 
The trigger - Section in class com.trevlar.menukit.api.element.MenuButton
 
The value - Section in class com.trevlar.menukit.api.element.ColorField
 
The value - Section in class com.trevlar.menukit.api.element.ItemPicker
 
thickness(int) - Method in class com.trevlar.menukit.api.element.Divider.Builder
The thickness of a filling divider, in pixels.
Three faces, one builder - Section in class com.trevlar.menukit.api.element.Button
 
Three scales, one lens - Section in class com.trevlar.menukit.api.element.Slider
 
tint(IntSupplier) - Method in class com.trevlar.menukit.api.element.Button.Builder
An ARGB fill over the background and under the label, read every frame; 0 for none.
tint(IntSupplier) - Method in class com.trevlar.menukit.api.element.Toggle.Builder
An ARGB fill over the face, read every frame; 0 for none.
title(Supplier) - Method in class com.trevlar.menukit.api.dialog.ConfirmDialog.Builder
Title text read every frame the dialog is shown (7.3.0): the item it is about, say.
title(Supplier) - Method in class com.trevlar.menukit.api.dialog.EditDialog.Builder
Title text read every frame the dialog is shown: the item it edits, say.
title(Supplier) - Method in class com.trevlar.menukit.api.element.ListView.Builder
ListView.Builder.title(Component) read every frame, so it can show a live count ("Ranges 4 rows", the count styled gray); its styles are kept.
title(Supplier) - Method in class com.trevlar.menukit.api.panel.ContainerRegion.Builder
The section's title, read every frame, drawn where vanilla draws a container's (1 px in, 11 px above the content).
title(Supplier, Supplier) - Method in class com.trevlar.menukit.api.element.ListView.Builder
ListView.Builder.title(Supplier), read every frame, with a hover tooltip read while hovered.
title(Supplier, Component) - Method in class com.trevlar.menukit.api.element.ListView.Builder
ListView.Builder.title(Supplier), read every frame, with a fixed hover tooltip.
title(Component) - Method in class com.trevlar.menukit.api.dialog.AlertDialog.Builder
Title text shown at the top of the dialog.
title(Component) - Method in class com.trevlar.menukit.api.dialog.ConfirmDialog.Builder
Title text shown at the top of the dialog.
title(Component) - Method in class com.trevlar.menukit.api.dialog.EditDialog.Builder
Title text shown at the top of the dialog.
title(Component) - Method in class com.trevlar.menukit.api.element.ListView.Builder
The list's heading, on the toolbar's line at its left edge, before the search field and the buttons: one line for both.
title(Component, Supplier) - Method in class com.trevlar.menukit.api.element.ListView.Builder
ListView.Builder.title(Component, Component) with the tooltip read every frame while hovered, as Button.Builder.tooltip(Supplier): a null result shows none.
title(Component, Component) - Method in class com.trevlar.menukit.api.element.ListView.Builder
ListView.Builder.title(Component) with a hover tooltip of its own (a config option's description, say), as Button.Builder.tooltip(Component): a \n starts a new line.
titleBox() - Method in class com.trevlar.menukit.api.element.ListView
The toolbar's title box, {x, y, width, height} where the toolbar sits, or null without one.
titleHover() - Method in class com.trevlar.menukit.api.element.ListView
What hovering the toolbar's title shows now: its own tooltip, else the whole title when cut; null for nothing.
Titles and names - Section in class com.trevlar.menukit.api.panel.ContainerRegion
 
titleShown() - Method in class com.trevlar.menukit.api.element.ListView
The toolbar's title as drawn now, cut with "..." when it doesn't fit; empty without one.
Toggle - Class in com.trevlar.menukit.api.element
A two-state on/off control: MenuKit's general boolean primitive, a lens onto the consumer's boolean and only a lens.
Toggle(Toggle.Builder) - Constructor for class com.trevlar.menukit.api.element.Toggle
 
Toggle.Builder - Class in com.trevlar.menukit.api.element
 
toggleKey(int) - Method in class com.trevlar.menukit.api.panel.Panel.Builder
Sets the key code (InputConstants.KEY_*) that toggles this panel's visibility.
toolbar() - Method in class com.trevlar.menukit.api.element.ListView
The toolbar: the title, search, sort, add, and remove and the arrows, whichever the list has, an ordinary element to put above the list's scroll area so it stays put while the rows scroll.
toolbarButtons() - Method in class com.trevlar.menukit.api.element.ListView
The toolbar's buttons' box, {x, y, width, height}: the first button's left edge and their line.
tooltip - Variable in class com.trevlar.menukit.api.element.AbstractPanelElement.Builder
 
tooltip(Supplier) - Method in class com.trevlar.menukit.api.panel.ContainerTabs.Builder
The tab's tooltip, read every frame it is hovered.
tooltip(Supplier) - Method in class com.trevlar.menukit.api.element.AbstractPanelElement.Builder
A hover tooltip read every frame while hovered; a null result shows none.
tooltip(Supplier) - Method in class com.trevlar.menukit.api.panel.Panel
Sets a tooltip whose text comes from a supplier, read every frame while the panel is hovered.
tooltip(AbstractContainerScreen, Slot, ItemStack, int, int) - Method in interface com.trevlar.menukit.api.panel.SlotDecorations.Decoration
The tooltip with the mouse at (mouseX, mouseY) on the slot, counted from the item box's top left (so -1 to 16 across the slot's frame), or null for none.
tooltip(Component) - Method in class com.trevlar.menukit.api.element.AbstractPanelElement.Builder
A hover tooltip with fixed text.
tooltip(Component) - Method in class com.trevlar.menukit.api.panel.Panel
Sets a tooltip shown whenever the cursor is over the panel's outer bounds, say to explain what a collapsible or configurable panel is for.
tooltip(Component, Component...) - Method in class com.trevlar.menukit.api.element.AbstractPanelElement.Builder
A hover tooltip of several fixed lines, top to bottom, each keeping its own style: a white title, then gray hints, say.
tooltip(Component, Component...) - Method in class com.trevlar.menukit.api.panel.Panel
Sets a tooltip of several fixed lines, top to bottom, each keeping its own style.
tooltipStarts(int) - Static method in class com.trevlar.menukit.api.element.MKTooltip
The frame's tooltip is about to be placed.
tooltipSupplier() - Method in class com.trevlar.menukit.api.element.AbstractPanelElement
 
tooltipSupplier() - Method in interface com.trevlar.menukit.api.element.PanelElement
The element's hover-tooltip text supplier, or null if none.
TOP - Enum constant in enum class com.trevlar.menukit.api.hud.HudNotification.SlideDirection
 
TOP_ALIGN_LEFT - Enum constant in enum class com.trevlar.menukit.api.panel.OutsideRegion
 
TOP_ALIGN_RIGHT - Enum constant in enum class com.trevlar.menukit.api.panel.OutsideRegion
 
TOP_CENTER - Enum constant in enum class com.trevlar.menukit.api.panel.InsideRegion
 
TOP_CENTER - Enum constant in enum class com.trevlar.menukit.api.panel.OutsideRegion
Above the menu's container frame, centered horizontally.
TOP_LEFT - Enum constant in enum class com.trevlar.menukit.api.panel.InsideRegion
 
TOP_RIGHT - Enum constant in enum class com.trevlar.menukit.api.panel.InsideRegion
 
TOP_TO_BOTTOM - Enum constant in enum class com.trevlar.menukit.api.element.ProgressBar.Direction
 
topPos() - Method in record class com.trevlar.menukit.api.panel.Reference
Returns the value of the topPos record component.
toString() - Method in record class com.trevlar.menukit.api.element.Button.Look
Returns a string representation of this record class.
toString() - Method in record class com.trevlar.menukit.api.element.Click
Returns a string representation of this record class.
toString() - Method in record class com.trevlar.menukit.api.element.InputContext
Returns a string representation of this record class.
toString() - Method in record class com.trevlar.menukit.api.element.ItemAnimation.Frame
Returns a string representation of this record class.
toString() - Method in record class com.trevlar.menukit.api.element.ItemAnimation.Pose
Returns a string representation of this record class.
toString() - Method in record class com.trevlar.menukit.api.element.ItemMatch
Returns a string representation of this record class.
toString() - Method in record class com.trevlar.menukit.api.element.ItemPicker.Box
Returns a string representation of this record class.
toString() - Method in record class com.trevlar.menukit.api.element.ListView.Sort
Returns a string representation of this record class.
toString() - Method in record class com.trevlar.menukit.api.element.MenuButton.Action
Returns a string representation of this record class.
toString() - Method in record class com.trevlar.menukit.api.element.RenderContext
Returns a string representation of this record class.
toString() - Method in record class com.trevlar.menukit.api.host.OwnHost.Layout
Returns a string representation of this record class.
toString() - Method in record class com.trevlar.menukit.api.host.OwnHost.Placement
Returns a string representation of this record class.
toString() - Method in record class com.trevlar.menukit.api.host.SlotHoverResult
Returns a string representation of this record class.
toString() - Method in record class com.trevlar.menukit.api.hud.HudCycleStrip.View
Returns a string representation of this record class.
toString() - Method in class com.trevlar.menukit.api.panel.Anchor
 
toString() - Method in record class com.trevlar.menukit.api.panel.ContainerRegion.Source
Returns a string representation of this record class.
toString() - Method in record class com.trevlar.menukit.api.panel.PanelPosition
Returns a string representation of this record class.
toString() - Method in record class com.trevlar.menukit.api.panel.Placement
Returns a string representation of this record class.
toString() - Method in record class com.trevlar.menukit.api.panel.Reference
Returns a string representation of this record class.
toString() - Method in record class com.trevlar.menukit.api.panel.ScreenOrigin
Returns a string representation of this record class.
toward(Object, boolean) - Method in class com.trevlar.menukit.api.element.Transition
key's eased progress now, going forward (toward 1) or back (toward 0).
toward(Object, boolean, long) - Method in class com.trevlar.menukit.api.element.Transition
Transition.toward(Object, boolean) at now, on Util.getMillis()'s scale: for a mod running its own clock, and for checks.
TRACK_WIDTH - Static variable in class com.trevlar.menukit.api.element.ScrollContainer
Scrollbar track width: the handle plus its padding.
tracksAsModal() - Method in class com.trevlar.menukit.api.panel.Panel
Whether this panel acts as a modal.
tracksAsModal(boolean) - Method in class com.trevlar.menukit.api.panel.Panel
Sets whether this panel acts as a modal for the whole window.
Transition - Class in com.trevlar.menukit.api.element
A timed change between two states, kept per key (7.4.0): one duration and one Easing, and for each key the mod names (a slot, a container, a tab) where that key is on its way.
triggerLabel(Function) - Method in class com.trevlar.menukit.api.element.DropdownMulti.Builder
Required: the trigger's summary of the chosen set ("3 selected", a joined list).
triggerLabel(Function) - Method in class com.trevlar.menukit.api.element.Dropdown.Builder
The trigger's text for the current item.
triggerText() - Method in class com.trevlar.menukit.api.element.Dropdown
 
triggerText() - Method in class com.trevlar.menukit.api.element.DropdownMulti
 
triggerText() - Method in class com.trevlar.menukit.api.element.MenuButton
 
Two panels - Section in class com.trevlar.menukit.api.panel.ContainerRegion
 
Two stacking gaps - Section in class com.trevlar.menukit.api.panel.RegionConstants
 
typeEdit(String, String) - Method in class com.trevlar.menukit.api.element.ItemPicker
Types into a field of the Edit tab ("name", "count", "components"), as a player does.
typeHex(String) - Method in class com.trevlar.menukit.api.element.ColorField
Text typed into the hex field: kept as typed, and written only when it is valid hex.
typeQuery(String) - Method in class com.trevlar.menukit.api.element.ListView
As typing in the search field: the query now.
typeQuery(String) - Method in class com.trevlar.menukit.api.element.Dropdown
As typing in the search field (7.3.0): the query now, for the checks (a real popover's query comes from the field itself).
typeQuery(String) - Method in class com.trevlar.menukit.api.element.DropdownMulti
As typing in the search field (7.3.0): the query now, for the checks (a real popover's query comes from the field itself).
typeQuery(String) - Method in class com.trevlar.menukit.api.element.MenuButton
As typing in the search field (7.3.0): the query now, for the checks (a real popover's query comes from the field itself).

U

under(String, SlotDecorations.Decoration) - Static method in class com.trevlar.menukit.api.panel.SlotDecorations
Declares a decoration drawn under the item, its id namespaced and unique among every decoration ("mymod:ghost").
UNPLACED - Enum constant in enum class com.trevlar.menukit.api.panel.PanelPosition.Mode
No placement declared.
UNPLACED - Static variable in record class com.trevlar.menukit.api.panel.PanelPosition
No placement.
unregister() - Method in class com.trevlar.menukit.api.panel.AnchorPanelAdapter
Withdraws this adapter from screens opened from now on.
unregister() - Method in class com.trevlar.menukit.api.panel.ScreenPanelAdapter
Withdraws this adapter: the next screen that opens no longer shows the panel.
unregister() - Method in class com.trevlar.menukit.api.panel.VanillaScreenPanelAdapter
Withdraws this adapter from screens opened from now on.
Usage - Section in class com.trevlar.menukit.api.dialog.AlertDialog
 
Usage - Section in class com.trevlar.menukit.api.dialog.ConfirmDialog
 
Usage - Section in class com.trevlar.menukit.api.layout.Column
 
Usage - Section in class com.trevlar.menukit.api.layout.Row
 

V

value() - Method in class com.trevlar.menukit.api.element.ColorField
The color the field shows now: 0xRRGGBB, or 0xAARRGGBB with alpha.
value() - Method in class com.trevlar.menukit.api.element.ItemPicker
The setting's slots now, in order, none empty: each a stack and its match mode.
value(DoubleSupplier) - Method in class com.trevlar.menukit.api.element.ProgressBar.Builder
The fraction to show, 0 to 1, read every frame.
value(DoubleSupplier) - Method in class com.trevlar.menukit.api.hud.HudPanel.BarBuilder
 
valueOf(String) - Static method in enum class com.trevlar.menukit.api.element.ItemMatch.Match
Returns the enum constant of this class with the specified name.
valueOf(String) - Static method in enum class com.trevlar.menukit.api.element.MKTooltip.Kind
Returns the enum constant of this class with the specified name.
valueOf(String) - Static method in enum class com.trevlar.menukit.api.element.ProgressBar.Direction
Returns the enum constant of this class with the specified name.
valueOf(String) - Static method in enum class com.trevlar.menukit.api.element.Tabs.Align
Returns the enum constant of this class with the specified name.
valueOf(String) - Static method in enum class com.trevlar.menukit.api.element.Tabs.Mode
Returns the enum constant of this class with the specified name.
valueOf(String) - Static method in enum class com.trevlar.menukit.api.element.TextRole
Returns the enum constant of this class with the specified name.
valueOf(String) - Static method in enum class com.trevlar.menukit.api.host.OwnHost.TitleBand
Returns the enum constant of this class with the specified name.
valueOf(String) - Static method in enum class com.trevlar.menukit.api.hud.HudCycleStrip.Axis
Returns the enum constant of this class with the specified name.
valueOf(String) - Static method in enum class com.trevlar.menukit.api.hud.HudCycleStrip.Direction
Returns the enum constant of this class with the specified name.
valueOf(String) - Static method in enum class com.trevlar.menukit.api.hud.HudNotification.SlideDirection
Returns the enum constant of this class with the specified name.
valueOf(String) - Static method in enum class com.trevlar.menukit.api.layout.CrossAlign
Returns the enum constant of this class with the specified name.
valueOf(String) - Static method in enum class com.trevlar.menukit.api.panel.ContainerTabs.Edge
Returns the enum constant of this class with the specified name.
valueOf(String) - Static method in enum class com.trevlar.menukit.api.panel.InsideRegion
Returns the enum constant of this class with the specified name.
valueOf(String) - Static method in enum class com.trevlar.menukit.api.panel.ModeScope
Returns the enum constant of this class with the specified name.
valueOf(String) - Static method in enum class com.trevlar.menukit.api.panel.OutsideRegion
Returns the enum constant of this class with the specified name.
valueOf(String) - Static method in enum class com.trevlar.menukit.api.panel.PanelPosition.Mode
Returns the enum constant of this class with the specified name.
valueOf(String) - Static method in enum class com.trevlar.menukit.api.panel.PanelStyle
Returns the enum constant of this class with the specified name.
valueOf(String) - Static method in enum class com.trevlar.menukit.api.panel.ScreenKind
Returns the enum constant of this class with the specified name.
values() - Static method in enum class com.trevlar.menukit.api.element.ItemMatch.Match
Returns an array containing the constants of this enum class, in the order they are declared.
values() - Static method in enum class com.trevlar.menukit.api.element.MKTooltip.Kind
Returns an array containing the constants of this enum class, in the order they are declared.
values() - Static method in enum class com.trevlar.menukit.api.element.ProgressBar.Direction
Returns an array containing the constants of this enum class, in the order they are declared.
values() - Static method in enum class com.trevlar.menukit.api.element.Tabs.Align
Returns an array containing the constants of this enum class, in the order they are declared.
values() - Static method in enum class com.trevlar.menukit.api.element.Tabs.Mode
Returns an array containing the constants of this enum class, in the order they are declared.
values() - Static method in enum class com.trevlar.menukit.api.element.TextRole
Returns an array containing the constants of this enum class, in the order they are declared.
values() - Static method in enum class com.trevlar.menukit.api.host.OwnHost.TitleBand
Returns an array containing the constants of this enum class, in the order they are declared.
values() - Static method in enum class com.trevlar.menukit.api.hud.HudCycleStrip.Axis
Returns an array containing the constants of this enum class, in the order they are declared.
values() - Static method in enum class com.trevlar.menukit.api.hud.HudCycleStrip.Direction
Returns an array containing the constants of this enum class, in the order they are declared.
values() - Static method in enum class com.trevlar.menukit.api.hud.HudNotification.SlideDirection
Returns an array containing the constants of this enum class, in the order they are declared.
values() - Static method in enum class com.trevlar.menukit.api.layout.CrossAlign
Returns an array containing the constants of this enum class, in the order they are declared.
values() - Static method in enum class com.trevlar.menukit.api.panel.ContainerTabs.Edge
Returns an array containing the constants of this enum class, in the order they are declared.
values() - Static method in enum class com.trevlar.menukit.api.panel.InsideRegion
Returns an array containing the constants of this enum class, in the order they are declared.
values() - Static method in enum class com.trevlar.menukit.api.panel.ModeScope
Returns an array containing the constants of this enum class, in the order they are declared.
values() - Static method in enum class com.trevlar.menukit.api.panel.OutsideRegion
Returns an array containing the constants of this enum class, in the order they are declared.
values() - Static method in enum class com.trevlar.menukit.api.panel.PanelPosition.Mode
Returns an array containing the constants of this enum class, in the order they are declared.
values() - Static method in enum class com.trevlar.menukit.api.panel.PanelStyle
Returns an array containing the constants of this enum class, in the order they are declared.
values() - Static method in enum class com.trevlar.menukit.api.panel.ScreenKind
Returns an array containing the constants of this enum class, in the order they are declared.
Vanilla's screens are one size already - Section in class com.trevlar.menukit.api.panel.ScreenFrames
 
VanillaScreenPanelAdapter - Class in com.trevlar.menukit.api.panel
Puts a Panel on vanilla non-container screens: Options, Controls, KeyBinds, world select, the title screen, and any other Screen that is not a container screen.
VanillaScreenPanelAdapter(Panel) - Constructor for class com.trevlar.menukit.api.panel.VanillaScreenPanelAdapter
Declares the panel with its own interior padding (0 for PanelStyle.NONE, VanillaScreenPanelAdapter.DEFAULT_PADDING otherwise).
VanillaScreenPanelAdapter(Panel, int) - Constructor for class com.trevlar.menukit.api.panel.VanillaScreenPanelAdapter
Declares the panel with explicit content padding.
vertical() - Static method in class com.trevlar.menukit.api.element.Divider
A vertical divider.
vertical() - Method in class com.trevlar.menukit.api.element.Flow.Builder
Top to bottom, wrapping into a new column to the right where the frame beside the panel ends.
vertical() - Method in class com.trevlar.menukit.api.panel.Contribution.Builder
Lays the panel out top to bottom (Flow.Builder.vertical()) instead of in a row.
Vertical: a column that wraps into columns - Section in class com.trevlar.menukit.api.element.Flow
 
Vertical alignment in a row (7.3.0) - Section in class com.trevlar.menukit.api.element.Flow
 
View(List, int) - Constructor for record class com.trevlar.menukit.api.hud.HudCycleStrip.View
Creates an instance of a View record class.
viewFor(int) - Method in interface com.trevlar.menukit.api.hud.HudCycleStrip.Source
The ring to draw for hotbarSlot (0 to 8), or null for none.
viewportWidthFor(int) - Static method in class com.trevlar.menukit.api.element.ScrollContainer
The content width that fits a container outerWidth wide in the Panel look: its width minus the scrollbar lane.
viewportWidthFor(int, ScreenKind) - Static method in class com.trevlar.menukit.api.element.ScrollContainer
The content width that fits a container outerWidth wide on a screen of kind: its width minus the scrollbar lane and, in the Default look, the list band's ScrollContainer.DEFAULT_INSET_X.
viewportWidthFor(int, ScreenKind, boolean) - Static method in class com.trevlar.menukit.api.element.ScrollContainer
Visibility - Section in class com.trevlar.menukit.api.element.Tabs
 
Visibility: imperative or supplier-driven - Section in class com.trevlar.menukit.api.panel.Panel
 
visible(boolean) - Method in class com.trevlar.menukit.api.panel.Panel.Builder
Sets the initial visibility state.
visibleWhen - Variable in class com.trevlar.menukit.api.element.AbstractPanelElement.Builder
 
visibleWhen(BooleanSupplier) - Method in class com.trevlar.menukit.api.panel.Panel
Makes a supplier decide this panel's visibility.
visibleWhen(BooleanSupplier) - Method in class com.trevlar.menukit.api.element.AbstractPanelElement.Builder
Shown only while condition holds, read every frame.
visibleWhen(BooleanSupplier) - Method in class com.trevlar.menukit.api.element.Tabs.TabSpec
Read every frame; a change relays out the strip.
visibleWhen(BooleanSupplier) - Method in class com.trevlar.menukit.api.hud.HudPanel.Builder
The panel shows only while this is true (the panel's own Panel.visibleWhen(BooleanSupplier)).
visibleWhen(BooleanSupplier) - Method in class com.trevlar.menukit.api.panel.ContainerRegion.Builder
Shown while this holds, read every frame.
visibleWhen(BooleanSupplier) - Method in class com.trevlar.menukit.api.panel.ContainerTabs.Builder
Shown while this holds, read every frame.
visibleWhen(BooleanSupplier) - Method in class com.trevlar.menukit.api.panel.Contribution.Builder
Shows the elements only while condition holds, read every frame; hidden, they take no room.
visibleWhen(BooleanSupplier) - Method in class com.trevlar.menukit.api.panel.Panel.Builder
Shows the panel only while condition holds, read every frame: the same name every element's builder uses.

W

w() - Method in record class com.trevlar.menukit.api.element.ItemPicker.Box
Returns the value of the w record component.
what() - Method in record class com.trevlar.menukit.api.element.ItemPicker.Box
Returns the value of the what record component.
What an instance keeps - Section in class com.trevlar.menukit.api.element.AbstractPanelElement
 
What attaching does - Section in class com.trevlar.menukit.api.element.Attachment
 
What the host does every frame - Section in class com.trevlar.menukit.api.element.WidgetHost
 
What the look changes - Section in enum class com.trevlar.menukit.api.panel.ScreenKind
 
What the region does - Section in class com.trevlar.menukit.api.panel.ContainerRegion
 
wheelMoved(double, double) - Static method in class com.trevlar.menukit.api.element.MKTooltip
The wheel moved (MouseHandler.onScroll HEAD).
where(Predicate) - Static method in class com.trevlar.menukit.api.panel.ScreenMatcher
The screens test accepts, asked of each container screen as it opens (its init, when its menu already holds every slot).
Where a row stands - Section in class com.trevlar.menukit.api.panel.ContainerTabs
 
Where dialogs work - Section in class com.trevlar.menukit.api.dialog.ConfirmDialog
 
Where the look comes from (#of) - Section in enum class com.trevlar.menukit.api.panel.ScreenKind
 
Why a tooltip is capped when panels are not - Section in class com.trevlar.menukit.api.element.MKTooltip
 
Why input receives its context - Section in record class com.trevlar.menukit.api.element.InputContext
 
Why it exists - Section in class com.trevlar.menukit.api.element.MKTooltip
 
widestRow() - Method in class com.trevlar.menukit.api.element.Dropdown
The widest row label, with the row's padding and check column: what a popover sized to its rows needs.
widestRow() - Method in class com.trevlar.menukit.api.element.DropdownMulti
The widest row label, with the row's padding and check column: what a popover sized to its rows needs.
widestRow() - Method in class com.trevlar.menukit.api.element.MenuButton
The widest row label, with the row's padding and check column: what a popover sized to its rows needs.
widget() - Method in class com.trevlar.menukit.api.element.Slider
The vanilla widget this element draws and registers: for narration or focus checks.
widget() - Method in class com.trevlar.menukit.api.element.TextField
The vanilla widget this element draws and registers, or null before the field's first screen init.
widget() - Method in class com.trevlar.menukit.api.element.WidgetHost
The hosted widget, or null before it is first needed.
widget(Supplier) - Method in class com.trevlar.menukit.api.element.WidgetHost.Builder
Required: the widget, made on first need (the screen's init).
WidgetHost<W> - Class in com.trevlar.menukit.api.element
Hosts a vanilla-style widget (anything that is a GuiEventListener and a Renderable) inside a panel, at the element's own rectangle.
WidgetHost(WidgetHost.Builder) - Constructor for class com.trevlar.menukit.api.element.WidgetHost
 
WidgetHost.Builder<W> - Class in com.trevlar.menukit.api.element
Builds a WidgetHost.
WidgetHost.Placer<W> - Interface in com.trevlar.menukit.api.element
Places a widget that is not a vanilla LayoutElement, or places one in the consumer's own way: called every frame and before every input event with the element's rectangle in screen coordinates.
width - Variable in class com.trevlar.menukit.api.element.AbstractPanelElement.Builder
Authored size, or -1 when not given.
width - Variable in class com.trevlar.menukit.api.element.AbstractPanelElement
The resolved (live) width: the authored width, capped by the last layout pass.
width() - Method in record class com.trevlar.menukit.api.host.OwnHost.Placement
Returns the value of the width record component.
width() - Method in interface com.trevlar.menukit.api.layout.ElementSpec
Width of the element in pixels (panel-local).
width(int) - Method in class com.trevlar.menukit.api.layout.Row.Builder
The row's overall width in pixels, the room an Row.Builder.addSpacer() expands into.
Wrap - Section in class com.trevlar.menukit.api.element.TextLabel
 
WRAP - Enum constant in enum class com.trevlar.menukit.api.element.Tabs.Mode
Break into as many rows as the width needs.
wrapAfter(int) - Method in class com.trevlar.menukit.api.element.Flow.Builder
At most n shown children in a column (in a row, in a row Flow), whatever room is left.
wrapAfter(ModeScope, int) - Method in class com.trevlar.menukit.api.panel.Contribution.Builder
In scope, at most n shown contributions in the panel's column, with however many are installed and shown: past that the lowest orders step out into a column to the right, and the highest keep the first, in order (7.5.0).
wrapAfter(IntSupplier) - Method in class com.trevlar.menukit.api.element.Flow.Builder
At most as many shown children in a column (a row) as n gives, read every frame; 0 or less for no cap.
wrapHeight(int) - Method in class com.trevlar.menukit.api.element.Flow
The room the panel hands down from this Flow's top edge to where the frame beside it ends (-1: no frame).
wrapHeight(int) - Method in interface com.trevlar.menukit.api.element.PanelElement
The height a wrapping element wraps at: the room from this element's top edge down to where the frame beside its panel ends (a container screen's frame for a panel in a side region; see Panel.setFrameHeight), or -1 when the panel has no frame beside it.
wrapped(Font, List, int) - Static method in class com.trevlar.menukit.api.element.MKTooltip
lines with every text line wider than MKTooltip.wrapWidth(int) split by vanilla's Font.split.
wraps() - Static method in class com.trevlar.menukit.api.element.MKTooltip
True when any registered MKTooltip.wrapWhen(BooleanSupplier) predicate holds this frame.
WrapsPanelAdapter - Annotation Interface in com.trevlar.menukit.api.panel
Marks a class as a thin wrapper around ScreenPanelAdapter, VanillaScreenPanelAdapter or AnchorPanelAdapter, so PanelHost.captureCallerModId() walks past it to credit the mod that actually called the wrapper, not the library that wrote it.
wrapWhen(BooleanSupplier) - Static method in class com.trevlar.menukit.api.element.MKTooltip
Wraps every tooltip to the screen's width on every frame condition is true: a text line wider than MKTooltip.wrapWidth(int) breaks onto more lines (vanilla's splitter, breaking at spaces) and the tooltip is kept inside the screen's sides.
wrapWidth(int) - Static method in class com.trevlar.menukit.api.element.MKTooltip
The widest a tooltip's text may be on a screen screenWidth wide: the screen less MKTooltip.EDGE on each side and the background's padding around the text.
wrapWidth(int) - Method in class com.trevlar.menukit.api.element.TextLabel.Builder
A fixed wrap width in font pixels, for a label with no panel budget (a HUD label).
wrapWidth(int) - Method in class com.trevlar.menukit.api.hud.HudPanel.TextBuilder
Wraps this text at maxWidth pixels, so it runs over several lines and an auto-sized HUD panel grows to fit.
wrapWidth(Component, int) - Static method in class com.trevlar.menukit.api.element.Text
The width text should wrap to inside available pixels: 0 (don't wrap) when it fits on one line, else available, floored at 1 so the splitter never sees a non-positive width.

X

x - Variable in class com.trevlar.menukit.api.element.AbstractPanelElement.Builder
Position within the panel's content area.
x() - Method in record class com.trevlar.menukit.api.element.ItemPicker.Box
Returns the value of the x record component.
x() - Method in record class com.trevlar.menukit.api.host.OwnHost.Placement
Returns the value of the x record component.
x() - Method in record class com.trevlar.menukit.api.panel.ScreenOrigin
Returns the value of the x record component.

Y

y - Variable in class com.trevlar.menukit.api.element.AbstractPanelElement.Builder
Position within the panel's content area.
y() - Method in record class com.trevlar.menukit.api.element.ItemPicker.Box
Returns the value of the y record component.
y() - Method in record class com.trevlar.menukit.api.host.OwnHost.Placement
Returns the value of the y record component.
y() - Method in record class com.trevlar.menukit.api.panel.ScreenOrigin
Returns the value of the y record component.
yieldHeight(int) - Method in class com.trevlar.menukit.api.element.Flow
A vertical Flow is as much shorter as its children give; a row is as tall as its tallest, so it gives nothing.
yieldHeight(int) - Method in interface com.trevlar.menukit.api.element.PanelElement
Gives back up to overflow pixels of height because what holds it has run out of room (7.4.0), returning how much it gave; 0 gives it all back.
yieldHeight(int) - Method in class com.trevlar.menukit.api.element.ScrollContainer
Fitting the room: gives back overflow rounded up to whole steps, so it stays whole rows and the list fits, but never below its declared height (past that the list scrolls instead).
yieldHeight(List, int) - Static method in class com.trevlar.menukit.api.element.ChildDispatch
Hands overflow down the children in order (PanelElement.yieldHeight(int)), each shown one asked for what the ones before it left, each hidden one for nothing (so it shows again at its full height); returns how much they gave.
A B C D E F G H I J K L M N O P Q R S T U V W X Y 
All Classes and Interfaces|All Packages|Constant Field Values