Package com.intellij.lang.annotation

Interface AnnotationHolder

All Known Implementing Classes:

AnnotationHolderImpl

public interface AnnotationHolder

Allows a custom language plugin to define annotations for files in that language.

See Also:

Annotator.annotate(PsiElement, AnnotationHolder)

Method Summary

Modifier and Type	Method and Description
Annotation	createAnnotation(HighlightSeverity severity, TextRange range, java.lang.String message) Deprecated. Use newAnnotation(HighlightSeverity, String) instead
Annotation	createAnnotation(HighlightSeverity severity, TextRange range, java.lang.String message, java.lang.String htmlTooltip) Deprecated. Use newAnnotation(HighlightSeverity, String) instead
Annotation	createErrorAnnotation(ASTNode node, java.lang.String message) Deprecated. Use newAnnotation(HighlightSeverity, String) instead
Annotation	createErrorAnnotation(PsiElement elt, java.lang.String message) Deprecated. Use newAnnotation(HighlightSeverity, String) instead
Annotation	createErrorAnnotation(TextRange range, java.lang.String message) Deprecated. Use newAnnotation(HighlightSeverity, String) instead
Annotation	createInfoAnnotation(ASTNode node, java.lang.String message) Deprecated. Use newAnnotation(HighlightSeverity, String) instead
Annotation	createInfoAnnotation(PsiElement elt, java.lang.String message) Deprecated. Use newAnnotation(HighlightSeverity, String) instead
Annotation	createInfoAnnotation(TextRange range, java.lang.String message) Deprecated. Use newAnnotation(HighlightSeverity, String) instead
Annotation	createWarningAnnotation(ASTNode node, java.lang.String message) Deprecated. Use newAnnotation(HighlightSeverity, String) instead
Annotation	createWarningAnnotation(PsiElement elt, java.lang.String message) Deprecated. Use newAnnotation(HighlightSeverity, String) instead
Annotation	createWarningAnnotation(TextRange range, java.lang.String message) Deprecated. Use newAnnotation(HighlightSeverity, String) instead
Annotation	createWeakWarningAnnotation(ASTNode node, java.lang.String message) Deprecated. Use newAnnotation(HighlightSeverity, String) instead
Annotation	createWeakWarningAnnotation(PsiElement elt, java.lang.String message) Deprecated. Use newAnnotation(HighlightSeverity, String) instead
Annotation	createWeakWarningAnnotation(TextRange range, java.lang.String message) Deprecated. Use newAnnotation(HighlightSeverity, String) instead
AnnotationSession	getCurrentAnnotationSession()
boolean	isBatchMode()
default AnnotationBuilder	newAnnotation(HighlightSeverity severity, java.lang.String message) Begin constructing a new annotation.
default AnnotationBuilder	newSilentAnnotation(HighlightSeverity severity) Begin constructing a new annotation with no message.

Method Detail

createErrorAnnotation

@Deprecated
Annotation createErrorAnnotation(PsiElement elt,
                                 java.lang.String message)

Deprecated. Use newAnnotation(HighlightSeverity, String) instead

Creates an error annotation with the specified message over the specified PSI element.

Parameters:

elt - the element over which the annotation is created.

message - the error message.

Returns:

the annotation (which can be modified to set additional annotation parameters)

createErrorAnnotation

@Deprecated
Annotation createErrorAnnotation(ASTNode node,
                                 java.lang.String message)

Deprecated. Use newAnnotation(HighlightSeverity, String) instead

Creates an error annotation with the specified message over the specified AST node.

Parameters:

node - the node over which the annotation is created.

message - the error message.

Returns:

the annotation (which can be modified to set additional annotation parameters)

createErrorAnnotation

@Deprecated
Annotation createErrorAnnotation(TextRange range,
                                 java.lang.String message)

Deprecated. Use newAnnotation(HighlightSeverity, String) instead

Creates an error annotation with the specified message over the specified text range.

Parameters:

range - the text range over which the annotation is created.

message - the error message.

Returns:

the annotation (which can be modified to set additional annotation parameters)

createWarningAnnotation

@Deprecated
Annotation createWarningAnnotation(PsiElement elt,
                                   java.lang.String message)

Deprecated. Use newAnnotation(HighlightSeverity, String) instead

Creates a warning annotation with the specified message over the specified PSI element.

Parameters:

elt - the element over which the annotation is created.

message - the warning message.

Returns:

the annotation (which can be modified to set additional annotation parameters)

createWarningAnnotation

@Deprecated
Annotation createWarningAnnotation(ASTNode node,
                                   java.lang.String message)

Deprecated. Use newAnnotation(HighlightSeverity, String) instead

Creates a warning annotation with the specified message over the specified AST node.

Parameters:

node - the node over which the annotation is created.

message - the warning message.

Returns:

the annotation (which can be modified to set additional annotation parameters)

createWarningAnnotation

@Deprecated
Annotation createWarningAnnotation(TextRange range,
                                   java.lang.String message)

Deprecated. Use newAnnotation(HighlightSeverity, String) instead

Creates a warning annotation with the specified message over the specified text range.

Parameters:

range - the text range over which the annotation is created.

