Package com.intellij.codeInsight.lookup

Interface Lookup

All Known Subinterfaces:

LookupEx

All Known Implementing Classes:

LookupImpl

public interface Lookup

Represents list with suggestions shown in code completion, refactorings, live templates etc.

Field Summary

Fields

Modifier and Type	Field and Description
static char	AUTO_INSERT_SELECT_CHAR
static char	COMPLETE_STATEMENT_SELECT_CHAR
static char	NORMAL_SELECT_CHAR
static char	REPLACE_SELECT_CHAR

Method Summary

Modifier and Type	Method and Description
void	addLookupListener(LookupListener listener)
java.util.List<java.lang.String>	getAdvertisements()
java.awt.Rectangle	getBounds()
LookupElement	getCurrentItem()
java.awt.Rectangle	getCurrentItemBounds()
Editor	getEditor() Consider using getTopLevelEditor() if you don't need injected editor.
java.util.List<LookupElement>	getItems()
int	getLookupStart()
Project	getProject()
PsiElement	getPsiElement()
PsiFile	getPsiFile()
Editor	getTopLevelEditor()
boolean	isCompletion()
boolean	isFocused()
boolean	isPositionedAboveCaret()
boolean	isSelectionTouched()
PrefixMatcher	itemMatcher(LookupElement item)
java.lang.String	itemPattern(LookupElement element)
void	removeLookupListener(LookupListener listener)

Field Detail

NORMAL_SELECT_CHAR

static final char NORMAL_SELECT_CHAR

See Also:

Constant Field Values

REPLACE_SELECT_CHAR

static final char REPLACE_SELECT_CHAR

See Also:

Constant Field Values

COMPLETE_STATEMENT_SELECT_CHAR

static final char COMPLETE_STATEMENT_SELECT_CHAR

See Also:

Constant Field Values

AUTO_INSERT_SELECT_CHAR

static final char AUTO_INSERT_SELECT_CHAR

See Also:

Constant Field Values

Method Detail

getLookupStart

int getLookupStart()

Returns:

the offset in getTopLevelEditor() which this lookup's left side should be aligned with. Note that if the lookup doesn't fit the screen due to its dimensions, the actual position might differ from this editor offset.

getCurrentItem

LookupElement getCurrentItem()

addLookupListener

void addLookupListener(LookupListener listener)

removeLookupListener

void removeLookupListener(LookupListener listener)

getBounds

java.awt.Rectangle getBounds()

Returns:

bounds in layered pane coordinate system

getCurrentItemBounds

java.awt.Rectangle getCurrentItemBounds()

Returns:

bounds of the current item in the layered pane coordinate system.

isPositionedAboveCaret

boolean isPositionedAboveCaret()

getPsiElement

PsiElement getPsiElement()

Returns:

leaf PSI element at this lookup's start position (see getLookupStart()) in getPsiFile() result.

getEditor

Editor getEditor()

Consider using getTopLevelEditor() if you don't need injected editor.

Returns:

editor, possibly injected, where this lookup is shown

getTopLevelEditor

Editor getTopLevelEditor()

Returns:

the non-injected editor where this lookup is shown

getProject

Project getProject()

getPsiFile

PsiFile getPsiFile()

Returns:

PSI file, possibly injected, associated with this lookup's editor

See Also:

getEditor()

isCompletion

boolean isCompletion()

getItems

java.util.List<LookupElement> getItems()

isFocused

boolean isFocused()

itemPattern

java.lang.String itemPattern(LookupElement element)

itemMatcher

PrefixMatcher itemMatcher(LookupElement item)

isSelectionTouched

boolean isSelectionTouched()

getAdvertisements

java.util.List<java.lang.String> getAdvertisements()