FindModel (Unofficial IntelliJ Community Edition API docs)

java.lang.Object
- com.intellij.openapi.util.UserDataHolderBase
- - com.intellij.find.FindModel

All Implemented Interfaces:

UserDataHolder, UserDataHolderEx, java.lang.Cloneable
```
public class FindModel
extends UserDataHolderBase
implements java.lang.Cloneable
```
Represents the settings of a Find, Replace, Find in Path or Replace in Path operations.

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static interface FindModel.FindModelObserver

static class FindModel.SearchContext

Nested Classes
Modifier and Type	Class and Description
`static interface`	`FindModel.FindModelObserver`
`static class`	`FindModel.SearchContext`

Constructor Summary

Constructors
Constructor and Description

FindModel()

Constructors
Constructor and Description
`FindModel()`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`void`	`addObserver(FindModel.FindModelObserver observer)`
`FindModel`	`clone()`
`java.util.regex.Pattern`	`compileRegExp()`
`void`	`copyFrom(FindModel model)` Copies all the settings from the specified model.
`boolean`	`equals(java.lang.Object o)`
`SearchScope`	`getCustomScope()`
`java.lang.String`	`getCustomScopeName()`
`java.lang.String`	`getDirectoryName()` Gets the directory used as a scope for Find in Path / Replace in Path.
`java.lang.String`	`getFileFilter()` Gets the file name filter used for Find in Path / Replace in Path operation.
`java.lang.String`	`getModuleName()` Gets the name of the module used as the scope for the Find in Path / Replace in Path operation.
`FindModel.SearchContext`	`getSearchContext()`
`java.lang.String`	`getStringToFind()` Gets the string to find.
`java.lang.String`	`getStringToReplace()` Gets the string to replace with.
`int`	`hashCode()`
`static void`	`initStringToFind(FindModel findModel, java.lang.String s)`
`static void`	`initStringToFindNoMultiline(FindModel findModel, java.lang.String s)` Deprecated.
`boolean`	`isCaseSensitive()` Gets the Case Sensitive flag.
`boolean`	`isCustomScope()`
`boolean`	`isExceptComments()`
`boolean`	`isExceptCommentsAndStringLiterals()`
`boolean`	`isExceptStringLiterals()`
`boolean`	`isFindAll()` Gets the flag indicating whether "Find All" button was used to initiate the find operation.
`boolean`	`isFindAllEnabled()` Gets the flag indicating whether "Find All" button is allowed for the operation.
`boolean`	`isForward()` Gets the direction for the find.
`boolean`	`isFromCursor()` Gets the origin for the find.
`boolean`	`isGlobal()` Gets the scope of the operation.
`boolean`	`isInCommentsOnly()`
`boolean`	`isInStringLiteralsOnly()`
`boolean`	`isMultiline()`
`boolean`	`isMultipleFiles()` Checks if the find or replace operation affects multiple files.
`boolean`	`isOpenInNewTab()` Deprecated. and not used anymore
`boolean`	`isOpenInNewTabEnabled()` Deprecated. and not used anymore
`boolean`	`isOpenInNewTabVisible()` Deprecated. and not used anymore
`boolean`	`isPreserveCase()` Gets the Preserve Case flag.
`boolean`	`isProjectScope()` Gets the flag indicating whether the Whole Project scope is selected for Find in Path / Replace in Path.
`boolean`	`isPromptOnReplace()` Gets the Prompt on Replace flag.
`boolean`	`isRegularExpressions()` Gets the Regular Expressions flag.
`boolean`	`isReplaceAll()` Gets the Replace All flag.
`boolean`	`isReplaceState()` Gets the value indicating whether the operation is a Find or a Replace.
`boolean`	`isSearchInProjectFiles()`
`boolean`	`isWholeWordsOnly()` Gets the Whole Words Only flag.
`boolean`	`isWithSubdirectories()` Gets the Recursive Search flag for Find in Path / Replace in Path.
`void`	`removeObserver(FindModel.FindModelObserver observer)`
`boolean`	`searchHighlighters()` Gets the flag indicating whether the search operation is Find Next / Find Previous after Highlight Usages in Files.
`void`	`setCaseSensitive(boolean val)` Sets the Case Sensitive flag.
`void`	`setCustomScope(boolean customScope)`
`void`	`setCustomScope(SearchScope customScope)`
`void`	`setCustomScopeName(java.lang.String customScopeName)`
`void`	`setDirectoryName(java.lang.String directoryName)` Sets the directory used as a scope for Find in Path / Replace in Path.
`void`	`setFileFilter(java.lang.String fileFilter)` Sets the file name filter used for Find in Path / Replace in Path operation.
`void`	`setFindAll(boolean findAll)` Sets the flag indicating whether "Find All" button was used to initiate the find operation.
`void`	`setFindAllEnabled(boolean findAllEnabled)` Sets the flag indicating whether "Find All" button is allowed for the operation.
`void`	`setForward(boolean val)` Sets the direction for the find.
`void`	`setFromCursor(boolean val)` Sets the origin for the find.
`void`	`setGlobal(boolean isGlobal)` Sets the scope of the operation.
`void`	`setInCommentsOnly(boolean inCommentsOnly)` Deprecated.
`void`	`setInStringLiteralsOnly(boolean inStringLiteralsOnly)` Deprecated.
`void`	`setModuleName(java.lang.String moduleName)` Sets the name of the module used as the scope for the Find in Path / Replace in Path operation.
`void`	`setMultiline(boolean multiline)`
`void`	`setMultipleFiles(boolean val)` Sets the value indicating whether the find or replace operation affects multiple files.
`void`	`setOpenInNewTab(boolean showInNewTab)` Deprecated. and not used anymore
`void`	`setOpenInNewTabEnabled(boolean showInNewTabEnabled)` Deprecated. and not used anymore
`void`	`setOpenInNewTabVisible(boolean showInNewTabVisible)` Deprecated. and not used anymore
`void`	`setPreserveCase(boolean preserveCase)` Sets the Preserve Case flag.
`void`	`setProjectScope(boolean projectScope)` Sets the flag indicating whether the Whole Project scope is selected for Find in Path / Replace in Path.
`void`	`setPromptOnReplace(boolean val)` Sets the Prompt on Replace flag.
`void`	`setRegularExpressions(boolean val)` Sets the Regular Expressions flag.
`void`	`setReplaceAll(boolean replaceAll)` Sets the Replace All flag.
`void`	`setReplaceState(boolean val)` Sets the value indicating whether the operation is a Find or a Replace.
`void`	`setSearchContext(FindModel.SearchContext _searchContext)`
`void`	`setSearchHighlighters(boolean search)` Sets the flag indicating whether the search operation is Find Next / Find Previous after Highlight Usages in Files.
`void`	`setSearchInProjectFiles(boolean searchInProjectFiles)`
`void`	`setStringToFind(java.lang.String s)` Sets the string to find.
`void`	`setStringToReplace(java.lang.String s)` Sets the string to replace with.
`void`	`setWholeWordsOnly(boolean isWholeWordsOnly)` Sets the Whole Words Only flag.
`void`	`setWithSubdirectories(boolean withSubdirectories)` Sets the Recursive Search flag for Find in Path / Replace in Path.
`java.lang.String`	`toString()`

