| edu.rice.cs.drjava.model.javadoc.JavadocModel
All known Subclasses: edu.rice.cs.drjava.model.javadoc.DefaultJavadocModel, edu.rice.cs.drjava.model.javadoc.NoJavadocAvailable,
| JavadocModel | | public interface JavadocModel (Code) | | Model interface for Javadoc integration features.
Note: Implementors should have a constructor taking an IGetDocuments.
version:
$Id: JavadocModel.java 4255 2007-08-28 19:17:37Z mgricken $ |
| Field Summary | |
| final public static String | SUGGESTED_DIR_NAME
Name for the suggested destination directory to be placed in the
source root of one of the open documents. |
| SUGGESTED_DIR_NAME | | final public static String SUGGESTED_DIR_NAME(Code) | | Name for the suggested destination directory to be placed in the
source root of one of the open documents. (Value is "doc".)
|
| addListener | | public void addListener(JavadocListener listener)(Code) | | Add a JavadocListener to the model.
Parameters:
listener - a listener that reacts to Javadoc events |
| isAvailable | | public boolean isAvailable()(Code) | | true iff the classes to run javadoc are available
|
| javadocAll | | public void javadocAll(DirectorySelector select, FileSaveSelector saver) throws IOException(Code) | | Javadocs all open documents, after ensuring that all are saved.
The user provides a destination, and the gm provides the package info.
Parameters:
select - a command object for selecting a directory and warning a userabout bad input
Parameters:
saver - a command object for saving a document (if it moved/changed)
throws:
IOException - if there is a problem manipulating files |
| javadocDocument | | public void javadocDocument(OpenDefinitionsDocument doc, FileSaveSelector saver) throws IOException(Code) | | Generates Javadoc for the given document only, after ensuring it is saved.
Saves the output to a temporary directory, which is provided in the
javadocEnded event on the provided listener.
Parameters:
doc - Document to generate Javadoc for
Parameters:
saver - a command object for saving the document (if it moved/changed)
throws:
IOException - if there is a problem manipulating files |
| removeAllListeners | | public void removeAllListeners()(Code) | | Removes all JavadocListeners from this model.
|
| removeListener | | public void removeListener(JavadocListener listener)(Code) | | Remove a JavadocListener from the model. If the listener is not currently
listening to this model, this method has no effect.
Parameters:
listener - a listener that reacts to Javadoc events |
| resetJavadocErrors | | public void resetJavadocErrors()(Code) | | Clears all current Javadoc errors.
|
| suggestJavadocDestination | | public File suggestJavadocDestination(OpenDefinitionsDocument doc)(Code) | | Suggests a default location for generating Javadoc, based on the given
document's source root. (Appends JavadocModel.SUGGESTED_DIR_NAME to
the sourceroot.)
Parameters:
doc - Document with the source root to use as the default. Suggested destination directory, or null if none could bedetermined. |
|
|