Package io.github.thecsdev.tcdcommons.api.client.gui.screen.explorer

Class TFileChooserScreen

java.lang.Object

io.github.thecsdev.tcdcommons.api.client.gui.screen.TScreen

io.github.thecsdev.tcdcommons.api.client.gui.screen.TScreenPlus

io.github.thecsdev.tcdcommons.api.client.gui.screen.explorer.TFileChooserScreen

All Implemented Interfaces:

TParentElement, IParentScreenProvider, IEnableStateProvider

public final class TFileChooserScreen
extends TScreenPlus
implements IParentScreenProvider

A file chooser screen that allows the user to choose a File for opening and saving.

See Also:

• TFileChooserBuilder
• builder()

Field Summary

Fields

Modifier and Type	Field	Description
protected final TElement	contentPane
protected @Nullable TFileFilter	currentFileFilter
protected Path	currentPath
protected final TFileExplorerPanel	explorerPanel
protected boolean	explorerPanelDraggable
protected final ArrayList<TFileFilter>	filters
protected boolean	fullScreen
protected final Consumer<TFileChooserResult>	onComplete
protected @Nullable net.minecraft.client.gui.screen.Screen	parent
protected @Nullable File	selectedFile
protected final @Nullable String	targetExtension
protected final FileChooserDialogType	type

Fields inherited from class io.github.thecsdev.tcdcommons.api.client.gui.screen.TScreen

children, client, title

Fields inherited from interface io.github.thecsdev.tcdcommons.api.client.gui.TParentElement

MAX_CHILD_NESTING_DEPTH

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	TFileChooserScreen(FileChooserDialogType type, Path startingPath, @Nullable String targetExtension, Consumer<TFileChooserResult> onComplete)

Method Summary

Modifier and Type	Method	Description
protected final void	addFileFilter(TFileFilter fileFilter)	Adds a TFileFilter to the list of TFileFilters associated with this TFileChooserScreen.
static TFileChooserBuilder	builder()
final void	close()
final @Nullable net.minecraft.client.gui.screen.Screen	getParentScreen()	Returns the "parent" Screen that should be opened when the current one closes.
protected final @Nullable File	getSelectedFile()	Returns the File that was eventually selected by the user, if any.
protected final void	init()	Initializes this TScreen. Add TElements to this TScreen here.
protected final void	onClosed()
final void	refresh()
final void	renderBackground(TDrawContext pencil)	Renders this TScreen's background.
protected final void	setFileFilter(TFileFilter fileFilter)	Clears all TFileFilters associated with this TFileChooserScreen, and adds the given TFileFilter.
final void	setParentScreen(@Nullable net.minecraft.client.gui.screen.Screen parent)
final boolean	shouldCloseOnEsc()
final boolean	shouldPause()
final boolean	shouldRenderInGameHud()
protected static void	showDialog(FileChooserDialogType type, @Nullable String targetExtension, Consumer<TFileChooserResult> onComplete)
static void	showOpenFileDialog(@Nullable String targetExtension, Consumer<TFileChooserResult> onComplete)
static void	showOpenFileDialog(Consumer<TFileChooserResult> onComplete)
static void	showSaveFileDialog(@Nullable String targetExtension, Consumer<TFileChooserResult> onComplete)
static void	showSaveFileDialog(Consumer<TFileChooserResult> onComplete)
static void	showSelectDirectoryDialog(Consumer<TFileChooserResult> onComplete)

Methods inherited from class io.github.thecsdev.tcdcommons.api.client.gui.screen.TScreenPlus

findClosestSideElement, findClosestSideElement, input

Methods inherited from class io.github.thecsdev.tcdcommons.api.client.gui.screen.TScreen

__postTabNavigation, createScreenWrapper, filesDragged, getAsScreen, getChildren, getClient, getDraggingElement, getEnabled, getFocusedElement, getHeight, getHoveredElement, getItemRenderer, getMousePosition, getParent, getTextRenderer, getTitle, getWidth, getX, getY, getZIndex, hasKeyDown, hasWndDown, inputTabNavigation, isEnabled, isOpen, onOpened, render, renderChildren, renderTooltip, setFocusedElement, setFocusedElement, tick

Methods inherited from class java.lang.Object

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

Methods inherited from interface io.github.thecsdev.tcdcommons.api.client.gui.TParentElement