Methods inherited from class com.intellij.openapi.util.UserDataHolderBase
changeUserMap, clearUserData, copyCopyableDataTo, copyUserDataTo, getCopyableUserData, getUserData, getUserDataString, getUserMap, isUserDataEmpty, putCopyableUserData, putUserData, putUserDataIfAbsent, replace, setUserMap

Methods inherited from class java.lang.Object
finalize, getClass, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - FindModel
```
public FindModel()
```
- Method Detail
  - initStringToFindNoMultiline
```
@Deprecated
public static void initStringToFindNoMultiline(FindModel findModel,
                                               java.lang.String s)
```
    Deprecated.
  - initStringToFind
```
public static void initStringToFind(FindModel findModel,
                                    java.lang.String s)
```
  - addObserver
```
public void addObserver(FindModel.FindModelObserver observer)
```
  - removeObserver
```
public void removeObserver(FindModel.FindModelObserver observer)
```
  - isMultiline
```
public boolean isMultiline()
```
  - setMultiline
```
public void setMultiline(boolean multiline)
```
  - isPreserveCase
```
public boolean isPreserveCase()
```
    Gets the Preserve Case flag.
    
    Returns:
    
    the value of the Preserve Case flag.
  - setPreserveCase
```
public void setPreserveCase(boolean preserveCase)
```
    Sets the Preserve Case flag.
    
    Parameters:
    
    preserveCase - the value of the Preserve Case flag.
  - copyFrom
```
public void copyFrom(FindModel model)
```
    Copies all the settings from the specified model.
    
    Parameters:
    
    model - the model to copy settings from.
  - equals
