Class AbstractMultiPanelWidget

java.lang.Object

net.minecraft.client.gui.components.events.AbstractContainerEventHandler

net.ixdarklord.coolcatcanvas.api.client.gui.components.widgets.AbstractDraggableWidget

net.ixdarklord.coolcatcanvas.api.client.gui.components.widgets.AbstractMultiPanelWidget

All Implemented Interfaces:

MovableElement, net.minecraft.client.gui.components.events.ContainerEventHandler, net.minecraft.client.gui.components.events.GuiEventListener, net.minecraft.client.gui.components.Renderable, net.minecraft.client.gui.components.TabOrderedElement, net.minecraft.client.gui.narration.NarratableEntry, net.minecraft.client.gui.narration.NarrationSupplier

@Experimental
public abstract class AbstractMultiPanelWidget
extends AbstractDraggableWidget

A (optionally draggable) window whose content area shows a stack of Panels.

• Panels are drawn bottom to top in the order they were added; hidden panels are skipped.
• Input goes to the window's own widgets (title bar buttons...) first, then to the panels from the top down. A visible modal panel stops input from reaching the panels below it, and those panels are dimmed with the overlay color.
• The panel that accepted a mouse press receives the following drag and release events.
• Only the topmost visible panel receives keyboard input.

Panels are laid out in getPanelRectangle(Panel) (the layout rectangle by default) whenever the window moves or is resized with setBounds(int, int, int, int).

Nested Class Summary

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

net.minecraft.client.gui.narration.NarratableEntry.NarrationPriority

Field Summary

Fields inherited from class AbstractDraggableWidget

blitOffset, font, height, layout, minecraft, movable, tickCount, title, visible, width, x, y

Constructor Summary

Constructors

Constructor	Description
AbstractMultiPanelWidget(net.minecraft.network.chat.Component title, int x, int y, int width, int height, boolean isMovable)

Method Summary

Modifier and Type	Method	Description
protected <P extends Panel> P	addPanel(P panel)
boolean	charTyped(net.minecraft.client.input.CharacterEvent event)
protected List<net.minecraft.network.chat.Component>	getDebugInfo()
protected net.minecraft.client.gui.navigation.ScreenRectangle	getPanelRectangle(Panel panel)	Where a panel is placed; the layout rectangle unless overridden.
List<Panel>	getPanels()
@Nullable Panel	getTopPanel()	The topmost visible panel, if any.
protected boolean	isCaptured(Panel panel)	Whether the given panel is currently receiving a mouse drag.
protected boolean	isMouseOverOwnWidget(double mouseX, double mouseY)	Whether the cursor is over one of the window's own widgets, which sit on top of the panels.
boolean	keyPressed(net.minecraft.client.input.KeyEvent event)
boolean	keyReleased(net.minecraft.client.input.KeyEvent event)
boolean	mouseClicked(net.minecraft.client.input.MouseButtonEvent event, boolean doubleClick)
boolean	mouseDragged(net.minecraft.client.input.MouseButtonEvent event, double dragX, double dragY)
void	mouseMoved(double mouseX, double mouseY)
boolean	mouseReleased(net.minecraft.client.input.MouseButtonEvent event)
boolean	mouseScrolled(double mouseX, double mouseY, double scrollX, double scrollY)
protected void	removePanel(Panel panel)
protected void	renderContents(net.minecraft.client.gui.GuiGraphicsExtractor graphics, float partialTick, int mouseX, int mouseY)
void	setBounds(int x, int y, int width, int height)	Moves and resizes the window.
void	setOverlayColor(int argb)	Color drawn over the panels below a visible modal panel.
protected void	updateChildren()

Methods inherited from class AbstractDraggableWidget

addRenderableOnly, addRenderableWidget, addWidget, applyIfVisible, changeFocus, children, clearFocus, clearWidgets, extractRenderState, getButtons, getDraggingAreaColor, getDraggingRectangle, getElements, getHeight, getRectangle, getTitle, getWidth, getX, getY, init, isDebug, isInitialized, isMouseOver, isMouseOverDraggingRectangle, isMouseOverLayoutRectangle, isVisible, layoutRectangle, moveTo, narrationPriority, playDownSound, postInit, rebuildWidgets, removeWidget, renderBackground, renderDebugInfo, renderDraggingBoxHighlight, renderLabels, setInitialFocus, setInitialFocus, setVisible, setX, setY, toggleVisibility, toggleVisibility, updateNarration

Methods inherited from class net.minecraft.client.gui.components.events.AbstractContainerEventHandler

getFocused, isDragging, setDragging, setFocused

Methods inherited from class Object

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

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

