KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > org > netbeans > spi > editor > completion > CompletionDocumentation


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.spi.editor.completion;
21
22 import java.net.URL JavaDoc;
23 import javax.swing.Action JavaDoc;
24
25 /**
26  * The interface of an item that can be displayed in the documentation popup.
27  *
28  * @author Dusan Balek
29  * @version 1.01
30  */
31
32 public interface CompletionDocumentation {
33
34     /**
35      * Returns a HTML text dispaleyd in the documentation popup.
36      */
37     public String JavaDoc getText();
38
39     /**
40      * Returns a URL of the item's external representation that can be displayed
41      * in an external browser or <code>null</code> if the item has no external
42      * representation.
43      */
44     public URL JavaDoc getURL();
45     
46     /**
47      * Returns a documentation item representing an object linked from the item's
48      * HTML text.
49      */
50     public CompletionDocumentation resolveLink(String JavaDoc link);
51     
52     /**
53      * Returns an action that opens the item's source representation in the editor
54      * or <code>null</code> if the item has no source representation.
55      */
56     public Action JavaDoc getGotoSourceAction();
57 }
58
Popular Tags