```
public boolean equals(java.lang.Object o)
```
    Overrides:
    
    equals in class java.lang.Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class java.lang.Object
  - getStringToFind
```
public java.lang.String getStringToFind()
```
    Gets the string to find.
    
    Returns:
    
    the string to find.
  - setStringToFind
```
public void setStringToFind(java.lang.String s)
```
    Sets the string to find.
    
    Parameters:
    
    s - the string to find.
  - getStringToReplace
```
public java.lang.String getStringToReplace()
```
    Gets the string to replace with.
    
    Returns:
    
    the string to replace with.
  - setStringToReplace
```
public void setStringToReplace(java.lang.String s)
```
    Sets the string to replace with.
    
    Parameters:
    
    s - the string to replace with.
  - isReplaceState
```
public boolean isReplaceState()
```
    Gets the value indicating whether the operation is a Find or a Replace.
    
    Returns:
    
    true if the operation is a Replace, false if it is a Find.
  - setReplaceState
```
public void setReplaceState(boolean val)
```
    Sets the value indicating whether the operation is a Find or a Replace.
    
    Parameters:
    
    val - true if the operation is a Replace, false if it is a Find.
  - isFromCursor
```
public boolean isFromCursor()
```
    Gets the origin for the find.
    
    Returns:
    
    true if the origin is From Cursor, false if it is Entire Scope.
  - setFromCursor
```
public void setFromCursor(boolean val)
```
    Sets the origin for the find.
    
    Parameters:
    
    val - true if the origin is From Cursor, false if it is Entire Scope.
  - isForward
```
public boolean isForward()
```
    Gets the direction for the find.
    
    Returns:
    
    true if the find is forward, false if it is backward.
  - setForward
```
public void setForward(boolean val)
```
    Sets the direction for the find.
    
    Parameters:
    
    val - true if the find is forward, false if it is backward.
  - isRegularExpressions
```
public boolean isRegularExpressions()
```
    Gets the Regular Expressions flag.
    
    Returns:
    
    the value of the Regular Expressions flag.
  - setRegularExpressions
```
public void setRegularExpressions(boolean val)
```
    Sets the Regular Expressions flag.
    
    Parameters:
    
    val - the value of the Regular Expressions flag.
  - isCaseSensitive
```
public boolean isCaseSensitive()
```
    Gets the Case Sensitive flag.
    
    Returns:
    
    the value of the Case Sensitive flag.
  - setCaseSensitive
```
public void setCaseSensitive(boolean val)
```
    Sets the Case Sensitive flag.
    
    Parameters:
    
    val - the value of the Case Sensitive flag.
  - isMultipleFiles
```
public boolean isMultipleFiles()
```
    Checks if the find or replace operation affects multiple files.
    
    Returns:
    
    true if the operation affects multiple files, false if it affects a single file.
  - setMultipleFiles
```
public void setMultipleFiles(boolean val)
```
    Sets the value indicating whether the find or replace operation affects multiple files.
    
    Parameters:
    
    val - true if the operation affects multiple files, false if it affects a single file.
  - isPromptOnReplace
```
public boolean isPromptOnReplace()
```
    Gets the Prompt on Replace flag.
    
    Returns:
    
    the value of the Prompt on Replace flag.
  - setPromptOnReplace
```
public void setPromptOnReplace(boolean val)
```
    Sets the Prompt on Replace flag.
    
    Parameters:
    
    val - the value of the Prompt on Replace flag.
  - isWholeWordsOnly
```
public boolean isWholeWordsOnly()
```
    Gets the Whole Words Only flag.
    
    Returns:
    
    the value of the Whole Words Only flag.
  - setWholeWordsOnly
```
public void setWholeWordsOnly(boolean isWholeWordsOnly)
```
    Sets the Whole Words Only flag.
    
    Parameters:
    
    isWholeWordsOnly - the value of the Whole Words Only flag.
  - isGlobal
```
public boolean isGlobal()
```
    Gets the scope of the operation.
    
    Returns:
    
    true if the operation affects the entire file, false if it affects the selected text.
  - setGlobal
```
public void setGlobal(boolean isGlobal)
```
    Sets the scope of the operation.
    
    Parameters:
    
    isGlobal - true if the operation affects the entire file, false if it affects the selected text.
  - isReplaceAll
```
public boolean isReplaceAll()
```
    Gets the Replace All flag.
    
    Returns:
    
    the value of the Replace All flag.
  - setReplaceAll
