Package com.intellij.ui

Class TextFieldWithAutoCompletionListProvider<T>

java.lang.Object

com.intellij.util.textCompletion.DefaultTextCompletionValueDescriptor<T>

com.intellij.ui.TextFieldWithAutoCompletionListProvider<T>

All Implemented Interfaces:

TextCompletionProvider, TextCompletionValueDescriptor<T>, java.util.Comparator<T>

Direct Known Subclasses:

TaskAutoCompletionListProvider, TextFieldWithAutoCompletion.StringsCompletionProvider

public abstract class TextFieldWithAutoCompletionListProvider<T>
extends DefaultTextCompletionValueDescriptor<T>
implements TextCompletionProvider

Extend this provider for:

1. caching (implement getItems(String, boolean, CompletionParameters), see fillCompletionVariants(CompletionParameters, String, CompletionResultSet));
2. changing completion variants (see setItems(Collection)).

Otherwise, use ValuesCompletionProvider for completion from a fixed set of elements or TextFieldCompletionProvider in other cases.

Nested Class Summary

Nested classes/interfaces inherited from class com.intellij.util.textCompletion.DefaultTextCompletionValueDescriptor

DefaultTextCompletionValueDescriptor.StringValueDescriptor

Field Summary

Fields

Modifier and Type	Field and Description
protected java.util.Collection<T>	myVariants

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	TextFieldWithAutoCompletionListProvider(java.util.Collection<T> variants)

Method Summary

Modifier and Type	Method and Description
CharFilter.Result	acceptChar(char c)
CompletionResultSet	applyPrefixMatcher(CompletionResultSet result, java.lang.String prefix)
PrefixMatcher	createPrefixMatcher(java.lang.String prefix)
void	fillCompletionVariants(CompletionParameters parameters, java.lang.String prefix, CompletionResultSet result)
java.lang.String	getAdvertisement() Completion list advertisement text, if null advertisement for documentation popup will be shown
static java.lang.String	getCompletionPrefix(CompletionParameters parameters)
java.util.Collection<T>	getItems(java.lang.String prefix, boolean cached, CompletionParameters parameters)
java.lang.String	getPrefix(java.lang.String text, int offset)
protected java.lang.String	getQuickDocHotKeyAdvertisementTail(java.lang.String shortcut)
void	setAdvertisement(java.lang.String completionAdvertisement)
void	setItems(java.util.Collection<T> variants)

Methods inherited from class com.intellij.util.textCompletion.DefaultTextCompletionValueDescriptor

compare, createInsertHandler, createLookupBuilder, getIcon, getLookupString, getTailText, getTypeText

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.util.Comparator

comparing, comparing, comparingDouble, comparingInt, comparingLong, equals, naturalOrder, nullsFirst, nullsLast, reversed, reverseOrder, thenComparing, thenComparing, thenComparing, thenComparingDouble, thenComparingInt, thenComparingLong

Field Detail

myVariants

protected java.util.Collection<T> myVariants

Constructor Detail

TextFieldWithAutoCompletionListProvider

protected TextFieldWithAutoCompletionListProvider(java.util.Collection<T> variants)

Method Detail

getPrefix

public java.lang.String getPrefix(java.lang.String text,
                                  int offset)

Specified by:

getPrefix in interface TextCompletionProvider

applyPrefixMatcher

public CompletionResultSet applyPrefixMatcher(CompletionResultSet result,
                                              java.lang.String prefix)

Specified by:

applyPrefixMatcher in interface TextCompletionProvider

acceptChar

public CharFilter.Result acceptChar(char c)

Specified by:

acceptChar in interface TextCompletionProvider

fillCompletionVariants

public void fillCompletionVariants(CompletionParameters parameters,
                                   java.lang.String prefix,
                                   CompletionResultSet result)

Specified by:

fillCompletionVariants in interface TextCompletionProvider

setItems

public void setItems(java.util.Collection<T> variants)

getItems

public java.util.Collection<T> getItems(java.lang.String prefix,
                                        boolean cached,
                                        CompletionParameters parameters)

getAdvertisement

public java.lang.String getAdvertisement()

Completion list advertisement text, if null advertisement for documentation popup will be shown

Specified by:

getAdvertisement in interface TextCompletionProvider

Returns:

text

getQuickDocHotKeyAdvertisementTail

protected java.lang.String getQuickDocHotKeyAdvertisementTail(java.lang.String shortcut)

setAdvertisement

public void setAdvertisement(java.lang.String completionAdvertisement)

createPrefixMatcher

public PrefixMatcher createPrefixMatcher(java.lang.String prefix)

getCompletionPrefix

public static java.lang.String getCompletionPrefix(CompletionParameters parameters)