Package com.intellij.ide.favoritesTreeView

Class PsiMethodFavoriteNodeProvider

java.lang.Object

com.intellij.ide.favoritesTreeView.FavoriteNodeProvider

com.intellij.ide.favoritesTreeView.PsiMethodFavoriteNodeProvider

public class PsiMethodFavoriteNodeProvider
extends FavoriteNodeProvider

Field Summary

Fields inherited from class com.intellij.ide.favoritesTreeView.FavoriteNodeProvider

EP_NAME

Constructor Summary

Constructors

Constructor and Description
PsiMethodFavoriteNodeProvider()

Method Summary

Modifier and Type	Method and Description
AbstractTreeNode	createNode(Project project, java.lang.Object element, ViewSettings viewSettings)
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.
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.
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.
java.lang.String	getElementModuleName(java.lang.Object element) Returns the name of the module containing the specified element.
java.lang.String	getElementUrl(java.lang.Object element) Returns the persistable URL for the specified element.
int	getElementWeight(java.lang.Object value, boolean isSortByType) Returns the weight of the specified project view node element to use when sorting the favorites list.
java.util.Collection<AbstractTreeNode<?>>	getFavoriteNodes(DataContext context, ViewSettings viewSettings)
java.lang.String	getFavoriteTypeId() Returns the identifier used to persist favorites for this provider.
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 com.intellij.ide.favoritesTreeView.FavoriteNodeProvider

getPsiElement

Methods inherited from class java.lang.Object

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

Constructor Detail

PsiMethodFavoriteNodeProvider

public PsiMethodFavoriteNodeProvider()

Method Detail

getFavoriteNodes

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

Specified by:

getFavoriteNodes in class FavoriteNodeProvider

createNode

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

Overrides:

createNode in class FavoriteNodeProvider

elementContainsFile

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

Description copied from class: FavoriteNodeProvider

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

Specified by:

elementContainsFile in class FavoriteNodeProvider

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 int getElementWeight(java.lang.Object value,
                            boolean isSortByType)

Description copied from class: FavoriteNodeProvider

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

Specified by:

getElementWeight in class FavoriteNodeProvider

Parameters:

value - 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 java.lang.String getElementLocation(java.lang.Object element)

Description copied from class: FavoriteNodeProvider

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

Specified by:

getElementLocation in class FavoriteNodeProvider

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 boolean isInvalidElement(java.lang.Object element)

Description copied from class: FavoriteNodeProvider

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

Specified by:

isInvalidElement in class FavoriteNodeProvider

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 java.lang.String getFavoriteTypeId()

Description copied from class: FavoriteNodeProvider

Returns the identifier used to persist favorites for this provider.

Specified by:

getFavoriteTypeId in class FavoriteNodeProvider

Returns:

the string identifier.

getElementUrl

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

Description copied from class: FavoriteNodeProvider

Returns the persistable URL for the specified element.

Specified by:

getElementUrl in class FavoriteNodeProvider

Returns:

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

getElementModuleName

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

Description copied from class: FavoriteNodeProvider

Returns the name of the module containing the specified element.

Specified by:

getElementModuleName in class FavoriteNodeProvider

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 java.lang.Object[] createPathFromUrl(Project project,
                                            java.lang.String url,
                                            java.lang.String moduleName)

Description copied from class: FavoriteNodeProvider

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

Specified by:

createPathFromUrl in class FavoriteNodeProvider

Parameters:

project - the project to which the favorite is related.

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

moduleName - the name of the module containing the element (initially returned from FavoriteNodeProvider.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.