/*
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
*
* Copyright 1997-2010 Oracle and/or its affiliates. All rights reserved.
*
* Oracle and Java are registered trademarks of Oracle and/or its affiliates.
* Other names may be trademarks of their respective owners.
*
* The contents of this file are subject to the terms of either the GNU
* General Public License Version 2 only ("GPL") or the Common
* Development and Distribution License("CDDL") (collectively, the
* "License"). You may not use this file except in compliance with the
* License. You can obtain a copy of the License at
* http://www.netbeans.org/cddl-gplv2.html
* or nbbuild/licenses/CDDL-GPL-2-CP. See the License for the
* specific language governing permissions and limitations under the
* License. When distributing the software, include this License Header
* Notice in each file and include the License file at
* nbbuild/licenses/CDDL-GPL-2-CP. Oracle designates this
* particular file as subject to the "Classpath" exception as provided
* by Oracle in the GPL Version 2 section of the License file that
* accompanied this code. If applicable, add the following below the
* License Header, with the fields enclosed by brackets [] replaced by
* your own identifying information:
* "Portions Copyrighted [year] [name of copyright owner]"
*
* Contributor(s):
*
* The Original Software is NetBeans. The Initial Developer of the Original
* Software is Sun Microsystems, Inc. Portions Copyright 1997-2006 Sun
* Microsystems, Inc. All Rights Reserved.
*
* If you wish your version of this file to be governed by only the CDDL
* or only the GPL Version 2, indicate your decision by adding
* "[Contributor] elects to include this software in this distribution
* under the [CDDL or GPL Version 2] license." If you do not indicate a
* single choice of license, a recipient has the option to distribute
* your version of this file under either the CDDL, the GPL Version 2 or
* to extend the choice of license to its licensees as provided above.
* However, if you add GPL Version 2 code and therefore, elected the GPL
* Version 2 license, then the option applies only if the new code is
* made subject to such option by the copyright holder.
*/
package com.tvl.spi.editor.completion;
import javax.swing.text.JTextComponent;
import org.netbeans.spi.editor.mimelookup.MimeLocation;
/**
* The basic interface for providing code completion items. You should implement this interface
* if you want to provide items that are available to users when they invoke code completion in
* a text document. You should register your implementation on the system FileSystem under the
* <code>Editors/<mime-type></code> folder. The registered implementation will then be used
* for documents that are of the specified <code>mime-type</code>.
* <p><b>Related documentation</b></p>
* <ul>
* <li><a href="http://platform.netbeans.org/tutorials/nbm-code-completion.html">NetBeans Code Completion Tutorial</a></li>
* </ul>
*
* @author Miloslav Metelka, Dusan Balek
* @version 1.01
*/
@MimeLocation(subfolderName="CompletionProviders")
public interface CompletionProvider {
/**
* The <code>int</code> value representing the query for a code completion.
*/
public static final int COMPLETION_QUERY_TYPE = 0x01;
/**
* The <code>int</code> value representing the query for a documentation.
*/
public static final int DOCUMENTATION_QUERY_TYPE = 0x02;
/**
* The <code>int</code> value representing the query for a tooltip hint.
*/
public static final int TOOLTIP_QUERY_TYPE = 0x04;
/**
* The <code>int</code> value representing the query for an all code completion.
*/
public static final int COMPLETION_ALL_QUERY_TYPE = 0x11;
/**
* The <code>int</code> mask representing the bits used for a completion query type.
*/
public static final int COMPLETION_QUERY_MASK = COMPLETION_QUERY_TYPE | COMPLETION_ALL_QUERY_TYPE;
/**
* The <code>int</code> mask of bits a user can specify to customize the query type.
*/
public static final int USER_QUERY_MASK = 0xFFFF0000;
/**
* The <code>int</code> mask of bits used by the API to specify the query type.
*/
public static final int RESERVED_QUERY_MASK = ~USER_QUERY_MASK;
/**
* Creates a task that performs a query of the given type on the given component.
*
* <p>This method is invoked in AWT thread only and the returned task
* may either be synchronous (if it's not complex)
* or it may be asynchronous
* (see {@link org.netbeans.spi.editor.completion.support.AsyncCompletionTask}).
*
* <p class="nonnormative">The task usually inspects the component's document, the
* text up to the caret position and returns the appropriate result.
*
* @param queryType Type of the query. It can be one of the {@link #COMPLETION_QUERY_TYPE},
* {@link #COMPLETION_ALL_QUERY_TYPE}, {@link #DOCUMENTATION_QUERY_TYPE},
* or {@link #TOOLTIP_QUERY_TYPE} (but not their combination).
* @param component A text component where the query should be performed.
*
* @return A task performing the query.
*/
public CompletionTask createTask(int queryType, JTextComponent component);
/**
* Determines whether text typed in a document should automatically pop up the code completion
* window. This method is called by the code completion infrastructure only to check whether
* text that has just been typed into a text component triggers an automatic query invocation.
*
* <p>An implementation of this method can return any combination of the query type constants
* available in this interface to tell the infrastructure that it should call {@link #createTask(int, JTextComponent)}
* and show the code completion window. Or it can return zero if the typed text does not trigger
* popping up the code completion window.
*
* <p class="nonnormative">Please note that there could be multiple <code>CompletionProvider</code>s registered for
* the same mime type and this method is called for all of them. This means that even if a particular
* implementation does not want the code completion window to pop up for the typed text (ie. returns zero
* from this method) there could be others that recognize the text as a trigger and will return non-zero.
* If at least one of the registered <code>CompletionProvider</code>s returns
* non-zero from this method the infrastructure will call <code>createTask</code> in all the registered
* implementations asking them to provide completion items for the requested query type.
*
* @param component A component in which the text was typed.
* @param typedText Typed text.
*
* @return Any combination of the {@link #COMPLETION_QUERY_TYPE}, {@link #COMPLETION_ALL_QUERY_TYPE},
* {@link #DOCUMENTATION_QUERY_TYPE}, and {@link #TOOLTIP_QUERY_TYPE}
* values, or zero if no query should be automatically invoked.
*/
public int getAutoQueryTypes(JTextComponent component, String typedText);
}