getBorderForArrowNavigation, getChildAt, getCurrentFocusPath, isFocused, nextFocusPath, preeditUpdated, setFocused

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

capturesInput, shouldTakeFocusAfterInteraction

Methods inherited from interface MovableElement

moveTo, step

Methods inherited from interface net.minecraft.client.gui.narration.NarratableEntry

getNarratables, isActive

Methods inherited from interface net.minecraft.client.gui.components.TabOrderedElement

getTabOrderGroup

Constructor Details

AbstractMultiPanelWidget

public AbstractMultiPanelWidget(net.minecraft.network.chat.Component title,
 int x,
 int y,
 int width,
 int height,
 boolean isMovable)

Method Details

addPanel

protected <P extends Panel> P addPanel(P panel)

removePanel

protected void removePanel(Panel panel)

getPanels

public List<Panel> getPanels()

getTopPanel

@Nullable
public @Nullable Panel getTopPanel()

The topmost visible panel, if any.

getPanelRectangle

protected net.minecraft.client.gui.navigation.ScreenRectangle getPanelRectangle(Panel panel)

Where a panel is placed; the layout rectangle unless overridden.

setOverlayColor

public void setOverlayColor(int argb)

Color drawn over the panels below a visible modal panel.

setBounds

public void setBounds(int x,
 int y,
 int width,
 int height)

Moves and resizes the window.

updateChildren

protected void updateChildren()

Overrides:

updateChildren in class AbstractDraggableWidget

isMouseOverOwnWidget

protected boolean isMouseOverOwnWidget(double mouseX,
 double mouseY)

Whether the cursor is over one of the window's own widgets, which sit on top of the panels.

renderContents

protected void renderContents(net.minecraft.client.gui.GuiGraphicsExtractor graphics,
 float partialTick,
 int mouseX,
 int mouseY)

Overrides:

renderContents in class AbstractDraggableWidget

mouseClicked

public boolean mouseClicked(net.minecraft.client.input.MouseButtonEvent event,
 boolean doubleClick)

Specified by:

mouseClicked in interface net.minecraft.client.gui.components.events.ContainerEventHandler

Specified by:

mouseClicked in interface net.minecraft.client.gui.components.events.GuiEventListener

Overrides:

mouseClicked in class AbstractDraggableWidget

mouseReleased

public boolean mouseReleased(net.minecraft.client.input.MouseButtonEvent event)

Specified by:

mouseReleased in interface net.minecraft.client.gui.components.events.ContainerEventHandler

Specified by:

mouseReleased in interface net.minecraft.client.gui.components.events.GuiEventListener

Overrides:

mouseReleased in class AbstractDraggableWidget

mouseDragged

public boolean mouseDragged(net.minecraft.client.input.MouseButtonEvent event,
 double dragX,
 double dragY)

Specified by:

mouseDragged in interface net.minecraft.client.gui.components.events.ContainerEventHandler

Specified by:

mouseDragged in interface net.minecraft.client.gui.components.events.GuiEventListener

Overrides:

mouseDragged in class AbstractDraggableWidget

mouseScrolled

public boolean mouseScrolled(double mouseX,
 double mouseY,
 double scrollX,
 double scrollY)

Specified by:

mouseScrolled in interface net.minecraft.client.gui.components.events.ContainerEventHandler

Specified by:

mouseScrolled in interface net.minecraft.client.gui.components.events.GuiEventListener

Overrides:

mouseScrolled in class AbstractDraggableWidget

mouseMoved

public void mouseMoved(double mouseX,
 double mouseY)

keyPressed

public boolean keyPressed(net.minecraft.client.input.KeyEvent event)

Specified by:

keyPressed in interface net.minecraft.client.gui.components.events.ContainerEventHandler

Specified by:

keyPressed in interface net.minecraft.client.gui.components.events.GuiEventListener

Overrides:

keyPressed in class AbstractDraggableWidget

keyReleased

public boolean keyReleased(net.minecraft.client.input.KeyEvent event)

charTyped

public boolean charTyped(net.minecraft.client.input.CharacterEvent event)

Specified by:

charTyped in interface net.minecraft.client.gui.components.events.ContainerEventHandler

Specified by:

charTyped in interface net.minecraft.client.gui.components.events.GuiEventListener

Overrides:

charTyped in class AbstractDraggableWidget

isCaptured

protected boolean isCaptured(Panel panel)

Whether the given panel is currently receiving a mouse drag.

getDebugInfo

protected List<net.minecraft.network.chat.Component> getDebugInfo()

Overrides:

getDebugInfo in class AbstractDraggableWidget