TodoTreeBuilder (Unofficial IntelliJ Community Edition API docs)

java.lang.Object
- com.intellij.ide.todo.TodoTreeBuilder

All Implemented Interfaces:

Disposable

Direct Known Subclasses:

AllTodosTreeBuilder, ChangeListTodosTreeBuilder, CurrentFileTodosTreeBuilder, CustomChangelistTodosTreeBuilder, ScopeBasedTodosTreeBuilder
```
public abstract class TodoTreeBuilder
extends java.lang.Object
implements Disposable
```

Nested Class Summary
- Nested classes/interfaces inherited from interface com.intellij.openapi.Disposable
  Disposable.Parent

Field Summary

Fields
Modifier and Type	Field and Description
`protected java.util.HashSet<VirtualFile>`	`myDirtyFileSet` This set contains "dirty" files.
`protected java.util.Map<VirtualFile,EditorHighlighter>`	`myFile2Highlighter`
`protected com.intellij.ide.todo.FileTree`	`myFileTree` All files that have T.O.D.O items are presented as tree.
`protected Project`	`myProject`
`protected PsiTodoSearchHelper`	`mySearchHelper`
`static java.util.Comparator<NodeDescriptor<?>>`	`NODE_DESCRIPTOR_COMPARATOR`

Method Summary

All Methods Instance Methods Abstract Methods Concrete Methods
Modifier and Type	Method and Description
`protected abstract TodoTreeStructure`	`createTreeStructure()`
`void`	`dispose()` Usually not invoked directly, see class javadoc.
`java.util.Iterator<PsiFile>`	`getAllFiles()`
`java.util.Iterator<PsiFile>`	`getFiles(Module module)`
`java.util.Iterator<PsiFile>`	`getFiles(PsiDirectory psiDirectory)`
`java.util.Iterator<PsiFile>`	`getFiles(PsiDirectory psiDirectory, boolean skip)`
`java.util.Iterator<PsiFile>`	`getFilesUnderDirectory(PsiDirectory psiDirectory)`
`TodoItemNode`	`getFirstPointerForElement(java.lang.Object element)`
`EditorHighlighter`	`getHighlighter(PsiFile psiFile, Document document)`
`TodoItemNode`	`getLastPointerForElement(java.lang.Object element)`
`StructureTreeModel`	`getModel()`
`TodoItemNode`	`getNextPointer(TodoItemNode pointer)`
`TodoItemNode`	`getPreviousPointer(TodoItemNode pointer)`
`TodoTreeStructure`	`getTodoTreeStructure()`
`void`	`init()` Initializes the builder.
`protected boolean`	`isAutoExpandNode(NodeDescriptor descriptor)`
`boolean`	`isDirectoryEmpty(PsiDirectory psiDirectory)`
`boolean`	`isDisposed()`
`void`	`select(java.lang.Object obj)`
`void`	`setModel(StructureTreeModel model)`
`Promise<?>`	`updateTree()`

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

- Field Detail
  - NODE_DESCRIPTOR_COMPARATOR
```
public static final java.util.Comparator<NodeDescriptor<?>> NODE_DESCRIPTOR_COMPARATOR
```
  - myProject
```
protected final Project myProject
```
  - myFileTree
```
protected final com.intellij.ide.todo.FileTree myFileTree
```
    All files that have T.O.D.O items are presented as tree. This tree help a lot to separate these files by directories.
  - myDirtyFileSet
```
protected final java.util.HashSet<VirtualFile> myDirtyFileSet
```
    This set contains "dirty" files. File is "dirty" if it's currently not unknown whether the file contains T.O.D.O item or not. To determine this it's necessary to perform some (perhaps, CPU expensive) operation. These "dirty" files are validated in validateCache() method.
  - myFile2Highlighter
```
protected final java.util.Map<VirtualFile,EditorHighlighter> myFile2Highlighter
```
  - mySearchHelper
```
protected final PsiTodoSearchHelper mySearchHelper
```
- Method Detail
  - getModel
```
public StructureTreeModel getModel()
```
  - setModel
```
public void setModel(StructureTreeModel model)
```
  - init
```
public final void init()
```
    Initializes the builder. Subclasses should don't forget to call this method after constructor has been invoked.
  - isDisposed
```
public boolean isDisposed()
```
  - dispose
