Package com.intellij.navigation

Interface ChooseByNameContributor

All Known Subinterfaces:

ChooseByNameContributorEx, GotoClassContributor

All Known Implementing Classes:

DefaultClassNavigationContributor, DefaultFileNavigationContributor, DefaultSymbolNavigationContributor, DefaultSymbolNavigationContributor.JavadocSeparatorContributor, EditorConfigGotoFileContributor, GotoSymbolContributor, GoToSymbolProvider, GroovyGoToSymbolContributor, PyGotoClassContributor, PyGotoSymbolContributor

public interface ChooseByNameContributor

Allows a plugin to add items to "Navigate Class|File|Symbol" lists.

Consider extending ChooseByNameContributorEx for better performance.

See Also:

ChooseByNameContributorEx, GotoClassContributor, ChooseByNameRegistry

Field Summary

Fields

Modifier and Type	Field and Description
static ExtensionPointName<ChooseByNameContributor>	CLASS_EP_NAME
static ExtensionPointName<ChooseByNameContributor>	FILE_EP_NAME
static ExtensionPointName<ChooseByNameContributor>	SYMBOL_EP_NAME

Method Summary

Modifier and Type	Method and Description
NavigationItem []	getItemsByName(java.lang.String name, java.lang.String pattern, Project project, boolean includeNonProjectItems) Returns the list of navigation items matching the specified name.
java.lang.String []	getNames(Project project, boolean includeNonProjectItems) Returns the list of names for the specified project to which it is possible to navigate by name.

Field Detail

CLASS_EP_NAME

static final ExtensionPointName<ChooseByNameContributor> CLASS_EP_NAME

SYMBOL_EP_NAME

static final ExtensionPointName<ChooseByNameContributor> SYMBOL_EP_NAME

FILE_EP_NAME

static final ExtensionPointName<ChooseByNameContributor> FILE_EP_NAME

Method Detail

getNames

java.lang.String [] getNames(Project project,
                             boolean includeNonProjectItems)

Returns the list of names for the specified project to which it is possible to navigate by name.

Parameters:

project - the project in which the navigation is performed.

includeNonProjectItems - if true, the names of non-project items (for example, library classes) should be included in the returned array.

Returns:

the array of names.

getItemsByName

NavigationItem [] getItemsByName(java.lang.String name,
                                 java.lang.String pattern,
                                 Project project,
                                 boolean includeNonProjectItems)

Returns the list of navigation items matching the specified name.

Parameters:

name - the name selected from the list.

pattern - the original pattern entered in the dialog

project - the project in which the navigation is performed.

includeNonProjectItems - if true, the navigation items for non-project items (for example, library classes) should be included in the returned array.

Returns:

the array of navigation items.