org.netbeans.api.search

Class SearchControl

java.lang.Object

org.netbeans.api.search.SearchControl

public final class SearchControl
extends Object

This class enables users to show search dialog and start searches programatically.

Method Summary

Modifier and Type	Method and Description
static void	openFindDialog(SearchPattern searchPattern, SearchScopeOptions searchScopeOptions, Boolean useIgnoreList, String scopeId) Shows dialog for basic search task.
static void	openFindDialog(SearchProvider.Presenter presenter) Show find dialog with a concrete presenter for one of providers.
static void	openReplaceDialog(SearchPattern searchPattern, String replaceString, Boolean preserveCase, SearchScopeOptions searchScopeOptions, Boolean useIgnoreList, String scopeId) Shows dialog for basic replace task.
static void	openReplaceDialog(SearchProvider.Presenter presenter) Show replace dialog with a concrete presenter for one of providers.
static void	startBasicSearch(SearchPattern searchPattern, SearchScopeOptions searchScopeOptions, String scopeId) Start basic search for specified parameters.

Methods inherited from class java.lang.Object

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

Method Detail

openFindDialog

public static void openFindDialog(@NullAllowed
                                  SearchPattern searchPattern,
                                  @NullAllowed
                                  SearchScopeOptions searchScopeOptions,
                                  @NullAllowed
                                  Boolean useIgnoreList,
                                  @NullAllowed
                                  String scopeId)

Shows dialog for basic search task. If options are not specified (null is passed), previous or default values are used.

openReplaceDialog

public static void openReplaceDialog(@NullAllowed
                                     SearchPattern searchPattern,
                                     @NullAllowed
                                     String replaceString,
                                     @NullAllowed
                                     Boolean preserveCase,
                                     @NullAllowed
                                     SearchScopeOptions searchScopeOptions,
                                     @NullAllowed
                                     Boolean useIgnoreList,
                                     @NullAllowed
                                     String scopeId)

Shows dialog for basic replace task. If options are not specified (null is passed), previous or default values are used.

openFindDialog

public static void openFindDialog(SearchProvider.Presenter presenter)

Show find dialog with a concrete presenter for one of providers.

Parameters:

presenter - Presenter to use, possibly initialized with proper values.

openReplaceDialog

public static void openReplaceDialog(SearchProvider.Presenter presenter)

Show replace dialog with a concrete presenter for one of providers.

Parameters:

presenter - Presenter to use, possibly initialized with proper values.

startBasicSearch

public static void startBasicSearch(@NonNull
                                    SearchPattern searchPattern,
                                    @NonNull
                                    SearchScopeOptions searchScopeOptions,
                                    @NullAllowed
                                    String scopeId)
                             throws IllegalArgumentException

Start basic search for specified parameters.

Parameters:

scopeId - Identifier of search scope (e.g. "main project", "open projects", "node selection", "browse"). If not specified, the default one is used.

Throws:

IllegalArgumentException - if neither non-trivial file name pattern nor non-empty text search pattern is specified.