Package com.intellij.codeInsight.completion

Class WordCompletionContributor

java.lang.Object

com.intellij.codeInsight.completion.CompletionContributor

com.intellij.codeInsight.completion.WordCompletionContributor

All Implemented Interfaces:

DumbAware

public class WordCompletionContributor
extends CompletionContributor
implements DumbAware

Field Summary

Fields inherited from class com.intellij.codeInsight.completion.CompletionContributor

EP

Constructor Summary

Constructors

Constructor and Description
WordCompletionContributor()

Method Summary

Modifier and Type	Method and Description
static void	addWordCompletionVariants(CompletionResultSet result, CompletionParameters parameters, java.util.Set<java.lang.String> excludes)
static void	addWordCompletionVariants(CompletionResultSet result, CompletionParameters parameters, java.util.Set<java.lang.String> excludes, boolean allowEmptyPrefix)
void	beforeCompletion(CompletionInitializationContext context) Invoked before completion is started.
void	fillCompletionVariants(CompletionParameters parameters, CompletionResultSet result) The main contributor method that is supposed to provide completion variants to result, based on completion parameters.

Methods inherited from class com.intellij.codeInsight.completion.CompletionContributor

advertise, duringCompletion, extend, forLanguage, forLanguageHonorDumbness, forParameters, handleAutoCompletionPossibility, handleEmptyLookup, invokeAutoPopup

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

WordCompletionContributor

public WordCompletionContributor()

Method Detail

beforeCompletion

public void beforeCompletion(CompletionInitializationContext context)

Description copied from class: CompletionContributor

Invoked before completion is started. Is used mainly for determining custom offsets in editor, and to change default dummy identifier.

Overrides:

beforeCompletion in class CompletionContributor

fillCompletionVariants

public void fillCompletionVariants(CompletionParameters parameters,
                                   CompletionResultSet result)

Description copied from class: CompletionContributor

The main contributor method that is supposed to provide completion variants to result, based on completion parameters. The default implementation looks for CompletionProviders you could register by invoking CompletionContributor.extend(CompletionType, ElementPattern, CompletionProvider) from your contributor constructor, matches the desired completion type and ElementPattern with actual ones, and, depending on it, invokes those completion providers.

If you want to implement this functionality directly by overriding this method, the following is for you. Always check that parameters match your situation, and that completion type (CompletionParameters.getCompletionType() is of your favourite kind. This method is run inside a read action. If you do any long activity non-related to PSI in it, please ensure you call ProgressManager.checkCanceled() often enough so that the completion process can be cancelled smoothly when the user begins to type in the editor.

Overrides:

fillCompletionVariants in class CompletionContributor

addWordCompletionVariants

public static void addWordCompletionVariants(CompletionResultSet result,
                                             CompletionParameters parameters,
                                             java.util.Set<java.lang.String> excludes)

addWordCompletionVariants

public static void addWordCompletionVariants(CompletionResultSet result,
                                             CompletionParameters parameters,
                                             java.util.Set<java.lang.String> excludes,
                                             boolean allowEmptyPrefix)