KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > org > netbeans > editor > ext > CompletionView


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.editor.ext;
21
22 /**
23 * Code copmletion view component interface. It best fits the <tt>JList</tt>
24 * but some users may require something else e.g. JTable for displaying
25 * the result of the completion query.
26 *
27 * @author Miloslav Metelka
28 * @version 1.00
29 */
30
31 public interface CompletionView {
32
33     /**
34      * Populate the view with the result from a query.
35      * @param result completions query result or <code>null</code> if not
36      * computed yet.
37      */
38     public void setResult(CompletionQuery.Result result);
39
40     /** Get the index of the currently selected item. */
41     public int getSelectedIndex();
42
43     /** Go up to the previous item in the data list.
44     * The <tt>getSelectedIndex</tt> must reflect the change.
45     */
46     public void up();
47
48     /** Go down to the next item in the data list.
49     * The <tt>getSelectedIndex</tt> must reflect the change.
50     */
51     public void down();
52
53     /** Go up one page in the data item list.
54     * The <tt>getSelectedIndex</tt> must reflect the change.
55     */
56     public void pageUp();
57
58     /** Go down one page in the data item list.
59     * The <tt>getSelectedIndex</tt> must reflect the change.
60     */
61     public void pageDown();
62
63     /** Go to the first item in the data item list.
64     * The <tt>getSelectedIndex</tt> must reflect the change.
65     */
66     public void begin();
67
68     /** Go to the last item in the data item list.
69     * The <tt>getSelectedIndex</tt> must reflect the change.
70     */
71     public void end();
72
73 }
74
Popular Tags