/*******************************************************************************
* Copyright (c) 2000, 2005 IBM Corporation and others.
* All rights reserved. This program and the accompanying materials
* are made available under the terms of the Eclipse Public License v1.0
* which accompanies this distribution, and is available at
* http://www.eclipse.org/legal/epl-v10.html
*
* Contributors:
* IBM Corporation - initial API and implementation
*******************************************************************************/
package org.eclipse.search.ui;
import org.eclipse.search.internal.ui.*;
import org.eclipse.search.internal.ui.util.ExceptionHandler;
import org.eclipse.swt.graphics.Image;
import org.eclipse.ui.*;
/**
* 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:
* <ul>
* <li>convenient access to the search result view of the active workbench
* window.</li>
* </ul>
*
* @see ISearchResultView
* @deprecated Part of the old ('classic') search. Since 3.0 clients can create their own search result view pages and use {@link org.eclipse.search.ui.NewSearchUI} instead.
*/
public final class SearchUI {
/**
* Search Plug-in Id (value <code>"org.eclipse.search"</code>).
* @deprecated Use {@link NewSearchUI#PLUGIN_ID} instead.
*/
public static final String PLUGIN_ID= NewSearchUI.PLUGIN_ID;
/**
* Search marker type (value <code>"org.eclipse.search.searchmarker"</code>).
*
* @see org.eclipse.core.resources.IMarker
* @deprecated Use {@link NewSearchUI#SEARCH_MARKER} instead.
*/
public static final String SEARCH_MARKER= NewSearchUI.SEARCH_MARKER;
/**
* Line marker attribute (value <code>"line"</code>)
* The value of the marker attribute is the line which contains the text search match.
*
* @see org.eclipse.core.resources.IMarker#getAttribute(java.lang.String)
*/
public static final String LINE= "line"; //$NON-NLS-1$
/**
* Potential match marker attribute
* (value <code>"potentialMatch"</code>).
* <p>
* 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.
* </p>
* <p>
* Potential matches are shown with a different background color in
* the Search view. The color can be changed in the Search preferences.
* </p>
*
* @see org.eclipse.core.resources.IMarker#getAttribute(java.lang.String)
* @since 2.0
*/
public static final String POTENTIAL_MATCH= "potentialMatch"; //$NON-NLS-1$
/**
* Id of the Search result view
* (value <code>"org.eclipse.search.SearchResultView"</code>).
*/
public static final String SEARCH_RESULT_VIEW_ID= "org.eclipse.search.SearchResultView"; //$NON-NLS-1$
/**
* Id of the new Search view
* (value <code>"org.eclipse.search.ui.views.SearchView"</code>).
* @deprecated Use {@link NewSearchUI#SEARCH_VIEW_ID} instead.
*/
public static final String SEARCH_VIEW_ID= NewSearchUI.SEARCH_VIEW_ID;
/**
* Id of the Search action set
* (value <code>"org.eclipse.search.searchActionSet"</code>).
*
* @since 2.0
* @deprecated Use {@link NewSearchUI#ACTION_SET_ID} instead.
*/
public static final String ACTION_SET_ID= NewSearchUI.ACTION_SET_ID;
/**
* Activates the search result view in the active page of the
* active workbench window. This call has no effect (but returns <code>true</code>
* if the search result view is already activated.
*
* @return <code>true</code> if the search result view could be activated
* @deprecated Use {@link NewSearchUI#activateSearchResultView()} instead.
*/
public static boolean activateSearchResultView() {
String defaultPerspectiveId= SearchUI.getDefaultPerspectiveId();
if (defaultPerspectiveId != null) {
IWorkbenchWindow window= SearchPlugin.getActiveWorkbenchWindow();
if (window != null && window.getShell() != null && !window.getShell().isDisposed()) {
try {
PlatformUI.getWorkbench().showPerspective(defaultPerspectiveId, window);
} catch (WorkbenchException ex) {
// show view in current perspective
}
}
}
try {
IViewPart viewPart= SearchPlugin.getActivePage().findView(SearchUI.SEARCH_RESULT_VIEW_ID);
if (viewPart == null /* || SearchPreferencePage.isViewBroughtToFront() */ ) {
return (SearchPlugin.getActivePage().showView(SearchUI.SEARCH_RESULT_VIEW_ID) != null);
}
return true;
} catch (PartInitException ex) {
ExceptionHandler.handle(ex, SearchMessages.Search_Error_openResultView_title, SearchMessages.Search_Error_openResultView_message);
return false;
}
}
/**
* Opens the search dialog.
* If <code>pageId</code> is specified and a corresponding page
* is found then it is brought to top.
*
* @param window the given window
* @param pageId the page to select or <code>null</code>
* if the best fitting page should be selected
* @since 2.0
* @deprecated Use {@link NewSearchUI#openSearchDialog(IWorkbenchWindow, String)} instead.
*/
public static void openSearchDialog(IWorkbenchWindow window, String pageId) {
NewSearchUI.openSearchDialog(window, pageId);
}
/**
* Returns the search result view of the active page of the
* active workbench window.
*
* @return the search result view or <code>null</code>
* if there is no active search result view
* @deprecated Use {@link NewSearchUI#getSearchResultView()} instead.
*/
public static ISearchResultView getSearchResultView() {
IViewPart part= SearchPlugin.getActivePage().findView(SearchUI.SEARCH_RESULT_VIEW_ID);
if (part instanceof ISearchResultView)
return (ISearchResultView) part;
return null;
}
/**
* 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.
*
* @return the shared image
*/
public static Image getSearchMarkerImage() {
return SearchPluginImages.get(SearchPluginImages.IMG_OBJ_SEARCHMARKER);
}
/**
* Returns the preference whether editors should be reused
* when showing search results.
*
* The goto action can decide to use or ignore this preference.
*
* @return <code>true</code> if editors should be reused for showing search results
* @since 2.0
* @deprecated Use {@link NewSearchUI#reuseEditor()} instead.
*/
public static boolean reuseEditor() {
return NewSearchUI.reuseEditor();
}
/**
* Returns the preference whether a search engine is
* allowed to report potential matches or not.
* <p>
* Search engines which can report inexact matches must
* respect this preference i.e. they should not report
* inexact matches if this method returns <code>true</code>
* </p>
* @return <code>true</code> if search engine must not report inexact matches
* @since 2.1
* @deprecated Use {@link NewSearchUI#arePotentialMatchesIgnored()} instead.
*/
public static boolean arePotentialMatchesIgnored() {
return NewSearchUI.arePotentialMatchesIgnored();
}
/**
* Returns the ID of the default perspective.
* <p>
* 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.
* </p>
* @return the ID of the default perspective <code>null</code> if no default perspective is set
* @since 2.1
* @deprecated Use {@link NewSearchUI#getDefaultPerspectiveId()} instead.
*/
public static String getDefaultPerspectiveId() {
return NewSearchUI.getDefaultPerspectiveId();
}
/**
* Block instantiation.
*/
private SearchUI() {
}
}