Package com.intellij.codeInsight.lookup

Enum AutoCompletionPolicy

java.lang.Object

java.lang.Enum<AutoCompletionPolicy>

com.intellij.codeInsight.lookup.AutoCompletionPolicy

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<AutoCompletionPolicy>

public enum AutoCompletionPolicy
extends java.lang.Enum<AutoCompletionPolicy>

What to do if there's only one element in completion lookup? Should the IDE show lookup or just insert this element? Call applyPolicy(LookupElement) to decorate LookupElement with correct policy. Use this only in simple cases, use CompletionContributor.handleAutoCompletionPossibility(com.intellij.codeInsight.completion.AutoCompletionContext) for finer tuning.

Enum Constant Summary

Enum Constants

Enum Constant and Description
ALWAYS_AUTOCOMPLETE Self-explaining.
GIVE_CHANCE_TO_OVERWRITE If caret is positioned inside an identifier, and 'auto-complete if only one choice' is configured in settings, a lookup with one item will still open, giving user a chance to overwrite the identifier using Tab key
NEVER_AUTOCOMPLETE Self-explaining.
SETTINGS_DEPENDENT If 'auto-complete if only one choice' is configured in settings, the item will be inserted, otherwise - no.

Method Summary

Modifier and Type	Method and Description
LookupElement	applyPolicy(LookupElement element)
static AutoCompletionPolicy	valueOf(java.lang.String name) Returns the enum constant of this type with the specified name.
static AutoCompletionPolicy[]	values() Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

NEVER_AUTOCOMPLETE

public static final AutoCompletionPolicy NEVER_AUTOCOMPLETE

Self-explaining.

SETTINGS_DEPENDENT

public static final AutoCompletionPolicy SETTINGS_DEPENDENT

If 'auto-complete if only one choice' is configured in settings, the item will be inserted, otherwise - no.

GIVE_CHANCE_TO_OVERWRITE

public static final AutoCompletionPolicy GIVE_CHANCE_TO_OVERWRITE

If caret is positioned inside an identifier, and 'auto-complete if only one choice' is configured in settings, a lookup with one item will still open, giving user a chance to overwrite the identifier using Tab key

ALWAYS_AUTOCOMPLETE

public static final AutoCompletionPolicy ALWAYS_AUTOCOMPLETE

Self-explaining.

Method Detail

values

public static AutoCompletionPolicy[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (AutoCompletionPolicy c : AutoCompletionPolicy.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static AutoCompletionPolicy valueOf(java.lang.String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

java.lang.IllegalArgumentException - if this enum type has no constant with the specified name

java.lang.NullPointerException - if the argument is null

applyPolicy

public LookupElement applyPolicy(LookupElement element)