Package com.intellij.find

Class FindManager

java.lang.Object

com.intellij.find.FindManager

Direct Known Subclasses:

FindManagerImpl

public abstract class FindManager
extends java.lang.Object

Allows to invoke and control Find, Replace and Find Usages operations.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	FindManager.MalformedReplacementStringException
static interface	FindManager.PromptResult Possible return values for the showPromptDialog(FindModel, String) method.
static interface	FindManager.PromptResultValue

Field Summary

Fields

Modifier and Type	Field and Description
static Topic<FindModelListener>	FIND_MODEL_TOPIC

Constructor Summary

Constructors

Constructor and Description
FindManager()

Method Summary

Modifier and Type	Method and Description
abstract boolean	canFindUsages(PsiElement element) Checks if the Find Usages action is available for the specified element.
abstract void	clearFindingNextUsageInFile() Explicitly tell FindManager that "Find Next" and "Find Previous" actions should not use find usages previous results.
abstract FindModel	createReplaceInFileModel()
abstract boolean	findNextUsageInEditor(Editor editor) Performs a "Find Next" operation after "Find Usages in File" or "Highlight Usages in File".
abstract boolean	findNextUsageInEditor(FileEditor editor) Deprecated. please use findNextUsageInEditor(Editor)
abstract boolean	findPreviousUsageInEditor(Editor editor) Performs a "Find Previous" operation after "Find Usages in File" or "Highlight Usages in File".
abstract boolean	findPreviousUsageInEditor(FileEditor editor) Deprecated. please use findPreviousUsageInEditor(Editor)
abstract FindResult	findString(java.lang.CharSequence text, int offset, FindModel model) Searches for the specified substring in the specified character sequence, using the specified find settings.
abstract FindResult	findString(java.lang.CharSequence text, int offset, FindModel model, VirtualFile findContextFile) Searches for the specified substring in the specified character sequence, using the specified find settings.
abstract void	findUsages(PsiElement element) Performs the Find Usages operation for the specified element.
abstract void	findUsages(PsiElement element, boolean showDialog) Shows the Find Usages dialog (if showDialog is true} and performs the Find Usages operation for the specified element.
abstract void	findUsagesInEditor(PsiElement element, FileEditor editor) Performs a "Find Usages in File" operation for the specified element.
abstract void	findUsagesInScope(PsiElement element, SearchScope searchScope)
abstract boolean	findWasPerformed() Gets the flag indicating whether the "Find Next" and "Find Previous" actions are available to continue a previously started search operation.
abstract FindModel	getFindInFileModel() Returns the settings of the last performed Find in File operation, or the default Find in File settings if no such operation was performed by the user.
abstract FindModel	getFindInProjectModel() Returns the settings of the last performed Find in Project operation, or the default Find in Project settings if no such operation was performed by the user.
abstract FindModel	getFindNextModel() Gets the model containing the search settings to use for "Find Next" and "Find Previous" operations.
abstract FindModel	getFindNextModel(Editor editor) Gets the model containing the search settings to use for "Find Next" and "Find Previous" operations specific for the editor given.
static FindManager	getInstance(Project project) Returns the find manager instance for the specified project.
abstract FindModel	getPreviousFindModel()
abstract java.lang.String	getStringToReplace(java.lang.String foundString, FindModel model, int startOffset, java.lang.CharSequence documentText) Gets the string to replace with, given the specified found string and find/replace settings.
abstract boolean	selectNextOccurrenceWasPerformed() Gets the flag indicating that 'Add Selection for Next Occurrence' action was performed recently, so "Find Next" and "Find Previous" actions should work in its context.
abstract void	setFindNextModel(FindModel model) Sets the model containing the search settings to use for "Find Next" and "Find Previous" operations.
abstract void	setFindWasPerformed() Sets the flag indicating that the "Find Next" and "Find Previous" actions are available to continue a previously started search operation.
abstract void	setPreviousFindModel(FindModel previousFindModel)
abstract void	setSelectNextOccurrenceWasPerformed() Sets the flag indicating that 'Add Selection for Next Occurrence' action was performed recently, so "Find Next" and "Find Previous" actions should work in its context.
abstract void	showFindDialog(FindModel model, java.lang.Runnable okHandler) Shows the Find, Replace or Find Usages dialog initializing it from the specified model and saves the settings entered by the user into the same model.
abstract int	showMalformedReplacementPrompt(FindModel model, java.lang.String title, FindManager.MalformedReplacementStringException exception) Shows a replace prompt dialog for the bad replace operation.
abstract int	showPromptDialog(FindModel model, java.lang.String title) Shows a replace prompt dialog for the specified replace operation.
abstract void	showSettingsAndFindUsages(NavigationItem [] targets)

