TextEditorHighlightingPass (Unofficial IntelliJ Community Edition API docs)

java.lang.Object
- com.intellij.codeHighlighting.TextEditorHighlightingPass

All Implemented Interfaces:

HighlightingPass

Direct Known Subclasses:

EditorBoundHighlightingPass, GroovyPostHighlightingPass, GrReferenceHighlighter, IdentifierHighlighterPass, IndentsPass, JavaTextBlockIndentPass, LineMarkersPass, ProgressableTextEditorHighlightingPass, ProjectProblemPass, ShowAutoImportPass, ShowIntentionsPass, XmlTagTreeHighlightingPass
```
public abstract class TextEditorHighlightingPass
extends java.lang.Object
implements HighlightingPass
```

Field Summary

Fields
Modifier and Type Field and Description

static TextEditorHighlightingPass[] EMPTY_ARRAY

protected Document myDocument

protected Project myProject

Fields
Modifier and Type	Field and Description
`static TextEditorHighlightingPass[]`	`EMPTY_ARRAY`
`protected Document`	`myDocument`
`protected Project`	`myProject`

Constructor Summary

Constructors
Modifier	Constructor and Description
`protected`	`TextEditorHighlightingPass(Project project, Document document)`
`protected`	`TextEditorHighlightingPass(Project project, Document document, boolean runIntentionPassAfter)`

Method Summary

All Methods Instance Methods Abstract Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`applyInformationToEditor()` Called to apply information collected by HighlightingPass.collectInformation(com.intellij.openapi.progress.ProgressIndicator) to the editor.
`void`	`collectInformation(ProgressIndicator progress)` Asks this pass to start analysis and hold collected information.
`abstract void`	`doApplyInformationToEditor()`
`abstract void`	`doCollectInformation(ProgressIndicator progress)`
`EditorColorsScheme`	`getColorsScheme()`
`int []`	`getCompletionPredecessorIds()`
`Document`	`getDocument()`
`int`	`getId()`
`java.util.List<HighlightInfo>`	`getInfos()`
`int []`	`getStartingPredecessorIds()`
`protected boolean`	`isDumbMode()`
`boolean`	`isRunIntentionPassAfter()`
`protected boolean`	`isValid()`
`void`	`setColorsScheme(EditorColorsScheme colorsScheme)`
`void`	`setCompletionPredecessorIds(int [] completionPredecessorIds)`
`void`	`setId(int id)`
`void`	`setStartingPredecessorIds(int [] startingPredecessorIds)`
`java.lang.String`	`toString()`

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

Field Detail

EMPTY_ARRAY

public static final TextEditorHighlightingPass[] EMPTY_ARRAY

myDocument
```
protected final Document myDocument
```

myProject
```
protected final Project myProject
```

Constructor Detail

TextEditorHighlightingPass

protected TextEditorHighlightingPass(Project project,
                                     Document document,
                                     boolean runIntentionPassAfter)

TextEditorHighlightingPass

protected TextEditorHighlightingPass(Project project,
                                     Document document)

Method Detail
- collectInformation
```
public final void collectInformation(ProgressIndicator progress)
```
  Description copied from interface: HighlightingPass
  
  Asks this pass to start analysis and hold collected information. This method is called from a background thread.
  
  Specified by:
  
  collectInformation in interface HighlightingPass
  
  Parameters:
  
  progress - to check if highlighting process is cancelled. Pass is to check progress.isCanceled() as often as possible and throw ProcessCanceledException if true is returned. See also ProgressIndicator.checkCanceled().
- getColorsScheme
```
public EditorColorsScheme getColorsScheme()
```
- setColorsScheme
```
public void setColorsScheme(EditorColorsScheme colorsScheme)
```
- isDumbMode
```
protected boolean isDumbMode()
```
- isValid
```
protected boolean isValid()
```
- applyInformationToEditor
```
public final void applyInformationToEditor()
```
  Description copied from interface: HighlightingPass
  
  Called to apply information collected by HighlightingPass.collectInformation(com.intellij.openapi.progress.ProgressIndicator) to the editor. This method is called from the event dispatch thread.
  
  Specified by:
  
  applyInformationToEditor in interface HighlightingPass
- doCollectInformation
```
public abstract void doCollectInformation(ProgressIndicator progress)
```
- doApplyInformationToEditor
```
public abstract void doApplyInformationToEditor()
```
- getId
```
public final int getId()
```
- setId
```
public final void setId(int id)
```
- getInfos
```
public java.util.List<HighlightInfo> getInfos()
```
- getCompletionPredecessorIds
```
public final int [] getCompletionPredecessorIds()
```
- setCompletionPredecessorIds
```
public final void setCompletionPredecessorIds(int [] completionPredecessorIds)
```
- getDocument
```
public Document getDocument()
```
- getStartingPredecessorIds
```
public final int [] getStartingPredecessorIds()
```
- setStartingPredecessorIds
```
public final void setStartingPredecessorIds(int [] startingPredecessorIds)
```
- toString
```
public java.lang.String toString()
```
  Overrides:
  
  toString in class java.lang.Object
- isRunIntentionPassAfter
```
public boolean isRunIntentionPassAfter()
```

Class TextEditorHighlightingPass

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

EMPTY_ARRAY

myDocument

myProject

Constructor Detail

TextEditorHighlightingPass

TextEditorHighlightingPass

Method Detail

collectInformation

getColorsScheme

setColorsScheme

isDumbMode

isValid

applyInformationToEditor

doCollectInformation

doApplyInformationToEditor

getId

setId

getInfos

getCompletionPredecessorIds

setCompletionPredecessorIds

getDocument

getStartingPredecessorIds

setStartingPredecessorIds

toString

isRunIntentionPassAfter