addChild, addChild, clearChildren, findChild, findLastChild, findParent, findParentTElement, forEachChild, getEndX, getEndY, input, removeChild, removeChild

Field Details

type

protected final FileChooserDialogType type

filters

protected final ArrayList<TFileFilter> filters

targetExtension

@Nullable
protected final @Nullable String targetExtension

onComplete

protected final Consumer<TFileChooserResult> onComplete

currentPath

protected Path currentPath

currentFileFilter

@Nullable
protected @Nullable TFileFilter currentFileFilter

selectedFile

@Nullable
protected @Nullable File selectedFile

fullScreen

protected boolean fullScreen

explorerPanelDraggable

protected boolean explorerPanelDraggable

parent

@Nullable
protected @Nullable net.minecraft.client.gui.screen.Screen parent

contentPane

protected final TElement contentPane

explorerPanel

protected final TFileExplorerPanel explorerPanel

Constructor Details

TFileChooserScreen

protected TFileChooserScreen(FileChooserDialogType type,
 Path startingPath,
 @Nullable
 @Nullable String targetExtension,
 Consumer<TFileChooserResult> onComplete)
                      throws NullPointerException

Throws:

NullPointerException

Method Details

builder

public static TFileChooserBuilder builder()

showOpenFileDialog

public static void showOpenFileDialog(Consumer<TFileChooserResult> onComplete)

showOpenFileDialog

public static void showOpenFileDialog(@Nullable
 @Nullable String targetExtension,
 Consumer<TFileChooserResult> onComplete)

showSaveFileDialog

public static void showSaveFileDialog(Consumer<TFileChooserResult> onComplete)

showSaveFileDialog

public static void showSaveFileDialog(@Nullable
 @Nullable String targetExtension,
 Consumer<TFileChooserResult> onComplete)

showSelectDirectoryDialog

public static void showSelectDirectoryDialog(Consumer<TFileChooserResult> onComplete)

showDialog

protected static void showDialog(FileChooserDialogType type,
 @Nullable
 @Nullable String targetExtension,
 Consumer<TFileChooserResult> onComplete)

close

public final void close()

Overrides:

close in class TScreen

shouldPause

public final boolean shouldPause()

Overrides:

shouldPause in class TScreen

shouldCloseOnEsc

public final boolean shouldCloseOnEsc()

Overrides:

shouldCloseOnEsc in class TScreen

shouldRenderInGameHud

public final boolean shouldRenderInGameHud()

Overrides:

shouldRenderInGameHud in class TScreen

renderBackground

public final void renderBackground(TDrawContext pencil)

Description copied from class: TScreen

Renders this TScreen's background.

Should be called before rendering children in TScreen.render(TDrawContext).

Overrides:

renderBackground in class TScreen

Parameters:

pencil - The TDrawContext.

See Also:

• TScreen.render(TDrawContext)
• TScreen.renderChildren(TDrawContext)

onClosed

protected final void onClosed()

Overrides:

onClosed in class TScreen

getParentScreen

@Nullable
public final @Nullable net.minecraft.client.gui.screen.Screen getParentScreen()

Description copied from interface: IParentScreenProvider

Returns the "parent" Screen that should be opened when the current one closes.

Specified by:

getParentScreen in interface IParentScreenProvider

setParentScreen

public final void setParentScreen(@Nullable
 @Nullable net.minecraft.client.gui.screen.Screen parent)

setFileFilter

@Experimental
protected final void setFileFilter(TFileFilter fileFilter)
                            throws NullPointerException

Clears all TFileFilters associated with this TFileChooserScreen, and adds the given TFileFilter.

Parameters:

fileFilter - The TFileFilter to set as the sole filter for this TFileChooserScreen.

Throws:

NullPointerException

See Also:

• addFileFilter(TFileFilter)

addFileFilter

@Experimental
protected final void addFileFilter(TFileFilter fileFilter)
                            throws NullPointerException

Adds a TFileFilter to the list of TFileFilters associated with this TFileChooserScreen.

Parameters:

fileFilter - The TFileFilter to add.

Throws:

NullPointerException

See Also:

• setFileFilter(TFileFilter)

getSelectedFile

@Experimental
@Nullable
protected final @Nullable File getSelectedFile()

Returns the File that was eventually selected by the user, if any.

refresh

public final void refresh()

init

protected final void init()

Description copied from class: TScreen

Initializes this TScreen.
Add TElements to this TScreen here.

Specified by:

init in class TScreen