KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > org > eclipse > search > ui > ISearchResultViewPart


1 /*******************************************************************************
2  * Copyright (c) 2000, 2006 IBM Corporation and others.
3  * All rights reserved. This program and the accompanying materials
4  * are made available under the terms of the Eclipse Public License v1.0
5  * which accompanies this distribution, and is available at
6  * http://www.eclipse.org/legal/epl-v10.html
7  *
8  * Contributors:
9  * IBM Corporation - initial API and implementation
10  *******************************************************************************/
11 package org.eclipse.search.ui;
12 import org.eclipse.jface.action.IMenuManager;
13 import org.eclipse.ui.IViewPart;
14 /**
15  * <p>
16  * Interface for the search result view. The search result view is responsible
17  * for managing the set of search result and delegates display of search results
18  * to the appropriate <code>ISearchResultPage</code>. Clients may access the
19  * search result view via the <code>NewSearchUI</code> facade class.
20  * </p>
21  * <p>
22  * This interface is not intended to be implemented by clients
23  * </p>
24  *
25  * @see NewSearchUI#activateSearchResultView()
26  * @see NewSearchUI#getSearchResultView()
27  *
28  * @since 3.0
29  */
30 public interface ISearchResultViewPart extends IViewPart {
31     /**
32      * Search result pages should call this method to have the search results
33      * view contribute to their context menus.
34      *
35      * @param menuManager
36      * the menu manager the search result view should contribute to
37      */
38     void fillContextMenu(IMenuManager menuManager);
39     /**
40      * Returns the <code>ISearchResultPage</code> currently shown in this
41      * search view. Returns <code>null</code> if no page is currently shown.
42      *
43      * @return the active <code>ISearchResultPage</code> or <code>null</code>
44      */
45     ISearchResultPage getActivePage();
46     
47     /**
48      * Requests that the search view updates the label it is showing for search result
49      * pages. Typically, a search result page will call this method when the search result
50      * it's displaying is updated.
51      * @see ISearchResultPage#getLabel()
52      */
53     void updateLabel();
54 }
55
Popular Tags