Package org.eclipse.search.ui

Class SearchUI

java.lang.Object
org.eclipse.search.ui.SearchUI
@Deprecated(forRemoval=true) public final class SearchUI extends Object
Deprecated, for removal: This API element is subject to removal in a future version.
Part of the old ('classic') search. Since 3.0 clients can create their own search result view pages and use 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.
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 Details

  • Method Details

    • activateSearchResultView

      @Deprecated public static boolean activateSearchResultView()
      Deprecated.
      Use NewSearchUI.activateSearchResultView() instead.
      Activates the search result view in the active page of the active workbench window. This call has no effect (but returns true if the search result view is already activated.
      Returns:
      true if the search result view could be activated

    • openSearchDialog

      @Deprecated public static void openSearchDialog(IWorkbenchWindow window, String pageId)
      Deprecated.
      Use NewSearchUI.openSearchDialog(IWorkbenchWindow, String) instead.
      Opens the search dialog. If pageId is specified and a corresponding page is found then it is brought to top.
      Parameters:
      window - the given window
      pageId - the page to select or null if the best fitting page should be selected
      Since:
      2.0

    • getSearchResultView

      @Deprecated public static ISearchResultView getSearchResultView()
      Deprecated.
      Use NewSearchUI.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

      public static Image 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 public static boolean reuseEditor()
      Deprecated.
      Use NewSearchUI.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 public static boolean arePotentialMatchesIgnored()
      Deprecated.
      Use NewSearchUI.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 public static String getDefaultPerspectiveId()
      Deprecated.
      Use NewSearchUI.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