diff options
Diffstat (limited to 'bundles/org.eclipse.swt/Eclipse SWT/motif/org/eclipse/swt/widgets/DirectoryDialog.java')
-rwxr-xr-x | bundles/org.eclipse.swt/Eclipse SWT/motif/org/eclipse/swt/widgets/DirectoryDialog.java | 111 |
1 files changed, 101 insertions, 10 deletions
diff --git a/bundles/org.eclipse.swt/Eclipse SWT/motif/org/eclipse/swt/widgets/DirectoryDialog.java b/bundles/org.eclipse.swt/Eclipse SWT/motif/org/eclipse/swt/widgets/DirectoryDialog.java index 28048caa14..2543e841c1 100755 --- a/bundles/org.eclipse.swt/Eclipse SWT/motif/org/eclipse/swt/widgets/DirectoryDialog.java +++ b/bundles/org.eclipse.swt/Eclipse SWT/motif/org/eclipse/swt/widgets/DirectoryDialog.java @@ -1,29 +1,82 @@ package org.eclipse.swt.widgets;
/*
-* Licensed Materials - Property of IBM,
-* SWT - The Simple Widget Toolkit,
-* (c) Copyright IBM Corp 1998, 1999.
-*/
+ * (c) Copyright IBM Corp. 2000, 2001.
+ * All Rights Reserved
+ */
-/* Imports */
import org.eclipse.swt.internal.*;
import org.eclipse.swt.internal.motif.*;
import org.eclipse.swt.*;
-/**
-* A DirectoryDialog allows the user to navigate
-* the file and select a directory.
-*/
+/** + * Instances of this class allow the user to navigate + * the file system and select a directory. + * <p> + * IMPORTANT: This class is intended to be subclassed <em>only</em> + * within the SWT implementation. + * </p> + */
-/* Class Definition */
public /*final*/ class DirectoryDialog extends Dialog {
String filterPath = "";
boolean cancel = true;
String message = "";
+/** + * Constructs a new instance of this class given only its + * parent. + * <p> + * 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. <b>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.</b> + * </p> + * + * @param parent a shell which will be the parent of the new instance + * + * @exception IllegalArgumentException <ul> + * <li>ERROR_NULL_ARGUMENT - if the parent is null</li> + * </ul> + * @exception SWTException <ul> + * <li>ERROR_THREAD_INVALID_ACCESS - if not called from the thread that created the parent</li> + * <li>ERROR_INVALID_SUBCLASS - if this class is not an allowed subclass</li> + * </ul> + */ public DirectoryDialog (Shell parent) {
this (parent, SWT.PRIMARY_MODAL);
}
+/** + * Constructs a new instance of this class given its parent + * and a style value describing its behavior and appearance. + * <p> + * The style value is either one of the style constants defined in + * class <code>SWT</code> which is applicable to instances of this + * class, or must be built by <em>bitwise OR</em>'ing together + * (that is, using the <code>int</code> "|" operator) two or more + * of those <code>SWT</code> style constants. The class description + * for all SWT dialog classes should include a comment which + * describes the style constants which are applicable to the class. + * </p> + * 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. <b>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.</b> + * </p> + * + * @param parent a shell which will be the parent of the new instance + * + * @exception IllegalArgumentException <ul> + * <li>ERROR_NULL_ARGUMENT - if the parent is null</li> + * </ul> + * @exception SWTException <ul> + * <li>ERROR_THREAD_INVALID_ACCESS - if not called from the thread that created the parent</li> + * <li>ERROR_INVALID_SUBCLASS - if this class is not an allowed subclass</li> + * </ul> + */ public DirectoryDialog (Shell parent, int style) {
super (parent, style);
}
@@ -32,12 +85,36 @@ int activate (int widget, int client, int call) { OS.XtUnmanageChild (widget);
return 0;
}
+/** + * Returns the path which the receiver will use to filter + * the directories it shows. + * + * @return the filter path + */ public String getFilterPath () {
return filterPath;
}
+/** + * Returns the receiver's message, which is a description of + * the purpose for which it was opened. This message will be + * visible on the receiver while it is open. + * + * @return the message + */ public String getMessage () {
return message;
}
+/** + * Makes the receiver visible and brings it to the front + * of the display. + * + * @return a string describing the absolute path of the selected directory + * + * @exception SWTException <ul> + * <li>ERROR_WIDGET_DISPOSED - if the receiver has been disposed</li> + * <li>ERROR_THREAD_INVALID_ACCESS - if not called from the thread that created the receiver</li> + * </ul> + */ public String open () {
/* Get the parent */
@@ -211,9 +288,23 @@ public String open () { if (cancel) return null;
return directoryPath;
}
+/** + * Sets the path which the receiver will use to filter + * the directories it shows to the argument, which may be + * null. + * + * @param string the filter path + */ public void setFilterPath (String string) {
filterPath = string;
}
+/** + * Sets the receiver's message, which is a description of + * the purpose for which it was opened. This message will be + * visible on the receiver while it is open. + * + * @param string the message + */ public void setMessage (String string) {
message = string;
}
|