Package com.shaiksphere.mindsmine.jems

Class SwingHelper

java.lang.Object

com.shaiksphere.mindsmine.jems.SwingHelper

public final class SwingHelper
extends Object

A collection of useful static methods to deal with Java Swing Framework.

Since:

4.0.0

Author:

Mohammed Shaik Hussain Ali

See Also:

javax.swing

Field Summary

Fields

Modifier and Type	Field	Description
static FileNameExtensionFilter	BIN_EXTENSION_FILTER	Convenient file extension filter for binary files.
static FileNameExtensionFilter	TXT_EXTENSION_FILTER	Convenient file extension filter for text files.

Method Summary

Modifier and Type	Method	Description
static Optional<File>	pickFile()	Displays a File Chooser to pick a single file using JFileChooser.showOpenDialog(java.awt.Component) window.
static Optional<File>	pickFile(Component component, String dialogTitle, FileNameExtensionFilter... fileNameExtensionFilter)	Displays a File Chooser to pick a single file using JFileChooser.showOpenDialog(java.awt.Component) window.
static Optional<File>	pickFile(String dialogTitle)	Displays a File Chooser to pick a single file using JFileChooser.showOpenDialog(java.awt.Component) window.
static Optional<File>	pickFile(String dialogTitle, FileNameExtensionFilter... fileNameExtensionFilter)	Displays a File Chooser to pick a single file using JFileChooser.showOpenDialog(java.awt.Component) window.
static Optional<File>	pickFolder()	Displays a File Chooser to pick a single folder using JFileChooser.showOpenDialog(java.awt.Component) window.
static Optional<File>	pickFolder(Component component, String dialogTitle)	Displays a File Chooser to pick a single folder using JFileChooser.showOpenDialog(java.awt.Component) window.
static Optional<File>	pickFolder(String dialogTitle)	Displays a File Chooser to pick a single folder using JFileChooser.showOpenDialog(java.awt.Component) window.
static void	showErrorDialog(Component component, String title, String message)	Displays a error message using the JOptionPane.showMessageDialog(java.awt.Component, java.lang.Object) window.
static void	showErrorDialog(String title, String message)	Displays a error message using the JOptionPane.showMessageDialog(java.awt.Component, java.lang.Object) window.
static void	showInformationDialog(Component component, String title, String message)	Displays a information message using the JOptionPane.showMessageDialog(java.awt.Component, java.lang.Object) window.
static void	showInformationDialog(String title, String message)	Displays a information message using the JOptionPane.showMessageDialog(java.awt.Component, java.lang.Object) window.
static void	showPlainDialog(Component component, String title, String message)	Displays a plain message without an icon using the JOptionPane.showMessageDialog(java.awt.Component, java.lang.Object) window.
static void	showPlainDialog(String title, String message)	Displays a plain message without an icon using the JOptionPane.showMessageDialog(java.awt.Component, java.lang.Object) window.
static void	showQuestionDialog(Component component, String title, String message)	Displays a question using the JOptionPane.showMessageDialog(java.awt.Component, java.lang.Object) window.
static void	showQuestionDialog(String title, String message)	Displays a question using the JOptionPane.showMessageDialog(java.awt.Component, java.lang.Object) window.
static void	showWarningDialog(Component component, String title, String message)	Displays a warning message using the JOptionPane.showMessageDialog(java.awt.Component, java.lang.Object) window.
static void	showWarningDialog(String title, String message)	Displays a warning message using the JOptionPane.showMessageDialog(java.awt.Component, java.lang.Object) window.

Methods inherited from class java.lang.Object

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

Field Details

BIN_EXTENSION_FILTER

public static final FileNameExtensionFilter BIN_EXTENSION_FILTER

Convenient file extension filter for binary files.

Since:

4.0.0

TXT_EXTENSION_FILTER

public static final FileNameExtensionFilter TXT_EXTENSION_FILTER

Convenient file extension filter for text files.

Method Details

pickFile

public static Optional<File> pickFile()

Displays a File Chooser to pick a single file using JFileChooser.showOpenDialog(java.awt.Component) window. Convenient method equivalent to SwingHelper.pickFile(null, null, null)

Returns:

the Optional object containing the selected file

Since:

4.0.0

See Also:

JFileChooser.showOpenDialog(java.awt.Component)

pickFile

public static Optional<File> pickFile(String dialogTitle)

Displays a File Chooser to pick a single file using JFileChooser.showOpenDialog(java.awt.Component) window. Convenient method equivalent to SwingHelper.pickFile(null, title, null)

Parameters:

dialogTitle - for the file picker window

Returns:

the Optional object containing the selected file

Since:

4.0.0

See Also:

JFileChooser.showOpenDialog(java.awt.Component)

pickFile

public static Optional<File> pickFile(String dialogTitle, FileNameExtensionFilter... fileNameExtensionFilter)

Displays a File Chooser to pick a single file using JFileChooser.showOpenDialog(java.awt.Component) window. Convenient method equivalent to SwingHelper.pickFile(null, title, filter)

Parameters:

dialogTitle - for the file picker window

fileNameExtensionFilter - to limit the types of acceptable files

Returns:

the Optional object containing the selected file

