Standard Widget Toolkit for GTK 3.125.0 · org.eclipse.swt.widgets.FileDialog

Modifier and Type	Field and Description
pack-priv static final char	EXTENSION_SEPARATOR
pack-priv static final char	FILE_EXTENSION_SEPARATOR
pack-priv String	fileName
pack-priv String[]	fileNames
pack-priv String[]	filterExtensions
pack-priv int	filterIndex
pack-priv String[]	filterNames
pack-priv String	filterPath
pack-priv String	fullPath
pack-priv long	handle
pack-priv boolean	overwrite
pack-priv static final char	SEPARATOR
pack-priv boolean	uriMode

Access	Constructor and Description
public	FileDialog(Shell a shell which will be the parent of the new instance parent) Constructs a new instance of this class given only its parent.
public	FileDialog(Shell a shell which will be the parent of the new instance parent, int the style of dialog to construct style) Constructs a new instance of this class given its parent and a style value describing its behavior and appearance.

Method Summary

Modifier and Type	Method and Description
pack-priv String	computeResultChooserDialog()
public String	Returns: the relative path of the file getFileName() Returns the path of the first file that was selected in the dialog relative to the filter path, or an empty string if no such file has been selected.
public String[]	Returns: the relative paths of the files getFileNames() Returns a (possibly empty) array with the paths of all files that were selected in the dialog relative to the filter path.
public String[]	Returns: the file extensions filter getFilterExtensions() Returns the file extensions which the dialog will use to filter the files it shows.
public int	Returns: index the file extension filter index getFilterIndex() Get the 0-based index of the file extension filter which was selected by the user, or -1 if no filter was selected.
public String[]	Returns: the list of filter names getFilterNames() Returns the names that describe the filter extensions which the dialog will use to filter the files it shows.
public String	Returns: the directory path string getFilterPath() Returns the directory path that the dialog will use, or an empty string if this is not set.
public boolean	Returns: true if the dialog will prompt for file overwrite, false otherwise getOverwrite() Returns the flag that the dialog will use to determine whether to prompt the user for file overwrite if the selected file already exists.
private boolean	Returns: true if the extension contains any of the glob pattern wildcards isGlobPattern(String file extension as a string extension) Check whether the file extension is a glob pattern.
public String	Returns: a string describing the absolute path of the first selected file, or null if the dialog was cancelled or an error occurred open() Makes the dialog visible and brings it to the front of the display.
pack-priv String	Returns: a string describing the absolute path of the first selected file, or null openNativeChooserDialog() Open the file chooser dialog using the GtkFileChooserNative API (GTK3.20+) for running applications without direct filesystem access (such as Flatpak).
pack-priv void	presetChooserDialog()
public void	setFileName(String the file name string) Set the initial filename which the dialog will select by default when opened to the argument, which may be null.
public void	setFilterExtensions(String[] the file extension filter extensions) Set the file extensions which the dialog will use to filter the files it shows to the argument, which may be null.
public void	setFilterIndex(int the file extension filter index index) Set the 0-based index of the file extension filter which the dialog will use initially to filter the files it shows to the argument.
public void	setFilterNames(String[] the list of filter names, or null for no filter names names) Sets the names that describe the filter extensions which the dialog will use to filter the files it shows to the argument, which may be null.
public void	setFilterPath(String the directory path string) Sets the directory path that the dialog will use to the argument, which may be null.
public void	setOverwrite(boolean true if the dialog will prompt for file overwrite, false otherwise overwrite) Sets the flag that the dialog will use to determine whether to prompt the user for file overwrite if the selected file already exists.
pack-priv void	setURIMode(boolean uriMode)

Inherited from org.eclipse.swt.widgets.Dialog:: checkParent checkStyle checkSubclass error getParent getStyle getText setText

Field Detail

EXTENSION_SEPARATOR	back to summary
pack-priv static final char EXTENSION_SEPARATOR

FILE_EXTENSION_SEPARATOR	back to summary
pack-priv static final char FILE_EXTENSION_SEPARATOR

fileName	back to summary
pack-priv String fileName

fileNames	back to summary
pack-priv String[] fileNames

filterExtensions	back to summary
pack-priv String[] filterExtensions

filterIndex	back to summary
pack-priv int filterIndex

filterNames	back to summary
pack-priv String[] filterNames

filterPath	back to summary
pack-priv String filterPath

fullPath	back to summary
pack-priv String fullPath

handle	back to summary
pack-priv long handle

overwrite	back to summary
pack-priv boolean overwrite

