Annotation (Unofficial IntelliJ Community Edition API docs)

java.lang.Object
- com.intellij.lang.annotation.Annotation

All Implemented Interfaces:

Segment
```
public final class Annotation
extends java.lang.Object
implements Segment
```
Defines an annotation, which is displayed as a gutter bar mark or an extra highlight in the editor.

See Also:

Annotator, AnnotationHolder, RangeHighlighter

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class Annotation.QuickFixInfo

Nested Classes
Modifier and Type	Class and Description
`static class`	`Annotation.QuickFixInfo`

Field Summary
- Fields inherited from interface com.intellij.openapi.util.Segment
  BY_START_OFFSET_THEN_END_OFFSET, EMPTY_ARRAY

Constructor Summary

Constructors
Constructor and Description
`Annotation(int startOffset, int endOffset, HighlightSeverity severity, java.lang.String message, java.lang.String tooltip)` Creates an instance of the annotation.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`java.util.List<Annotation.QuickFixInfo>`	`getBatchFixes()`
`int`	`getEndOffset()` Returns the end offset of the text range covered by the annotation.
`TextAttributes`	`getEnforcedTextAttributes()`
`GutterIconRenderer`	`getGutterIconRenderer()` Gets the renderer used to draw the gutter icon in the region covered by the annotation.
`ProblemHighlightType`	`getHighlightType()` If the annotation matches one of commonly encountered problem types, returns the ID of that problem type so that an appropriate color can be used for highlighting the annotation.
`java.lang.String`	`getMessage()` Returns the description of the annotation (shown in the status bar or by "View \| Error Description" action).
`ProblemGroup`	`getProblemGroup()` Gets the unique object, which is the same for all of the problems of this group
`java.util.List<Annotation.QuickFixInfo>`	`getQuickFixes()` Returns the list of quick fixes registered for the annotation.
`HighlightSeverity`	`getSeverity()` Returns the severity of the problem indicated by the annotation (highlight, warning or error).
`int`	`getStartOffset()` Returns the start offset of the text range covered by the annotation.
`TextAttributesKey`	`getTextAttributes()` Returns the text attribute key used for highlighting the annotation.
`java.lang.String`	`getTooltip()` Returns the tooltip for the annotation (shown when hovering the mouse in the gutter bar).
`boolean`	`isAfterEndOfLine()` Returns the flag indicating whether the annotation is shown after the end of line containing it.
`boolean`	`isFileLevelAnnotation()` File level annotations are visualized differently than lesser range annotations by showing a title bar on top of the editor rather than applying text attributes to the text range.
`boolean`	`needsUpdateOnTyping()` Gets a flag indicating what happens with the annotation when the user starts typing.
`<T extends IntentionAction & LocalQuickFix> void`	`registerBatchFix(T fix, TextRange range, HighlightDisplayKey key)` Registers a quickfix which would be available during batch mode only, in particular during com.intellij.codeInspection.DefaultHighlightVisitorBasedInspection run
`void`	`registerFix(IntentionAction fix)` Registers a quick fix for the annotation.
`void`	`registerFix(IntentionAction fix, TextRange range)`
`void`	`registerFix(IntentionAction fix, TextRange range, HighlightDisplayKey key)` Registers a quick fix for the annotation which is only available on a particular range of text within the annotation.
`void`	`registerFix(LocalQuickFix fix, TextRange range, HighlightDisplayKey key, ProblemDescriptor problemDescriptor)`
`<T extends IntentionAction & LocalQuickFix> void`	`registerUniversalFix(T fix, TextRange range, HighlightDisplayKey key)` Register a quickfix which would be available onTheFly and in the batch mode.
`void`	`setAfterEndOfLine(boolean afterEndOfLine)` Sets the flag indicating whether the annotation is shown after the end of line containing it.
`void`	`setEnforcedTextAttributes(TextAttributes enforcedAttributes)` Sets the text attributes used for highlighting the annotation.
`void`	`setFileLevelAnnotation(boolean isFileLevelAnnotation)` File level annotations are visualized differently than lesser range annotations by showing a title bar on top of the editor rather than applying text attributes to the text range.
`void`	`setGutterIconRenderer(GutterIconRenderer gutterIconRenderer)` Sets the renderer used to draw the gutter icon in the region covered by the annotation.
`void`	`setHighlightType(ProblemHighlightType highlightType)` If the annotation matches one of commonly encountered problem types, sets the ID of that problem type so that an appropriate color can be used for highlighting the annotation.
`void`	`setNeedsUpdateOnTyping(boolean b)` Sets a flag indicating what happens with the annotation when the user starts typing.
`void`	`setProblemGroup(ProblemGroup problemGroup)` Sets the unique object, which is the same for all of the problems of this group
`void`	`setTextAttributes(TextAttributesKey enforcedAttributes)` Sets the text attributes key used for highlighting the annotation.
`void`	`setTooltip(java.lang.String tooltip)` Sets the tooltip for the annotation (shown when hovering the mouse in the gutter bar).
`java.lang.String`	`toString()`

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - Annotation
```
public Annotation(int startOffset,
                  int endOffset,
                  HighlightSeverity severity,
                  java.lang.String message,
                  java.lang.String tooltip)
```
    Creates an instance of the annotation. Do not create Annotation manually, please use AnnotationHolder.newAnnotation(HighlightSeverity, String) builder methods instead.
    
    Parameters:
    
    startOffset - the start offset of the text range covered by the annotation.
    
    endOffset - the end offset of the text range covered by the annotation.
    
    severity - the severity of the problem indicated by the annotation (highlight, warning or error).
    
    message - the description of the annotation (shown in the status bar or by "View | Error Description" action)
    
    tooltip - the tooltip for the annotation (shown when hovering the mouse in the gutter bar)
    
    See Also:
    
    AnnotationHolder.newAnnotation(com.intellij.lang.annotation.HighlightSeverity, java.lang.String)
