Package com.intellij.codeInsight.lookup.impl

Class LookupImpl

java.lang.Object

com.intellij.openapi.util.UserDataHolderBase

com.intellij.ui.LightweightHint

com.intellij.codeInsight.lookup.impl.LookupImpl

All Implemented Interfaces:

LookupElementListPresenter, Lookup, LookupEx, Disposable, UserDataHolder, UserDataHolderEx, Hint

public class LookupImpl
extends LightweightHint
implements LookupEx, Disposable, LookupElementListPresenter

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	LookupImpl.FocusDegree Deprecated. Use LookupFocusDegree

Nested classes/interfaces inherited from interface com.intellij.openapi.Disposable

Disposable.Parent

Field Summary

Fields inherited from class com.intellij.ui.LightweightHint

SHOWN_AT_DEBUG

Fields inherited from interface com.intellij.codeInsight.lookup.Lookup

AUTO_INSERT_SELECT_CHAR, COMPLETE_STATEMENT_SELECT_CHAR, NORMAL_SELECT_CHAR, REPLACE_SELECT_CHAR

Constructor Summary

Constructors

Constructor and Description
LookupImpl(Project project, Editor editor, LookupArranger arranger)

Method Summary

Modifier and Type	Method and Description
void	addAdvertisement(java.lang.String text, javax.swing.Icon icon)
boolean	addItem(LookupElement item, PrefixMatcher matcher)
void	addLookupListener(LookupListener listener)
void	addPrefixChangeListener(PrefixChangeListener listener, Disposable parentDisposable)
void	checkValid()
void	clear()
void	dispose() Usually not invoked directly, see class javadoc.
void	ensureSelectionVisible(boolean forceTopSelection)
void	finishLookup(char completionChar)
void	finishLookup(char completionChar, LookupElement item)
void	fireItemSelected(LookupElement item, char completionChar)
java.util.Collection<LookupElementAction>	getActionsFor(LookupElement element)
java.lang.String	getAdditionalPrefix()
java.util.List<java.lang.String>	getAdvertisements()
Advertiser	getAdvertiser()
LookupArranger	getArranger()
LookupElement	getCurrentItem()
java.awt.Rectangle	getCurrentItemBounds()
LookupElement	getCurrentItemOrEmpty()
Editor	getEditor() Consider using Lookup.getTopLevelEditor() if you don't need injected editor.
java.util.List<LookupElement>	getItems()
static java.lang.String	getLastLookupDisposeTrace()
int	getLastVisibleIndex()
javax.swing.JList	getList()
LookupFocusDegree	getLookupFocusDegree()
int	getLookupOriginalStart()
int	getLookupStart()
int	getPrefixLength(LookupElement item)
Project	getProject()
PsiElement	getPsiElement()
PsiFile	getPsiFile()
java.util.Map<LookupElement,java.util.List<Pair<java.lang.String,java.lang.Object>>>	getRelevanceObjects(java.lang.Iterable<? extends LookupElement> items, boolean hideSingleValued)
int	getSelectedIndex()
Editor	getTopLevelEditor()
void	hide() Hides current hint object.
void	hideLookup(boolean explicitly)
protected void	insertLookupString(LookupElement item, int prefix)
static void	insertLookupString(Project project, Editor editor, LookupElement item, PrefixMatcher matcher, java.lang.String itemPattern, int prefixLength)
boolean	isAvailableToUser()
boolean	isCalculating()
boolean	isCompletion()
boolean	isFocused()
boolean	isLookupDisposed()
boolean	isPositionedAboveCaret()
boolean	isSelectionTouched()
boolean	isSelectionVisible()
boolean	isShown()
boolean	isStartCompletionWhenNothingMatches()
PrefixMatcher	itemMatcher(LookupElement item)
java.lang.String	itemPattern(LookupElement element)
void	markReused()
void	markSelectionTouched()
boolean	mayBeNoticed()
protected void	onPopupCancel()
boolean	performGuardedChange(java.lang.Runnable change)
void	refreshUi(boolean mayCheckReused, boolean onExplicitAction)
void	removeLookupListener(LookupListener listener)
void	repaintLookup(boolean onExplicitAction, boolean reused, boolean selectionVisible, boolean itemsChanged)
void	replacePrefix(java.lang.String presentPrefix, java.lang.String newPrefix)
void	requestResize()
void	resort(boolean addAgain)
void	setArranger(LookupArranger arranger)
void	setCalculating(boolean calculating)
void	setCurrentItem(LookupElement item)
void	setDummyItemCount(int count)
void	setFocusDegree(LookupImpl.FocusDegree focusDegree) Deprecated. Use setLookupFocusDegree(LookupFocusDegree)
void	setLastVisibleIndex(int lastVisibleIndex)
void	setLookupFocusDegree(LookupFocusDegree lookupFocusDegree)
void	setPrefixChangeListener(PrefixChangeListener listener)
void	setSelectedIndex(int index)
void	setSelectionTouched(boolean selectionTouched)
void	setStartCompletionWhenNothingMatches(boolean startCompletionWhenNothingMatches)
void	showElementActions(java.awt.event.InputEvent event)
boolean	showLookup()
void	updateLookupWidth(LookupElement item)
boolean	vetoesHiding()

