core/org.eclipse.ptp.ui/src/org/eclipse/ptp/ui/actions/GotoDropDownAction.java

/*******************************************************************************
 * Copyright (c) 2005 The Regents of the University of California. 
 * This material was produced under U.S. Government contract W-7405-ENG-36 
 * for Los Alamos National Laboratory, which is operated by the University 
 * of California for the U.S. Department of Energy. The U.S. Government has 
 * rights to use, reproduce, and distribute this software. NEITHER THE 
 * GOVERNMENT NOR THE UNIVERSITY MAKES ANY WARRANTY, EXPRESS OR IMPLIED, OR 
 * ASSUMES ANY LIABILITY FOR THE USE OF THIS SOFTWARE. If software is modified 
 * to produce derivative works, such modified software should be clearly marked, 
 * so as not to confuse it with the version available from LANL.
 * 
 * Additionally, 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
 * 
 * LA-CC 04-115
 *******************************************************************************/
package org.eclipse.ptp.ui.actions;

import org.eclipse.jface.action.ActionContributionItem;
import org.eclipse.jface.action.IAction;
import org.eclipse.jface.action.IContributionItem;
import org.eclipse.jface.action.IMenuCreator;
import org.eclipse.jface.action.MenuManager;
import org.eclipse.ptp.ui.model.IElement;
import org.eclipse.ptp.ui.views.AbstractParallelElementView;
import org.eclipse.swt.widgets.Control;
import org.eclipse.swt.widgets.Menu;

/**
 * @author Clement chu
 *
 */
public abstract class GotoDropDownAction extends ParallelAction {
    protected IMenuCreator menuCreator = new IMenuCreator() {
        private MenuManager dropDownMenuMgr = null;

        private void createDropDownMenuMgr() {
        	if (dropDownMenuMgr != null)
        		dispose();
        	
        	dropDownMenuMgr = new MenuManager();
        	createDropDownMenu(dropDownMenuMgr);
        }
        public Menu getMenu(Control parent) {
            createDropDownMenuMgr();
            return dropDownMenuMgr.createContextMenu(parent);
        }
        public Menu getMenu(Menu parent) {
            createDropDownMenuMgr();
            Menu menu = new Menu(parent);
            IContributionItem[] items = dropDownMenuMgr.getItems();
            for (int i = 0; i < items.length; i++) {
                IContributionItem item = items[i];
                IContributionItem newItem = item;
                if (item instanceof ActionContributionItem) {
                    newItem = new ActionContributionItem(((ActionContributionItem) item).getAction());
                }
                newItem.fill(menu, -1);
            }
            return menu;
        }
        public void dispose() {
            if (dropDownMenuMgr != null) {
                dropDownMenuMgr.dispose();
                dropDownMenuMgr = null;
            }
        }
    };
    
    /** Constructor
     * @param name name of action
     * @param view view
     */
    public GotoDropDownAction(String name, AbstractParallelElementView view) {
		super(name, IAction.AS_DROP_DOWN_MENU, view);
	    setMenuCreator(menuCreator);
    }
     
	/** Create drop down menu
	 * @param dropDownMenuMgr
	 */
	protected abstract void createDropDownMenu(MenuManager dropDownMenuMgr);	
	/** run action
	 * @param elements elements to take this action
	 * @param setID set ID
	 */
	protected abstract void run(IElement[] elements, String setID, Object data);
	/** Add action into drop down menu
	 * @param dropDownMenuMgr
	 * @param name name of action
	 * @param id action ID
	 * @param curID current ID
	 */
	protected abstract void addAction(MenuManager dropDownMenuMgr, String name, String id, String curID, Object data);
}