Package com.intellij.lang.parameterInfo

Interface ParameterInfoHandler<ParameterOwner extends java.lang.Object & PsiElement,ParameterType>

All Known Subinterfaces:

ParameterInfoHandlerWithTabActionSupport<ParameterOwner,ParameterType,ActualParameterType>

All Known Implementing Classes:

AnnotationParameterInfoHandler, GroovyAnnotationAttributeInfoHandler, GroovyParameterInfoHandler, GroovyTypeParameterInfoHandler, MethodParameterInfoHandler, PyParameterInfoHandler, ReferenceParameterInfoHandler, XmlParameterInfoHandler, XPathParameterInfoHandler

public interface ParameterInfoHandler<ParameterOwner extends java.lang.Object & PsiElement,ParameterType>

Method Summary

Modifier and Type	Method and Description
boolean	couldShowInLookup()
default void	dispose(DeleteParameterInfoContext context)
ParameterOwner	findElementForParameterInfo(CreateParameterInfoContext context) Find psiElement for parameter info should also set ItemsToShow in context and may set highlighted element
ParameterOwner	findElementForUpdatingParameterInfo(UpdateParameterInfoContext context) Hint has to be removed if method returns null.
default java.lang.String	getParameterCloseChars() Deprecated. not used
default java.lang.Object []	getParametersForDocumentation(ParameterType p, ParameterInfoContext context) Deprecated. not used
java.lang.Object []	getParametersForLookup(LookupElement item, ParameterInfoContext context)
default boolean	isWhitespaceSensitive()
default void	processFoundElementForUpdatingParameterInfo(ParameterOwner parameterOwner, UpdateParameterInfoContext context) This method performs some extra action (e.g.
void	showParameterInfo(ParameterOwner element, CreateParameterInfoContext context)
default boolean	supportsOverloadSwitching()
default void	syncUpdateOnCaretMove(UpdateParameterInfoContext context)
default boolean	tracksParameterIndex() Deprecated. not used
void	updateParameterInfo(ParameterOwner parameterOwner, UpdateParameterInfoContext context) Updates parameter info context due to change of caret position.
void	updateUI(ParameterType p, ParameterInfoUIContext context) This method is executed on UI thread and supposed only to update UI representation using ParameterInfoUIContext.setUIComponentEnabled(boolean) or ParameterInfoUIContext.setupUIComponentPresentation(String, int, int, boolean, boolean, boolean, Color).

Method Detail

couldShowInLookup

boolean couldShowInLookup()

getParametersForLookup

java.lang.Object [] getParametersForLookup(LookupElement item,
                                           ParameterInfoContext context)

findElementForParameterInfo

ParameterOwner findElementForParameterInfo(CreateParameterInfoContext context)

Find psiElement for parameter info should also set ItemsToShow in context and may set highlighted element

Note: it is executed on non UI thread

showParameterInfo

void showParameterInfo(ParameterOwner element,
                       CreateParameterInfoContext context)

findElementForUpdatingParameterInfo

ParameterOwner findElementForUpdatingParameterInfo(UpdateParameterInfoContext context)

Hint has to be removed if method returns null.

Note: it is executed on non-UI thread

processFoundElementForUpdatingParameterInfo

default void processFoundElementForUpdatingParameterInfo(ParameterOwner parameterOwner,
                                                         UpdateParameterInfoContext context)

This method performs some extra action (e.g. show hints) with a result of execution of findElementForUpdatingParameterInfo(UpdateParameterInfoContext) on UI thread.

updateParameterInfo

void updateParameterInfo(ParameterOwner parameterOwner,
                         UpdateParameterInfoContext context)

Updates parameter info context due to change of caret position.

It could update context and state of UpdateParameterInfoContext.getObjectsToView()

Note: context.getParameterOwner() equals to parameterOwner or null

Note: it is executed on non UI thread.

updateUI

void updateUI(ParameterType p,
              ParameterInfoUIContext context)

This method is executed on UI thread and supposed only to update UI representation using ParameterInfoUIContext.setUIComponentEnabled(boolean) or ParameterInfoUIContext.setupUIComponentPresentation(String, int, int, boolean, boolean, boolean, Color).

Don't perform any heavy calculations like resolve here: move it to findElementForParameterInfo(CreateParameterInfoContext) or updateParameterInfo(Object, UpdateParameterInfoContext).

supportsOverloadSwitching

default boolean supportsOverloadSwitching()

dispose

default void dispose(DeleteParameterInfoContext context)

isWhitespaceSensitive

default boolean isWhitespaceSensitive()

syncUpdateOnCaretMove

default void syncUpdateOnCaretMove(UpdateParameterInfoContext context)

getParametersForDocumentation

@Deprecated
default java.lang.Object [] getParametersForDocumentation(ParameterType p,
                                                          ParameterInfoContext context)

Deprecated. not used

getParameterCloseChars

@Deprecated
default java.lang.String getParameterCloseChars()

Deprecated. not used

tracksParameterIndex

@Deprecated
default boolean tracksParameterIndex()

Deprecated. not used