Overview

 
Package  Use  Tree  Deprecated  Index  Help 
Eclipse Platform
Release 3.0
 PREV CLASS   NEXT CLASS FRAMES    NO FRAMES  
SUMMARY: NESTED | FIELD | CONSTR | METHOD DETAIL: FIELD | CONSTR | METHOD


 

org.eclipse.ui.dialogs
Class FileSelectionDialog

java.lang.Object
  extended byorg.eclipse.jface.window.Window
      extended byorg.eclipse.jface.dialogs.Dialog
          extended byorg.eclipse.ui.dialogs.SelectionDialog
              extended byorg.eclipse.ui.dialogs.FileSelectionDialog


Deprecated. Use org.eclipse.swt.widgets.FileDialog,

public class FileSelectionDialog
extends SelectionDialog

A standard file selection dialog which solicits a list of files from the user. The getResult method returns the selected files.

This class may be instantiated; it is not intended to be subclassed.

Example:

    FileSelectionDialog dialog = 
        new FileSelectionDialog(getShell(), rootElement, msg);
    dialog.setInitialSelections(selectedResources);
    dialog.open();
    return dialog.getResult();
 


Nested Class Summary
 
Nested classes inherited from class org.eclipse.jface.window.Window
Window.IExceptionHandler
 
Field Summary
 
Fields inherited from class org.eclipse.jface.dialogs.Dialog
blockedHandler, buttonBar, dialogArea, DLG_IMG_ERROR, DLG_IMG_INFO, DLG_IMG_MESSAGE_ERROR, DLG_IMG_MESSAGE_INFO, DLG_IMG_MESSAGE_WARNING, DLG_IMG_QUESTION, DLG_IMG_WARNING, ELLIPSIS
 
Fields inherited from class org.eclipse.jface.window.Window
CANCEL, OK
 
Constructor Summary
FileSelectionDialog(Shell parentShell, FileSystemElement fileSystemElement, String message)
          Deprecated. Creates a file selection dialog rooted at the given file system element.
 
Method Summary
protected  void configureShell(Shell shell)
          Deprecated. Configures the given shell in preparation for opening this window in it.
 void create()
          Deprecated. Creates this window's widgetry in a new top-level shell.
protected  Control createDialogArea(Composite parent)
          Deprecated. Creates and returns the contents of the upper part of this dialog (above the button bar).
 boolean getExpandAllOnOpen()
          Deprecated. Returns whether the tree view of the file system element will be fully expanded when the dialog is opened.
protected  void okPressed()
          Deprecated. The FileSelectionDialog implementation of this Dialog method builds a list of the selected files for later retrieval by the client and closes this dialog.
 void setExpandAllOnOpen(boolean expandAll)
          Deprecated. Set whether the tree view of the file system element will be fully expanded when the dialog is opened.
 
Methods inherited from class org.eclipse.ui.dialogs.SelectionDialog
createButtonsForButtonBar, createMessageArea, getInitialElementSelections, getInitialSelections, getMessage, getOkButton, getResult, setInitialElementSelections, setInitialSelections, setMessage, setResult, setSelectionResult, setTitle
 
Methods inherited from class org.eclipse.jface.dialogs.Dialog
applyDialogFont, buttonPressed, cancelPressed, close, convertHeightInCharsToPixels, convertHeightInCharsToPixels, convertHorizontalDLUsToPixels, convertHorizontalDLUsToPixels, convertVerticalDLUsToPixels, convertVerticalDLUsToPixels, convertWidthInCharsToPixels, convertWidthInCharsToPixels, createButton, createButtonBar, createContents, dialogFontIsDefault, getBlockedHandler, getButton, getButtonBar, getCancelButton, getDialogArea, getImage, getOKButton, initializeBounds, initializeDialogUnits, setBlockedHandler, setButtonLayoutData, setButtonLayoutFormData, shortenText
 
Methods inherited from class org.eclipse.jface.window.Window
canHandleShellCloseEvent, constrainShellSize, createShell, getConstrainedShellBounds, getContents, getDefaultImage, getDefaultImages, getInitialLocation, getInitialSize, getLayout, getParentShell, getReturnCode, getShell, getShellListener, getShellStyle, getWindowManager, handleFontChange, handleShellCloseEvent, open, setBlockOnOpen, setDefaultImage, setDefaultImages, setExceptionHandler, setReturnCode, setShellStyle, setWindowManager
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

 

 

FileSelectionDialog

public FileSelectionDialog(Shell parentShell,
                           FileSystemElement fileSystemElement,
                           String message)

Deprecated. 
Creates a file selection dialog rooted at the given file system element.

Parameters:
parentShell - the parent shell
fileSystemElement - the root element to populate this dialog with
message - the message to be displayed at the top of this dialog, or null to display a default message
Method Detail

 

 

configureShell

protected void configureShell(Shell shell)

Deprecated. 
Description copied from class: Window
Configures the given shell in preparation for opening this window in it.

The default implementation of this framework method sets the shell's image and gives it a grid layout. Subclasses may extend or reimplement.

Overrides:
configureShell in class SelectionDialog


 

 

create

public void create()

Deprecated. 
Description copied from class: Window
Creates this window's widgetry in a new top-level shell.

The default implementation of this framework method creates this window's shell (by calling createShell), and its controls (by calling createContents), then initializes this window's shell bounds (by calling initializeBounds).

Overrides:
create in class Dialog


 

 

createDialogArea

protected Control createDialogArea(Composite parent)

Deprecated. 
Description copied from class: Dialog
Creates and returns the contents of the upper part of this dialog (above the button bar).

The Dialog implementation of this framework method creates and returns a new Composite with standard margins and spacing.

The returned control's layout data must be an instance of GridData. This method must not modify the parent's layout.

Subclasses must override this method but may call super as in the following example:

 Composite composite = (Composite) super.createDialogArea(parent);
 //add controls to composite as necessary
 return composite;
 

Overrides:
createDialogArea in class Dialog

Parameters:
parent - the parent composite to contain the dialog area
Returns:
the dialog area control


 

 

getExpandAllOnOpen

public boolean getExpandAllOnOpen()

Deprecated. 
Returns whether the tree view of the file system element will be fully expanded when the dialog is opened.

Returns:
true to expand all on dialog open, false otherwise.


 

 

okPressed

protected void okPressed()

Deprecated. 
The FileSelectionDialog implementation of this Dialog method builds a list of the selected files for later retrieval by the client and closes this dialog.

Overrides:
okPressed in class Dialog


 

 

setExpandAllOnOpen

public void setExpandAllOnOpen(boolean expandAll)

Deprecated. 
Set whether the tree view of the file system element will be fully expanded when the dialog is opened.

Parameters:
expandAll - true to expand all on dialog open, false otherwise.


 

Overview

 
Package  Use  Tree  Deprecated  Index  Help 
Eclipse Platform
Release 3.0
 PREV CLASS   NEXT CLASS FRAMES    NO FRAMES  
SUMMARY: NESTED | FIELD | CONSTR | METHOD DETAIL: FIELD | CONSTR | METHOD


Guidelines for using Eclipse APIs.

Copyright (c) IBM Corp. and others 2000, 2004. All rights reserved.