Package org.polyfrost.oneconfig.api.ui.v1.api

Interface TinyFdApi

public interface TinyFdApi

API for native file dialogs and message boxes

Backed by TinyFD before Minecraft 26.3 and by SDL from then on

Every method blocks the calling thread until the dialog is closed so call them from a background thread
File dialogs leave the render thread free meanwhile whereas message boxes on Minecraft 26.3 and above block it until they are closed

Field Summary

Fields

Modifier and Type	Field	Description
static final String	ERROR_ICON
static final String	INFO_ICON
static final String	OK_CANCEL_DIALOG
static final String	OK_DIALOG
static final String	QUESTION_ICON
static final String	WARNING_ICON
static final String	YES_NO_CANCEL_DIALOG
static final String	YES_NO_DIALOG

Method Summary

Modifier and Type	Method	Description
static TinyFdApi	getInstance()
@Nullable Path	openFileSelector(@Nullable String title, @Nullable String defaultFilePath, String[] filterPatterns, @Nullable String filterDescription)	Open a file selection prompt
Path	openFolderSelector(@Nullable String title, @Nullable String defaultFolderPath)	Open a folder selection prompt
Path[]	openMultiFileSelector(@Nullable String title, @Nullable String defaultFilePath, String[] filterPatterns, @Nullable String filterDescription)	Open a multi file selection prompt
Path	openSaveSelector(@Nullable String title, @Nullable String defaultFilePath, String[] filterPatterns, @Nullable String filterDescription)	Open a save file selection prompt
boolean	showMessageBox(String title, String message, @NotNull String dialog, String icon, boolean defaultValue)	Shows a message box
int	showNotification(String title, String message, String icon)	Shows a notification

Field Details

QUESTION_ICON

static final String QUESTION_ICON

See Also:

• Constant Field Values

ERROR_ICON

static final String ERROR_ICON

See Also:

• Constant Field Values

WARNING_ICON

static final String WARNING_ICON

See Also:

• Constant Field Values

INFO_ICON

static final String INFO_ICON

See Also:

• Constant Field Values

OK_DIALOG

static final String OK_DIALOG

See Also:

• Constant Field Values

OK_CANCEL_DIALOG

static final String OK_CANCEL_DIALOG

See Also:

• Constant Field Values

YES_NO_DIALOG

static final String YES_NO_DIALOG

See Also:

• Constant Field Values

YES_NO_CANCEL_DIALOG

static final String YES_NO_CANCEL_DIALOG

See Also:

• Constant Field Values

Method Details

getInstance

static TinyFdApi getInstance()

openSaveSelector

Path openSaveSelector(@Nullable
 @Nullable String title,
 @Nullable
 @Nullable String defaultFilePath,
 String[] filterPatterns,
 @Nullable
 @Nullable String filterDescription)

Open a save file selection prompt

Same as openFileSelector(String, String, String[], String) but says save instead of open

openFileSelector

@Nullable
@Nullable Path openFileSelector(@Nullable
 @Nullable String title,
 @Nullable
 @Nullable String defaultFilePath,
 String[] filterPatterns,
 @Nullable
 @Nullable String filterDescription)

Open a file selection prompt

Parameters:

title - the title of the prompt

defaultFilePath - the path to the default file to select

filterPatterns - the file extensions to filter by such as new String[]{"*.png", "*.jpg"}

filterDescription - the description for said filter such as "Images"

Returns:

the selected file or null if the user cancelled

openMultiFileSelector

Path[] openMultiFileSelector(@Nullable
 @Nullable String title,
 @Nullable
 @Nullable String defaultFilePath,
 String[] filterPatterns,
 @Nullable
 @Nullable String filterDescription)

Open a multi file selection prompt

Same as openFileSelector(String, String, String[], String) but allows the user to select multiple files

openFolderSelector

Path openFolderSelector(@Nullable
 @Nullable String title,
 @Nullable
 @Nullable String defaultFolderPath)

Open a folder selection prompt

Same as openFileSelector(String, String, String[], String) but allows the user to select a folder

showMessageBox

boolean showMessageBox(String title,
 String message,
 @NotNull
 @NotNull String dialog,
 String icon,
 boolean defaultValue)

Shows a message box

Parameters:

message - the message which may contain \n and \t

dialog - the type of message box to show

• OK_DIALOG
• OK_CANCEL_DIALOG
• YES_NO_DIALOG
• YES_NO_CANCEL_DIALOG

icon - the icon to use

• QUESTION_ICON
• ERROR_ICON
• WARNING_ICON
• INFO_ICON

defaultValue - the default value to return if the user closes the dialog without clicking a button

Returns:

true if the user clicked the "ok" or "yes" button
false for "cancel" or "no"

showNotification

int showNotification(String title,
 String message,
 String icon)

Shows a notification

Parameters:

icon - the icon to use

• QUESTION_ICON
• ERROR_ICON
• WARNING_ICON
• INFO_ICON

Returns:

0 if the user clicked the "ok" button
1 for "cancel"