KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > org > netbeans > modules > xml > api > model > HintContext


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.xml.api.model;
21
22 import org.w3c.dom.Node JavaDoc;
23
24 /**
25  * Completion context description that holds additional context information.
26  * Instances can be reliably queried only for properties that represent
27  * references to other nodes such as siblings, parents, attributes, etc.
28  * <p>
29  * <b>Note:</b> this interface is never implemented by a <code>GrammarQuery</code>
30  * provider.
31  *
32  * @author Petr Kuzel
33  */

34 public interface HintContext extends Node JavaDoc {
35
36     /**
37      * Property representing text that already forms context Node.
38      * E.g. for <sample>&lt;elem<blink>|</blink>ent attr="dsD"></sample>
39      * it will return <sample>"elem"</sample> string.
40      * @return String representing prefix as entered by user
41      * that can be used for refining results
42      */

43     String JavaDoc getCurrentPrefix();
44 }
45
46
Popular Tags