SearchHistory (Search API)

java.lang.Object
- org.netbeans.api.search.SearchHistory

```
public final class SearchHistory
extends java.lang.Object
```
Shareable search history. Known clients are "Find (Replace) in Projects" dialog and editor find/replace bar. Typical use case: Editor registers a listener to listen on lastSelected SearchPattern. If user opens explorer's search dialog and perform search, a search expression is added into SearchHistory and lastSelected SearchPattern is setted. The event is fired, editor can retrieve lastSelected SearchPattern and in accordance with its parameters it can highlight(in yellow) all matched patterns. If editor dialog is open, it contains shareable SearchHistory. Another direction is search in editor, that adds a SearchPattern in SearchHistory, thus the new item is available also in explorer's search dialog.

Field Summary

Fields
Modifier and Type	Field	Description
`static java.lang.String`	`ADD_TO_HISTORY`	Property name for adding pattern that was not in history Firing: oldValue - null newValue - added pattern
`static java.lang.String`	`ADD_TO_REPLACE`	Property name for adding replace pattern that was not in history Firing: oldValue - null newValue - added pattern
`static java.lang.String`	`LAST_SELECTED`	Deprecated. just changes in history

Method Summary

All Methods Static Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method	Description
`void`	`add(SearchPattern pattern)`	Adds SearchPattern to SearchHistory
`void`	`addPropertyChangeListener(java.beans.PropertyChangeListener pcl)`	Adds a property change listener.
`void`	`addReplace(ReplacePattern pattern)`	Adds ReplacePattern to ReplaceHistory
`static SearchHistory`	`getDefault()`
`SearchPattern`	`getLastSelected()`	Deprecated. Use `getSearchPatterns().get(0)`
`java.util.List<ReplacePattern>`	`getReplacePatterns()`
`java.util.List<SearchPattern>`	`getSearchPatterns()`
`void`	`removePropertyChangeListener(java.beans.PropertyChangeListener pcl)`	Removes a property change listener.
`void`	`setLastSelected(SearchPattern pattern)`	Deprecated. Use only `add(SearchPattern pattern)`
`void`	`storeFileNamePattern(java.lang.String pattern)`	Store last used file name pattern.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - LAST_SELECTED
```
@Deprecated
public static final java.lang.String LAST_SELECTED
```
    Deprecated. just changes in history
    
    Property name for last selected search pattern Firing: oldValue - old selected pattern newValue - new selected pattern
    
    See Also:
    
    Constant Field Values
  - ADD_TO_HISTORY
```
public static final java.lang.String ADD_TO_HISTORY
```
    Property name for adding pattern that was not in history Firing: oldValue - null newValue - added pattern
    
    See Also:
    
    Constant Field Values
  - ADD_TO_REPLACE
```
public static final java.lang.String ADD_TO_REPLACE
```
    Property name for adding replace pattern that was not in history Firing: oldValue - null newValue - added pattern
    
    Since:
    
    1.8
    
    See Also:
    
    Constant Field Values
- Method Detail
  - getDefault
```
public static SearchHistory getDefault()
```
    Returns:
    
    singleton instance of SearchHistory
  - getLastSelected
```
@Deprecated
public SearchPattern getLastSelected()
```
    Deprecated. Use getSearchPatterns().get(0)
    
    Returns:
    
    last selected SearchPattern
  - setLastSelected
```
@Deprecated
public void setLastSelected(SearchPattern pattern)
```
    Deprecated. Use only add(SearchPattern pattern)
    
    Sets last selected SearchPattern
    
    Parameters:
    
    pattern - last selected pattern
  - addPropertyChangeListener
```
public void addPropertyChangeListener(java.beans.PropertyChangeListener pcl)
```
    Adds a property change listener.
    
    Parameters:
    
    pcl - the listener to add
  - removePropertyChangeListener
```
public void removePropertyChangeListener(java.beans.PropertyChangeListener pcl)
```
    Removes a property change listener.
    
    Parameters:
    
    pcl - the listener to remove
  - getSearchPatterns
```
public java.util.List<SearchPattern> getSearchPatterns()
```
    Returns:
    
    unmodifiable List of SearchPatterns
  - getReplacePatterns
```
public java.util.List<ReplacePattern> getReplacePatterns()
```
    Returns:
    
    unmodifiable List of ReplacePatterns
    
    Since:
    
    1.8
  - add
```
public void add(SearchPattern pattern)
```
    Adds SearchPattern to SearchHistory
    
    Parameters:
    
    pattern - the SearchPattern to add
  - addReplace
```
public void addReplace(ReplacePattern pattern)
```
    Adds ReplacePattern to ReplaceHistory
    
    Parameters:
    
    pattern - the ReplacePattern to add
    
    Since:
    
    1.8
  - storeFileNamePattern
```
public void storeFileNamePattern(java.lang.String pattern)
```
    Store last used file name pattern.
    
    Since:
    
    api.search/1.1

Class SearchHistory

Field Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

LAST_SELECTED

ADD_TO_HISTORY

ADD_TO_REPLACE

Method Detail

getDefault

getLastSelected

setLastSelected

addPropertyChangeListener

removePropertyChangeListener

getSearchPatterns

getReplacePatterns

add

addReplace

storeFileNamePattern