KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > org > openide > text > AnnotationProvider


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 package org.openide.text;
20
21 import org.openide.util.Lookup;
22
23
24 /**
25  * A provider of annotations for given context.
26  *
27  * Implementations of this interface are looked up in the global lookup
28  * and called to let them attach annotations to the lines in the set.
29  * The call is performed during opening of given context.
30  *
31  * @author Petr Nejedly
32  * @since 4.30
33  */
34 public interface AnnotationProvider {
35     /**
36      * Attach annotations to the Line.Set for given context.
37      *
38      * @param set the Line.Set to attach annotations to.
39      * @param context a Lookup describing the context for the Line.Set.
40      * If the Line.Set is associated with a document originating from
41      * a file, the context shall contain the respective FileObject.
42      */
43     public void annotate(Line.Set set, Lookup context);
44 }
45
Popular Tags