- Method Detail
  - registerFix
```
public void registerFix(IntentionAction fix)
```
    Registers a quick fix for the annotation.
    
    Parameters:
    
    fix - the quick fix implementation.
  - registerFix
```
public void registerFix(IntentionAction fix,
                        TextRange range)
```
  - registerFix
```
public void registerFix(LocalQuickFix fix,
                        TextRange range,
                        HighlightDisplayKey key,
                        ProblemDescriptor problemDescriptor)
```
  - registerFix
```
public void registerFix(IntentionAction fix,
                        TextRange range,
                        HighlightDisplayKey key)
```
    Registers a quick fix for the annotation which is only available on a particular range of text within the annotation.
    
    Parameters:
    
    fix - the quick fix implementation.
    
    range - the text range (relative to the document) where the quick fix is available.
  - registerBatchFix
```
public <T extends IntentionAction & LocalQuickFix> void registerBatchFix(T fix,
                                                                         TextRange range,
                                                                         HighlightDisplayKey key)
```
    Registers a quickfix which would be available during batch mode only, in particular during com.intellij.codeInspection.DefaultHighlightVisitorBasedInspection run
  - registerUniversalFix
```
public <T extends IntentionAction & LocalQuickFix> void registerUniversalFix(T fix,
                                                                             TextRange range,
                                                                             HighlightDisplayKey key)
```
    Register a quickfix which would be available onTheFly and in the batch mode. Should implement both IntentionAction and LocalQuickFix.
  - setNeedsUpdateOnTyping
```
public void setNeedsUpdateOnTyping(boolean b)
```
    Sets a flag indicating what happens with the annotation when the user starts typing. If the parameter is true, the annotation is removed as soon as the user starts typing and is possibly restored by a later run of the annotator. If false, the annotation remains in place while the user is typing.
    
    Parameters:
    
    b - whether the annotation needs to be removed on typing.
    
    See Also:
    
    needsUpdateOnTyping()
  - needsUpdateOnTyping
```
public boolean needsUpdateOnTyping()
```
    Gets a flag indicating what happens with the annotation when the user starts typing.
    
    Returns:
    
    true if the annotation is removed on typing, false otherwise.
    
    See Also:
    
    setNeedsUpdateOnTyping(boolean)
  - getStartOffset
```
public int getStartOffset()
```
    Returns the start offset of the text range covered by the annotation.
    
    Specified by:
    
    getStartOffset in interface Segment
    
    Returns:
    
    the annotation start offset.
  - getEndOffset
```
public int getEndOffset()
```
    Returns the end offset of the text range covered by the annotation.
    
    Specified by:
    
    getEndOffset in interface Segment
    
    Returns:
    
    the annotation end offset.
  - getSeverity
```
public HighlightSeverity getSeverity()
```
    Returns the severity of the problem indicated by the annotation (highlight, warning or error).
    
    Returns:
    
    the annotation severity.
  - getHighlightType
```
public ProblemHighlightType getHighlightType()
```
    If the annotation matches one of commonly encountered problem types, returns the ID of that problem type so that an appropriate color can be used for highlighting the annotation.
    
    Returns:
    
    the common problem type.
  - getTextAttributes
```
public TextAttributesKey getTextAttributes()
```
    Returns the text attribute key used for highlighting the annotation. If not specified explicitly, the key is determined automatically based on the problem highlight type and the annotation severity.
    
    Returns:
    
    the text attribute key used for highlighting
  - getEnforcedTextAttributes
```
public TextAttributes getEnforcedTextAttributes()
```
  - setEnforcedTextAttributes
