Package com.intellij.xml.breadcrumbs

Class PsiFileBreadcrumbsCollector

java.lang.Object

com.intellij.codeInsight.breadcrumbs.FileBreadcrumbsCollector

com.intellij.xml.breadcrumbs.PsiFileBreadcrumbsCollector

public class PsiFileBreadcrumbsCollector
extends FileBreadcrumbsCollector

Field Summary

Fields inherited from class com.intellij.codeInsight.breadcrumbs.FileBreadcrumbsCollector

EP_NAME

Constructor Summary

Constructors

Constructor and Description
PsiFileBreadcrumbsCollector(Project project)

Method Summary

Modifier and Type	Method and Description
java.lang.Iterable<Crumb>	computeCrumbs(VirtualFile file, Document document, int offset, java.lang.Boolean forcedShown)
static PsiElement []	getLinePsiElements(Document document, int offset, VirtualFile file, Project project, BreadcrumbsProvider infoProvider)
boolean	handlesFile(VirtualFile virtualFile) Checks if this collector handles the given file.
boolean	isShownForFile(Editor editor, VirtualFile file) Checks if the breadcrumbs should be shown for the given file.
void	watchForChanges(VirtualFile file, Editor editor, Disposable disposable, java.lang.Runnable changesHandler) Adds event listeners required to redraw the breadcrumbs when the contents of the file changes.

Methods inherited from class com.intellij.codeInsight.breadcrumbs.FileBreadcrumbsCollector

findBreadcrumbsCollector

Methods inherited from class java.lang.Object

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

Constructor Detail

PsiFileBreadcrumbsCollector

public PsiFileBreadcrumbsCollector(Project project)

Method Detail

handlesFile

public boolean handlesFile(VirtualFile virtualFile)

Description copied from class: FileBreadcrumbsCollector

Checks if this collector handles the given file.

Specified by:

handlesFile in class FileBreadcrumbsCollector

isShownForFile

public boolean isShownForFile(Editor editor,
                              VirtualFile file)

Description copied from class: FileBreadcrumbsCollector

Checks if the breadcrumbs should be shown for the given file.

Overrides:

isShownForFile in class FileBreadcrumbsCollector

watchForChanges

public void watchForChanges(VirtualFile file,
                            Editor editor,
                            Disposable disposable,
                            java.lang.Runnable changesHandler)

Description copied from class: FileBreadcrumbsCollector

Adds event listeners required to redraw the breadcrumbs when the contents of the file changes.

Specified by:

watchForChanges in class FileBreadcrumbsCollector

Parameters:

file - the file to watch

editor - current editor

disposable - the disposable used to detach listeners when the file is closed.

changesHandler - the callback to be called when any changes are detected.

computeCrumbs

public java.lang.Iterable<Crumb> computeCrumbs(VirtualFile file,
                                               Document document,
                                               int offset,
                                               java.lang.Boolean forcedShown)

Specified by:

computeCrumbs in class FileBreadcrumbsCollector

getLinePsiElements

public static PsiElement [] getLinePsiElements(Document document,
                                               int offset,
                                               VirtualFile file,
                                               Project project,
                                               BreadcrumbsProvider infoProvider)