```
public final void dispose()
```
    Description copied from interface: Disposable
    
    Usually not invoked directly, see class javadoc.
    
    Specified by:
    
    dispose in interface Disposable
  - createTreeStructure
```
protected abstract TodoTreeStructure createTreeStructure()
```
  - getTodoTreeStructure
```
public final TodoTreeStructure getTodoTreeStructure()
```
  - getAllFiles
```
public java.util.Iterator<PsiFile> getAllFiles()
```
    Returns:
    
    read-only iterator of all current PSI files that can contain TODOs. Don't invoke its remove method. For "removing" use markFileAsDirty method. Note, that next() method of iterator can return null elements. These null elements correspond to the invalid PSI files (PSI file cannot be found by virtual file, or virtual file is invalid). The reason why we return such "dirty" iterator is the performance.
  - getFiles
```
public java.util.Iterator<PsiFile> getFiles(PsiDirectory psiDirectory)
```
    Returns:
    
    read-only iterator of all valid PSI files that can have T.O.D.O items and which are located under specified psiDirectory.
    
    See Also:
    
    FileTree.getFiles(VirtualFile)
  - getFiles
```
public java.util.Iterator<PsiFile> getFiles(PsiDirectory psiDirectory,
                                            boolean skip)
```
    Returns:
    
    read-only iterator of all valid PSI files that can have T.O.D.O items and which are located under specified psiDirectory.
    
    See Also:
    
    FileTree.getFiles(VirtualFile)
  - getFilesUnderDirectory
```
public java.util.Iterator<PsiFile> getFilesUnderDirectory(PsiDirectory psiDirectory)
```
    Returns:
    
    read-only iterator of all valid PSI files that can have T.O.D.O items and which are located under specified psiDirectory.
    
    See Also:
    
    FileTree.getFiles(VirtualFile)
  - getFiles
```
public java.util.Iterator<PsiFile> getFiles(Module module)
```
    Returns:
    
    read-only iterator of all valid PSI files that can have T.O.D.O items and which in specified module.
    
    See Also:
    
    FileTree.getFiles(VirtualFile)
  - isAutoExpandNode
```
protected boolean isAutoExpandNode(NodeDescriptor descriptor)
```
  - getFirstPointerForElement
```
public TodoItemNode getFirstPointerForElement(java.lang.Object element)
```
    Returns:
    
    first SmartTodoItemPointer that is the children (in depth) of the specified element. If element itself is a TodoItem then the method returns the element.
  - getLastPointerForElement
```
public TodoItemNode getLastPointerForElement(java.lang.Object element)
```
    Returns:
    
    last SmartTodoItemPointer that is the children (in depth) of the specified element. If element itself is a TodoItem then the method returns the element.
  - updateTree
```
public final Promise<?> updateTree()
```
  - select
```
public void select(java.lang.Object obj)
```
  - getNextPointer
```
public TodoItemNode getNextPointer(TodoItemNode pointer)
```
    Returns:
    
    next TodoItem for the passed pointer. Returns null if the pointer is the last t.o.d.o item in the tree.
  - getPreviousPointer
```
public TodoItemNode getPreviousPointer(TodoItemNode pointer)
```
    Returns:
    
    next SmartTodoItemPointer for the passed pointer. Returns null if the pointer is the last t.o.d.o item in the tree.
  - getHighlighter
```
public EditorHighlighter getHighlighter(PsiFile psiFile,
                                        Document document)
```
    Returns:
    
    SelectInEditorManager for the specified psiFile. Highlighters are lazy created and initialized.
  - isDirectoryEmpty
```
public boolean isDirectoryEmpty(PsiDirectory psiDirectory)
```

Class TodoTreeBuilder

Nested Class Summary

Nested classes/interfaces inherited from interface com.intellij.openapi.Disposable

Field Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

NODE_DESCRIPTOR_COMPARATOR

myProject

myFileTree

myDirtyFileSet

myFile2Highlighter

mySearchHelper

Method Detail

getModel

setModel

init

isDisposed

dispose

createTreeStructure

getTodoTreeStructure

getAllFiles

getFiles

getFiles

getFilesUnderDirectory

getFiles

isAutoExpandNode

getFirstPointerForElement

getLastPointerForElement

updateTree

select

getNextPointer

getPreviousPointer

getHighlighter

isDirectoryEmpty