KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > org > eclipse > jdt > ui > actions > FindDeclarationsInWorkingSetAction


1 /*******************************************************************************
2  * Copyright (c) 2000, 2007 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.jdt.ui.actions;
12
13 import org.eclipse.ui.IWorkbenchSite;
14 import org.eclipse.ui.IWorkingSet;
15 import org.eclipse.ui.PlatformUI;
16
17 import org.eclipse.jdt.core.IJavaElement;
18 import org.eclipse.jdt.core.JavaModelException;
19 import org.eclipse.jdt.core.search.IJavaSearchScope;
20
21 import org.eclipse.jdt.ui.search.ElementQuerySpecification;
22 import org.eclipse.jdt.ui.search.QuerySpecification;
23
24 import org.eclipse.jdt.internal.ui.IJavaHelpContextIds;
25 import org.eclipse.jdt.internal.ui.JavaPluginImages;
26 import org.eclipse.jdt.internal.ui.javaeditor.JavaEditor;
27 import org.eclipse.jdt.internal.ui.search.JavaSearchScopeFactory;
28 import org.eclipse.jdt.internal.ui.search.SearchMessages;
29 import org.eclipse.jdt.internal.ui.search.SearchUtil;
30
31 /**
32  * Finds declarations of the selected element in working sets.
33  * The action is applicable to selections representing a Java element.
34  *
35  * <p>
36  * This class may be instantiated; it is not intended to be subclassed.
37  * </p>
38  *
39  * @since 2.0
40  */
41 public class FindDeclarationsInWorkingSetAction extends FindDeclarationsAction {
42
43     private IWorkingSet[] fWorkingSet;
44
45     /**
46      * Creates a new <code>FindDeclarationsInWorkingSetAction</code>. The action
47      * requires that the selection provided by the site's selection provider is of type
48      * <code>org.eclipse.jface.viewers.IStructuredSelection</code>. The user will be
49      * prompted to select the working sets.
50      *
51      * @param site the site providing context information for this action
52      */
53     public FindDeclarationsInWorkingSetAction(IWorkbenchSite site) {
54         this(site, null);
55     }
56
57     /**
58      * Creates a new <code>FindDeclarationsInWorkingSetAction</code>. The action
59      * requires that the selection provided by the site's selection provider is of type
60      * <code>org.eclipse.jface.viewers.IStructuredSelection</code>.
61      *
62      * @param site the site providing context information for this action
63      * @param workingSets the working sets to be used in the search
64      */
65     public FindDeclarationsInWorkingSetAction(IWorkbenchSite site, IWorkingSet[] workingSets) {
66         super(site);
67         fWorkingSet= workingSets;
68     }
69
70     /**
71      * Note: This constructor is for internal use only. Clients should not call this constructor.
72      * @param editor the Java editor
73      */
74     public FindDeclarationsInWorkingSetAction(JavaEditor editor) {
75         this(editor, null);
76     }
77
78     /**
79      * Note: This constructor is for internal use only. Clients should not call this constructor.
80      *
81      * @param editor the Java editor
82      * @param workingSets the working sets to be used in the search
83      */
84     public FindDeclarationsInWorkingSetAction(JavaEditor editor, IWorkingSet[] workingSets) {
85         super(editor);
86         fWorkingSet= workingSets;
87     }
88
89     void init() {
90         setText(SearchMessages.Search_FindDeclarationsInWorkingSetAction_label);
91         setToolTipText(SearchMessages.Search_FindDeclarationsInWorkingSetAction_tooltip);
92         setImageDescriptor(JavaPluginImages.DESC_OBJS_SEARCH_DECL);
93         PlatformUI.getWorkbench().getHelpSystem().setHelp(this, IJavaHelpContextIds.FIND_DECLARATIONS_IN_WORKING_SET_ACTION);
94     }
95
96     QuerySpecification createQuery(IJavaElement element) throws JavaModelException, InterruptedException JavaDoc {
97         JavaSearchScopeFactory factory= JavaSearchScopeFactory.getInstance();
98         
99         IWorkingSet[] workingSets= fWorkingSet;
100         if (fWorkingSet == null) {
101             workingSets= factory.queryWorkingSets();
102             if (workingSets == null)
103                 return null;
104         }
105         SearchUtil.updateLRUWorkingSets(workingSets);
106         IJavaSearchScope scope= factory.createJavaSearchScope(workingSets, true);
107         String JavaDoc description= factory.getWorkingSetScopeDescription(workingSets, true);
108         return new ElementQuerySpecification(element, getLimitTo(), scope, description);
109     }
110
111 }
112
Popular Tags