Class FileChooser

java.lang.Object

VASSAL.tools.filechooser.FileChooser

public abstract class FileChooser
extends Object

FileChooser provides a wrapper for JFileChooser and FileDialog, selecting whichever is preferred on the user's OS. FileChooser's methods mirror those of JFileChooser.

Author:

Joel Uckelman

Field Summary

Fields

Modifier and Type	Field	Description
static final int	APPROVE_OPTION
static final int	CANCEL_OPTION
static final int	DIRECTORIES_ONLY
static final int	ERROR_OPTION
static final int	FILES_ONLY
protected Component	parent
protected DirectoryConfigurer	prefs

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	FileChooser(Component parent, DirectoryConfigurer pref)

Method Summary

Modifier and Type	Method	Description
abstract void	addChoosableFileFilter(FileFilter filter)
static FileChooser	createFileChooser(Component parent)
static FileChooser	createFileChooser(Component parent, DirectoryConfigurer prefs)
static FileChooser	createFileChooser(Component parent, DirectoryConfigurer prefs, int mode)	Creates a FileChooser appropriate for the user's OS.
abstract File	getCurrentDirectory()
abstract String	getDialogTitle()
abstract FileFilter	getFileFilter()
abstract File	getSelectedFile()
abstract boolean	removeChoosableFileFilter(FileFilter filter)
abstract void	rescanCurrentDirectory()
abstract void	resetChoosableFileFilters()
void	selectDotSavFile()	Selects filename.vsav if filename.foo is selected.
abstract void	setCurrentDirectory(File dir)
abstract void	setDialogTitle(String title)
abstract void	setFileFilter(FileFilter filter)
abstract void	setSelectedFile(File file)
int	showOpenDialog()	Same as showOpenDialog(Component), but uses the parent set on creation of this FileDialog.
abstract int	showOpenDialog(Component parent)
int	showSaveDialog()	Same as showSaveDialog(Component), but uses the parent set on creation of this FileDialog.
abstract int	showSaveDialog(Component parent)
protected void	updateDirectoryPreference()

Methods inherited from class java.lang.Object

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

Field Details

parent

protected Component parent

prefs

protected DirectoryConfigurer prefs

APPROVE_OPTION

public static final int APPROVE_OPTION

See Also:

• Constant Field Values

CANCEL_OPTION

public static final int CANCEL_OPTION

See Also:

• Constant Field Values

ERROR_OPTION

public static final int ERROR_OPTION

See Also:

• Constant Field Values

FILES_ONLY

public static final int FILES_ONLY

See Also:

• Constant Field Values

DIRECTORIES_ONLY

public static final int DIRECTORIES_ONLY

See Also:

• Constant Field Values

Constructor Details

FileChooser

protected FileChooser(Component parent,
 DirectoryConfigurer pref)

Method Details

createFileChooser

public static FileChooser createFileChooser(Component parent)

createFileChooser

public static FileChooser createFileChooser(Component parent,
 DirectoryConfigurer prefs)

createFileChooser

public static FileChooser createFileChooser(Component parent,
 DirectoryConfigurer prefs,
 int mode)

Creates a FileChooser appropriate for the user's OS.

Parameters:

parent - The Component over which the FileChooser should appear.

prefs - A FileConfigure that stores the preferred starting directory of the FileChooser in preferences

getCurrentDirectory

public abstract File getCurrentDirectory()

setCurrentDirectory

public abstract void setCurrentDirectory(File dir)

rescanCurrentDirectory

public abstract void rescanCurrentDirectory()

getSelectedFile

public abstract File getSelectedFile()

setSelectedFile

public abstract void setSelectedFile(File file)

getDialogTitle

public abstract String getDialogTitle()

setDialogTitle

public abstract void setDialogTitle(String title)

showOpenDialog

public abstract int showOpenDialog(Component parent)

showSaveDialog

public abstract int showSaveDialog(Component parent)

getFileFilter

public abstract FileFilter getFileFilter()

setFileFilter

public abstract void setFileFilter(FileFilter filter)

addChoosableFileFilter

public abstract void addChoosableFileFilter(FileFilter filter)

removeChoosableFileFilter

public abstract boolean removeChoosableFileFilter(FileFilter filter)

resetChoosableFileFilters

public abstract void resetChoosableFileFilters()

selectDotSavFile

public void selectDotSavFile()

Selects filename.vsav if filename.foo is selected.

showOpenDialog

public int showOpenDialog()

Same as showOpenDialog(Component), but uses the parent set on creation of this FileDialog.

showSaveDialog

public int showSaveDialog()

Same as showSaveDialog(Component), but uses the parent set on creation of this FileDialog.

updateDirectoryPreference

protected void updateDirectoryPreference()