KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > org > netbeans > modules > editor > structure > api > DocumentElementListener


1 /*
2  * The contents of this file are subject to the terms of the Common Development
3  * and Distribution License (the License). You may not use this file except in
4  * compliance with the License.
5  *
6  * You can obtain a copy of the License at http://www.netbeans.org/cddl.html
7  * or http://www.netbeans.org/cddl.txt.
8  *
9  * When distributing Covered Code, include this CDDL Header Notice in each file
10  * and include the License file at http://www.netbeans.org/cddl.txt.
11  * If applicable, add the following below the CDDL Header, with the fields
12  * enclosed by brackets [] replaced by your own identifying information:
13  * "Portions Copyrighted [year] [name of copyright owner]"
14  *
15  * The Original Software is NetBeans. The Initial Developer of the Original
16  * Software is Sun Microsystems, Inc. Portions Copyright 1997-2006 Sun
17  * Microsystems, Inc. All Rights Reserved.
18  */
19
20 package org.netbeans.modules.editor.structure.api;
21
22 import java.util.EventListener JavaDoc;
23
24
25
26 /**
27  * An implementation of EventListener allowing to listen o changes of a DocumentElement.
28  *<br>
29  * Allows to listen on following changes:
30  * <ul>
31  * <li>A child has been added into the element
32  * <li>A child has been removed into the element
33  * <li>Children of the element have been reordered
34  * <li>Text content of the element has changed
35  * <li>Attributes of the element has changed
36  * </ul>
37  *
38  * @author Marek Fukala
39  * @version 1.0
40  * @see DocumentElement
41  * @see DocumentElementEvent
42  */
43 public interface DocumentElementListener extends EventListener JavaDoc {
44
45     //note: there are no events like elementRenamed or elementPositionChanged
46 //1.if the element is renamed then the parent disposes it and creates a new one.
47 //2.the Positions objects changes its inner position representation itself.
48
49     /** fired when a new child has been added into the element. */
50     public void elementAdded(DocumentElementEvent e);
51     
52     /** fired when a child has been removed from the element. */
53     public void elementRemoved(DocumentElementEvent e);
54
55     /** fired when children of the element have been reordered. */
56     public void childrenReordered(DocumentElementEvent e);
57     
58     /** fired when the element's text content has been changed. */
59     public void contentChanged(DocumentElementEvent e);
60     
61     /** fired when attributes of the element have been changed (removed/added/value changed) */
62     public void attributesChanged(DocumentElementEvent e);
63    
64 }
65
Popular Tags