Package com.intellij.codeInsight.daemon.impl

Class JavaLineMarkerProvider

java.lang.Object

com.intellij.codeInsight.daemon.GutterIconDescriptor

com.intellij.codeInsight.daemon.LineMarkerProviderDescriptor

com.intellij.codeInsight.daemon.impl.JavaLineMarkerProvider

All Implemented Interfaces:

LineMarkerProvider

public class JavaLineMarkerProvider
extends LineMarkerProviderDescriptor

Nested Class Summary

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

GutterIconDescriptor.Option

Field Summary

Fields

Modifier and Type	Field and Description
static GutterIconDescriptor.Option	LAMBDA_OPTION

Constructor Summary

Constructors

Constructor and Description
JavaLineMarkerProvider()
JavaLineMarkerProvider(DaemonCodeAnalyzerSettings daemonSettings, EditorColorsManager colorsManager) Deprecated. use JavaLineMarkerProvider()

Method Summary

Modifier and Type	Method and Description
protected java.util.List<LineMarkerInfo<PsiElement>>	collectInheritingClasses(PsiClass aClass)
void	collectSlowLineMarkers(java.util.List<? extends PsiElement> elements, java.util.Collection<? super LineMarkerInfo<?>> result)
LineMarkerInfo<?>	getLineMarkerInfo(PsiElement element) Get line markers for this PsiElement.
java.lang.String	getName() Human-readable provider name for UI.
GutterIconDescriptor.Option []	getOptions()

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

getIcon, getId, isEnabledByDefault, toString

Methods inherited from class java.lang.Object

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

Field Detail

LAMBDA_OPTION

public static final GutterIconDescriptor.Option LAMBDA_OPTION

Constructor Detail

JavaLineMarkerProvider

public JavaLineMarkerProvider()

JavaLineMarkerProvider

@Deprecated
public JavaLineMarkerProvider(DaemonCodeAnalyzerSettings daemonSettings,
                              EditorColorsManager colorsManager)

Deprecated. use JavaLineMarkerProvider()

Method Detail

getLineMarkerInfo

public LineMarkerInfo<?> 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 void collectSlowLineMarkers(java.util.List<? extends PsiElement> elements,
                                   java.util.Collection<? super LineMarkerInfo<?>> result)

collectInheritingClasses

protected java.util.List<LineMarkerInfo<PsiElement>> collectInheritingClasses(PsiClass aClass)

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

getOptions

public GutterIconDescriptor.Option [] getOptions()

Overrides:

getOptions in class GutterIconDescriptor