```
public void setReplaceAll(boolean replaceAll)
```
    Sets the Replace All flag.
    
    Parameters:
    
    replaceAll - the value of the Replace All flag.
  - isOpenInNewTab
```
@Deprecated
public boolean isOpenInNewTab()
```
    Deprecated. and not used anymore
    
    Gets the Open in New Tab flag.
    
    Returns:
    
    the value of the Open in New Tab flag.
  - setOpenInNewTab
```
@Deprecated
public void setOpenInNewTab(boolean showInNewTab)
```
    Deprecated. and not used anymore
    
    Sets the Open in New Tab flag.
    
    Parameters:
    
    showInNewTab - the value of the Open in New Tab flag.
  - isOpenInNewTabEnabled
```
@Deprecated
public boolean isOpenInNewTabEnabled()
```
    Deprecated. and not used anymore
    
    Gets the value indicating whether the Open in New Tab flag is enabled for the operation.
    
    Returns:
    
    true if Open in New Tab is enabled, false otherwise.
  - setOpenInNewTabEnabled
```
@Deprecated
public void setOpenInNewTabEnabled(boolean showInNewTabEnabled)
```
    Deprecated. and not used anymore
    
    Sets the value indicating whether the Open in New Tab flag is enabled for the operation.
    
    Parameters:
    
    showInNewTabEnabled - true if Open in New Tab is enabled, false otherwise.
  - isOpenInNewTabVisible
```
@Deprecated
public boolean isOpenInNewTabVisible()
```
    Deprecated. and not used anymore
  - setOpenInNewTabVisible
```
@Deprecated
public void setOpenInNewTabVisible(boolean showInNewTabVisible)
```
    Deprecated. and not used anymore
  - getDirectoryName
```
public java.lang.String getDirectoryName()
```
    Gets the directory used as a scope for Find in Path / Replace in Path.
    
    Returns:
    
    the directory used as a scope, or null if the selected scope is not "Directory".
  - setDirectoryName
```
public void setDirectoryName(java.lang.String directoryName)
```
    Sets the directory used as a scope for Find in Path / Replace in Path.
    
    Parameters:
    
    directoryName - the directory scope.
  - isWithSubdirectories
```
public boolean isWithSubdirectories()
```
    Gets the Recursive Search flag for Find in Path / Replace in Path.
    
    Returns:
    
    true if directories are searched recursively, false otherwise.
  - setWithSubdirectories
```
public void setWithSubdirectories(boolean withSubdirectories)
```
    Sets the Recursive Search flag for Find in Path / Replace in Path.
    
    Parameters:
    
    withSubdirectories - true if directories are searched recursively, false otherwise.
  - isProjectScope
```
public boolean isProjectScope()
```
    Gets the flag indicating whether the Whole Project scope is selected for Find in Path / Replace in Path.
    
    Returns:
    
    true if the whole project scope is selected, false otherwise.
  - setProjectScope
```
public void setProjectScope(boolean projectScope)
```
    Sets the flag indicating whether the Whole Project scope is selected for Find in Path / Replace in Path.
    
    Parameters:
    
    projectScope - true if the whole project scope is selected, false otherwise.
  - clone
```
public FindModel clone()
```
    Overrides:
    
    clone in class UserDataHolderBase
  - toString
```
public java.lang.String toString()
```
    Overrides:
    
    toString in class java.lang.Object
  - searchHighlighters
```
public boolean searchHighlighters()
```
    Gets the flag indicating whether the search operation is Find Next / Find Previous after Highlight Usages in Files.
    
    Returns:
    
    true if the operation moves between highlighted regions, false otherwise.
  - setSearchHighlighters
```
public void setSearchHighlighters(boolean search)
```
    Sets the flag indicating whether the search operation is Find Next / Find Previous after Highlight Usages in Files.
    
    Parameters:
    
    search - true if the operation moves between highlighted regions, false otherwise.
  - getFileFilter
```
public java.lang.String getFileFilter()
```
    Gets the file name filter used for Find in Path / Replace in Path operation.
    
    Returns:
    
    the file name filter text.
  - setFileFilter
```
public void setFileFilter(java.lang.String fileFilter)
```
    Sets the file name filter used for Find in Path / Replace in Path operation.
    
    Parameters:
    
    fileFilter - the file name filter text.
  - getModuleName
```
public java.lang.String getModuleName()
```
    Gets the name of the module used as the scope for the Find in Path / Replace in Path operation.
    
    Returns:
    
    the module name, or null if the selected scope is not "Module".
  - setModuleName
