KickJava   Java API By Example, From Geeks To Geeks.

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


1 /*******************************************************************************
2  * Copyright (c) 2000, 2005 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
13 import org.eclipse.ui.actions.ActionGroup;
14 import org.eclipse.jface.resource.ImageDescriptor;
15 import org.eclipse.jface.operation.IRunnableWithProgress;
16 import org.eclipse.jface.viewers.ILabelProvider;
17 import org.eclipse.jface.action.IAction;
18
19 /**
20  * Allows to specify an <code>ActionGroup</code> factory
21  * which will be used by the Search view to create an
22  * <code>ActionGroup</code> which is used to build the
23  * actions bars and the context menu.
24  * <p>
25  * Note: Local tool bar contributions are not supported in 2.0.
26  * </p>
27  *
28  * Clients can implement this interface and pass an
29  * instance to the search result view.
30  *
31  * @see org.eclipse.ui.actions.ActionGroup
32  * @see ISearchResultView#searchStarted(IActionGroupFactory, String, String, ImageDescriptor, String, ILabelProvider, IAction, IGroupByKeyComputer, IRunnableWithProgress)
33  * @since 2.0
34  * @deprecated Part of the old ('classic') search result view. Since 3.0 clients can create their own search result view pages (see {@link ISearchResultPage}), leaving it up to the page
35  * how to create actions.
36  */
37 public interface IActionGroupFactory {
38
39     /**
40      * Creates an <code>ActionGroup</code> for a Search view.
41      *
42      * @param searchView the search result view for which the group is made
43      * @see org.eclipse.ui.actions.ActionGroup
44      * @return an <code>ActionGroup</code> for a Search view
45      */
46     ActionGroup createActionGroup(ISearchResultView searchView);
47 }
48
Popular Tags