```
public void setEnforcedTextAttributes(TextAttributes enforcedAttributes)
```
    Sets the text attributes used for highlighting the annotation.
    
    Parameters:
    
    enforcedAttributes - the text attributes for highlighting,
  - getQuickFixes
```
public java.util.List<Annotation.QuickFixInfo> getQuickFixes()
```
    Returns the list of quick fixes registered for the annotation.
    
    Returns:
    
    the list of quick fixes, or null if none have been registered.
  - getBatchFixes
```
public java.util.List<Annotation.QuickFixInfo> getBatchFixes()
```
  - getMessage
```
public java.lang.String getMessage()
```
    Returns the description of the annotation (shown in the status bar or by "View | Error Description" action).
    
    Returns:
    
    the description of the annotation.
  - getTooltip
```
public java.lang.String getTooltip()
```
    Returns the tooltip for the annotation (shown when hovering the mouse in the gutter bar).
    
    Returns:
    
    the tooltip for the annotation.
  - setTooltip
```
public void setTooltip(java.lang.String tooltip)
```
    Sets the tooltip for the annotation (shown when hovering the mouse in the gutter bar).
    
    Parameters:
    
    tooltip - the tooltip text.
  - setHighlightType
```
public void setHighlightType(ProblemHighlightType highlightType)
```
    If the annotation matches one of commonly encountered problem types, sets the ID of that problem type so that an appropriate color can be used for highlighting the annotation.
    
    Parameters:
    
    highlightType - the ID of the problem type.
  - setTextAttributes
```
public void setTextAttributes(TextAttributesKey enforcedAttributes)
```
    Sets the text attributes key used for highlighting the annotation.
    
    Parameters:
    
    enforcedAttributes - the text attributes key for highlighting,
  - isAfterEndOfLine
```
public boolean isAfterEndOfLine()
```
    Returns the flag indicating whether the annotation is shown after the end of line containing it.
    
    Returns:
    
    true if the annotation is shown after the end of line, false otherwise.
  - setAfterEndOfLine
```
public void setAfterEndOfLine(boolean afterEndOfLine)
```
    Sets the flag indicating whether the annotation is shown after the end of line containing it. This can be used for errors like "unclosed string literal", "missing semicolon" and so on.
    
    Parameters:
    
    afterEndOfLine - true if the annotation should be shown after the end of line, false otherwise.
  - isFileLevelAnnotation
```
public boolean isFileLevelAnnotation()
```
    File level annotations are visualized differently than lesser range annotations by showing a title bar on top of the editor rather than applying text attributes to the text range.
    
    Returns:
    
    true if this particular annotation have been defined as file level.
  - setFileLevelAnnotation
```
public void setFileLevelAnnotation(boolean isFileLevelAnnotation)
```
    File level annotations are visualized differently than lesser range annotations by showing a title bar on top of the editor rather than applying text attributes to the text range.
    
    Parameters:
    
    isFileLevelAnnotation - true if this particular annotation should be visualized at file level.
  - getGutterIconRenderer
```
public GutterIconRenderer getGutterIconRenderer()
```
    Gets the renderer used to draw the gutter icon in the region covered by the annotation.
    
    Returns:
    
    the gutter icon renderer instance.
  - setGutterIconRenderer
```
public void setGutterIconRenderer(GutterIconRenderer gutterIconRenderer)
```
    Sets the renderer used to draw the gutter icon in the region covered by the annotation.
    
    Parameters:
    
    gutterIconRenderer - the gutter icon renderer instance.
  - getProblemGroup
```
public ProblemGroup getProblemGroup()
```
    Gets the unique object, which is the same for all of the problems of this group
    
    Returns:
    
    the problem group
  - setProblemGroup
```
public void setProblemGroup(ProblemGroup problemGroup)
```
    Sets the unique object, which is the same for all of the problems of this group
    
    Parameters:
    
    problemGroup - the problem group
  - toString
```
public java.lang.String toString()
```
    Overrides:
    
    toString in class java.lang.Object

Class Annotation

Nested Class Summary

Field Summary

Fields inherited from interface com.intellij.openapi.util.Segment

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

Annotation

Method Detail

registerFix

registerFix

registerFix

registerFix

registerBatchFix

registerUniversalFix

setNeedsUpdateOnTyping

needsUpdateOnTyping

getStartOffset

getEndOffset

getSeverity

getHighlightType

getTextAttributes

getEnforcedTextAttributes

setEnforcedTextAttributes

getQuickFixes

getBatchFixes

getMessage

getTooltip

setTooltip

setHighlightType

setTextAttributes

isAfterEndOfLine

setAfterEndOfLine

isFileLevelAnnotation

setFileLevelAnnotation

getGutterIconRenderer

setGutterIconRenderer

getProblemGroup

setProblemGroup

toString