com.plealog.genericapp.api.file

Class EZFileManager

java.lang.Object

com.plealog.genericapp.api.file.EZFileManager

public class EZFileManager
extends Object

This class manages the access to file and directory as well as generic UI File Chooser.

Method Summary

Methods

Modifier and Type	Method and Description
static File	chooseDirectory() Manages a File Chooser to choose a directory.
static File	chooseDirectory(Component parent, String dialogTitle, EZFileFilter ff) Manages a File Chooser to choose a directory.
static File	chooseDirectory(String dialogTitle) Manages a File Chooser to choose a directory.
static File	chooseDirectory(String dialogTitle, EZFileFilter ff) Manages a File Chooser to choose a directory.
static File	chooseFileForOpenAction() Manages a File Chooser to choose a file for open operations.
static File	chooseFileForOpenAction(Component parent, String dialogTitle, EZFileFilter ff) Manages a File Chooser to choose a file for open operations.
static File	chooseFileForOpenAction(String dialogTitle) Manages a File Chooser to choose a file for open operations.
static File	chooseFileForOpenAction(String dialogTitle, EZFileFilter ff) Manages a File Chooser to choose a file for open operations.
static File	chooseFileForSaveAction() Manages a File Chooser to choose a file for save operations.
static File	chooseFileForSaveAction(Component parent, String dialogTitle, EZFileFilter ff) Manages a File Chooser to choose a file for save operations.
static File	chooseFileForSaveAction(Component parent, String dialogTitle, EZFileFilter ff, List<com.plealog.genericapp.implem.file.EZFileExtDescriptor> types) Manages a File Chooser to choose a file for save operations.
static File	chooseFileForSaveAction(String dialogTitle) Manages a File Chooser to choose a file for save operations.
static File	chooseFileForSaveAction(String dialogTitle, EZFileFilter ff) Manages a File Chooser to choose a file for save operations.
static String	getDefaultPath() Returns the default directory path.
static String	getUserHomeDirectory() Gets the user home directory.
static boolean	isUsingOSNativeFileDialog() Figures out whether or not this manager uses native OS dependent FileChooser.
static void	setDefaultPath(String path) Changes the default directory used in File Chooser dialogue boxes.
static void	useOSNativeFileDialog(boolean useNativeOSFileDialog) Figures out whether or not this manager will use native OS dependent FileChooser.

Methods inherited from class java.lang.Object

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

Method Detail

useOSNativeFileDialog

public static void useOSNativeFileDialog(boolean useNativeOSFileDialog)

Figures out whether or not this manager will use native OS dependent FileChooser.

Parameters:

useNativeOSFileDialog - passes in true to use FileDialog, false to use JFileChooser. The former enables the display of an OS-dependent File Chooser, while the latter is the Java Swing specific File CHooser.

isUsingOSNativeFileDialog

public static boolean isUsingOSNativeFileDialog()

Figures out whether or not this manager uses native OS dependent FileChooser.

getDefaultPath

public static String getDefaultPath()

Returns the default directory path. It is the path used to initialize File Chooser dialogues.

setDefaultPath

public static void setDefaultPath(String path)

Changes the default directory used in File Chooser dialogue boxes. At startup, this default path is set to the user home directory.

getUserHomeDirectory

public static String getUserHomeDirectory()

Gets the user home directory. This method takes into account workaround defined by http://bugs.sun.com/bugdatabase/view_bug.do?bug_id=4787931.

chooseFileForOpenAction

public static File chooseFileForOpenAction()

Manages a File Chooser to choose a file for open operations.

Returns:

a file or null if dialogue has been canceled.

chooseFileForOpenAction

public static File chooseFileForOpenAction(String dialogTitle)

Manages a File Chooser to choose a file for open operations.

Parameters:

dialogTitle - title of the dialogue box

Returns:

a file or null if dialogue has been canceled.

chooseFileForOpenAction

public static File chooseFileForOpenAction(String dialogTitle,
                           EZFileFilter ff)

Manages a File Chooser to choose a file for open operations.

Parameters:

dialogTitle - title of the dialogue box

ff - a file filter. Use EZFileTypes to manage file filters.

Returns:

a file or null if dialogue has been canceled.

chooseFileForOpenAction

public static File chooseFileForOpenAction(Component parent,
                           String dialogTitle,
                           EZFileFilter ff)

Manages a File Chooser to choose a file for open operations.

Parameters:

parent - the parent component of the File Chooser

dialogTitle - title of the dialogue box

ff - a file filter. Use EZFileTypes to manage file filters.

Returns:

a file or null if dialogue has been canceled.

chooseFileForSaveAction

public static File chooseFileForSaveAction()

Manages a File Chooser to choose a file for save operations.

Returns:

a file or null if dialogue has been canceled.

chooseFileForSaveAction

public static File chooseFileForSaveAction(String dialogTitle)

Manages a File Chooser to choose a file for save operations.

Parameters:

dialogTitle - title of the dialogue box

Returns:

a file or null if dialogue has been canceled.

chooseFileForSaveAction

public static File chooseFileForSaveAction(String dialogTitle,
                           EZFileFilter ff)

Manages a File Chooser to choose a file for save operations.

Parameters:

dialogTitle - title of the dialogue box

ff - a file filter. Use EZFileTypes to manage file filters.

Returns:

a file or null if dialogue has been canceled.

chooseFileForSaveAction

public static File chooseFileForSaveAction(Component parent,
                           String dialogTitle,
                           EZFileFilter ff)

Manages a File Chooser to choose a file for save operations.

Parameters:

parent - the parent component of the File Chooser

dialogTitle - title of the dialogue box

ff - a file filter. Use EZFileTypes to manage file filters.

Returns:

a file or null if dialogue has been canceled.

chooseFileForSaveAction

public static File chooseFileForSaveAction(Component parent,
                           String dialogTitle,
                           EZFileFilter ff,
                           List<com.plealog.genericapp.implem.file.EZFileExtDescriptor> types)

Manages a File Chooser to choose a file for save operations.

Parameters:

parent - the parent component of the File Chooser

dialogTitle - title of the dialogue box

ff - a file filter. Use EZFileTypes to manage file filters.

types - list of file types to restrict display of the dialog box to them

Returns:

a file or null if dialogue has been canceled.

chooseDirectory

public static File chooseDirectory()

Manages a File Chooser to choose a directory.

Returns:

a directory or null if dialogue has been canceled.

chooseDirectory

public static File chooseDirectory(String dialogTitle)

Manages a File Chooser to choose a directory.

Parameters:

dialogTitle - title of the dialogue box

Returns:

a directory or null if dialogue has been canceled.

chooseDirectory

public static File chooseDirectory(String dialogTitle,
                   EZFileFilter ff)

Manages a File Chooser to choose a directory.

Parameters:

dialogTitle - title of the dialogue box

ff - a file filter. Use EZFileTypes to manage file filters.

Returns:

a directory or null if dialogue has been canceled.

chooseDirectory

public static File chooseDirectory(Component parent,
                   String dialogTitle,
                   EZFileFilter ff)

Manages a File Chooser to choose a directory.

Parameters:

parent - the parent component of the File Chooser

dialogTitle - title of the dialogue box

ff - a file filter. Use EZFileTypes to manage file filters.

Returns:

a directory or null if dialogue has been canceled.