SEPARATOR	back to summary
pack-priv static final char SEPARATOR

uriMode	back to summary
pack-priv boolean uriMode

Constructor Detail

FileDialog	back to summary
public FileDialog(Shell parent) Constructs a new instance of this class given only its parent. Parameters parent:Shell a shell which will be the parent of the new instance Exceptions IllegalArgumentException: ERROR_NULL_ARGUMENT - if the parent is null SWTException: ERROR_THREAD_INVALID_ACCESS - if not called from the thread that created the parent ERROR_INVALID_SUBCLASS - if this class is not an allowed subclass

FileDialog

back to summary

public FileDialog(Shell parent)

Constructs a new instance of this class given only its parent.

Parameters

parent:Shell: a shell which will be the parent of the new instance

Exceptions

IllegalArgumentException:

ERROR_NULL_ARGUMENT - if the parent is null

SWTException:

ERROR_THREAD_INVALID_ACCESS - if not called from the thread that created the parent
ERROR_INVALID_SUBCLASS - if this class is not an allowed subclass

FileDialog back to summary

FileDialog	back to summary
public FileDialog(Shell parent, int style) Constructs a new instance of this class given its parent and a style value describing its behavior and appearance. The style value is either one of the style constants defined in class `SWT` which is applicable to instances of this class, or must be built by bitwise OR'ing together (that is, using the `int` "\|" operator) two or more of those `SWT` style constants. The class description lists the style constants that are applicable to the class. Style bits are also inherited from superclasses. Parameters parent:Shell a shell which will be the parent of the new instance style:int the style of dialog to construct Exceptions IllegalArgumentException: ERROR_NULL_ARGUMENT - if the parent is null SWTException: ERROR_THREAD_INVALID_ACCESS - if not called from the thread that created the parent ERROR_INVALID_SUBCLASS - if this class is not an allowed subclass See Also `SWT#SAVE`, `SWT#OPEN`, `SWT#MULTI`

public FileDialog(Shell parent, int style)

Constructs a new instance of this class given its parent and a style value describing its behavior and appearance.

The style value is either one of the style constants defined in class SWT which is applicable to instances of this class, or must be built by bitwise OR'ing together (that is, using the int "|" operator) two or more of those SWT style constants. The class description lists the style constants that are applicable to the class. Style bits are also inherited from superclasses.

Parameters

parent:Shell: a shell which will be the parent of the new instance
style:int: the style of dialog to construct

Exceptions

IllegalArgumentException:

ERROR_NULL_ARGUMENT - if the parent is null

SWTException:

ERROR_THREAD_INVALID_ACCESS - if not called from the thread that created the parent
ERROR_INVALID_SUBCLASS - if this class is not an allowed subclass

See Also

SWT#SAVE, SWT#OPEN, SWT#MULTI

Method Detail

computeResultChooserDialog	back to summary
pack-priv String computeResultChooserDialog()

getFileName	back to summary
public String getFileName() Returns the path of the first file that was selected in the dialog relative to the filter path, or an empty string if no such file has been selected. Returns:String the relative path of the file

getFileName

back to summary

public String getFileName()

Returns the path of the first file that was selected in the dialog relative to the filter path, or an empty string if no such file has been selected.

Returns:String: the relative path of the file

getFileNames	back to summary
public String[] getFileNames() Returns a (possibly empty) array with the paths of all files that were selected in the dialog relative to the filter path. Returns:String[] the relative paths of the files

getFileNames

back to summary

public String[] getFileNames()

Returns a (possibly empty) array with the paths of all files that were selected in the dialog relative to the filter path.

Returns:String[]: the relative paths of the files

getFilterExtensions	back to summary
public String[] getFilterExtensions() Returns the file extensions which the dialog will use to filter the files it shows. Returns:String[] the file extensions filter

getFilterExtensions

back to summary

public String[] getFilterExtensions()

Returns the file extensions which the dialog will use to filter the files it shows.

Returns:String[]: the file extensions filter

getFilterIndex back to summary

getFilterIndex	back to summary
public int getFilterIndex() Get the 0-based index of the file extension filter which was selected by the user, or -1 if no filter was selected. This is an index into the FilterExtensions array and the FilterNames array. Returns:int index the file extension filter index Since 3.4 See Also `getFilterExtensions`, `getFilterNames`

public int getFilterIndex()

Get the 0-based index of the file extension filter which was selected by the user, or -1 if no filter was selected.

This is an index into the FilterExtensions array and the FilterNames array.