message - the warning message.

Returns:

the annotation (which can be modified to set additional annotation parameters)

createWeakWarningAnnotation

@Deprecated
Annotation createWeakWarningAnnotation(PsiElement elt,
                                       java.lang.String message)

Deprecated. Use newAnnotation(HighlightSeverity, String) instead

Creates an annotation with severity HighlightSeverity.WEAK_WARNING ('weak warning') with the specified message over the specified PSI element.

Parameters:

elt - the element over which the annotation is created.

message - the info message.

Returns:

the annotation (which can be modified to set additional annotation parameters)

createWeakWarningAnnotation

@Deprecated
Annotation createWeakWarningAnnotation(ASTNode node,
                                       java.lang.String message)

Deprecated. Use newAnnotation(HighlightSeverity, String) instead

Creates an annotation with severity HighlightSeverity.WEAK_WARNING ('weak warning') with the specified message over the specified AST node.

Parameters:

node - the node over which the annotation is created.

message - the info message.

Returns:

the annotation (which can be modified to set additional annotation parameters)

createWeakWarningAnnotation

@Deprecated
Annotation createWeakWarningAnnotation(TextRange range,
                                       java.lang.String message)

Deprecated. Use newAnnotation(HighlightSeverity, String) instead

Creates an annotation with severity HighlightSeverity.WEAK_WARNING ('weak warning') with the specified message over the specified text range.

Parameters:

range - the text range over which the annotation is created.

message - the info message.

Returns:

the annotation (which can be modified to set additional annotation parameters)

createInfoAnnotation

@Deprecated
Annotation createInfoAnnotation(PsiElement elt,
                                java.lang.String message)

Deprecated. Use newAnnotation(HighlightSeverity, String) instead

Creates an information annotation (colored highlighting only, with no gutter mark and not participating in "Next Error/Warning" navigation) with the specified message over the specified PSI element.

Parameters:

elt - the element over which the annotation is created.

message - the information message.

Returns:

the annotation (which can be modified to set additional annotation parameters)

createInfoAnnotation

@Deprecated
Annotation createInfoAnnotation(ASTNode node,
                                java.lang.String message)

Deprecated. Use newAnnotation(HighlightSeverity, String) instead

Creates an information annotation (colored highlighting only, with no gutter mark and not participating in "Next Error/Warning" navigation) with the specified message over the specified AST node.

Parameters:

node - the node over which the annotation is created.

message - the information message.

Returns:

the annotation (which can be modified to set additional annotation parameters)

createInfoAnnotation

@Deprecated
Annotation createInfoAnnotation(TextRange range,
                                java.lang.String message)

Deprecated. Use newAnnotation(HighlightSeverity, String) instead

Creates an information annotation (colored highlighting only, with no gutter mark and not participating in "Next Error/Warning" navigation) with the specified message over the specified text range.

Parameters:

range - the text range over which the annotation is created.

message - the information message.

Returns:

the annotation (which can be modified to set additional annotation parameters)

createAnnotation

@Deprecated
Annotation createAnnotation(HighlightSeverity severity,
                            TextRange range,
                            java.lang.String message)

Deprecated. Use newAnnotation(HighlightSeverity, String) instead

Creates an annotation with the given severity (colored highlighting only, with no gutter mark and not participating in "Next Error/Warning" navigation) with the specified message over the specified text range.

Parameters:

severity - the severity.

range - the text range over which the annotation is created.

message - the information message.

Returns:

the annotation (which can be modified to set additional annotation parameters)

createAnnotation

@Deprecated
Annotation createAnnotation(HighlightSeverity severity,
                            TextRange range,
                            java.lang.String message,
                            java.lang.String htmlTooltip)

Deprecated. Use newAnnotation(HighlightSeverity, String) instead

Creates an annotation with the given severity (colored highlighting only, with no gutter mark and not participating in "Next Error/Warning" navigation) with the specified message and tooltip markup over the specified text range.

Parameters:

severity - the severity.

range - the text range over which the annotation is created.

message - the information message.

htmlTooltip - the tooltip to show (usually the message, but escaped as HTML and surrounded by a <html> tag

Returns:

the annotation (which can be modified to set additional annotation parameters)

getCurrentAnnotationSession

AnnotationSession getCurrentAnnotationSession()

isBatchMode

boolean isBatchMode()

newAnnotation

default AnnotationBuilder newAnnotation(HighlightSeverity severity,
                                        java.lang.String message)

Begin constructing a new annotation. To finish construction and show the annotation on screen AnnotationBuilder.create() must be called. For example:

holder.newAnnotation(HighlightSeverity.WARNING, "My warning message").create();

Parameters:

severity - The severity of the annotation.

message - The message this annotation will show in the status bar and the tooltip.

newSilentAnnotation

default AnnotationBuilder newSilentAnnotation(HighlightSeverity severity)

Begin constructing a new annotation with no message. To finish construction and show the annotation on screen AnnotationBuilder.create() must be called. For example:

holder.newSilentAnnotation(HighlightSeverity.WARNING).textAttributes(MY_ATTRIBUTES_KEY).create();

Parameters:

severity - The severity of the annotation.