Package com.intellij.codeInsight.lookup

Class LookupElementDecorator<T extends LookupElement>

java.lang.Object

com.intellij.openapi.util.UserDataHolderBase

com.intellij.codeInsight.lookup.LookupElement

com.intellij.codeInsight.lookup.LookupElementDecorator<T>

All Implemented Interfaces:

UserDataHolder, UserDataHolderEx

Direct Known Subclasses:

CastingLookupElementDecorator, JavaChainLookupElement, JavaConstructorCallElement, JavaRelevantChainLookupElement, PrioritizedLookupElement, SmartCompletionDecorator, TailTypeDecorator, UserColorLookup

public abstract class LookupElementDecorator<T extends LookupElement>
extends LookupElement

See Also:

PrioritizedLookupElement

Field Summary

Fields inherited from class com.intellij.codeInsight.lookup.LookupElement

EMPTY_ARRAY

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	LookupElementDecorator(T delegate)

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 LookupElement.as(Class)
boolean	equals(java.lang.Object o)
java.util.Set<java.lang.String>	getAllLookupStrings()
AutoCompletionPolicy	getAutoCompletionPolicy()
T	getDelegate()
java.lang.String	getLookupString()
java.lang.Object	getObject()
PsiElement	getPsiElement()
void	handleInsert(InsertionContext context)
int	hashCode()
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)
java.lang.String	toString()
static <T extends LookupElement> LookupElementDecorator<T>	withInsertHandler(T element, InsertHandler<? super LookupElementDecorator<T>> insertHandler)
static <T extends LookupElement> LookupElementDecorator<T>	withRenderer(T element, LookupElementRenderer<? super LookupElementDecorator<T>> visagiste)

Methods inherited from class com.intellij.codeInsight.lookup.LookupElement

requiresCommittedDocuments

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

finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

LookupElementDecorator

protected LookupElementDecorator(T delegate)

Method Detail

getDelegate

public T getDelegate()

isValid

public boolean isValid()

Overrides:

isValid in class LookupElement

getLookupString

public java.lang.String getLookupString()

Specified by:

getLookupString in class LookupElement

getAllLookupStrings

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

Overrides:

getAllLookupStrings in class LookupElement

getObject

public java.lang.Object getObject()

Overrides:

getObject in class LookupElement

handleInsert

public void handleInsert(InsertionContext context)

Overrides:

handleInsert in class LookupElement

getAutoCompletionPolicy

public AutoCompletionPolicy getAutoCompletionPolicy()

Overrides:

getAutoCompletionPolicy in class LookupElement

toString

public java.lang.String toString()

Overrides:

toString in class LookupElement

renderElement

public void renderElement(LookupElementPresentation presentation)

Overrides:

renderElement in class LookupElement

equals

public boolean equals(java.lang.Object o)

Overrides:

equals in class java.lang.Object

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

withInsertHandler

public static <T extends LookupElement> LookupElementDecorator<T> withInsertHandler(T element,
                                                                                    InsertHandler<? super LookupElementDecorator<T>> insertHandler)

withRenderer

public static <T extends LookupElement> LookupElementDecorator<T> withRenderer(T element,
                                                                               LookupElementRenderer<? super LookupElementDecorator<T>> visagiste)

as

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

Description copied from class: LookupElement

Prefer to use LookupElement.as(Class)

Overrides:

as in class LookupElement

as

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

Description copied from class: LookupElement

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.

Overrides:

as in class LookupElement

isCaseSensitive

public boolean isCaseSensitive()

Overrides:

isCaseSensitive in class LookupElement

isWorthShowingInAutoPopup

public boolean isWorthShowingInAutoPopup()

Description copied from class: LookupElement

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.

Overrides:

isWorthShowingInAutoPopup in class LookupElement

getPsiElement

public PsiElement getPsiElement()

Overrides:

getPsiElement in class LookupElement

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 LookupElement.getObject() result.