Source code: javax/ide/editor/EditorListener.java
1 package javax.ide.editor;
2
3 import java.util.EventListener;
4
5 /**
6 * The <code>EditorListener</code> interface should be
7 * implemented by clients that are interested in receiving
8 * notifications about <code>Editor</code> instances being opened,
9 * activated, deactivated, or closed in the IDE. <p>
10 *
11 * This allows clients to attach to or detach from the given Editor
12 * for the purpose of providing extra functionality. For example, the
13 * debugger may use this for determining when a Code Editor is opened
14 * so that it can display the breakpoint icon locations properly. <p>
15 *
16 * Clients should register listeners with the EditorManager singleton
17 * instance. When an editor is opened, the <code>opened()</code>
18 * method will be called. When an editor is about to be closed, the
19 * <code>closed()</code> method will be called. <p>
20 *
21 * @see Editor
22 * @see EditorManager
23 * @see EditorEvent
24 */
25 public interface EditorListener extends EventListener
26 {
27 /**
28 * Notify listeners that a new Editor has been opened. This method
29 * is called after an Editor is opened, and its <code>open()</code>
30 * method called.
31 * @param event the {@link EditorEvent} object.
32 */
33 public void opened( EditorEvent event );
34
35 /**
36 * Notify listeners that an existing Editor has been activated.
37 * This method is called after an Editor is activated, and its
38 * <code>activate()</code> method called.
39 * @param event the {@link EditorEvent} object.
40 */
41 public void activated( EditorEvent event );
42
43 /**
44 * Notify listeners that an existing Editor listener is
45 * de-activated. This methodis called after an Editor is
46 * deactivated, and its <code>deactivate()</code> method called.
47 * @param event the {@link EditorEvent} object.
48 */
49 public void deactivated( EditorEvent event );
50
51 /**
52 * Notify listeners that an existing Editor is being closed. This
53 * method is called right before an Editor's <code>close()</code>
54 * method is called.
55 * @param event the {@link EditorEvent} object.
56 */
57 public void closed( EditorEvent event );
58 }