Returns:int: index the file extension filter index
Since: 3.4
See Also: getFilterExtensions, getFilterNames

getFilterNames	back to summary
public String[] getFilterNames() Returns the names that describe the filter extensions which the dialog will use to filter the files it shows. Returns:String[] the list of filter names

getFilterNames

back to summary

public String[] getFilterNames()

Returns the names that describe the filter extensions which the dialog will use to filter the files it shows.

Returns:String[]: the list of filter names

getFilterPath back to summary

getFilterPath	back to summary
public String getFilterPath() Returns the directory path that the dialog will use, or an empty string if this is not set. File names in this path will appear in the dialog, filtered according to the filter extensions. Returns:String the directory path string See Also `setFilterExtensions`

public String getFilterPath()

Returns the directory path that the dialog will use, or an empty string if this is not set. File names in this path will appear in the dialog, filtered according to the filter extensions.

Returns:String: the directory path string
See Also: setFilterExtensions

getOverwrite	back to summary
public boolean getOverwrite() Returns the flag that the dialog will use to determine whether to prompt the user for file overwrite if the selected file already exists. Returns:boolean true if the dialog will prompt for file overwrite, false otherwise Since 3.4

getOverwrite

back to summary

public boolean getOverwrite()

Returns the flag that the dialog will use to determine whether to prompt the user for file overwrite if the selected file already exists.

Returns:boolean: true if the dialog will prompt for file overwrite, false otherwise
Since: 3.4

isGlobPattern	back to summary
private boolean isGlobPattern(String extension) Check whether the file extension is a glob pattern. For example, . is a glob pattern which corresponds to all files .jp corresponds to all the files with extension starting with jp like jpg,jpeg etc .jp? corresponds to 3 letter extension starting with jp with any 3rd letter .[pq]ng this corresponds to .png and .qng Parameters extension:String file extension as a string Returns:boolean true if the extension contains any of the glob pattern wildcards

isGlobPattern

back to summary

private boolean isGlobPattern(String extension)

Check whether the file extension is a glob pattern. For example, *.* is a glob pattern which corresponds to all files *.jp* corresponds to all the files with extension starting with jp like jpg,jpeg etc *.jp? corresponds to 3 letter extension starting with jp with any 3rd letter *.[pq]ng this corresponds to *.png and *.qng

Parameters

extension:String: file extension as a string

Returns:boolean

true if the extension contains any of the glob pattern wildcards

open	back to summary
public String open() Makes the dialog visible and brings it to the front of the display. Returns:String a string describing the absolute path of the first selected file, or null if the dialog was cancelled or an error occurred Exceptions SWTException: ERROR_WIDGET_DISPOSED - if the dialog has been disposed ERROR_THREAD_INVALID_ACCESS - if not called from the thread that created the dialog

open

back to summary

public String open()

Makes the dialog visible and brings it to the front of the display.

Returns:String

a string describing the absolute path of the first selected file, or null if the dialog was cancelled or an error occurred

Exceptions

SWTException:

ERROR_WIDGET_DISPOSED - if the dialog has been disposed
ERROR_THREAD_INVALID_ACCESS - if not called from the thread that created the dialog

openNativeChooserDialog	back to summary
pack-priv String openNativeChooserDialog() Open the file chooser dialog using the GtkFileChooserNative API (GTK3.20+) for running applications without direct filesystem access (such as Flatpak). API for GtkFileChoosernative does not give access to any GtkWindow or GtkWidget for the dialog, thus this method omits calls that requires such access. These are be handled by the GtkNativeDialog API. Returns:String a string describing the absolute path of the first selected file, or null

openNativeChooserDialog

back to summary

pack-priv String openNativeChooserDialog()

Open the file chooser dialog using the GtkFileChooserNative API (GTK3.20+) for running applications without direct filesystem access (such as Flatpak). API for GtkFileChoosernative does not give access to any GtkWindow or GtkWidget for the dialog, thus this method omits calls that requires such access. These are be handled by the GtkNativeDialog API.

Returns:String: a string describing the absolute path of the first selected file, or null

presetChooserDialog	back to summary
pack-priv void presetChooserDialog()

setFileName	back to summary
public void setFileName(String string) Set the initial filename which the dialog will select by default when opened to the argument, which may be null. The name will be prefixed with the filter path when one is supplied. Parameters string:String the file name

setFileName

back to summary

public void setFileName(String string)

Set the initial filename which the dialog will select by default when opened to the argument, which may be null. The name will be prefixed with the filter path when one is supplied.