Methods inherited from class java.lang.Object

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

Field Detail

FIND_MODEL_TOPIC

public static final Topic<FindModelListener> FIND_MODEL_TOPIC

Constructor Detail

FindManager

public FindManager()

Method Detail

createReplaceInFileModel

public abstract FindModel createReplaceInFileModel()

getPreviousFindModel

public abstract FindModel getPreviousFindModel()

setPreviousFindModel

public abstract void setPreviousFindModel(FindModel previousFindModel)

showSettingsAndFindUsages

public abstract void showSettingsAndFindUsages(NavigationItem [] targets)

getInstance

public static FindManager getInstance(Project project)

Returns the find manager instance for the specified project.

Parameters:

project - the project for which the manager is requested.

Returns:

the manager instance.

showFindDialog

public abstract void showFindDialog(FindModel model,
                                    java.lang.Runnable okHandler)

Shows the Find, Replace or Find Usages dialog initializing it from the specified model and saves the settings entered by the user into the same model. Does not perform the actual find or replace operation.

Parameters:

model - the model containing the settings of a find or replace operation.

okHandler - Will be executed after doOkAction

showPromptDialog

public abstract int showPromptDialog(FindModel model,
                                     java.lang.String title)

Shows a replace prompt dialog for the specified replace operation.

Parameters:

model - the model containing the settings of the replace operation.

title - the title of the dialog to show.

Returns:

the exit code of the dialog, as defined by the FindManager.PromptResult interface.

getFindInFileModel

public abstract FindModel getFindInFileModel()

Returns the settings of the last performed Find in File operation, or the default Find in File settings if no such operation was performed by the user.

Returns:

the last Find in File settings.

getFindInProjectModel

public abstract FindModel getFindInProjectModel()

Returns the settings of the last performed Find in Project operation, or the default Find in Project settings if no such operation was performed by the user.

Returns:

the last Find in Project settings.

findString

public abstract FindResult findString(java.lang.CharSequence text,
                                      int offset,
                                      FindModel model)

Searches for the specified substring in the specified character sequence, using the specified find settings. Supports case sensitive and insensitive searches, forward and backward searches, regular expression searches and searches for whole words.

Parameters:

text - the text in which the search is performed.

offset - the start offset for the search.

model - the settings for the search, including the string to find.

Returns:

the result of the search.

findString

public abstract FindResult findString(java.lang.CharSequence text,
                                      int offset,
                                      FindModel model,
                                      VirtualFile findContextFile)

Searches for the specified substring in the specified character sequence, using the specified find settings. Supports case sensitive and insensitive searches, forward and backward searches, regular expression searches and searches for whole words.

Parameters:

text - the text in which the search is performed.

offset - the start offset for the search.

model - the settings for the search, including the string to find.

Returns:

the result of the search.

showMalformedReplacementPrompt

public abstract int showMalformedReplacementPrompt(FindModel model,
                                                   java.lang.String title,
                                                   FindManager.MalformedReplacementStringException exception)

Shows a replace prompt dialog for the bad replace operation.

Parameters:

model - the model containing the settings of the replace operation.

title - the title of the dialog to show.

exception - exception from getStringToReplace(String, FindModel, int, CharSequence)

Returns:

the exit code of the dialog, as defined by the FindManager.PromptResult interface. May be only FindManager.PromptResult.CANCEL or FindManager.PromptResult.SKIP for bad replace operation

getStringToReplace

public abstract java.lang.String getStringToReplace(java.lang.String foundString,
                                                    FindModel model,
                                                    int startOffset,
                                                    java.lang.CharSequence documentText)
                                             throws FindManager.MalformedReplacementStringException

Gets the string to replace with, given the specified found string and find/replace settings. Supports case-preserving and regular expression replaces.

Parameters:

foundString - the found string.