Methods inherited from class com.intellij.ui.LightweightHint

addHintListener, beforeShow, canAutoHideOn, canControlAutoHide, getBounds, getComponent, getCurrentIdeTooltip, getLocationOn, getSize, hide, isAwtTooltip, isForceHideShadow, isInsideHint, isRealPopup, isSelectingHint, isVisible, pack, removeHintListener, setCancelOnClickOutside, setCancelOnOtherWindowOpen, setFocusRequestor, setForceHideShadow, setForceLightweightPopup, setForceShowAsPopup, setLocation, setResizable, setSelectingHint, setSize, setTitle, show, toString, updateLocation, updatePosition

Methods inherited from class com.intellij.openapi.util.UserDataHolderBase

changeUserMap, clearUserData, clone, copyCopyableDataTo, copyUserDataTo, getCopyableUserData, getUserData, getUserDataString, getUserMap, isUserDataEmpty, putCopyableUserData, putUserData, putUserDataIfAbsent, replace, setUserMap

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.intellij.codeInsight.lookup.LookupEx

getComponent

Methods inherited from interface com.intellij.codeInsight.lookup.Lookup

getBounds

Constructor Detail

LookupImpl

public LookupImpl(Project project,
                  Editor editor,
                  LookupArranger arranger)

Method Detail

getArranger

public LookupArranger getArranger()

setArranger

public void setArranger(LookupArranger arranger)

isFocused

public boolean isFocused()

Specified by:

isFocused in interface Lookup

setFocusDegree

@Deprecated
public void setFocusDegree(LookupImpl.FocusDegree focusDegree)

Deprecated. Use setLookupFocusDegree(LookupFocusDegree)

getLookupFocusDegree

public LookupFocusDegree getLookupFocusDegree()

Specified by:

getLookupFocusDegree in interface LookupElementListPresenter

setLookupFocusDegree

public void setLookupFocusDegree(LookupFocusDegree lookupFocusDegree)

isCalculating

public boolean isCalculating()

setCalculating

public void setCalculating(boolean calculating)

markSelectionTouched

public void markSelectionTouched()

setSelectionTouched

public void setSelectionTouched(boolean selectionTouched)

getSelectedIndex

public int getSelectedIndex()

Specified by:

getSelectedIndex in interface LookupElementListPresenter

setSelectedIndex

public void setSelectedIndex(int index)

setDummyItemCount

public void setDummyItemCount(int count)

repaintLookup

public void repaintLookup(boolean onExplicitAction,
                          boolean reused,
                          boolean selectionVisible,
                          boolean itemsChanged)

resort

public void resort(boolean addAgain)

addItem

public boolean addItem(LookupElement item,
                       PrefixMatcher matcher)

clear

public void clear()

updateLookupWidth

public void updateLookupWidth(LookupElement item)

requestResize

public void requestResize()

getActionsFor

public java.util.Collection<LookupElementAction> getActionsFor(LookupElement element)

getList

public javax.swing.JList getList()

getItems

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

Specified by:

getItems in interface Lookup

getAdditionalPrefix

public java.lang.String getAdditionalPrefix()

Specified by:

getAdditionalPrefix in interface LookupElementListPresenter

setStartCompletionWhenNothingMatches

public void setStartCompletionWhenNothingMatches(boolean startCompletionWhenNothingMatches)

isStartCompletionWhenNothingMatches

public boolean isStartCompletionWhenNothingMatches()

ensureSelectionVisible

public void ensureSelectionVisible(boolean forceTopSelection)

isSelectionVisible

public boolean isSelectionVisible()

itemPattern

public java.lang.String itemPattern(LookupElement element)

Specified by:

itemPattern in interface Lookup

itemMatcher

public PrefixMatcher itemMatcher(LookupElement item)

Specified by:

itemMatcher in interface Lookup

finishLookup

public void finishLookup(char completionChar)

finishLookup

public void finishLookup(char completionChar,
                         LookupElement item)

getPrefixLength

public int getPrefixLength(LookupElement item)

insertLookupString

protected void insertLookupString(LookupElement item,
                                  int prefix)

insertLookupString

public static void insertLookupString(Project project,
                                      Editor editor,
                                      LookupElement item,
                                      PrefixMatcher matcher,
                                      java.lang.String itemPattern,
                                      int prefixLength)

