Package com.intellij.codeInsight.lookup

Class LookupElement

java.lang.Object

com.intellij.openapi.util.UserDataHolderBase

com.intellij.codeInsight.lookup.LookupElement

All Implemented Interfaces:

UserDataHolder, UserDataHolderEx

Direct Known Subclasses:

ChainCompletionNewVariableLookupElement, EmptyLookupItem, ExpressionLookupItem, ExternalProjectPathLookupElement, FilePathCompletionContributor.FilePathLookupItem, FunctionLookup, JavaGlobalMemberLookupElement, KeywordLookupItem, LiveTemplateLookupElement, LookupElementBuilder, LookupElementDecorator, MutableLookupElement, NamespaceLookup, PackageLookupItem, PsiTypeCanonicalLookupElement, PythonLookupElement, SimpleMethodCallLookupElement

public abstract class LookupElement
extends UserDataHolderBase

A typical way to create lookup element is to use LookupElementBuilder. Another way is to subclass it. Use the latter way only if you need it to implement some additional interface, to modify equals/hashCode or other advanced logic.

See Also:

PrioritizedLookupElement

Field Summary

Fields

Modifier and Type	Field and Description
static LookupElement[]	EMPTY_ARRAY

Constructor Summary

Constructors

Constructor and Description
LookupElement()

Method Summary

Modifier and Type	Method and Description
<T> T	as(java.lang.Class<T> clazz) Return the first element of the given class in a LookupElementDecorator wrapper chain.
<T> T	as(ClassConditionKey<T> conditionKey) Prefer to use as(Class)
java.util.Set<java.lang.String>	getAllLookupStrings()
AutoCompletionPolicy	getAutoCompletionPolicy()
abstract java.lang.String	getLookupString()
java.lang.Object	getObject()
PsiElement	getPsiElement()
void	handleInsert(InsertionContext context)
boolean	isCaseSensitive()
boolean	isValid()
boolean	isWorthShowingInAutoPopup() Invoked when the completion autopopup contains only the items that exactly match the user-entered prefix to determine whether the popup should be closed to not get in the way when navigating through the code.
void	renderElement(LookupElementPresentation presentation)
boolean	requiresCommittedDocuments()
java.lang.String	toString()

Methods inherited from class com.intellij.openapi.util.UserDataHolderBase

changeUserMap, clearUserData, clone, copyCopyableDataTo, copyUserDataTo, getCopyableUserData, getUserData, getUserDataString, getUserMap, isUserDataEmpty, putCopyableUserData, putUserData, putUserDataIfAbsent, replace, setUserMap

Methods inherited from class java.lang.Object

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

Field Detail

EMPTY_ARRAY

public static final LookupElement[] EMPTY_ARRAY

Constructor Detail

LookupElement

public LookupElement()

Method Detail

getLookupString

public abstract java.lang.String getLookupString()

getAllLookupStrings

public java.util.Set<java.lang.String> getAllLookupStrings()

getObject

public java.lang.Object getObject()

getPsiElement

public PsiElement getPsiElement()

Returns:

a PSI element associated with this lookup element. It's used for navigation, showing quick documentation and sorting by proximity to the current location. The default implementation tries to extract PSI element from getObject() result.

isValid

public boolean isValid()

handleInsert

public void handleInsert(InsertionContext context)

requiresCommittedDocuments

public boolean requiresCommittedDocuments()

Returns:

whether handleInsert(com.intellij.codeInsight.completion.InsertionContext) expects all documents to be committed at the moment of its invocation. The default is true, overriders can change that, for example if automatic commit is too slow.

getAutoCompletionPolicy

public AutoCompletionPolicy getAutoCompletionPolicy()

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

renderElement

public void renderElement(LookupElementPresentation presentation)

as

public <T> T as(ClassConditionKey<T> conditionKey)

Prefer to use as(Class)

as

public <T> T as(java.lang.Class<T> clazz)

Return the first element of the given class in a LookupElementDecorator wrapper chain. If this object is not a decorator, return it if it's instance of the given class, otherwise null.

isCaseSensitive

public boolean isCaseSensitive()

isWorthShowingInAutoPopup

public boolean isWorthShowingInAutoPopup()

Invoked when the completion autopopup contains only the items that exactly match the user-entered prefix to determine whether the popup should be closed to not get in the way when navigating through the code. Should return true if there's some meaningful information in this item's presentation that the user will miss if the autopopup is suddenly closed automatically. Java method parameters are a good example. For simple variables, there's nothing else interesting besides the variable name which is already entered in the editor, so the autopopup may be closed.