```
public void setModuleName(java.lang.String moduleName)
```
    Sets the name of the module used as the scope for the Find in Path / Replace in Path operation.
    
    Parameters:
    
    moduleName - the name of the module used as the scope.
  - isFindAll
```
public boolean isFindAll()
```
    Gets the flag indicating whether "Find All" button was used to initiate the find operation.
    
    Returns:
    
    true if the operation is a "Find All", false otherwise.
  - setFindAll
```
public void setFindAll(boolean findAll)
```
    Sets the flag indicating whether "Find All" button was used to initiate the find operation.
    
    Parameters:
    
    findAll - true if the operation is a "Find All", false otherwise.
  - isFindAllEnabled
```
public boolean isFindAllEnabled()
```
    Gets the flag indicating whether "Find All" button is allowed for the operation.
    
    Returns:
    
    true if "Find All" is enabled, false otherwise.
  - setFindAllEnabled
```
public void setFindAllEnabled(boolean findAllEnabled)
```
    Sets the flag indicating whether "Find All" button is allowed for the operation.
    
    Parameters:
    
    findAllEnabled - true if "Find All" is enabled, false otherwise.
  - getCustomScopeName
```
public java.lang.String getCustomScopeName()
```
  - setCustomScopeName
```
public void setCustomScopeName(java.lang.String customScopeName)
```
  - getCustomScope
```
public SearchScope getCustomScope()
```
  - setCustomScope
```
public void setCustomScope(SearchScope customScope)
```
  - isCustomScope
```
public boolean isCustomScope()
```
  - setCustomScope
```
public void setCustomScope(boolean customScope)
```
  - isInStringLiteralsOnly
```
public boolean isInStringLiteralsOnly()
```
  - isExceptComments
```
public boolean isExceptComments()
```
  - isExceptStringLiterals
```
public boolean isExceptStringLiterals()
```
  - isInCommentsOnly
```
public boolean isInCommentsOnly()
```
  - isExceptCommentsAndStringLiterals
```
public boolean isExceptCommentsAndStringLiterals()
```
  - setInCommentsOnly
```
@Deprecated
public void setInCommentsOnly(boolean inCommentsOnly)
```
    Deprecated.
  - setInStringLiteralsOnly
```
@Deprecated
public void setInStringLiteralsOnly(boolean inStringLiteralsOnly)
```
    Deprecated.
  - getSearchContext
```
public FindModel.SearchContext getSearchContext()
```
  - setSearchContext
```
public void setSearchContext(FindModel.SearchContext _searchContext)
```
  - isSearchInProjectFiles
```
public boolean isSearchInProjectFiles()
```
  - setSearchInProjectFiles
```
public void setSearchInProjectFiles(boolean searchInProjectFiles)
```
  - compileRegExp
```
public java.util.regex.Pattern compileRegExp()
```

Class FindModel

Nested Class Summary

Constructor Summary

Method Summary

Methods inherited from class com.intellij.openapi.util.UserDataHolderBase

Methods inherited from class java.lang.Object

Constructor Detail

FindModel

Method Detail

initStringToFindNoMultiline

initStringToFind

addObserver

removeObserver

isMultiline

setMultiline

isPreserveCase

setPreserveCase

copyFrom

equals

hashCode

getStringToFind

setStringToFind

getStringToReplace

setStringToReplace

isReplaceState

setReplaceState

isFromCursor

setFromCursor

isForward

setForward

isRegularExpressions

setRegularExpressions

isCaseSensitive

setCaseSensitive

isMultipleFiles

setMultipleFiles

isPromptOnReplace

setPromptOnReplace

isWholeWordsOnly

setWholeWordsOnly

isGlobal

setGlobal

isReplaceAll

setReplaceAll

isOpenInNewTab

setOpenInNewTab

isOpenInNewTabEnabled

setOpenInNewTabEnabled

isOpenInNewTabVisible

setOpenInNewTabVisible

getDirectoryName

setDirectoryName

isWithSubdirectories

setWithSubdirectories

isProjectScope

setProjectScope

clone

toString

searchHighlighters

setSearchHighlighters

getFileFilter

setFileFilter

getModuleName

setModuleName

isFindAll

setFindAll

isFindAllEnabled

setFindAllEnabled

getCustomScopeName

setCustomScopeName

getCustomScope

setCustomScope

isCustomScope

setCustomScope

isInStringLiteralsOnly

isExceptComments

isExceptStringLiterals

isInCommentsOnly

isExceptCommentsAndStringLiterals

setInCommentsOnly