Package com.intellij.ide.todo

Class TodoTreeStructure

java.lang.Object

com.intellij.ide.util.treeView.AbstractTreeStructure

com.intellij.ide.util.treeView.AbstractTreeStructureBase

com.intellij.ide.todo.TodoTreeStructure

All Implemented Interfaces:

ToDoSettings

Direct Known Subclasses:

AllTodosTreeStructure, ChangeListTodosTreeStructure, CurrentFileTodosTreeStructure, CustomChangelistTodoTreeStructure, ScopeBasedTodosTreeStructure

public abstract class TodoTreeStructure
extends AbstractTreeStructureBase
implements ToDoSettings

Field Summary

Fields

Modifier and Type	Field and Description
protected boolean	myArePackagesShown
protected TodoTreeBuilder	myBuilder
protected AbstractTreeNode	myRootElement
protected PsiTodoSearchHelper	mySearchHelper
protected ToDoSummary	mySummaryElement
protected TodoFilter	myTodoFilter Current TodoFilter.

Fields inherited from class com.intellij.ide.util.treeView.AbstractTreeStructureBase

myProject

Constructor Summary

Constructors

Constructor and Description
TodoTreeStructure(Project project)

Method Summary

Modifier and Type	Method and Description
abstract boolean	accept(PsiFile psiFile)
boolean	areFlattenPackages()
ActionCallback	asyncCommit()
void	commit()
protected abstract AbstractTreeNode	createRootElement()
boolean	getIsFlattenPackages()
java.util.List<TreeStructureProvider>	getProviders()
java.lang.Object	getRootElement()
PsiTodoSearchHelper	getSearchHelper()
TodoFilter	getTodoFilter()
int	getTodoItemCount(PsiFile psiFile)
boolean	hasSomethingToCommit()
boolean	isModulesShown()
boolean	isPackagesShown()
void	setFlattenPackages(boolean state)
protected void	validateCache() Validate whole the cache

Methods inherited from class com.intellij.ide.util.treeView.AbstractTreeStructureBase

createDescriptor, getChildElements, getDataFromProviders, getParentElement, isValid

Methods inherited from class com.intellij.ide.util.treeView.AbstractTreeStructure

asyncCommitDocuments, getLeafState, isAlwaysLeaf, isToBuildChildrenInBackground, revalidateElement

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.intellij.ide.todo.ToDoSettings

getIsPackagesShown

Field Detail

myBuilder

protected TodoTreeBuilder myBuilder

myRootElement

protected AbstractTreeNode myRootElement

mySummaryElement

protected final ToDoSummary mySummaryElement

myArePackagesShown

protected boolean myArePackagesShown

mySearchHelper

protected final PsiTodoSearchHelper mySearchHelper

myTodoFilter

protected TodoFilter myTodoFilter

Current TodoFilter. If no filter is set then this field is null.

Constructor Detail

TodoTreeStructure

public TodoTreeStructure(Project project)

Method Detail

createRootElement

protected abstract AbstractTreeNode createRootElement()

accept

public abstract boolean accept(PsiFile psiFile)

validateCache

protected void validateCache()

Validate whole the cache

isPackagesShown

public final boolean isPackagesShown()

areFlattenPackages

public final boolean areFlattenPackages()

setFlattenPackages

public final void setFlattenPackages(boolean state)

getTodoItemCount

public final int getTodoItemCount(PsiFile psiFile)

Returns:

number of TodoItems located in the file.

commit

public final void commit()

Specified by:

commit in class AbstractTreeStructure

hasSomethingToCommit

public boolean hasSomethingToCommit()

Specified by:

hasSomethingToCommit in class AbstractTreeStructure

asyncCommit

public ActionCallback asyncCommit()

Overrides:

asyncCommit in class AbstractTreeStructure

Returns:

callback which is set to ActionCallback.setDone() when the tree structure is committed. By default it just calls AbstractTreeStructure.commit() synchronously but it is desirable to override it to provide asynchronous commit to the tree structure to make it more responsible. E.g. when you should commit all documents during the AbstractTreeStructure.commit(), you can use AbstractTreeStructure.asyncCommitDocuments(Project) to do it asynchronously.

getRootElement

public final java.lang.Object getRootElement()

Specified by:

getRootElement in class AbstractTreeStructure

getIsFlattenPackages

public boolean getIsFlattenPackages()

getSearchHelper

public PsiTodoSearchHelper getSearchHelper()

getTodoFilter

public TodoFilter getTodoFilter()

getProviders

public java.util.List<TreeStructureProvider> getProviders()

Specified by:

getProviders in class AbstractTreeStructureBase

isModulesShown

public boolean isModulesShown()

Specified by:

isModulesShown in interface ToDoSettings