Package io.github.thecsdev.tcdcommons.api.client.gui.panel.explorer.impl

Interface TFileExplorerPanel.FileExplorerPanelProxy

All Superinterfaces:

TitleBar.TitleBarProxy

Enclosing class:

TFileExplorerPanel

public static interface TFileExplorerPanel.FileExplorerPanelProxy
extends TitleBar.TitleBarProxy

This interface defines the "current state" a TFileExplorerPanel is in at a given moment. Because changes to the game's window and GUI components triggers a GUI "reset" for technical reasons, this interface is responsible for properly preserving and communicating the state of the TFileExplorerPanel to the said panel.

Method Summary

Modifier and Type	Method	Description
default boolean	canClose()
default boolean	canDrag()	Returns true if the TFileExplorerPanel may be dragged by the user's mouse by clicking and dragging the TitleBar.
default boolean	canMinimize()
default boolean	canRestore()
Path	getCurrentDirectory()	Returns the Path of a directory that should currently be displayed by the TFileExplorerPanel.
FileChooserDialogType	getDialogType()	Returns the FileChooserDialogType associated with the corresponding TFileExplorerPanel.
Iterable<TFileFilter>	getFileFilters()
default UITexture	getIcon()	Returns the TitleBar icon for this TFileExplorerPanel.
TFileFilter	getSelectedFileFilter()
@Nullable String	getTargetFileExtension()	Returns the File extension that should be used when "saving" files.
default net.minecraft.text.Text	getTitle()	Returns the title Text that should be used for this TFileExplorerPanel dialog.
void	onComplete(TFileChooserResult result)	A method that is called once the user makes a choice in the TFileExplorerPanel.
void	setCurrentDirectory(Path directory)	Called by TFileExplorerPanel to indicate user directory navigation.
void	setSelectedFileFilter(TFileFilter fileFilter)

Methods inherited from interface io.github.thecsdev.tcdcommons.api.client.gui.panel.explorer.TitleBar.TitleBarProxy

onClose, onMinimize, onRestore

Method Details

getDialogType

FileChooserDialogType getDialogType()

Returns the FileChooserDialogType associated with the corresponding TFileExplorerPanel.

onComplete

void onComplete(TFileChooserResult result)

A method that is called once the user makes a choice in the TFileExplorerPanel.

getFileFilters

Iterable<TFileFilter> getFileFilters()

getSelectedFileFilter

TFileFilter getSelectedFileFilter()

setSelectedFileFilter

void setSelectedFileFilter(TFileFilter fileFilter)

getCurrentDirectory

Path getCurrentDirectory()

Returns the Path of a directory that should currently be displayed by the TFileExplorerPanel.

setCurrentDirectory

void setCurrentDirectory(Path directory)

Called by TFileExplorerPanel to indicate user directory navigation.

getTargetFileExtension

@Nullable
@Nullable String getTargetFileExtension()

Returns the File extension that should be used when "saving" files. Primarily used for FileChooserDialogType.SAVE_FILE, as the dialog has to somehow know what extension you wish to "save as".

canDrag

default boolean canDrag()

Returns true if the TFileExplorerPanel may be dragged by the user's mouse by clicking and dragging the TitleBar.

See Also:

• MouseDragHelper.snapToParentBounds(TElement)

getTitle

default net.minecraft.text.Text getTitle()

Returns the title Text that should be used for this TFileExplorerPanel dialog.

Specified by:

getTitle in interface TitleBar.TitleBarProxy

See Also:

• FileChooserDialogType.getDialogTitle()

getIcon

default UITexture getIcon()

Returns the TitleBar icon for this TFileExplorerPanel.

Specified by:

getIcon in interface TitleBar.TitleBarProxy

canClose

default boolean canClose()

Specified by:

canClose in interface TitleBar.TitleBarProxy

canRestore

default boolean canRestore()

Specified by:

canRestore in interface TitleBar.TitleBarProxy

canMinimize

default boolean canMinimize()

Specified by:

canMinimize in interface TitleBar.TitleBarProxy