org.eclipse.swt.widgets
Class FileDialog
java.lang.Object
|
+--org.eclipse.swt.widgets.Dialog
|
+--org.eclipse.swt.widgets.FileDialog
- public class FileDialog
- extends Dialog
Unsafe: Instances of this class allow the user to navigate
the file system and select or enter a file name.
- Styles:
- SAVE, OPEN, MULTI
- Events:
- (none)
IMPORTANT: This class is intended to be subclassed only
within the SWT implementation.
Field Summary
Fields inherited from class org.eclipse.swt.widgets.Dialog
Constructor Summary
FileDialog(Shell parent)
Enabled: Constructs a new instance of this class given only its
parent.
FileDialog(Shell parent,
int style)
Enabled: Constructs a new instance of this class given its parent
and a style value describing its behavior and appearance.
Method Summary
String
getFileName()
Enabled: Returns the path of the first file that was
selected in the dialog relative to the filter path
String[]
getFileNames()
Enabled: Returns the paths of all files that were selected
in the dialog relative to the filter path, or null
if none are available.
String[]
getFilterNames()
Enabled: Returns the file names which the dialog will
use to filter the files it shows.
String
open()
Enabled: Makes the dialog visible and brings it to the front
of the display.
void
setFileName(String string)
Enabled: Set the initial filename which the dialog will
select by default when opened to the argument,
which may be null.
void
setFilterExtensions(String[] extensions)
Enabled: Set the file extensions which the dialog will
use to filter the files it shows to the argument,
which may be null.
void
setFilterNames(String[] names)
Enabled: Sets the file names which the dialog will
use to filter the files it shows to the argument,
which may be null.
void
setFilterPath(String string)
Enabled: Sets the directory path that the dialog will use
to the argument, which may be null.
Methods inherited from class org.eclipse.swt.widgets.Dialog
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
Field Detail
filterNames
String[] filterNames
filterExtensions
String[] filterExtensions
fileNames
String[] fileNames
filterPath
String filterPath
fileName
String fileName
FILTER
static final String FILTER
BUFFER_SIZE
static int BUFFER_SIZE
Constructor Detail
FileDialog
public FileDialog(Shell parent)
- Enabled: Constructs a new instance of this class given only its
parent.
Note: Currently, null can be passed in for the parent.
This has the effect of creating the dialog on the currently active
display if there is one. If there is no current display, the
dialog is created on a "default" display. Passing in null as
the parent is not considered to be good coding style,
and may not be supported in a future release of SWT.
- Parameters:
parent
- a shell which will be the parent of the new instance
FileDialog
public FileDialog(Shell parent,
int style)
- Enabled: 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.
Note: Currently, null can be passed in for the parent.
This has the effect of creating the dialog on the currently active
display if there is one. If there is no current display, the
dialog is created on a "default" display. Passing in null as
the parent is not considered to be good coding style,
and may not be supported in a future release of SWT.
- Parameters:
parent
- a shell which will be the parent of the new instance
Method Detail
getFileName
public String getFileName()
- Enabled: Returns the path of the first file that was
selected in the dialog relative to the filter path
- Returns:
- the relative path of the file
getFileNames
public String[] getFileNames()
- Enabled: Returns the paths of all files that were selected
in the dialog relative to the filter path, or null
if none are available.
- Returns:
- the relative paths of the files
getFilterExtensions
public String[] getFilterExtensions()
- Enabled: Returns the file extensions which the dialog will
use to filter the files it shows.
- Returns:
- the file extensions filter
getFilterNames
public String[] getFilterNames()
- Enabled: Returns the file names which the dialog will
use to filter the files it shows.
- Returns:
- the file name filter
getFilterPath
public String getFilterPath()
- Enabled: Returns the directory path that the dialog will use.
File names in this path will appear in the dialog,
filtered according to the filter extensions.
- Returns:
- the directory path string
- See Also:
setFilterExtensions(java.lang.String[])
open
public String open()
- Enabled: Makes the dialog visible and brings it to the front
of the display.
- Returns:
- a string describing the absolute path of the first selected file,
or null if the dialog was cancelled or an error occurred
setFileName
public void setFileName(String string)
- Enabled: 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
- the file name
setFilterExtensions
public void setFilterExtensions(String[] extensions)
- Enabled: Set the file extensions which the dialog will
use to filter the files it shows to the argument,
which may be null.
- Parameters:
extensions
- the file extension filter
setFilterNames
public void setFilterNames(String[] names)
- Enabled: Sets the file names which the dialog will
use to filter the files it shows to the argument,
which may be null.
- Parameters:
names
- the file name filter
setFilterPath
public void setFilterPath(String string)
- Enabled: 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.
- Parameters:
string
- the directory path- See Also:
setFilterExtensions(java.lang.String[])