getLookupStart

public int getLookupStart()

Specified by:

getLookupStart in interface Lookup

Returns:

the offset in Lookup.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.

getLookupOriginalStart

public int getLookupOriginalStart()

performGuardedChange

public boolean performGuardedChange(java.lang.Runnable change)

vetoesHiding

public boolean vetoesHiding()

Overrides:

vetoesHiding in class LightweightHint

isAvailableToUser

public boolean isAvailableToUser()

isShown

public boolean isShown()

Specified by:

isShown in interface LookupElementListPresenter

showLookup

public boolean showLookup()

getAdvertiser

public Advertiser getAdvertiser()

mayBeNoticed

public boolean mayBeNoticed()

getCurrentItem

public LookupElement getCurrentItem()

Specified by:

getCurrentItem in interface LookupElementListPresenter

Specified by:

getCurrentItem in interface Lookup

getCurrentItemOrEmpty

public LookupElement getCurrentItemOrEmpty()

Specified by:

getCurrentItemOrEmpty in interface LookupElementListPresenter

setCurrentItem

public void setCurrentItem(LookupElement item)

Specified by:

setCurrentItem in interface LookupEx

addLookupListener

public void addLookupListener(LookupListener listener)

Specified by:

addLookupListener in interface Lookup

removeLookupListener

public void removeLookupListener(LookupListener listener)

Specified by:

removeLookupListener in interface Lookup

getCurrentItemBounds

public java.awt.Rectangle getCurrentItemBounds()

Specified by:

getCurrentItemBounds in interface Lookup

Returns:

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

fireItemSelected

public void fireItemSelected(LookupElement item,
                             char completionChar)

replacePrefix

public void replacePrefix(java.lang.String presentPrefix,
                          java.lang.String newPrefix)

getPsiFile

public PsiFile getPsiFile()

Specified by:

getPsiFile in interface Lookup

Returns:

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

See Also:

Lookup.getEditor()

isCompletion

public boolean isCompletion()

Specified by:

isCompletion in interface Lookup

getPsiElement

public PsiElement getPsiElement()

Specified by:

getPsiElement in interface Lookup

Returns:

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

getEditor

public Editor getEditor()

Description copied from interface: Lookup

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

Specified by:

getEditor in interface Lookup

Returns:

editor, possibly injected, where this lookup is shown

getTopLevelEditor

public Editor getTopLevelEditor()

Specified by:

getTopLevelEditor in interface Lookup

Returns:

the non-injected editor where this lookup is shown

getProject

public Project getProject()

Specified by:

getProject in interface Lookup

isPositionedAboveCaret

public boolean isPositionedAboveCaret()

Specified by:

isPositionedAboveCaret in interface Lookup

isSelectionTouched

public boolean isSelectionTouched()

Specified by:

isSelectionTouched in interface LookupElementListPresenter

Specified by:

isSelectionTouched in interface Lookup

getLastVisibleIndex

public int getLastVisibleIndex()

Specified by:

getLastVisibleIndex in interface LookupElementListPresenter

setLastVisibleIndex

public void setLastVisibleIndex(int lastVisibleIndex)

getAdvertisements

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

Specified by:

getAdvertisements in interface Lookup

hide

public void hide()

Description copied from interface: Hint

Hides current hint object.

Note: this method is also used as a destruction callback, i.e. it performs necessary de-initialization when current hint is not necessary to use anymore. Hence, it's necessary to call it from place where you definitely know that current hint will not be used.

Specified by:

hide in interface Hint

Overrides:

hide in class LightweightHint

hideLookup

public void hideLookup(boolean explicitly)

Specified by:

hideLookup in interface LookupEx

onPopupCancel

protected void onPopupCancel()

Overrides:

onPopupCancel in class LightweightHint

getLastLookupDisposeTrace

public static java.lang.String getLastLookupDisposeTrace()

dispose

public void dispose()

Description copied from interface: Disposable

Usually not invoked directly, see class javadoc.

Specified by:

dispose in interface Disposable

refreshUi

public void refreshUi(boolean mayCheckReused,
                      boolean onExplicitAction)

markReused

public void markReused()

addAdvertisement

public void addAdvertisement(java.lang.String text,
                             javax.swing.Icon icon)

isLookupDisposed

public boolean isLookupDisposed()

checkValid

public void checkValid()

showElementActions

public void showElementActions(java.awt.event.InputEvent event)

Specified by:

showElementActions in interface LookupEx

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)

setPrefixChangeListener

public void setPrefixChangeListener(PrefixChangeListener listener)

addPrefixChangeListener

public void addPrefixChangeListener(PrefixChangeListener listener,
                                    Disposable parentDisposable)