org.eclipse.search.ui.ISearchResultViewPart Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of org.eclipse.search Show documentation
Search Support
The newest version!
/*******************************************************************************
 * Copyright (c) 2000, 2008 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-2.0/
 *
 * SPDX-License-Identifier: EPL-2.0
 *
 * Contributors:
 *     IBM Corporation - initial API and implementation
 *******************************************************************************/
package org.eclipse.search.ui;
import org.eclipse.jface.action.IMenuManager;

import org.eclipse.ui.IViewPart;
/**
 * 
 * Interface for the search result view. The search result view is responsible
 * for managing the set of search result and delegates display of search results
 * to the appropriate ISearchResultPage. Clients may access the
 * search result view via the NewSearchUI facade class.
 * 
 * 
 * This interface is not intended to be implemented by clients
 * 
 *
 * @see NewSearchUI#activateSearchResultView()
 * @see NewSearchUI#getSearchResultView()
 *
 * @since 3.0
 *
 * @noimplement This interface is not intended to be implemented by clients.
 * @noextend This interface is not intended to be extended by clients.
 */
public interface ISearchResultViewPart extends IViewPart {
	/**
	 * Search result pages should call this method to have the search results view contribute to
	 * their context menus.
	 *
	 * @param menuManager the menu manager the search result view should contribute to
	 */
	void fillContextMenu(IMenuManager menuManager);
	/**
	 * Returns the ISearchResultPage currently shown in this
	 * search view. Returns null if no page is currently shown.
	 *
	 * @return the active ISearchResultPage or null
	 */
	ISearchResultPage getActivePage();

	/**
	 * Requests that the search view updates the label it is showing for search result
	 * pages. Typically, a search result page will call this method when the search result
	 * it's displaying is updated.
	 * @see ISearchResultPage#getLabel()
	 */
	void updateLabel();
}