Package com.intellij.ide.favoritesTreeView

Class FavoriteNodeProvider

java.lang.Object

com.intellij.ide.favoritesTreeView.FavoriteNodeProvider

Direct Known Subclasses:

PsiClassFavoriteNodeProvider, PsiFieldFavoriteNodeProvider, PsiMethodFavoriteNodeProvider, PsiPackageFavoriteNodeProvider, ResourcesFavoriteNodeProvider, UIDesignerFavoriteNodeProvider, UsageFavoriteNodeProvider

public abstract class FavoriteNodeProvider
extends java.lang.Object

Returns the nodes which should be added to the Favorites for the given data context. Implementations of this class must be registered as extensions for com.intellij.favoriteNodeProvider extension point.

Field Summary

Fields

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

Constructor Summary

Constructors

Constructor and Description
FavoriteNodeProvider()

Method Summary

Modifier and Type	Method and Description
AbstractTreeNode<?>	createNode(Project project, java.lang.Object element, ViewSettings viewSettings)
abstract java.lang.Object []	createPathFromUrl(Project project, java.lang.String url, java.lang.String moduleName) Returns the path of node objects to be added to the favorites tree for the specified persisted URL and module name.
abstract boolean	elementContainsFile(java.lang.Object element, VirtualFile vFile) Checks if the specified project view node element (the value of AbstractTreeNode) contains the specified virtual file as one of its children.
abstract java.lang.String	getElementLocation(java.lang.Object element) Returns the location text (grey text in parentheses) to display in the Favorites view for the specified element.
abstract java.lang.String	getElementModuleName(java.lang.Object element) Returns the name of the module containing the specified element.
abstract java.lang.String	getElementUrl(java.lang.Object element) Returns the persistable URL for the specified element.
abstract int	getElementWeight(java.lang.Object element, boolean isSortByType) Returns the weight of the specified project view node element to use when sorting the favorites list.
abstract java.util.Collection<AbstractTreeNode<?>>	getFavoriteNodes(DataContext context, ViewSettings viewSettings)
abstract java.lang.String	getFavoriteTypeId() Returns the identifier used to persist favorites for this provider.
PsiElement	getPsiElement(java.lang.Object element)
abstract boolean	isInvalidElement(java.lang.Object element) Checks if the specified element is invalid and needs to be removed from the tree.

Methods inherited from class java.lang.Object

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

Field Detail

EP_NAME

public static final ExtensionPointName<FavoriteNodeProvider> EP_NAME

Constructor Detail

FavoriteNodeProvider

public FavoriteNodeProvider()

Method Detail

getFavoriteNodes

public abstract java.util.Collection<AbstractTreeNode<?>> getFavoriteNodes(DataContext context,
                                                                           ViewSettings viewSettings)

createNode

public AbstractTreeNode<?> createNode(Project project,
                                      java.lang.Object element,
                                      ViewSettings viewSettings)

elementContainsFile

public abstract boolean elementContainsFile(java.lang.Object element,
                                            VirtualFile vFile)

Checks if the specified project view node element (the value of AbstractTreeNode) contains the specified virtual file as one of its children.

Parameters:

element - the value element of a project view node.

vFile - the file to check.

Returns:

true if the file is contained, false if not or if element is not an element supported by this provider.

getElementWeight

public abstract int getElementWeight(java.lang.Object element,
                                     boolean isSortByType)

Returns the weight of the specified project view node element to use when sorting the favorites list.

Parameters:

element - the element for which the weight is requested.

Returns:

the weight, or -1 if element is not an element supported by this provider.

getElementLocation

public abstract java.lang.String getElementLocation(java.lang.Object element)

Returns the location text (grey text in parentheses) to display in the Favorites view for the specified element.

Parameters:

element - the element for which the location is requested.

Returns:

the location text, or -1 if element is not an element supported by this provider.

isInvalidElement

public abstract boolean isInvalidElement(java.lang.Object element)

Checks if the specified element is invalid and needs to be removed from the tree.

Parameters:

element - the element to check.

Returns:

true if the element is invalid, false if the element is valid or not supported by this provider.

getFavoriteTypeId

public abstract java.lang.String getFavoriteTypeId()

Returns the identifier used to persist favorites for this provider.

Returns:

the string identifier.

getElementUrl

public abstract java.lang.String getElementUrl(java.lang.Object element)

Returns the persistable URL for the specified element.

Returns:

the URL, or null if the element is not supported by this provider.

getElementModuleName

public abstract java.lang.String getElementModuleName(java.lang.Object element)

Returns the name of the module containing the specified element.

Returns:

the name of the module, or null if the element is not supported by this provider or the module name is unknown.

createPathFromUrl

public abstract java.lang.Object [] createPathFromUrl(Project project,
                                                      java.lang.String url,
                                                      java.lang.String moduleName)

Returns the path of node objects to be added to the favorites tree for the specified persisted URL and module name.

Parameters:

project - the project to which the favorite is related.

url - the loaded URL (initially returned from getElementUrl(java.lang.Object)).

moduleName - the name of the module containing the element (initially returned from getElementModuleName(java.lang.Object))

Returns:

the path of objects to be added to the tree, or null if it was not possible to locate an object with the specified URL.

getPsiElement

public PsiElement getPsiElement(java.lang.Object element)