content: /*******************************************************************************
   * Copyright (c) 2000, 2008 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.wst.jsdt.ui.actions;
  
  import java.util.Iterator;
  
  import org.eclipse.core.runtime.Assert;
  import org.eclipse.jface.action.IAction;
  import org.eclipse.jface.action.IMenuManager;
  import org.eclipse.jface.action.MenuManager;
  import org.eclipse.jface.action.Separator;
  import org.eclipse.jface.viewers.ISelection;
  import org.eclipse.jface.viewers.ISelectionChangedListener;
  import org.eclipse.jface.viewers.ISelectionProvider;
  import org.eclipse.ui.IActionBars;
  import org.eclipse.ui.IWorkbenchSite;
  import org.eclipse.ui.IWorkingSet;
  import org.eclipse.ui.actions.ActionGroup;
  import org.eclipse.ui.texteditor.ITextEditorActionConstants;
  import org.eclipse.wst.jsdt.internal.ui.javaeditor.JavaEditor;
  import org.eclipse.wst.jsdt.internal.ui.search.SearchMessages;
  import org.eclipse.wst.jsdt.internal.ui.search.SearchUtil;
  import org.eclipse.wst.jsdt.ui.IContextMenuConstants;
  
  /**
   * Action group that adds the search for declarations actions to a
   * context menu and the global menu bar.
   * 
   * <p>
   * This class may be instantiated; it is not intended to be subclassed.
   * </p>
   * 
   *
   * Provisional API: This class/interface is part of an interim API that is still under development and expected to
   * change significantly before reaching stability. It is being made available at this early stage to solicit feedback
   * from pioneering adopters on the understanding that any code that uses this API will almost certainly be broken
   * (repeatedly) as the API evolves.
   */
  public class DeclarationsSearchGroup extends ActionGroup  {
  
  	private static final String MENU_TEXT= SearchMessages.group_declarations; 
  	
  	private IWorkbenchSite fSite;
  	private JavaEditor fEditor;
  	private IActionBars fActionBars;
  	
  	private String fGroupId;
  
  	private FindDeclarationsAction fFindDeclarationsAction;
  	private FindDeclarationsInProjectAction fFindDeclarationsInProjectAction;
  	private FindDeclarationsInWorkingSetAction fFindDeclarationsInWorkingSetAction;
  	private FindDeclarationsInHierarchyAction fFindDeclarationsInHierarchyAction;
  
  	/**
  	 * Creates a new <code>DeclarationsSearchGroup</code>. The group requires
  	 * that the selection provided by the site's selection provider is of type <code>
  	 * IStructuredSelection</code>.
  	 * 
  	 * @param site the workbench site that owns this action group
  	 */
  	public DeclarationsSearchGroup(IWorkbenchSite site) {
  		fSite= site;
  		fGroupId= IContextMenuConstants.GROUP_SEARCH;
  		
  		fFindDeclarationsAction= new FindDeclarationsAction(site);
  		fFindDeclarationsAction.setActionDefinitionId(IJavaEditorActionDefinitionIds.SEARCH_DECLARATIONS_IN_WORKSPACE);
  
  		fFindDeclarationsInProjectAction= new FindDeclarationsInProjectAction(site);
  		fFindDeclarationsInProjectAction.setActionDefinitionId(IJavaEditorActionDefinitionIds.SEARCH_DECLARATIONS_IN_PROJECTS);
  
  		fFindDeclarationsInHierarchyAction= new FindDeclarationsInHierarchyAction(site);
  		fFindDeclarationsInHierarchyAction.setActionDefinitionId(IJavaEditorActionDefinitionIds.SEARCH_DECLARATIONS_IN_HIERARCHY);
  
  		fFindDeclarationsInWorkingSetAction= new FindDeclarationsInWorkingSetAction(site);
  		fFindDeclarationsInWorkingSetAction.setActionDefinitionId(IJavaEditorActionDefinitionIds.SEARCH_DECLARATIONS_IN_WORKING_SET);
  
  		// register the actions as selection listeners
  		ISelectionProvider provider= fSite.getSelectionProvider();
  		ISelection selection= provider.getSelection();
  		registerAction(fFindDeclarationsAction, provider, selection);
  		registerAction(fFindDeclarationsInProjectAction, provider, selection);
  		registerAction(fFindDeclarationsInHierarchyAction, provider, selection);
  		registerAction(fFindDeclarationsInWorkingSetAction, provider, selection);
  	}
  
  	/**
  	 * Note: This constructor is for internal use only. Clients should not call this constructor.
  	 * 
  	 * @param editor the JavaScript editor
  	 */
  	public DeclarationsSearchGroup(JavaEditor editor) {
  		Assert.isNotNull(editor);
  		fEditor= editor;
  		fSite= fEditor.getSite();
  		fGroupId= ITextEditorActionConstants.GROUP_FIND;
  
  		fFindDeclarationsAction= new FindDeclarationsAction(fEditor);
  		fFindDeclarationsAction.setActionDefinitionId(IJavaEditorActionDefinitionIds.SEARCH_DECLARATIONS_IN_WORKSPACE);
  		fEditor.setAction("SearchDeclarationsInWorkspace", fFindDeclarationsAction); //$NON-NLS-1$
  
  		fFindDeclarationsInProjectAction= new FindDeclarationsInProjectAction(fEditor);
  		fFindDeclarationsInProjectAction.setActionDefinitionId(IJavaEditorActionDefinitionIds.SEARCH_DECLARATIONS_IN_PROJECTS);
  		fEditor.setAction("SearchDeclarationsInProjects", fFindDeclarationsInProjectAction); //$NON-NLS-1$
  
  		fFindDeclarationsInHierarchyAction= new FindDeclarationsInHierarchyAction(fEditor);
  		fFindDeclarationsInHierarchyAction.setActionDefinitionId(IJavaEditorActionDefinitionIds.SEARCH_DECLARATIONS_IN_HIERARCHY);
  		fEditor.setAction("SearchDeclarationsInHierarchy", fFindDeclarationsInHierarchyAction); //$NON-NLS-1$
  
  		fFindDeclarationsInWorkingSetAction= new FindDeclarationsInWorkingSetAction(fEditor);
  		fFindDeclarationsInWorkingSetAction.setActionDefinitionId(IJavaEditorActionDefinitionIds.SEARCH_DECLARATIONS_IN_WORKING_SET);
  		fEditor.setAction("SearchDeclarationsInWorkingSet", fFindDeclarationsInWorkingSetAction); //$NON-NLS-1$
  	}
  
  	private void registerAction(SelectionDispatchAction action, ISelectionProvider provider, ISelection selection) {
  		action.update(selection);
  		provider.addSelectionChangedListener(action);
  	}
  
  	/* (non-Javadoc)
  	 * Method declared on ActionGroup.
  	 */
  	public void fillActionBars(IActionBars actionBars) {
  		Assert.isNotNull(actionBars);
  		super.fillActionBars(actionBars);
  		fActionBars= actionBars;
  		updateGlobalActionHandlers();
  	}
  
  	private void addAction(IAction action, IMenuManager manager) {
  		if (action.isEnabled()) {
  			manager.add(action);
  		}
  	}
  	
  	private void addWorkingSetAction(IWorkingSet[] workingSets, IMenuManager manager) {
  		FindAction action;
  		if (fEditor != null)
  			action= new WorkingSetFindAction(fEditor, new FindDeclarationsInWorkingSetAction(fEditor, workingSets), SearchUtil.toString(workingSets));
  		else
  			action= new WorkingSetFindAction(fSite, new FindDeclarationsInWorkingSetAction(fSite, workingSets), SearchUtil.toString(workingSets));
  		action.update(getContext().getSelection());
  		addAction(action, manager);
  	}
  	
  	
  	/* (non-Javadoc)
  	 * Method declared on ActionGroup.
  	 */
  	public void fillContextMenu(IMenuManager manager) {
  		IMenuManager javaSearchMM= new MenuManager(MENU_TEXT, IContextMenuConstants.GROUP_SEARCH);
  		addAction(fFindDeclarationsAction, javaSearchMM);
  		addAction(fFindDeclarationsInProjectAction, javaSearchMM);
  		addAction(fFindDeclarationsInHierarchyAction, javaSearchMM);
  		
  		javaSearchMM.add(new Separator());
  		
  		Iterator iter= SearchUtil.getLRUWorkingSets().sortedIterator();
  		while (iter.hasNext()) {
  			addWorkingSetAction((IWorkingSet[]) iter.next(), javaSearchMM);
  		}
  		addAction(fFindDeclarationsInWorkingSetAction, javaSearchMM);
  
  		if (!javaSearchMM.isEmpty())
  			manager.appendToGroup(fGroupId, javaSearchMM);
  	}
  	
  	/* 
  	 * Method declared on ActionGroup.
  	 */
  	public void dispose() {
  		ISelectionProvider provider= fSite.getSelectionProvider();
  		if (provider != null) {
  			disposeAction(fFindDeclarationsAction, provider);
  			disposeAction(fFindDeclarationsInProjectAction, provider);
  			disposeAction(fFindDeclarationsInHierarchyAction, provider);
  			disposeAction(fFindDeclarationsInWorkingSetAction, provider);
  		}
  		fFindDeclarationsAction= null;
  		fFindDeclarationsInProjectAction= null;
  		fFindDeclarationsInHierarchyAction= null;
  		fFindDeclarationsInWorkingSetAction= null;
  		updateGlobalActionHandlers();
  		super.dispose();
  	}
  
  	private void updateGlobalActionHandlers() {
  		if (fActionBars != null) {
  			fActionBars.setGlobalActionHandler(JdtActionConstants.FIND_DECLARATIONS_IN_WORKSPACE, fFindDeclarationsAction);
  			fActionBars.setGlobalActionHandler(JdtActionConstants.FIND_DECLARATIONS_IN_PROJECT, fFindDeclarationsInProjectAction);
  			fActionBars.setGlobalActionHandler(JdtActionConstants.FIND_DECLARATIONS_IN_HIERARCHY, fFindDeclarationsInHierarchyAction);
  			fActionBars.setGlobalActionHandler(JdtActionConstants.FIND_DECLARATIONS_IN_WORKING_SET, fFindDeclarationsInWorkingSetAction);
  		}
  	}
  
  	private void disposeAction(ISelectionChangedListener action, ISelectionProvider provider) {
  		if (action != null)
  			provider.removeSelectionChangedListener(action);
  	}
  }
  