Package com.intellij.util.textCompletion

Class ValuesCompletionProvider<T>

java.lang.Object

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

Type Parameters:

T - completion element type.

All Implemented Interfaces:

TextCompletionProvider

Direct Known Subclasses:

TwoStepCompletionProvider, ValuesCompletionProvider.ValuesCompletionProviderDumbAware

public class ValuesCompletionProvider<T>
extends java.lang.Object
implements TextCompletionProvider

Completion provider for a fixed collection of elements. See ValuesCompletionProvider.ValuesCompletionProviderDumbAware for dumb aware version.

Completion elements and their presentation (represented with TextCompletionValueDescriptor) are provided in constructor. Use TextFieldWithCompletion to create a text field component with completion.

Completion is done via TextFieldCompletionProvider.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
class	ValuesCompletionProvider.CompletionCharInsertHandler
static class	ValuesCompletionProvider.ValuesCompletionProviderDumbAware<T>

Field Summary

Fields

Modifier and Type	Field and Description
protected TextCompletionValueDescriptor<T>	myDescriptor
protected java.util.Collection<? extends T>	myValues

Constructor Summary

Constructors

Constructor and Description
ValuesCompletionProvider(TextCompletionValueDescriptor<T> presentation, java.util.Collection<? extends T> values) Creates a completion provider for selecting single value from a list of values.
ValuesCompletionProvider(TextCompletionValueDescriptor<T> descriptor, java.util.List<java.lang.Character> separators, java.util.Collection<? extends T> values, boolean caseSensitive) Create a completion provider.

Method Summary

Modifier and Type	Method and Description
CharFilter.Result	acceptChar(char c)
CompletionResultSet	applyPrefixMatcher(CompletionResultSet result, java.lang.String prefix)
void	fillCompletionVariants(CompletionParameters parameters, java.lang.String prefix, CompletionResultSet result)
java.lang.String	getAdvertisement()
java.lang.String	getPrefix(java.lang.String text, int offset)
protected static java.lang.String	getPrefix(java.lang.String text, int offset, java.util.Collection<java.lang.Character> separators)
protected java.util.Collection<? extends T>	getValues(java.lang.String prefix, CompletionResultSet result)
protected LookupElement	installInsertHandler(LookupElementBuilder builder)

Methods inherited from class java.lang.Object

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

Field Detail

myDescriptor

protected final TextCompletionValueDescriptor<T> myDescriptor

myValues

protected final java.util.Collection<? extends T> myValues

Constructor Detail

ValuesCompletionProvider

public ValuesCompletionProvider(TextCompletionValueDescriptor<T> descriptor,
                                java.util.List<java.lang.Character> separators,
                                java.util.Collection<? extends T> values,
                                boolean caseSensitive)

Create a completion provider.

Parameters:

descriptor - descriptor for completion values (text, icons, etc).

separators - characters that separate values in the editor (like new line or space). If user is supposed to choose only one value this list should be empty.

values - values to show in completion.

caseSensitive - is completion case-sensitive.

ValuesCompletionProvider

public ValuesCompletionProvider(TextCompletionValueDescriptor<T> presentation,
                                java.util.Collection<? extends T> values)

Creates a completion provider for selecting single value from a list of values. Completion is case-insensitive.

Parameters:

presentation - descriptor for completion values.

values - list of values.

Method Detail

getAdvertisement

public java.lang.String getAdvertisement()

Specified by:

getAdvertisement in interface TextCompletionProvider

getPrefix

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

Specified by:

getPrefix in interface TextCompletionProvider

getPrefix

protected static java.lang.String getPrefix(java.lang.String text,
                                            int offset,
                                            java.util.Collection<java.lang.Character> separators)

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

installInsertHandler

protected LookupElement installInsertHandler(LookupElementBuilder builder)

getValues

protected java.util.Collection<? extends T> getValues(java.lang.String prefix,
                                                      CompletionResultSet result)