Package com.intellij.codeInsight.lookup

Class LookupArranger

java.lang.Object

com.intellij.codeInsight.lookup.LookupArranger

All Implemented Interfaces:

WeighingContext

Direct Known Subclasses:

LookupArranger.DefaultArranger

public abstract class LookupArranger
extends java.lang.Object
implements WeighingContext

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	LookupArranger.DefaultArranger

Field Summary

Fields

Modifier and Type	Field and Description
protected java.util.List<LookupElement>	myItems

Constructor Summary

Constructors

Constructor and Description
LookupArranger()

Method Summary

Modifier and Type	Method and Description
void	addElement(LookupElement item, LookupElementPresentation presentation)
abstract Pair<java.util.List<LookupElement>,java.lang.Integer>	arrangeItems(Lookup lookup, boolean onExplicitAction)
void	clear()
abstract LookupArranger	createEmptyCopy()
java.util.List<LookupElement>	getMatchingItems()
protected java.util.List<LookupElement>	getPrefixItems(boolean exactly)
java.util.Map<LookupElement,java.util.List<Pair<java.lang.String,java.lang.Object>>>	getRelevanceObjects(java.lang.Iterable<? extends LookupElement> items, boolean hideSingleValued)
boolean	isCompletion()
protected boolean	isPrefixItem(LookupElement item, boolean exactly)
PrefixMatcher	itemMatcher(LookupElement item)
java.lang.String	itemPattern(LookupElement element)
void	itemSelected(LookupElement lookupItem, char completionChar)
void	prefixChanged(Lookup lookup)
void	prefixReplaced(Lookup lookup, java.lang.String newPrefix)
void	prefixTruncated(LookupEx lookup, int hideOffset) Called when the prefix has been truncated farther than the additional prefix typed while the lookup was visible.
void	registerMatcher(LookupElement item, PrefixMatcher matcher)
protected java.util.List<LookupElement>	retainItems(java.util.Set<LookupElement> retained)

Methods inherited from class java.lang.Object

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

Field Detail

myItems

protected final java.util.List<LookupElement> myItems

Constructor Detail

LookupArranger

public LookupArranger()

Method Detail

addElement

public void addElement(LookupElement item,
                       LookupElementPresentation presentation)

clear

public void clear()

registerMatcher

public void registerMatcher(LookupElement item,
                            PrefixMatcher matcher)

itemPattern

public java.lang.String itemPattern(LookupElement element)

Specified by:

itemPattern in interface WeighingContext

itemMatcher

public PrefixMatcher itemMatcher(LookupElement item)

Specified by:

itemMatcher in interface WeighingContext

itemSelected

public void itemSelected(LookupElement lookupItem,
                         char completionChar)

prefixReplaced

public final void prefixReplaced(Lookup lookup,
                                 java.lang.String newPrefix)

prefixChanged

public void prefixChanged(Lookup lookup)

retainItems

protected java.util.List<LookupElement> retainItems(java.util.Set<LookupElement> retained)

arrangeItems

public abstract Pair<java.util.List<LookupElement>,java.lang.Integer> arrangeItems(Lookup lookup,
                                                                                   boolean onExplicitAction)

createEmptyCopy

public abstract LookupArranger createEmptyCopy()

getPrefixItems

protected java.util.List<LookupElement> getPrefixItems(boolean exactly)

isPrefixItem

protected boolean isPrefixItem(LookupElement item,
                               boolean exactly)

getMatchingItems

public java.util.List<LookupElement> getMatchingItems()

getRelevanceObjects

public java.util.Map<LookupElement,java.util.List<Pair<java.lang.String,java.lang.Object>>> getRelevanceObjects(java.lang.Iterable<? extends LookupElement> items,
                                                                                                                boolean hideSingleValued)

Parameters:

items - the items to give relevance weight for

hideSingleValued - whether criteria that gave same values for all items should be skipped

Returns:

for each item, an (ordered) map of criteria used for lookup relevance sorting along with the objects representing the weights in these criteria

prefixTruncated

public void prefixTruncated(LookupEx lookup,
                            int hideOffset)

Called when the prefix has been truncated farther than the additional prefix typed while the lookup was visible.

isCompletion

public boolean isCompletion()