Package com.intellij.find.impl

Class FindManagerImpl

java.lang.Object

com.intellij.find.FindManager

com.intellij.find.impl.FindManagerImpl

public final class FindManagerImpl
extends FindManager

Nested Class Summary

Nested classes/interfaces inherited from class com.intellij.find.FindManager

FindManager.MalformedReplacementStringException, FindManager.PromptResult, FindManager.PromptResultValue

Field Summary

Fields inherited from class com.intellij.find.FindManager

FIND_MODEL_TOPIC

Constructor Summary

Constructors

Constructor and Description
FindManagerImpl(Project project)

Method Summary

Modifier and Type	Method and Description
boolean	canFindUsages(PsiElement element) Checks if the Find Usages action is available for the specified element.
void	clearFindingNextUsageInFile() Explicitly tell FindManager that "Find Next" and "Find Previous" actions should not use find usages previous results.
FindModel	createReplaceInFileModel()
boolean	findNextUsageInEditor(Editor editor) Performs a "Find Next" operation after "Find Usages in File" or "Highlight Usages in File".
boolean	findNextUsageInEditor(FileEditor fileEditor)
boolean	findPreviousUsageInEditor(Editor editor) Performs a "Find Previous" operation after "Find Usages in File" or "Highlight Usages in File".
boolean	findPreviousUsageInEditor(FileEditor fileEditor)
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.
FindResult	findString(java.lang.CharSequence text, int offset, FindModel model, VirtualFile file) Searches for the specified substring in the specified character sequence, using the specified find settings.
void	findUsages(PsiElement element) Performs the Find Usages operation for the specified element.
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.
void	findUsagesInEditor(PsiElement element, FileEditor fileEditor) Performs a "Find Usages in File" operation for the specified element.
void	findUsagesInScope(PsiElement element, SearchScope searchScope)
boolean	findWasPerformed() Gets the flag indicating whether the "Find Next" and "Find Previous" actions are available to continue a previously started search operation.
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.
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.
FindModel	getFindNextModel() Gets the model containing the search settings to use for "Find Next" and "Find Previous" operations.
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.
FindUsagesManager	getFindUsagesManager()
FindModel	getPreviousFindModel()
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.
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.
void	setFindNextModel(FindModel findNextModel) Sets the model containing the search settings to use for "Find Next" and "Find Previous" operations.
void	setFindWasPerformed() Sets the flag indicating that the "Find Next" and "Find Previous" actions are available to continue a previously started search operation.
void	setPreviousFindModel(FindModel previousFindModel)
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.
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.
int	showMalformedReplacementPrompt(FindModel model, java.lang.String title, FindManager.MalformedReplacementStringException exception) Shows a replace prompt dialog for the bad replace operation.
int	showPromptDialog(FindModel model, java.lang.String title) Shows a replace prompt dialog for the specified replace operation.
void	showSettingsAndFindUsages(NavigationItem [] targets)

Methods inherited from class com.intellij.find.FindManager

getInstance

Methods inherited from class java.lang.Object

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

Constructor Detail

FindManagerImpl

public FindManagerImpl(Project project)

Method Detail

createReplaceInFileModel

public FindModel createReplaceInFileModel()

Specified by:

createReplaceInFileModel in class FindManager

showPromptDialog

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

Description copied from class: FindManager

Shows a replace prompt dialog for the specified replace operation.

Specified by:

showPromptDialog in class FindManager

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.

showFindDialog

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

Description copied from class: FindManager

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.

Specified by:

showFindDialog in class FindManager

Parameters:

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

okHandler - Will be executed after doOkAction

getFindInFileModel

public FindModel getFindInFileModel()

Description copied from class: FindManager

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.

Specified by:

getFindInFileModel in class FindManager

Returns:

the last Find in File settings.

getFindInProjectModel

public FindModel getFindInProjectModel()

Description copied from class: FindManager

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.

Specified by:

getFindInProjectModel in class FindManager

Returns:

the last Find in Project settings.

findWasPerformed

public boolean findWasPerformed()

Description copied from class: FindManager

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.)

Specified by:

findWasPerformed in class FindManager

Returns:

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

setFindWasPerformed

public void setFindWasPerformed()

Description copied from class: FindManager

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

Specified by:

setFindWasPerformed in class FindManager

selectNextOccurrenceWasPerformed

public boolean selectNextOccurrenceWasPerformed()

Description copied from class: FindManager

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.

Specified by:

selectNextOccurrenceWasPerformed in class FindManager

setSelectNextOccurrenceWasPerformed

public void setSelectNextOccurrenceWasPerformed()

Description copied from class: FindManager

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.

Specified by:

setSelectNextOccurrenceWasPerformed in class FindManager

getFindNextModel

public FindModel getFindNextModel()

Description copied from class: FindManager

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

Specified by:

getFindNextModel in class FindManager

Returns:

the model to use for the operations.

getFindNextModel

public FindModel getFindNextModel(Editor editor)

Description copied from class: FindManager

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 FindManager.getFindNextModel() if there is find bar currently shown for the editor.

Specified by:

getFindNextModel in class FindManager

Parameters:

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

Returns:

the model to use for the operations.

setFindNextModel

public void setFindNextModel(FindModel findNextModel)

Description copied from class: FindManager

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

Specified by:

setFindNextModel in class FindManager

Parameters:

findNextModel - the model to use for the operations.

findString

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

Description copied from class: FindManager

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.

Specified by:

findString in class FindManager

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 FindResult findString(java.lang.CharSequence text,
                             int offset,
                             FindModel model,
                             VirtualFile file)

Description copied from class: FindManager

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.

Specified by:

findString in class FindManager

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 int showMalformedReplacementPrompt(FindModel model,
                                          java.lang.String title,
                                          FindManager.MalformedReplacementStringException exception)

Description copied from class: FindManager

Shows a replace prompt dialog for the bad replace operation.

Specified by:

showMalformedReplacementPrompt in class FindManager

Parameters:

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

title - the title of the dialog to show.

exception - exception from FindManager.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

getPreviousFindModel

public FindModel getPreviousFindModel()

Specified by:

getPreviousFindModel in class FindManager

setPreviousFindModel

public void setPreviousFindModel(FindModel previousFindModel)

Specified by:

setPreviousFindModel in class FindManager

getStringToReplace

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

Description copied from class: FindManager

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

Specified by:

getStringToReplace in class FindManager

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

canFindUsages

public boolean canFindUsages(PsiElement element)

Description copied from class: FindManager

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

Specified by:

canFindUsages in class FindManager

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 void findUsages(PsiElement element)

Description copied from class: FindManager

Performs the Find Usages operation for the specified element.

Specified by:

findUsages in class FindManager

Parameters:

element - the element to find the usages for.

findUsagesInScope

public void findUsagesInScope(PsiElement element,
                              SearchScope searchScope)

Specified by:

findUsagesInScope in class FindManager

findUsages

public void findUsages(PsiElement element,
                       boolean showDialog)

Description copied from class: FindManager

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

Specified by:

findUsages in class FindManager

Parameters:

element - the element to find the usages for.

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

showSettingsAndFindUsages

public void showSettingsAndFindUsages(NavigationItem [] targets)

Specified by:

showSettingsAndFindUsages in class FindManager

clearFindingNextUsageInFile

public void clearFindingNextUsageInFile()

Description copied from class: FindManager

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

Specified by:

clearFindingNextUsageInFile in class FindManager

findUsagesInEditor

public void findUsagesInEditor(PsiElement element,
                               FileEditor fileEditor)

Description copied from class: FindManager

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

Specified by:

findUsagesInEditor in class FindManager

Parameters:

element - the element for which the find is performed.

fileEditor - the editor in which the find is performed.

findNextUsageInEditor

public boolean findNextUsageInEditor(FileEditor fileEditor)

Specified by:

findNextUsageInEditor in class FindManager

findNextUsageInEditor

public boolean findNextUsageInEditor(Editor editor)

Description copied from class: FindManager

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

Specified by:

findNextUsageInEditor in class FindManager

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

public boolean findPreviousUsageInEditor(Editor editor)

Description copied from class: FindManager

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

Specified by:

findPreviousUsageInEditor in class FindManager

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

public boolean findPreviousUsageInEditor(FileEditor fileEditor)

Specified by:

findPreviousUsageInEditor in class FindManager

getFindUsagesManager

public FindUsagesManager getFindUsagesManager()