Parameters

string:String: the file name

setFilterExtensions back to summary

setFilterExtensions	back to summary
public void setFilterExtensions(String[] extensions) Set the file extensions which the dialog will use to filter the files it shows to the argument, which may be null. The strings are platform specific. For example, on some platforms, an extension filter string is typically of the form ".extension", where "." matches all files. For filters with multiple extensions, use semicolon as a separator, e.g. ".jpg;*.png". Note On Mac, setting the file extension filter affects how app bundles are treated by the dialog. When a filter extension having the app extension (.app) is selected, bundles are treated as files. For all other extension filters, bundles are treated as directories. When no filter extension is set, bundles are treated as files. Parameters extensions:String[] the file extension filter See Also `to specify the user-friendly names corresponding to the extensions`

public void setFilterExtensions(String[] extensions)

Set the file extensions which the dialog will use to filter the files it shows to the argument, which may be null.

The strings are platform specific. For example, on some platforms, an extension filter string is typically of the form "*.extension", where "*.*" matches all files. For filters with multiple extensions, use semicolon as a separator, e.g. "*.jpg;*.png".

Note

On Mac, setting the file extension filter affects how app bundles are treated by the dialog. When a filter extension having the app extension (.app) is selected, bundles are treated as files. For all other extension filters, bundles are treated as directories. When no filter extension is set, bundles are treated as files.

Parameters

extensions:String[]: the file extension filter

setFilterIndex back to summary

setFilterIndex	back to summary
public void setFilterIndex(int index) Set the 0-based index of the file extension filter which the dialog will use initially to filter the files it shows to the argument. This is an index into the FilterExtensions array and the FilterNames array. Parameters index:int the file extension filter index Since 3.4 See Also `setFilterExtensions`, `setFilterNames`

public void setFilterIndex(int index)

Set the 0-based index of the file extension filter which the dialog will use initially to filter the files it shows to the argument.

This is an index into the FilterExtensions array and the FilterNames array.

Parameters

index:int: the file extension filter index

Since

3.4

See Also

setFilterExtensions, setFilterNames

setFilterNames back to summary

setFilterNames	back to summary
public void setFilterNames(String[] names) Sets the names that describe the filter extensions which the dialog will use to filter the files it shows to the argument, which may be null. Each name is a user-friendly short description shown for its corresponding filter. The `names` array must be the same length as the `extensions` array. Parameters names:String[] the list of filter names, or null for no filter names See Also `setFilterExtensions`

public void setFilterNames(String[] names)

Sets the names that describe the filter extensions which the dialog will use to filter the files it shows to the argument, which may be null.

Each name is a user-friendly short description shown for its corresponding filter. The names array must be the same length as the extensions array.

Parameters

names:String[]: the list of filter names, or null for no filter names

See Also

setFilterExtensions

setFilterPath back to summary

setFilterPath	back to summary
public void setFilterPath(String string) Sets the directory path that the dialog will use to the argument, which may be null. File names in this path will appear in the dialog, filtered according to the filter extensions. If the string is null, then the operating system's default filter path will be used. Note that the path string is platform dependent. For convenience, either '/' or '\' can be used as a path separator. Parameters string:String the directory path See Also `setFilterExtensions`

public void setFilterPath(String string)

Sets the directory path that the dialog will use to the argument, which may be null. File names in this path will appear in the dialog, filtered according to the filter extensions. If the string is null, then the operating system's default filter path will be used.

Note that the path string is platform dependent. For convenience, either '/' or '\' can be used as a path separator.

Parameters

string:String: the directory path

See Also

setFilterExtensions

setOverwrite	back to summary
public void setOverwrite(boolean overwrite) Sets the flag that the dialog will use to determine whether to prompt the user for file overwrite if the selected file already exists. Note On some platforms where suppressing the overwrite prompt is not supported, the prompt is shown even when invoked with overwrite false. Parameters overwrite:boolean true if the dialog will prompt for file overwrite, false otherwise Since 3.4

setOverwrite

back to summary

public void setOverwrite(boolean overwrite)

Sets the flag that the dialog will use to determine whether to prompt the user for file overwrite if the selected file already exists.

Note

On some platforms where suppressing the overwrite prompt is not supported, the prompt is shown even when invoked with overwrite false.

Parameters

overwrite:boolean: true if the dialog will prompt for file overwrite, false otherwise

Since

3.4

setURIMode	back to summary
pack-priv void setURIMode(boolean uriMode)

public Class FileDialog

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail