Home » Eclipse-SWT-3.5.1 » org.eclipse.swt.widgets » [javadoc | source]
org.eclipse.swt.widgets
public class: DirectoryDialog [javadoc | source]
java.lang.Object
   org.eclipse.swt.widgets.Dialog
      org.eclipse.swt.widgets.DirectoryDialog
Instances of this class allow the user to navigate the file system and select a directory.
Styles:
(none)
Events:
(none)

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

Field Summary
 String message     
 String filterPath     
 String directoryPath     
Fields inherited from org.eclipse.swt.widgets.Dialog:
style,  parent,  title
Constructor:
 public DirectoryDialog(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:
    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

    exception: IllegalArgumentException -
    • ERROR_NULL_ARGUMENT - if the parent is null

    exception: 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

 public DirectoryDialog(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:
    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

    exception: IllegalArgumentException -
    • ERROR_NULL_ARGUMENT - if the parent is null

    exception: 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 from org.eclipse.swt.widgets.DirectoryDialog Summary:
BrowseCallbackProc,   getFilterPath,   getMessage,   open,   setFilterPath,   setMessage
Methods from org.eclipse.swt.widgets.Dialog:
checkParent,   checkStyle,   checkSubclass,   error,   getParent,   getStyle,   getText,   setText
Methods from java.lang.Object:
clone,   equals,   finalize,   getClass,   hashCode,   notify,   notifyAll,   toString,   wait,   wait,   wait
Method from org.eclipse.swt.widgets.DirectoryDialog Detail:
 int BrowseCallbackProc(int hwnd,
    int uMsg,
    int lParam,
    int lpData) 
 public String getFilterPath() 
    Returns the path which the dialog will use to filter the directories it shows.
 public String getMessage() 
    Returns the dialog's message, which is a description of the purpose for which it was opened. This message will be visible on the dialog while it is open.
 public String open() 
    Makes the dialog visible and brings it to the front of the display.
 public  void setFilterPath(String string) 
    Sets the path that the dialog will use to filter the directories it shows to the argument, which may be null. 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.

 public  void setMessage(String string) 
    Sets the dialog's message, which is a description of the purpose for which it was opened. This message will be visible on the dialog while it is open.