KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > bluej > editor > EditorWatcher


1 //Copyright (c) 2000, 2005 BlueJ Group, Deakin University
2 //
3 // This software is made available under the terms of the "MIT License"
4 // A copy of this license is included with this source distribution
5 // in "license.txt" and is also available at:
6 // http://www.opensource.org/licenses/mit-license.html
7 // Any queries should be directed to Michael Kolling mik@bluej.org
8
9 package bluej.editor;
10
11 /**
12  * @version $Id: EditorWatcher.java,v 1.10 2005/05/02 03:23:32 davmac Exp $
13  * @author Michael Kolling
14  * Interface between the editor and the rest of BlueJ
15  * The editor uses this class
16  */
17 public interface EditorWatcher
18 {
19     /**
20      * Called by Editor when a file is changed
21      */
22     void modificationEvent(Editor editor);
23
24     /**
25      * Called by Editor when a file is saved
26      */
27     void saveEvent(Editor editor);
28
29     /**
30      * Called by Editor when it is closed
31      */
32     void closeEvent(Editor editor);
33
34     /**
35      * Called by Editor when a breakpoint is been set/cleared
36      * @param lineNo the line number of the breakpoint
37      * @param set whether the breakpoint is set (true) or cleared
38      * @return An error message or null if okay.
39      */
40     String JavaDoc breakpointToggleEvent(Editor editor, int lineNo,
41                                  boolean set);
42
43     /**
44      * Called by Editor when a file is to be compiled
45      */
46     void compile(Editor editor);
47     
48     /**
49      * Called by Editor when documentation is to be compiled
50      */
51     void generateDoc();
52
53 } // end class EditorWatcher
54
Popular Tags