| java.lang.Object
 edu.rice.cs.drjava.ui.JavadocDialog
| JavadocDialog | | public class JavadocDialog implements DirectorySelector(Code) | | Manages a dialog box that can select a destination directory for generating Javadoc. The getDirectory method should
be called to show the dialog, using the suggested location for the Javadoc as the "start" file. If the user
modifies the selection once, the user's choice will be remembered and no further suggestions will be used.
version:
$Id: JavadocDialog.java 4255 2007-08-28 19:17:37Z mgricken $ |
| Constructor Summary | |
| public | JavadocDialog(JFrame frame)
Creates a new JavadocDialog to show from the given frame. |
| Method Summary | |
| public boolean | askUser(String message, String title)
Asks the user a yes/no question. | | public File | getDirectory(File start)
Shows the dialog prompting the user for a destination directory in which to generate Javadoc.
This operation must be executed from the event-handling thread!
Parameters:
start - The directory to display in the text box. | | public boolean | isRecursive()
| | public void | setSuggestedDir(File dir)
Sets the suggested destination directory for Javadoc generation. | | public void | setUseSuggestion(boolean use)
Sets whether the dialog should use the suggested directory provided
to the getDirectory method as the default location. | | public void | warnUser(String message, String title)
Warns the user about an error condition. |
| JavadocDialog | | public JavadocDialog(JFrame frame)(Code) | | Creates a new JavadocDialog to show from the given frame.
Parameters:
frame - Parent frame of this dialog |
| askUser | | public boolean askUser(String message, String title)(Code) | | Asks the user a yes/no question.
true if the user responded affirmatively, false if negatively |
| getDirectory | | public File getDirectory(File start) throws OperationCanceledException(Code) | | Shows the dialog prompting the user for a destination directory in which to generate Javadoc.
This operation must be executed from the event-handling thread!
Parameters:
start - The directory to display in the text box. If null,the most recent suggested directory (passed in via setSuggestedDir)is displayed, unless the user has modified a previous suggestion. A directory to use for the Javadoc (which might not exist)
throws:
OperationCanceledException - if the selection request is canceled |
| isRecursive | | public boolean isRecursive()(Code) | | |
| setSuggestedDir | | public void setSuggestedDir(File dir)(Code) | | Sets the suggested destination directory for Javadoc generation. This directory will be displayed
in the file field if the user has not modified the suggestion in the past.
Parameters:
dir - Suggested destination directory |
| setUseSuggestion | | public void setUseSuggestion(boolean use)(Code) | | Sets whether the dialog should use the suggested directory provided
to the getDirectory method as the default location.
Parameters:
use - Whether to use the suggested directory |
| warnUser | | public void warnUser(String message, String title)(Code) | | Warns the user about an error condition.
|
|
|