Package com.intellij.codeInsight.completion

Class PrioritizedLookupElement<T extends LookupElement>

java.lang.Object

com.intellij.openapi.util.UserDataHolderBase

com.intellij.codeInsight.lookup.LookupElement

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

com.intellij.codeInsight.completion.PrioritizedLookupElement<T>

All Implemented Interfaces:

UserDataHolder, UserDataHolderEx

public class PrioritizedLookupElement<T extends LookupElement>
extends LookupElementDecorator<T>

Using PrioritizedLookupElement allows to plug into 3 CompletionWeighers: "priority", "explicitProximity" and "grouping". Standard weigher list includes the following ones in the specified order:

• "priority", (see PriorityWeigher class) based on the value passed via withPriority(LookupElement, double)
• "prefix", (see PrefixMatchingWeigher class) checks prefix matching
• "stats", (see StatisticsWeigher class) bubbles up the most frequently used items
• "explicitProximity", (see ExplicitProximityWeigher class) based on the value passed via withExplicitProximity(LookupElement, int)
• "proximity", (see LookupElementProximityWeigher class)
• "grouping", (see GroupingWeigher class) based on the value passed via withGrouping(LookupElement, int)

PrioritizedLookupElement is normally used when you want to control lookup sorting in simple cases, like when you have control over ALL the items in lookup. Be especially careful with using withPriority(LookupElement, double) as the corresponding weigher has the top precedence. Other way to control completion items order is implementing a custom CompletionWeigher, (see CompletionService.RELEVANCE_KEY).

To debug the order of the completion items use 'Dump lookup element weights to log' action when the completion lookup is shown (Ctrl+Alt+Shift+W / Cmd+Alt+Shift+W), the action also copies the debug info to the Clipboard.

See Also:

CompletionContributor

Field Summary

Fields

Modifier and Type	Field and Description
static ClassConditionKey<PrioritizedLookupElement>	CLASS_CONDITION_KEY

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

EMPTY_ARRAY

Method Summary

Modifier and Type	Method and Description
int	getExplicitProximity()
int	getGrouping()
double	getPriority()
static LookupElement	withExplicitProximity(LookupElement element, int explicitProximity)
static LookupElement	withGrouping(LookupElement element, int grouping)
static LookupElement	withPriority(LookupElement element, double priority)

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

as, as, equals, getAllLookupStrings, getAutoCompletionPolicy, getDelegate, getLookupString, getObject, getPsiElement, handleInsert, hashCode, isCaseSensitive, isValid, isWorthShowingInAutoPopup, renderElement, toString, withInsertHandler, withRenderer

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

Field Detail

CLASS_CONDITION_KEY

public static final ClassConditionKey<PrioritizedLookupElement> CLASS_CONDITION_KEY

Method Detail

getPriority

public double getPriority()

getGrouping

public int getGrouping()

getExplicitProximity

public int getExplicitProximity()

withPriority

public static LookupElement withPriority(LookupElement element,
                                         double priority)

withGrouping

public static LookupElement withGrouping(LookupElement element,
                                         int grouping)

withExplicitProximity

public static LookupElement withExplicitProximity(LookupElement element,
                                                  int explicitProximity)