com.xmlmind.guiutil

Class ChooseFile

java.lang.Object

com.xmlmind.guiutil.ChooseFile

public final class ChooseFile
extends Object

Displays a dialog box allowing the user to specify a file or directory, open or save, File.

An application must register its File chooser dialog box with this facility otherwise a standard JFileChooser is used.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	ChooseFile.FileChooser This interface must be implemented by the application if it has an advanced file chooser dialog box.
static class	ChooseFile.FileChooserImpl Default implementation of ChooseFile.FileChooser: uses the standard JFileChooser.

Field Summary

Fields

Modifier and Type	Field and Description
static ChooseFile.FileChooserImpl	DEFAULT_CHOOSER Ready-to-use instance of ChooseFile.FileChooserImpl.

Constructor Summary

Constructors

Constructor and Description
ChooseFile()

Method Summary

Modifier and Type	Method and Description
static File	chooseFile(Component parentComponent, File templateFile, boolean dirMode, boolean saveMode, ChooseFileOptions options) Low-level utility: selects a file according to specified arguments.
static File	chooseOpenDirectory(Component parentComponent, File template, ChooseFileOptions options) Convenience method: equivalent to getFileChooser().chooseOpenDirectory(parentComponent,template,options).
static File	chooseOpenFile(Component parentComponent, File template, ChooseFileOptions options) Convenience method: equivalent to getFileChooser().chooseOpenFile(parentComponent, template, options).
static File	chooseSaveDirectory(Component parentComponent, File template, ChooseFileOptions options) Convenience method: equivalent to getFileChooser().chooseSaveDirectory(parentComponent,template,options).
static File	chooseSaveFile(Component parentComponent, File template, ChooseFileOptions options) Convenience method: equivalent to getFileChooser().chooseSaveFile(parentComponent, template, options).
static String	getChooserTitle(boolean dirMode, boolean saveMode) Low-level helper: returns a localized title for a file chooser dialog box working using specified modes.
static ChooseFile.FileChooser	getFileChooser() Returns the object implementing an File chooser dialog box.
static void	setFileChooser(ChooseFile.FileChooser fileChooser) Specifies the object implementing an File chooser dialog box.

Methods inherited from class java.lang.Object

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

Field Detail

DEFAULT_CHOOSER

public static ChooseFile.FileChooserImpl DEFAULT_CHOOSER

Ready-to-use instance of ChooseFile.FileChooserImpl.

Constructor Detail

ChooseFile

public ChooseFile()

Method Detail

setFileChooser

public static void setFileChooser(ChooseFile.FileChooser fileChooser)

Specifies the object implementing an File chooser dialog box.

getFileChooser

public static ChooseFile.FileChooser getFileChooser()

Returns the object implementing an File chooser dialog box.

chooseOpenFile

public static File chooseOpenFile(Component parentComponent,
                                  File template,
                                  ChooseFileOptions options)

Convenience method: equivalent to getFileChooser().chooseOpenFile(parentComponent, template, options).

chooseSaveFile

public static File chooseSaveFile(Component parentComponent,
                                  File template,
                                  ChooseFileOptions options)

Convenience method: equivalent to getFileChooser().chooseSaveFile(parentComponent, template, options).

chooseOpenDirectory

public static File chooseOpenDirectory(Component parentComponent,
                                       File template,
                                       ChooseFileOptions options)

Convenience method: equivalent to getFileChooser().chooseOpenDirectory(parentComponent,template,options).

chooseSaveDirectory

public static File chooseSaveDirectory(Component parentComponent,
                                       File template,
                                       ChooseFileOptions options)

Convenience method: equivalent to getFileChooser().chooseSaveDirectory(parentComponent,template,options).

chooseFile

public static File chooseFile(Component parentComponent,
                              File templateFile,
                              boolean dirMode,
                              boolean saveMode,
                              ChooseFileOptions options)

Low-level utility: selects a file according to specified arguments.

Parameters:

parentComponent - used to find a parent for the dialog box

templateFile - used as a template for the file to be selected. May be null.

dirMode - if true, selected file must be directory

saveMode - if true, returned file must be a save file

options - dialog box options. May be null.

Returns:

selected file or null if user has canceled the selection.

getChooserTitle

public static String getChooserTitle(boolean dirMode,
                                     boolean saveMode)

Low-level helper: returns a localized title for a file chooser dialog box working using specified modes.