org.eclipse.swt.widgets

Class FileDialog

java.lang.Object

org.eclipse.swt.widgets.Dialog

org.eclipse.swt.widgets.FileDialog

All Implemented Interfaces:

Adaptable

public class FileDialog
extends Dialog

Instances of this class allow the user to navigate the file system and select a file name. The selected file will be uploaded to the server and the path made available as the result of the dialog.

Styles:

MULTI

Events:

(none)

The OPEN style is applied by default and setting any other styles has no effect.

IMPORTANT: This class is intended to be subclassed only within the SWT implementation.

See Also:

FileDialog snippets, SWT Example: ControlExample, Dialog tab, Sample code and further information

Field Summary

Fields inherited from class org.eclipse.swt.widgets.Dialog

returnCode, shell

Constructor Summary

Constructors

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.

Method Summary

Modifier and Type	Method and Description
protected Button	createButton(Composite parent, java.lang.String text)
protected FileUpload	createFileUpload(Composite parent, java.lang.String text)
java.lang.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.
java.lang.String[]	getFileNames() Returns a (possibly empty) array with the paths of all files that were selected in the dialog relative to the filter path.
java.lang.String	open() Makes the dialog visible and brings it to the front of the display.
protected void	prepareOpen()
void	setClientFiles(ClientFile[] files) Sets initial client files to be uploaded.

Methods inherited from class org.eclipse.swt.widgets.Dialog

checkOperationMode, checkSubclass, getAdapter, getParent, getStyle, getText, open, runEventLoop, setText

Methods inherited from class java.lang.Object

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

Constructor Detail

FileDialog

public FileDialog(Shell parent)

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

Parameters:

parent - a shell which will be the parent of the new instance

Throws:

java.lang.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

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 - a shell which will be the parent of the new instance

style - the style of dialog to construct

Throws:

java.lang.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

Method Detail

getFileName

public java.lang.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:

the relative path of the file

getFileNames

public java.lang.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:

the relative paths of the files

setClientFiles

public void setClientFiles(ClientFile[] files)

Sets initial client files to be uploaded. The upload of these files will start immediately after opening the dialog. Hence, this method must be called before opening the dialog.

A user can drag and drop files from the client operating system on any control with a drop listener attached. In this case, the client files can be obtained from the ClientFileTransfer object. This FileDialog can then be used to handle the upload and display upload progress.

Parameters:

files - an array of client files to be added to the dialog

Since:

3.1

open

public java.lang.String open()

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

RAP Note: This method is not supported when running the application in JEE_COMPATIBILITY mode. Use Dialog#open(DialogCallback) instead.

Returns:

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

Throws:

SWTException -

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

prepareOpen

protected void prepareOpen()

Overrides:

prepareOpen in class Dialog

createFileUpload

protected FileUpload createFileUpload(Composite parent,
                                      java.lang.String text)

createButton

protected Button createButton(Composite parent,
                              java.lang.String text)