SearchHistory (Search API) - NetBeans API Javadoc (Current Development Version)

Overview

Package

Class

Use

Tree

Deprecated

Index

Help

org.openidex.util/3 3.11

PREV CLASS NEXT CLASS

FRAMES NO FRAMES

SUMMARY: NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

org.openidex.search
Class SearchHistory

java.lang.Object
  org.openidex.search.SearchHistory

public final class SearchHistory
extends Object
extends Object

Shareable search history. Known implementations are explorer search dialog and editor find&replace dialog. 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.

Since:: org.openidex.util/3 3.5, NB 4.1

Field Summary

static String ADD_TO_HISTORY
          Property name for adding pattern to history Firing: oldValue - null newValue - added pattern

static String LAST_SELECTED
          Property name for last selected search pattern Firing: oldValue - old selected pattern newValue - new selected pattern

Method Summary

void add(SearchPattern pattern)
          Adds SearchPattern to SearchHistory

void addPropertyChangeListener(PropertyChangeListener pcl)
          Adds a property change listener.

static SearchHistory getDefault()


SearchPattern getLastSelected()


List getSearchPatterns()


void removePropertyChangeListener(PropertyChangeListener pcl)
          Removes a property change listener.

void setLastSelected(SearchPattern pattern)
          Sets last selected SearchPattern

Methods inherited from class java.lang.Object

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

Field Summary
`static String`	`ADD_TO_HISTORY` Property name for adding pattern to history Firing: oldValue - null newValue - added pattern
`static String`	`LAST_SELECTED` Property name for last selected search pattern Firing: oldValue - old selected pattern newValue - new selected pattern

Method Summary
`void`	`add(SearchPattern pattern)` Adds SearchPattern to SearchHistory
`void`	`addPropertyChangeListener(PropertyChangeListener pcl)` Adds a property change listener.
`static SearchHistory`	`getDefault()`
`SearchPattern`	`getLastSelected()`
`List`	`getSearchPatterns()`
`void`	`removePropertyChangeListener(PropertyChangeListener pcl)` Removes a property change listener.
`void`	`setLastSelected(SearchPattern pattern)` Sets last selected SearchPattern

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

Field Detail

LAST_SELECTED

public static final String LAST_SELECTED

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 String ADD_TO_HISTORY

Property name for adding pattern to history Firing: oldValue - null newValue - added pattern

See Also:: Constant Field Values

Method Detail

getDefault

public static SearchHistory getDefault()

Returns:: singleton instance of SearchHistory

getLastSelected

public SearchPattern getLastSelected()

Returns:: last selected SearchPattern

setLastSelected

public void setLastSelected(SearchPattern pattern)

Sets last selected SearchPattern

Parameters:: pattern - last selected pattern

addPropertyChangeListener

public void addPropertyChangeListener(PropertyChangeListener pcl)

Adds a property change listener.

Parameters:: pcl - the listener to add

removePropertyChangeListener

public void removePropertyChangeListener(PropertyChangeListener pcl)

Removes a property change listener.

Parameters:: pcl - the listener to remove

getSearchPatterns

public List getSearchPatterns()

Returns:: unmodifiable List of SearchPatterns

add

public void add(SearchPattern pattern)

Adds SearchPattern to SearchHistory

Parameters:: pattern - the SearchPattern to add