public class FileDialog extends Dialog
Note: Only one of the styles SAVE and OPEN may be specified.
IMPORTANT: This class is not intended to be subclassed.
Constructor and Description |
---|
FileDialog(Shell parent)
Constructs a new instance of this class given only its parent.
|
FileDialog(Shell parent,
int style)
Constructs a new instance of this class given its parent
and a style value describing its behavior and appearance.
|
Modifier and Type | Method and Description |
---|---|
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.
|
String[] |
getFileNames()
Returns a (possibly empty) array with the paths of all files
that were selected in the dialog relative to the filter path.
|
String[] |
getFilterExtensions()
Returns the file extensions which the dialog will
use to filter the files it shows.
|
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.
|
String[] |
getFilterNames()
Returns the names that describe the filter extensions
which the dialog will use to filter the files it shows.
|
String |
getFilterPath()
Returns the directory path that the dialog will use, or an empty
string if this is not set.
|
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.
|
String |
open()
Makes the dialog visible and brings it to the front
of the display.
|
void |
setFileName(String string)
Set the initial filename which the dialog will
select by default when opened to the argument,
which may be null.
|
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.
|
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.
|
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.
|
void |
setFilterPath(String string)
Sets the directory path that the dialog will use
to the argument, which may be null.
|
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.
|
public FileDialog(Shell parent)
parent
- a shell which will be the parent of the new instanceIllegalArgumentException
- SWTException
- public FileDialog(Shell parent, int style)
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.
parent
- a shell which will be the parent of the new instancestyle
- the style of dialog to constructIllegalArgumentException
- SWTException
- SWT.SAVE
,
SWT.OPEN
,
SWT.MULTI
public String getFileName()
public String[] getFileNames()
public String[] getFilterExtensions()
public int getFilterIndex()
This is an index into the FilterExtensions array and the FilterNames array.
getFilterExtensions()
,
getFilterNames()
public String[] getFilterNames()
public String getFilterPath()
setFilterExtensions(java.lang.String[])
public boolean getOverwrite()
public String open()
SWTException
- public void setFileName(String string)
string
- the file namepublic void setFilterExtensions(String[] extensions)
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.
extensions
- the file extension filterto specify the user-friendly
names corresponding to the extensions
public void setFilterIndex(int index)
This is an index into the FilterExtensions array and the FilterNames array.
index
- the file extension filter indexsetFilterExtensions(java.lang.String[])
,
setFilterNames(java.lang.String[])
public void setFilterNames(String[] names)
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.
names
- the list of filter names, or null for no filter namessetFilterExtensions(java.lang.String[])
public void setFilterPath(String string)
Note that the path string is platform dependent. For convenience, either '/' or '\' can be used as a path separator.
string
- the directory pathsetFilterExtensions(java.lang.String[])
public void setOverwrite(boolean overwrite)
overwrite
- true if the dialog will prompt for file overwrite, false otherwiseCopyright © 2017. All Rights Reserved.