Package com.intellij.codeInsight.hints

Interface InlayParameterHintsProvider

public interface InlayParameterHintsProvider

Method Summary

Modifier and Type	Method and Description
default boolean	canShowHintsWhenDisabled() Whether provider should be queried for hints (getParameterHints(PsiElement)) even if showing hints is disabled globally (EditorSettingsExternalizable.isShowParameterNameHints()).
default SyntaxTraverser<PsiElement>	createTraversal(PsiElement root)
default Language	getBlackListDependencyLanguage() Returns language which blacklist will be appended to the resulting one.
default java.lang.String	getBlacklistExplanationHTML() Text explaining black list patterns.
java.util.Set<java.lang.String>	getDefaultBlackList() Default list of patterns for which hints should not be shown.
default HintInfo	getHintInfo(PsiElement element) Provides hint info, for alt-enter action (can be HintInfo.MethodInfo or HintInfo.OptionInfo).
default HintInfo	getHintInfo(PsiElement element, PsiFile file)
default java.lang.String	getInlayPresentation(java.lang.String inlayText) Customise hints presentation.
default java.lang.String	getMainCheckboxText()
default java.util.List<InlayInfo>	getParameterHints(PsiElement element) Hints for params to be shown, hints offsets should be located within element's text range.
default java.util.List<InlayInfo>	getParameterHints(PsiElement element, PsiFile file)
default java.lang.String	getSettingsPreview()
default java.util.List<Option>	getSupportedOptions() List of supported options, shown in settings dialog.
default boolean	isBlackListSupported() If false no blacklist panel will be shown in "Parameter Name Hints Settings".
default boolean	isExhaustive()

Method Detail

getParameterHints

default java.util.List<InlayInfo> getParameterHints(PsiElement element)

Hints for params to be shown, hints offsets should be located within element's text range.

getParameterHints

default java.util.List<InlayInfo> getParameterHints(PsiElement element,
                                                    PsiFile file)

getHintInfo

default HintInfo getHintInfo(PsiElement element)

Provides hint info, for alt-enter action (can be HintInfo.MethodInfo or HintInfo.OptionInfo).

MethodInfo: provides fully qualified method name (e.g. "java.util.Map.put") and list of its parameter names. Used to match method with blacklist, and to add method into blacklist

OptionInfo: provides option to disable/enable by alt-enter

getHintInfo

default HintInfo getHintInfo(PsiElement element,
                             PsiFile file)

getDefaultBlackList

java.util.Set<java.lang.String> getDefaultBlackList()

Default list of patterns for which hints should not be shown.

getBlackListDependencyLanguage

default Language getBlackListDependencyLanguage()

Returns language which blacklist will be appended to the resulting one. E.g. to prevent possible Groovy and Kotlin extensions from showing hints for blacklisted Java methods.

getSupportedOptions

default java.util.List<Option> getSupportedOptions()

List of supported options, shown in settings dialog.

isBlackListSupported

default boolean isBlackListSupported()

If false no blacklist panel will be shown in "Parameter Name Hints Settings".

getBlacklistExplanationHTML

default java.lang.String getBlacklistExplanationHTML()

Text explaining black list patterns.

getInlayPresentation

default java.lang.String getInlayPresentation(java.lang.String inlayText)

Customise hints presentation.

canShowHintsWhenDisabled

default boolean canShowHintsWhenDisabled()

Whether provider should be queried for hints (getParameterHints(PsiElement)) even if showing hints is disabled globally (EditorSettingsExternalizable.isShowParameterNameHints()).

getSettingsPreview

default java.lang.String getSettingsPreview()

Returns:

text of preview, will be used in settings.

isExhaustive

default boolean isExhaustive()

Returns:

true if set of options is complete and if all options are off, provider will collect no hints.

getMainCheckboxText

default java.lang.String getMainCheckboxText()

Returns:

text of main checkbox in hints settings

createTraversal

default SyntaxTraverser<PsiElement> createTraversal(PsiElement root)

Returns:

Traverser for `root` element subtree.