Package com.intellij.ide.util.gotoByName

Class ContributorsBasedGotoByModel

java.lang.Object

com.intellij.ide.util.gotoByName.ContributorsBasedGotoByModel

All Implemented Interfaces:

ChooseByNameModel, ChooseByNameModelEx, PossiblyDumbAware

Direct Known Subclasses:

FilteringGotoByModel

public abstract class ContributorsBasedGotoByModel
extends java.lang.Object
implements ChooseByNameModelEx, PossiblyDumbAware

Contributor-based goto model

Field Summary

Fields

Modifier and Type	Field and Description
static Logger	LOG
protected Project	myProject

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	ContributorsBasedGotoByModel(Project project, ChooseByNameContributor [] contributors)
protected	ContributorsBasedGotoByModel(Project project, java.util.List<ChooseByNameContributor> contributors)

Method Summary

Modifier and Type	Method and Description
protected boolean	acceptItem(NavigationItem item) This method allows extending classes to introduce additional filtering criteria to model beyond pattern and project/non-project files.
protected java.util.List<ChooseByNameContributor>	getContributorList()
protected ChooseByNameContributor[]	getContributors()
java.lang.String	getElementName(java.lang.Object element)
java.lang.Object []	getElementsByName(java.lang.String name, boolean checkBoxState, java.lang.String pattern) Get elements by name from contributors.
java.lang.Object []	getElementsByName(java.lang.String name, FindSymbolParameters parameters, ProgressIndicator canceled)
java.lang.String	getHelpId()
javax.swing.ListCellRenderer	getListCellRenderer()
java.lang.String []	getNames(boolean checkBoxState) Returns the list of names to show in the chooser.
Project	getProject()
boolean	isDumbAware()
void	processContributorNames(ChooseByNameContributor contributor, FindSymbolParameters parameters, Processor<? super java.lang.String> nameProcessor)
void	processNames(Processor<? super java.lang.String> nameProcessor, FindSymbolParameters parameters)
java.lang.String	removeModelSpecificMarkup(java.lang.String pattern)
boolean	sameNamesForProjectAndLibraries()
boolean	useMiddleMatching()

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.intellij.ide.util.gotoByName.ChooseByNameModelEx

getItemProvider, getItemProvider, processNames

Methods inherited from interface com.intellij.ide.util.gotoByName.ChooseByNameModel

getCheckBoxMnemonic, getCheckBoxName, getFullName, getNotFoundMessage, getNotInMessage, getPromptText, getSeparators, loadInitialCheckBoxState, saveInitialCheckBoxState, willOpenEditor

Field Detail

LOG

public static final Logger LOG

myProject

protected final Project myProject

Constructor Detail

ContributorsBasedGotoByModel

protected ContributorsBasedGotoByModel(Project project,
                                       ChooseByNameContributor [] contributors)

ContributorsBasedGotoByModel

protected ContributorsBasedGotoByModel(Project project,
                                       java.util.List<ChooseByNameContributor> contributors)

Method Detail

isDumbAware

public boolean isDumbAware()

Specified by:

isDumbAware in interface PossiblyDumbAware

getListCellRenderer

public javax.swing.ListCellRenderer getListCellRenderer()

Specified by:

getListCellRenderer in interface ChooseByNameModel

sameNamesForProjectAndLibraries

public boolean sameNamesForProjectAndLibraries()

processNames

public void processNames(Processor<? super java.lang.String> nameProcessor,
                         FindSymbolParameters parameters)

Specified by:

processNames in interface ChooseByNameModelEx

processContributorNames

public void processContributorNames(ChooseByNameContributor contributor,
                                    FindSymbolParameters parameters,
                                    Processor<? super java.lang.String> nameProcessor)

getNames

public java.lang.String [] getNames(boolean checkBoxState)

Description copied from interface: ChooseByNameModel

Returns the list of names to show in the chooser.

Specified by:

getNames in interface ChooseByNameModel

Parameters:

checkBoxState - the current state of the chooser checkbox (for example, [x] Include non-project classes for Ctrl-N)

Returns:

the names to show. All items in the returned array must be non-null.

getElementsByName

public java.lang.Object [] getElementsByName(java.lang.String name,
                                             FindSymbolParameters parameters,
                                             ProgressIndicator canceled)

getElementsByName

public java.lang.Object [] getElementsByName(java.lang.String name,
                                             boolean checkBoxState,
                                             java.lang.String pattern)

Get elements by name from contributors.

Specified by:

getElementsByName in interface ChooseByNameModel

Parameters:

name - a name

checkBoxState - if true, non-project files are considered as well

pattern - a pattern to use

Returns:

a list of navigation items from contributors for which {@link #acceptItem(NavigationItem) returns true.

getElementName

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

Specified by:

getElementName in interface ChooseByNameModel

getHelpId

public java.lang.String getHelpId()

Specified by:

getHelpId in interface ChooseByNameModel

getContributorList

protected java.util.List<ChooseByNameContributor> getContributorList()

getContributors

protected ChooseByNameContributor[] getContributors()

acceptItem

protected boolean acceptItem(NavigationItem item)

This method allows extending classes to introduce additional filtering criteria to model beyond pattern and project/non-project files. The default implementation just returns true.

Parameters:

item - an item to filter

Returns:

true if the item is acceptable according to additional filtering criteria.

useMiddleMatching

public boolean useMiddleMatching()

Specified by:

useMiddleMatching in interface ChooseByNameModel

removeModelSpecificMarkup

public java.lang.String removeModelSpecificMarkup(java.lang.String pattern)

getProject

public Project getProject()