Class TFileChooserScreen

java.lang.Object

com.thecsdev.common.scene.Node<TElement>

com.thecsdev.commonmc.api.client.gui.TElement

com.thecsdev.commonmc.api.client.gui.screen.TScreen

com.thecsdev.commonmc.api.client.gui.screen.promise.TCompletableScreen<List<Path>>

com.thecsdev.commonmc.api.client.gui.screen.promise.TFileChooserScreen

All Implemented Interfaces:

INode<TElement>, INodeBounded<TElement,Bounds2i>, INodeRenderable<TElement, TGuiGraphics>, ILastScreenProvider, Iterable<TElement>, Collection<TElement>

@Environment(CLIENT)
public final class TFileChooserScreen
extends TCompletableScreen<List<Path>>

TScreen implementation that provides a user-friendly interface for selecting files from the device's file-system. This screen is particularly useful for cases that require file opening and saving functionalities, allowing users to easily navigate through their directories and choose the desired files.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final class	TFileChooserScreen.Builder	A builder class for creating TFileChooserScreen instances.
static enum	TFileChooserScreen.Mode	Defines the operational modes of the TFileChooserScreen, determining its behavior and user interactions.
static interface	TFileChooserScreen.PathFilter	A filter interface for filtering Paths displayed on the TFileChooserScreen interface.

Field Summary

Fields inherited from class TElement

eInitialized

Method Summary

Modifier and Type	Method	Description
final @NotNull TFileChooserScreen.Mode	getMode()	Returns the operating TFileChooserScreen.Mode of this TFileChooserScreen.
protected final void	initCallback()	Callback method that is invoked when this TElement is initializing.
final boolean	inputCallback(TInputContext.InputDiscoveryPhase phase, @NotNull TInputContext context)	A callback method that is invoked when the user makes an input.
final void	refresh()	Refreshes the window element, re-initializing its contents to reflect any changes in the file-system or current directory.
protected final void	tickCallback()	Callback method that is invoked automatically every GUI tick, if and after Node.getParent() ticks.

Methods inherited from class TCompletableScreen

canCompleteAsync, closeCallback, getLastScreen, getResult, renderCallback

Methods inherited from class TScreen

close, createWrapperScreen, focusedElementProperty, getAsScreen, getClient, hoveredElementProperty, isAllowingInGameHud, isOpen, isPauseScreen, openCallback, sendInput, titleProperty

Methods inherited from class TElement

addRel, boundsProperty, clearAndInit, clipsDescendantsProperty, contextMenuProperty, dragEndCallback, dragStartCallback, findElementAt, focusableProperty, focusGainedCallback, focusLostCallback, forEachVisible, getBaseType, getBounds, getContentBounds, getCursor, getSelf, getTooltip, hoverableProperty, hoverGainedCallback, hoverLostCallback, invalidateTooltipCache, isFocusable, isFocused, isHoverable, isHovered, isHoveredOrFocused, isVisible, move, moveChildren, moveTo, postRenderCallback, removeRel, screenProperty, setBounds, setBounds, setBounds, showContextMenu, tooltipProperty, toString, visibleProperty

Methods inherited from class Node

add, addAll, childAddedCallback, childRemovedCallback, clear, contains, containsAll, equals, findChild, findParent, findSibling, forEach, get, getFirst, getLast, getParent, hashCode, indexOf, isEmpty, iterator, parentProperty, remove, remove, remove, removeAll, retainAll, rootProperty, size, toArray, toArray

Methods inherited from class Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface Collection

add, addAll, clear, contains, containsAll, equals, hashCode, isEmpty, iterator, parallelStream, remove, removeAll, removeIf, retainAll, size, spliterator, stream, toArray, toArray, toArray

Methods inherited from interface Iterable

forEach

Method Details

getMode

@NotNull
public final @NotNull TFileChooserScreen.Mode getMode()

Returns the operating TFileChooserScreen.Mode of this TFileChooserScreen.

tickCallback

protected final void tickCallback()

Description copied from class: TElement

Callback method that is invoked automatically every GUI tick, if and after Node.getParent() ticks.

For performance optimization reasons, this is invoked if this element is contained within its parent's TElement.getBounds().

Note that this is regardless of what TElement.isVisible() returns. The only requirements are the element being "within parent bounds" and the parent having ticked.

Overrides:

tickCallback in class TElement

refresh

public final void refresh()

Refreshes the window element, re-initializing its contents to reflect any changes in the file-system or current directory.

initCallback

protected final void initCallback()

Description copied from class: TElement

Callback method that is invoked when this TElement is initializing. You may override this method to create and add child TElements.

Specified by:

initCallback in class TScreen

See Also:

• TElement.clearAndInit()

inputCallback

public final boolean inputCallback(@NotNull
 TInputContext.InputDiscoveryPhase phase,
 @NotNull
 @NotNull TInputContext context)
                            throws NullPointerException

Description copied from class: TElement

A callback method that is invoked when the user makes an input.

Overrides:

inputCallback in class TElement

Parameters:

phase - The input discovery phase.

context - Information about the user's input.

Returns:

true if this TElement handled the input.

Throws:

NullPointerException - If an argument is null.