model - the search and replace settings, including the replace string.

startOffset - offset in the source text at which the string was found (matters for regex searches)

documentText - source text in which the string was found (matters for regex searches)

Returns:

the string to replace the specified found string.

Throws:

FindManager.MalformedReplacementStringException

findWasPerformed

public abstract boolean findWasPerformed()

Gets the flag indicating whether the "Find Next" and "Find Previous" actions are available to continue a previously started search operation. (The operations are available if at least one search was performed in the current IDE session.)

Returns:

true if the actions are available, false if there is no previous search operation to continue.

setFindWasPerformed

public abstract void setFindWasPerformed()

Sets the flag indicating that the "Find Next" and "Find Previous" actions are available to continue a previously started search operation.

selectNextOccurrenceWasPerformed

public abstract boolean selectNextOccurrenceWasPerformed()

Gets the flag indicating that 'Add Selection for Next Occurrence' action was performed recently, so "Find Next" and "Find Previous" actions should work in its context.

setSelectNextOccurrenceWasPerformed

public abstract void setSelectNextOccurrenceWasPerformed()

Sets the flag indicating that 'Add Selection for Next Occurrence' action was performed recently, so "Find Next" and "Find Previous" actions should work in its context.

clearFindingNextUsageInFile

public abstract void clearFindingNextUsageInFile()

Explicitly tell FindManager that "Find Next" and "Find Previous" actions should not use find usages previous results.

setFindNextModel

public abstract void setFindNextModel(FindModel model)

Sets the model containing the search settings to use for "Find Next" and "Find Previous" operations.

Parameters:

model - the model to use for the operations.

getFindNextModel

public abstract FindModel getFindNextModel()

Gets the model containing the search settings to use for "Find Next" and "Find Previous" operations.

Returns:

the model to use for the operations.

getFindNextModel

public abstract FindModel getFindNextModel(Editor editor)

Gets the model containing the search settings to use for "Find Next" and "Find Previous" operations specific for the editor given. It may be different than getFindNextModel() if there is find bar currently shown for the editor.

Parameters:

editor - editor, for which find model shall be retreived for

Returns:

the model to use for the operations.

canFindUsages

public abstract boolean canFindUsages(PsiElement element)

Checks if the Find Usages action is available for the specified element.

Parameters:

element - the element to check the availability for.

Returns:

true if Find Usages is available, false otherwise.

See Also:

FindUsagesProvider.canFindUsagesFor(PsiElement)

findUsages

public abstract void findUsages(PsiElement element)

Performs the Find Usages operation for the specified element.

Parameters:

element - the element to find the usages for.

findUsagesInScope

public abstract void findUsagesInScope(PsiElement element,
                                       SearchScope searchScope)

findUsages

public abstract void findUsages(PsiElement element,
                                boolean showDialog)

Shows the Find Usages dialog (if showDialog is true} and performs the Find Usages operation for the specified element.

Parameters:

element - the element to find the usages for.

showDialog - true if find usages settings dialog needs to be shown.

findUsagesInEditor

public abstract void findUsagesInEditor(PsiElement element,
                                        FileEditor editor)

Performs a "Find Usages in File" operation for the specified element.

Parameters:

element - the element for which the find is performed.

editor - the editor in which the find is performed.

findNextUsageInEditor

@Deprecated
public abstract boolean findNextUsageInEditor(FileEditor editor)

Deprecated. please use findNextUsageInEditor(Editor)

findNextUsageInEditor

public abstract boolean findNextUsageInEditor(Editor editor)

Performs a "Find Next" operation after "Find Usages in File" or "Highlight Usages in File".

Parameters:

editor - the editor in which the find is performed.

Returns:

true if the operation was performed (not necessarily found anything), false if an error occurred during the operation.

findPreviousUsageInEditor

@Deprecated
public abstract boolean findPreviousUsageInEditor(FileEditor editor)

Deprecated. please use findPreviousUsageInEditor(Editor)

findPreviousUsageInEditor

public abstract boolean findPreviousUsageInEditor(Editor editor)

Performs a "Find Previous" operation after "Find Usages in File" or "Highlight Usages in File".

Parameters:

editor - the editor in which the find is performed.

Returns:

true if the operation was performed (not necessarily found anything), false if an error occurred during the operation.