Package com.intellij.codeInsight.hint.api.impls

Class MethodParameterInfoHandler

java.lang.Object

com.intellij.codeInsight.hint.api.impls.MethodParameterInfoHandler

All Implemented Interfaces:

ParameterInfoHandler<PsiExpressionList,java.lang.Object>, ParameterInfoHandlerWithTabActionSupport<PsiExpressionList,java.lang.Object,PsiExpression>, DumbAware

public class MethodParameterInfoHandler
extends java.lang.Object
implements ParameterInfoHandlerWithTabActionSupport<PsiExpressionList,java.lang.Object,PsiExpression>, DumbAware

Constructor Summary

Constructors

Constructor and Description
MethodParameterInfoHandler()

Method Summary

Modifier and Type	Method and Description
boolean	couldShowInLookup()
void	dispose(DeleteParameterInfoContext context)
PsiExpressionList	findElementForParameterInfo(CreateParameterInfoContext context) Find psiElement for parameter info should also set ItemsToShow in context and may set highlighted element
PsiExpressionList	findElementForUpdatingParameterInfo(UpdateParameterInfoContext context) Hint has to be removed if method returns null.
IElementType	getActualParameterDelimiterType()
PsiExpression []	getActualParameters(PsiExpressionList psiExpressionList)
IElementType	getActualParametersRBraceType()
java.util.Set<? extends java.lang.Class<?>>	getArgListStopSearchClasses()
java.util.Set<java.lang.Class<?>>	getArgumentListAllowedParentClasses()
java.lang.Class<PsiExpressionList>	getArgumentListClass()
java.lang.Object[]	getParametersForLookup(LookupElement item, ParameterInfoContext context)
void	processFoundElementForUpdatingParameterInfo(PsiExpressionList expressionList, UpdateParameterInfoContext context) This method performs some extra action (e.g.
void	showParameterInfo(PsiExpressionList element, CreateParameterInfoContext context)
boolean	supportsOverloadSwitching()
void	syncUpdateOnCaretMove(UpdateParameterInfoContext context)
static java.lang.String	updateMethodPresentation(PsiMethod method, PsiSubstitutor substitutor, ParameterInfoUIContext context)
void	updateParameterInfo(PsiExpressionList o, UpdateParameterInfoContext context) Updates parameter info context due to change of caret position.
void	updateUI(java.lang.Object 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).

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.intellij.lang.parameterInfo.ParameterInfoHandlerWithTabActionSupport

isWhitespaceSensitive

Methods inherited from interface com.intellij.lang.parameterInfo.ParameterInfoHandler

getParameterCloseChars, getParametersForDocumentation, tracksParameterIndex

Constructor Detail

MethodParameterInfoHandler

public MethodParameterInfoHandler()

Method Detail

getParametersForLookup

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

Specified by:

getParametersForLookup in interface ParameterInfoHandler<PsiExpressionList,java.lang.Object>

couldShowInLookup

public boolean couldShowInLookup()

Specified by:

couldShowInLookup in interface ParameterInfoHandler<PsiExpressionList,java.lang.Object>

findElementForParameterInfo

public PsiExpressionList findElementForParameterInfo(CreateParameterInfoContext context)

Description copied from interface: ParameterInfoHandler

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

Note: it is executed on non UI thread

Specified by:

findElementForParameterInfo in interface ParameterInfoHandler<PsiExpressionList,java.lang.Object>

showParameterInfo

public void showParameterInfo(PsiExpressionList element,
                              CreateParameterInfoContext context)

Specified by:

showParameterInfo in interface ParameterInfoHandler<PsiExpressionList,java.lang.Object>

findElementForUpdatingParameterInfo

public PsiExpressionList findElementForUpdatingParameterInfo(UpdateParameterInfoContext context)

Description copied from interface: ParameterInfoHandler

Hint has to be removed if method returns null.

Note: it is executed on non-UI thread

Specified by:

findElementForUpdatingParameterInfo in interface ParameterInfoHandler<PsiExpressionList,java.lang.Object>

processFoundElementForUpdatingParameterInfo

public void processFoundElementForUpdatingParameterInfo(PsiExpressionList expressionList,
                                                        UpdateParameterInfoContext context)

Description copied from interface: ParameterInfoHandler

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

Specified by:

processFoundElementForUpdatingParameterInfo in interface ParameterInfoHandler<PsiExpressionList,java.lang.Object>

updateParameterInfo

public void updateParameterInfo(PsiExpressionList o,
                                UpdateParameterInfoContext context)

Description copied from interface: ParameterInfoHandler

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.

Specified by:

updateParameterInfo in interface ParameterInfoHandler<PsiExpressionList,java.lang.Object>

dispose

public void dispose(DeleteParameterInfoContext context)

Specified by:

dispose in interface ParameterInfoHandler<PsiExpressionList,java.lang.Object>

getArgumentListClass

public java.lang.Class<PsiExpressionList> getArgumentListClass()

Specified by:

getArgumentListClass in interface ParameterInfoHandlerWithTabActionSupport<PsiExpressionList,java.lang.Object,PsiExpression>

getActualParametersRBraceType

public IElementType getActualParametersRBraceType()

Specified by:

getActualParametersRBraceType in interface ParameterInfoHandlerWithTabActionSupport<PsiExpressionList,java.lang.Object,PsiExpression>

getArgumentListAllowedParentClasses

public java.util.Set<java.lang.Class<?>> getArgumentListAllowedParentClasses()

Specified by:

getArgumentListAllowedParentClasses in interface ParameterInfoHandlerWithTabActionSupport<PsiExpressionList,java.lang.Object,PsiExpression>

getArgListStopSearchClasses

public java.util.Set<? extends java.lang.Class<?>> getArgListStopSearchClasses()

Specified by:

getArgListStopSearchClasses in interface ParameterInfoHandlerWithTabActionSupport<PsiExpressionList,java.lang.Object,PsiExpression>

getActualParameterDelimiterType

public IElementType getActualParameterDelimiterType()

Specified by:

getActualParameterDelimiterType in interface ParameterInfoHandlerWithTabActionSupport<PsiExpressionList,java.lang.Object,PsiExpression>

getActualParameters

public PsiExpression [] getActualParameters(PsiExpressionList psiExpressionList)

Specified by:

getActualParameters in interface ParameterInfoHandlerWithTabActionSupport<PsiExpressionList,java.lang.Object,PsiExpression>

updateMethodPresentation

public static java.lang.String updateMethodPresentation(PsiMethod method,
                                                        PsiSubstitutor substitutor,
                                                        ParameterInfoUIContext context)

updateUI

public void updateUI(java.lang.Object p,
                     ParameterInfoUIContext context)

Description copied from interface: ParameterInfoHandler

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 ParameterInfoHandler.findElementForParameterInfo(CreateParameterInfoContext) or ParameterInfoHandler.updateParameterInfo(Object, UpdateParameterInfoContext).

Specified by:

updateUI in interface ParameterInfoHandler<PsiExpressionList,java.lang.Object>

supportsOverloadSwitching

public boolean supportsOverloadSwitching()

Specified by:

supportsOverloadSwitching in interface ParameterInfoHandler<PsiExpressionList,java.lang.Object>

syncUpdateOnCaretMove

public void syncUpdateOnCaretMove(UpdateParameterInfoContext context)

Specified by:

syncUpdateOnCaretMove in interface ParameterInfoHandler<PsiExpressionList,java.lang.Object>