Package com.intellij.ui.breadcrumbs

Interface BreadcrumbsProvider

All Known Implementing Classes:

BreadcrumbsInfoProvider, JavaBreadcrumbsInfoProvider, JsonBreadcrumbsProvider, XmlLanguageBreadcrumbsInfoProvider, YAMLBreadcrumbsInfoProvider

public interface BreadcrumbsProvider

Field Summary

Fields

Modifier and Type	Field and Description
static ExtensionPointName<BreadcrumbsProvider>	EP_NAME

Method Summary

Modifier and Type	Method and Description
boolean	acceptElement(PsiElement element)
default java.util.List<PsiElement>	getChildren(PsiElement element) Reserved for future releases.
default java.util.List<? extends javax.swing.Action>	getContextActions(PsiElement element)
default javax.swing.Icon	getElementIcon(PsiElement element)
java.lang.String	getElementInfo(PsiElement element)
default java.lang.String	getElementTooltip(PsiElement element)
Language[]	getLanguages()
default PsiElement	getParent(PsiElement element)
default boolean	isShownByDefault()

Field Detail

EP_NAME

static final ExtensionPointName<BreadcrumbsProvider> EP_NAME

Method Detail

getLanguages

Language[] getLanguages()

Returns:

an array of languages supported by this provider

acceptElement

boolean acceptElement(PsiElement element)

Parameters:

element - that represents a single crumb

Returns:

true if the specified element is supported by this provider

getElementInfo

java.lang.String getElementInfo(PsiElement element)

Parameters:

element - that represents a single crumb

Returns:

a text for the specified element

getElementIcon

default javax.swing.Icon getElementIcon(PsiElement element)

Parameters:

element - that represents a single crumb

Returns:

an icon for the specified element

getElementTooltip

default java.lang.String getElementTooltip(PsiElement element)

Parameters:

element - that represents a single crumb

Returns:

a description for the specified element

getParent

default PsiElement getParent(PsiElement element)

Parameters:

element - that represents a single crumb

Returns:

an element that represents a parent crumb, or null

getChildren

default java.util.List<PsiElement> getChildren(PsiElement element)

Reserved for future releases. Not supported yet.

Parameters:

element - that represents a single crumb

Returns:

a list of elements to navigate

getContextActions

default java.util.List<? extends javax.swing.Action> getContextActions(PsiElement element)

Parameters:

element - that represents a single crumb

Returns:

a list of actions for context menu

isShownByDefault

default boolean isShownByDefault()