Package com.intellij.codeInsight.daemon

Class RelatedItemLineMarkerProvider

java.lang.Object

com.intellij.codeInsight.daemon.GutterIconDescriptor

com.intellij.codeInsight.daemon.LineMarkerProviderDescriptor

com.intellij.codeInsight.daemon.RelatedItemLineMarkerProvider

All Implemented Interfaces:

LineMarkerProvider

Direct Known Subclasses:

JavaFxRelatedItemLineMarkerProvider, PyiRelatedItemLineMarkerProvider

public abstract class RelatedItemLineMarkerProvider
extends LineMarkerProviderDescriptor

Override this class and register the implementation as codeInsight.lineMarkerProvider extension to provide both line marker and 'Go to related symbol' targets.

Nested Class Summary

Nested classes/interfaces inherited from class com.intellij.codeInsight.daemon.GutterIconDescriptor

GutterIconDescriptor.Option

Constructor Summary

Constructors

Constructor and Description
RelatedItemLineMarkerProvider()

Method Summary

Modifier and Type	Method and Description
void	collectNavigationMarkers(java.util.List<? extends PsiElement> elements, java.util.Collection<? super RelatedItemLineMarkerInfo<?>> result, boolean forNavigation)
protected void	collectNavigationMarkers(PsiElement element, java.util.Collection<? super RelatedItemLineMarkerInfo<?>> result)
void	collectSlowLineMarkers(java.util.List<? extends PsiElement> elements, java.util.Collection<? super LineMarkerInfo<?>> result)
RelatedItemLineMarkerInfo<?>	getLineMarkerInfo(PsiElement element) Get line markers for this PsiElement.
java.lang.String	getName() Human-readable provider name for UI.

Methods inherited from class com.intellij.codeInsight.daemon.GutterIconDescriptor

getIcon, getId, getOptions, isEnabledByDefault, toString

Methods inherited from class java.lang.Object

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

Constructor Detail

RelatedItemLineMarkerProvider

public RelatedItemLineMarkerProvider()

Method Detail

getLineMarkerInfo

public RelatedItemLineMarkerInfo<?> getLineMarkerInfo(PsiElement element)

Description copied from interface: LineMarkerProvider

Get line markers for this PsiElement.

NOTE for implementers: Please create line marker info for leaf elements only - i.e. the smallest possible elements. For example, instead of returning method marker for PsiMethod, create the marker for the PsiIdentifier which is a name of this method.

More technical details:

Highlighting (specifically, LineMarkersPass) queries all LineMarkerProviders in two passes (for performance reasons):

• first pass for all elements in visible area
• second pass for all the rest elements

If provider returned nothing for both areas, its line markers are cleared.

So imagine a LineMarkerProvider which (incorrectly) written like this:

 
   class MyBadLineMarkerProvider implements LineMarkerProvider {
     public LineMarkerInfo getLineMarkerInfo(PsiElement element) {
       if (element instanceof PsiMethod) { // ACTUALLY DONT!
          return new LineMarkerInfo(element, element.getTextRange(), icon, null,null, alignment);
       }
       else {
         return null;
       }
     }
     ...
   }
 
 

Note that it create LineMarkerInfo for the whole method body. Following will happen when this method is half-visible (e.g. its name is visible but a part of its body isn't):

• the first pass would remove line marker info because the whole PsiMethod isn't visible
• the second pass would try to add line marker info back because LineMarkerProvider was called for the PsiMethod at last

As a result, line marker icon will blink annoyingly. Instead, write this:

 
   class MyGoodLineMarkerProvider implements LineMarkerProvider {
     public LineMarkerInfo getLineMarkerInfo(PsiElement element) {
       if (element instanceof PsiIdentifier &&
           (parent = element.getParent()) instanceof PsiMethod &&
           ((PsiMethod)parent).getMethodIdentifier() == element)) { // aha, we are at method name
            return new LineMarkerInfo(element, element.getTextRange(), icon, null,null, alignment);
       }
       else {
         return null;
       }
     }
     ...
   }
 
 

collectSlowLineMarkers

public final void collectSlowLineMarkers(java.util.List<? extends PsiElement> elements,
                                         java.util.Collection<? super LineMarkerInfo<?>> result)

collectNavigationMarkers

public void collectNavigationMarkers(java.util.List<? extends PsiElement> elements,
                                     java.util.Collection<? super RelatedItemLineMarkerInfo<?>> result,
                                     boolean forNavigation)

collectNavigationMarkers

protected void collectNavigationMarkers(PsiElement element,
                                        java.util.Collection<? super RelatedItemLineMarkerInfo<?>> result)

getName

public java.lang.String getName()

Description copied from class: GutterIconDescriptor

Human-readable provider name for UI.

Specified by:

getName in class GutterIconDescriptor

Returns:

null if no configuration needed