Since:

4.0.0

See Also:

JFileChooser.showOpenDialog(java.awt.Component)

pickFile

public static Optional<File> pickFile(Component component, String dialogTitle, FileNameExtensionFilter... fileNameExtensionFilter)

Displays a File Chooser to pick a single file using JFileChooser.showOpenDialog(java.awt.Component) window.

Parameters:

component - the parent component of the dialog, can be null

dialogTitle - for the file picker window

fileNameExtensionFilter - to limit the types of acceptable files

Returns:

the Optional object containing the selected file

Since:

4.0.0

pickFolder

public static Optional<File> pickFolder()

Displays a File Chooser to pick a single folder using JFileChooser.showOpenDialog(java.awt.Component) window. Convenient method equivalent to SwingHelper.pickFolder(null, null)

Returns:

the Optional object containing the selected file

Since:

4.0.0

See Also:

JFileChooser.showOpenDialog(java.awt.Component)

pickFolder

public static Optional<File> pickFolder(String dialogTitle)

Displays a File Chooser to pick a single folder using JFileChooser.showOpenDialog(java.awt.Component) window. Convenient method equivalent to SwingHelper.pickFolder(null, title)

Parameters:

dialogTitle - for the folder picker window

Returns:

the Optional object containing the selected file

Since:

4.0.0

See Also:

JFileChooser.showOpenDialog(java.awt.Component)

pickFolder

public static Optional<File> pickFolder(Component component, String dialogTitle)

Displays a File Chooser to pick a single folder using JFileChooser.showOpenDialog(java.awt.Component) window.

Parameters:

component - the parent component of the dialog, can be null

dialogTitle - for the folder picker window

Returns:

the Optional object containing the selected file

Since:

4.0.0

See Also:

JFileChooser.showOpenDialog(java.awt.Component)

showErrorDialog

public static void showErrorDialog(String title, String message)

Displays a error message using the JOptionPane.showMessageDialog(java.awt.Component, java.lang.Object) window. Convenient method equivalent to SwingHelper.showErrorDialog(null, title, message)

Parameters:

title - the title string for the dialog

message - the message to display in the dialog

Since:

4.0.0

showErrorDialog

public static void showErrorDialog(Component component, String title, String message)

Displays a error message using the JOptionPane.showMessageDialog(java.awt.Component, java.lang.Object) window.

Parameters:

component - the parent component of the dialog, can be null

title - the title string for the dialog

message - the message to display in the dialog

Since:

4.0.0

showInformationDialog

public static void showInformationDialog(String title, String message)

Displays a information message using the JOptionPane.showMessageDialog(java.awt.Component, java.lang.Object) window. Convenient method equivalent to SwingHelper.showInformationDialog(null, title, message)

Parameters:

title - the title string for the dialog

message - the message to display in the dialog

Since:

4.0.0

showInformationDialog

public static void showInformationDialog(Component component, String title, String message)

Displays a information message using the JOptionPane.showMessageDialog(java.awt.Component, java.lang.Object) window.

Parameters:

component - the parent component of the dialog, can be null

title - the title string for the dialog

message - the message to display in the dialog

Since:

4.0.0

showWarningDialog

public static void showWarningDialog(String title, String message)

Displays a warning message using the JOptionPane.showMessageDialog(java.awt.Component, java.lang.Object) window. Convenient method equivalent to SwingHelper.showWarningDialog(null, title, message)

Parameters:

title - the title string for the dialog

message - the message to display in the dialog

Since:

4.0.0

showWarningDialog

public static void showWarningDialog(Component component, String title, String message)

Displays a warning message using the JOptionPane.showMessageDialog(java.awt.Component, java.lang.Object) window.

Parameters:

component - the parent component of the dialog, can be null

title - the title string for the dialog

message - the message to display in the dialog

Since:

4.0.0

showQuestionDialog

public static void showQuestionDialog(String title, String message)

Displays a question using the JOptionPane.showMessageDialog(java.awt.Component, java.lang.Object) window. Convenient method equivalent to SwingHelper.showQuestionDialog(null, title, message)

Parameters:

title - the title string for the dialog

message - the message to display in the dialog

Since:

4.0.0

showQuestionDialog

public static void showQuestionDialog(Component component, String title, String message)

Displays a question using the JOptionPane.showMessageDialog(java.awt.Component, java.lang.Object) window.

Parameters:

component - the parent component of the dialog, can be null

title - the title string for the dialog

message - the message to display in the dialog

Since:

4.0.0

showPlainDialog

public static void showPlainDialog(String title, String message)

Displays a plain message without an icon using the JOptionPane.showMessageDialog(java.awt.Component, java.lang.Object) window. Convenient method equivalent to SwingHelper.showPlainDialog(null, title, message)

Parameters:

title - the title string for the dialog

message - the message to display in the dialog

Since:

4.0.0

showPlainDialog

public static void showPlainDialog(Component component, String title, String message)

Displays a plain message without an icon using the JOptionPane.showMessageDialog(java.awt.Component, java.lang.Object) window.

Parameters:

component - the parent component of the dialog, can be null

title - the title string for the dialog

message - the message to display in the dialog

Since:

4.0.0