Package org.eclipse.search.ui
Class SearchUI
java.lang.Object
org.eclipse.search.ui.SearchUI
Deprecated, for removal: This API element is subject to removal in a future version.
The central class for access to the Search Plug-in's User Interface. This
class cannot be instantiated; all functionality is provided by static
methods.
Features provided:
- convenient access to the search result view of the active workbench window.
- See Also:
- Restriction:
- Restriction:
- Restriction:
- Restriction:
- This class is not intended to be instantiated by clients.
-
Field Summary
FieldsModifier and TypeFieldDescriptionstatic final String
Deprecated.UseNewSearchUI.ACTION_SET_ID
instead.static final String
Deprecated, for removal: This API element is subject to removal in a future version.Line marker attribute (value"line"
) The value of the marker attribute is the line which contains the text search match.static final String
Deprecated.UseNewSearchUI.PLUGIN_ID
instead.static final String
Deprecated, for removal: This API element is subject to removal in a future version.Potential match marker attribute (value"potentialMatch"
).static final String
Deprecated.UseNewSearchUI.SEARCH_MARKER
instead.static final String
Deprecated, for removal: This API element is subject to removal in a future version.Id of the Search result view (value"org.eclipse.search.SearchResultView"
).static final String
Deprecated.UseNewSearchUI.SEARCH_VIEW_ID
instead. -
Method Summary
Modifier and TypeMethodDescriptionstatic boolean
Deprecated.UseNewSearchUI.activateSearchResultView()
instead.static boolean
Deprecated.UseNewSearchUI.arePotentialMatchesIgnored()
instead.static String
Deprecated.UseNewSearchUI.getDefaultPerspectiveId()
instead.static Image
Deprecated, for removal: This API element is subject to removal in a future version.Returns the shared search marker image.static ISearchResultView
Deprecated.UseNewSearchUI.getSearchResultView()
instead.static void
openSearchDialog
(IWorkbenchWindow window, String pageId) Deprecated.static boolean
Deprecated.UseNewSearchUI.reuseEditor()
instead.
-
Field Details
-
PLUGIN_ID
Deprecated.UseNewSearchUI.PLUGIN_ID
instead.Search Plug-in Id (value"org.eclipse.search"
).- See Also:
-
SEARCH_MARKER
Deprecated.UseNewSearchUI.SEARCH_MARKER
instead.Search marker type (value"org.eclipse.search.searchmarker"
).- See Also:
-
LINE
Deprecated, for removal: This API element is subject to removal in a future version.Line marker attribute (value"line"
) The value of the marker attribute is the line which contains the text search match. -
POTENTIAL_MATCH
Deprecated, for removal: This API element is subject to removal in a future version.Potential match marker attribute (value"potentialMatch"
).This optional marker attribute tells whether a marker is a potential or an exact match. The marker is considered an exact match if the attribute is missing.
Potential matches are shown with a different background color in the Search view. The color can be changed in the Search preferences.
- Since:
- 2.0
- See Also:
-
SEARCH_RESULT_VIEW_ID
Deprecated, for removal: This API element is subject to removal in a future version.Id of the Search result view (value"org.eclipse.search.SearchResultView"
).- See Also:
-
SEARCH_VIEW_ID
Deprecated.UseNewSearchUI.SEARCH_VIEW_ID
instead.Id of the new Search view (value"org.eclipse.search.ui.views.SearchView"
).- See Also:
-
ACTION_SET_ID
Deprecated.UseNewSearchUI.ACTION_SET_ID
instead.Id of the Search action set (value"org.eclipse.search.searchActionSet"
).- Since:
- 2.0
- See Also:
-
-
Method Details
-
activateSearchResultView
Deprecated.UseNewSearchUI.activateSearchResultView()
instead.Activates the search result view in the active page of the active workbench window. This call has no effect (but returnstrue
if the search result view is already activated.- Returns:
true
if the search result view could be activated
-
openSearchDialog
Deprecated.Opens the search dialog. IfpageId
is specified and a corresponding page is found then it is brought to top.- Parameters:
window
- the given windowpageId
- the page to select ornull
if the best fitting page should be selected- Since:
- 2.0
-
getSearchResultView
Deprecated.UseNewSearchUI.getSearchResultView()
instead.Returns the search result view of the active page of the active workbench window.- Returns:
- the search result view or
null
if there is no active search result view
-
getSearchMarkerImage
Deprecated, for removal: This API element is subject to removal in a future version.Returns the shared search marker image. Normally, editors show this icon in their vertical ruler. This image is owned by the search UI plug-in and must not be disposed by clients.- Returns:
- the shared image
-
reuseEditor
Deprecated.UseNewSearchUI.reuseEditor()
instead.Returns the preference whether editors should be reused when showing search results. The goto action can decide to use or ignore this preference.- Returns:
true
if editors should be reused for showing search results- Since:
- 2.0
-
arePotentialMatchesIgnored
Deprecated.UseNewSearchUI.arePotentialMatchesIgnored()
instead.Returns the preference whether a search engine is allowed to report potential matches or not.Search engines which can report inexact matches must respect this preference i.e. they should not report inexact matches if this method returns
true
- Returns:
true
if search engine must not report inexact matches- Since:
- 2.1
-
getDefaultPerspectiveId
Deprecated.UseNewSearchUI.getDefaultPerspectiveId()
instead.Returns the ID of the default perspective.The perspective with this ID will be used to show the Search view. If no default perspective is set then the Search view will appear in the current perspective.
- Returns:
- the ID of the default perspective
null
if no default perspective is set - Since:
- 2.1
-
NewSearchUI
instead. This class will be removed after 2023-09 release. See https://bugs.eclipse.org/bugs/show_bug.cgi?id=487303 for more information.