com.xmlmind.guiutil

Class ChooseFileOptions

java.lang.Object

com.xmlmind.guiutil.ChooseFileOptions

public class ChooseFileOptions
extends Object

Options of the dialog box displayed by ChooseFile and ChooseURL.

Field Summary

Fields

Modifier and Type	Field and Description
FileFilter	activeFilter Active filter of the dialog box.
boolean	allowOverwrite If true, do not ask the user to confirm before overwriting an existing file.
List<FileFilter>	filterList File filters of the dialog box.
Boolean	nativeDialog If Boolean.TRUE, use the native file chooser dialog box rather than Swing's emulation of native file chooser dialog box.
boolean	previewImages If true, add an accessory to the file chooser in order to display a thumbnail of the selected image file.
boolean	showHiddenFiles If true, also list the hidden files.
Dimension	size Size of the dialog box.
String	title Title of the dialog box.

Constructor Summary

Constructors

Constructor and Description
ChooseFileOptions()

Method Summary

Modifier and Type	Method and Description
void	addFilter(String extension) Equivalent to addFilter(new String[] { extension }).
void	addFilter(String[] extensions) Convenience method: add specified FilterByExtension to the list of filters.
void	setActiveFilter(String... extensions) Convenience method: add specified FilterByExtension to the list of filters and make it the active filter.

Methods inherited from class java.lang.Object

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

Field Detail

title

public String title

Title of the dialog box. May be null.

Default behavior: give the dialog box a default title (adapted to the operation performed by the dialog box).

size

public Dimension size

Size of the dialog box. May be null.

Default behavior: give the dialog box its intrinsic size.

Note that the size is updated to reflect the dialog box resize operation possibly performed by the user.

nativeDialog

public Boolean nativeDialog

If Boolean.TRUE, use the native file chooser dialog box rather than Swing's emulation of native file chooser dialog box. If Boolean.FALSE, use Swing's JFileChooser. If null, this depends on the user preferences. If nothing is specified in the user preferences, then use Swing's JFileChooser.

showHiddenFiles

public boolean showHiddenFiles

If true, also list the hidden files. Default behavior: do not list the hidden files.

previewImages

public boolean previewImages

If true, add an accessory to the file chooser in order to display a thumbnail of the selected image file. Default: false.

Ignored when nativeDialog is Boolean.TRUE and when the file chooser is used to select directories.

allowOverwrite

public boolean allowOverwrite

If true, do not ask the user to confirm before overwriting an existing file.

Default behavior: ask the user to confirm before overwriting an existing file.

filterList

public List<FileFilter> filterList

File filters of the dialog box. May be null.

Default behavior: add the filter derived from the template file (if any) passed as an argument to the selection operation.

activeFilter

public FileFilter activeFilter

Active filter of the dialog box. May be null.

Must one of the filters contained in filterList.

Default behavior: use as the active filter the filter derived from the template file (if any) passed as an argument to the selection operation.

Constructor Detail

ChooseFileOptions

public ChooseFileOptions()

Method Detail

addFilter

public void addFilter(String extension)

Equivalent to addFilter(new String[] { extension }).

addFilter

public void addFilter(String[] extensions)

Convenience method: add specified FilterByExtension to the list of filters.

See Also:

filterList, activeFilter, setActiveFilter(java.lang.String...)

setActiveFilter

public void setActiveFilter(String... extensions)

Convenience method: add specified FilterByExtension to the list of filters and make it the active filter.

See Also:

filterList, activeFilter, addFilter(java.lang.String)