Search Result View Pages

Identifier:

org.eclipse.search.searchResultViewPages

Since:

3.0

Description:

This extension point allows clients to plug pages into the search result view.

Configuration Markup:

<!ELEMENT extension (viewPage)+>

<!ATTLIST extension

point CDATA #REQUIRED

id CDATA #IMPLIED>

point - a fully qualified identifier of the target extension point
id - an optional identifier of the extension instance

<!ELEMENT viewPage EMPTY>

<!ATTLIST viewPage

searchResultClass CDATA #REQUIRED

class CDATA #REQUIRED

id CDATA #REQUIRED

label CDATA #IMPLIED

icon CDATA #IMPLIED

helpContextId CDATA #IMPLIED>

searchResultClass - The fully qualified class name of the ISearchResult implementation this search result page supposed to show.
class - the fully qualified class name implementing this search result page. The class must implement org.eclipse.search.ui.ISearchResultPage.
id - the id, typically the same as the fully qualified class name
label - a translatable label that can be used in the search result page to list all available search result views. It is currently not used but might be in the future.
icon - an icon that can be used in the search result page in a list of all available search result views. It is currently not used but might be in the future.
helpContextId - The help context for the page. Added in 3.4.

Examples:

As an example, here is the markup for the file search result page.


<extension
 id="FileSearchPage"
    point="org.eclipse.search.searchResultViewPages">
 <viewPage
  id="org.eclipse.search.text.FileSearchResultPage"
  searchResultClass="org.eclipse.search.internal.ui.text.FileSearchResult"
  class="org.eclipse.search.internal.ui.text.FileSearchPage">
 </viewPage>
</extension>

API Information:

The contributed class must implement org.eclipse.search.ui.ISearchResultPage

Supplied Implementation:

The search plugin provide a search result page for file searches.

Copyright (c) 2001, 2004 IBM Corporation and others.
This program and the accompanying materials are made available under the terms of the Eclipse Public License 2.0 which accompanies this distribution, and is available at https://www.eclipse.org/legal/epl-v20.html/ SPDX-License-Identifier: EPL-2.0