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

Class XmlParameterInfoHandler

java.lang.Object

com.intellij.codeInsight.hint.api.impls.XmlParameterInfoHandler

All Implemented Interfaces:

ParameterInfoHandler<XmlTag,XmlElementDescriptor>

public class XmlParameterInfoHandler
extends java.lang.Object
implements ParameterInfoHandler<XmlTag,XmlElementDescriptor>

Constructor Summary

Constructors

Constructor and Description
XmlParameterInfoHandler()

Method Summary

Modifier and Type	Method and Description
boolean	couldShowInLookup()
XmlTag	findElementForParameterInfo(CreateParameterInfoContext context) Find psiElement for parameter info should also set ItemsToShow in context and may set highlighted element
XmlTag	findElementForUpdatingParameterInfo(UpdateParameterInfoContext context) Hint has to be removed if method returns null.
java.lang.Object[]	getParametersForLookup(LookupElement item, ParameterInfoContext context)
static XmlAttributeDescriptor[]	getSortedDescriptors(XmlElementDescriptor p)
void	showParameterInfo(XmlTag element, CreateParameterInfoContext context)
static void	updateElementDescriptor(XmlElementDescriptor descriptor, ParameterInfoUIContext context, Function<? super java.lang.String,java.lang.Boolean> attributePresentFun)
void	updateParameterInfo(XmlTag parameterOwner, UpdateParameterInfoContext context) Updates parameter info context due to change of caret position.
void	updateUI(XmlElementDescriptor o, 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.ParameterInfoHandler

dispose, getParameterCloseChars, getParametersForDocumentation, isWhitespaceSensitive, processFoundElementForUpdatingParameterInfo, supportsOverloadSwitching, syncUpdateOnCaretMove, tracksParameterIndex

Constructor Detail

XmlParameterInfoHandler

public XmlParameterInfoHandler()

Method Detail

getParametersForLookup

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

Specified by:

getParametersForLookup in interface ParameterInfoHandler<XmlTag,XmlElementDescriptor>

getSortedDescriptors

public static XmlAttributeDescriptor[] getSortedDescriptors(XmlElementDescriptor p)

couldShowInLookup

public boolean couldShowInLookup()

Specified by:

couldShowInLookup in interface ParameterInfoHandler<XmlTag,XmlElementDescriptor>

findElementForParameterInfo

public XmlTag 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<XmlTag,XmlElementDescriptor>

showParameterInfo

public void showParameterInfo(XmlTag element,
                              CreateParameterInfoContext context)

Specified by:

showParameterInfo in interface ParameterInfoHandler<XmlTag,XmlElementDescriptor>

findElementForUpdatingParameterInfo

public XmlTag 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<XmlTag,XmlElementDescriptor>

updateParameterInfo

public void updateParameterInfo(XmlTag parameterOwner,
                                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<XmlTag,XmlElementDescriptor>

updateUI

public void updateUI(XmlElementDescriptor o,
                     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<XmlTag,XmlElementDescriptor>

updateElementDescriptor

public static void updateElementDescriptor(XmlElementDescriptor descriptor,
                                           ParameterInfoUIContext context,
                                           Function<? super java.lang.String,java.lang.Boolean> attributePresentFun)