Package com.intellij.codeInsight.completion

Class CompletionParameters

java.lang.Object

com.intellij.codeInsight.completion.CompletionParameters

public final class CompletionParameters
extends java.lang.Object

Constructor Summary

Constructors

Constructor and Description
CompletionParameters(PsiElement position, PsiFile originalFile, CompletionType completionType, int offset, int invocationCount, Editor editor, CompletionProcess process)

Method Summary

Modifier and Type	Method and Description
CompletionType	getCompletionType()
Editor	getEditor()
int	getInvocationCount()
int	getOffset()
PsiFile	getOriginalFile()
PsiElement	getOriginalPosition()
PsiElement	getPosition() Return the leaf PSI element in the "completion file" at offset getOffset().
CompletionProcess	getProcess()
boolean	isAutoPopup()
boolean	isCompleteOnlyNotImported()
boolean	isExtendedCompletion()
boolean	isTestingMode()
void	setCompleteOnlyNotImported(boolean onlyNonImported)
void	setIsTestingMode(boolean runTestingMode)
CompletionParameters	withInvocationCount(int newCount)
CompletionParameters	withPosition(PsiElement element, int offset)
CompletionParameters	withType(CompletionType type)

Methods inherited from class java.lang.Object

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

Constructor Detail

CompletionParameters

public CompletionParameters(PsiElement position,
                            PsiFile originalFile,
                            CompletionType completionType,
                            int offset,
                            int invocationCount,
                            Editor editor,
                            CompletionProcess process)

Method Detail

withType

public CompletionParameters withType(CompletionType type)

withInvocationCount

public CompletionParameters withInvocationCount(int newCount)

getPosition

public PsiElement getPosition()

Return the leaf PSI element in the "completion file" at offset getOffset().

"Completion file" is a PSI file used for completion purposes. Most often it's a non-physical copy of the file being edited (the original file can be accessed from PsiFile.getOriginalFile() or getOriginalFile()).

A special 'dummy identifier' string is inserted to the copied file at caret offset (removing the selection). Most often this string is an identifier (see CompletionInitializationContext.DUMMY_IDENTIFIER). It can be changed via CompletionContributor.beforeCompletion(CompletionInitializationContext) method.

Why? This way there'll always be some non-empty element there, which usually reduces the number of possible cases to be considered inside a CompletionContributor. Also, even if completion was invoked in the middle of a white space, a reference might appear there after dummy identifier is inserted, and its PsiReference.getVariants() can then be suggested.

If the dummy identifier is empty, then the file isn't copied and this method returns whatever is at caret in the original file.

getOriginalPosition

public PsiElement getOriginalPosition()

getOriginalFile

public PsiFile getOriginalFile()

Returns:

the file being edited, possibly injected, where code completion was invoked.

getCompletionType

public CompletionType getCompletionType()

getOffset

public int getOffset()

Returns:

the offset (relative to the file) where code completion was invoked.

getInvocationCount

public int getInvocationCount()

Returns:

0 for autopopup
1 for explicitly invoked completion
>1 for next completion invocations when one lookup is already active

isAutoPopup

public boolean isAutoPopup()

withPosition

public CompletionParameters withPosition(PsiElement element,
                                         int offset)

isExtendedCompletion

public boolean isExtendedCompletion()

getEditor

public Editor getEditor()

Returns:

the editor where the completion was started

getProcess

public CompletionProcess getProcess()

isTestingMode

public boolean isTestingMode()

setIsTestingMode

public void setIsTestingMode(boolean runTestingMode)

isCompleteOnlyNotImported

public boolean isCompleteOnlyNotImported()

setCompleteOnlyNotImported

public void setCompleteOnlyNotImported(boolean onlyNonImported)