bundles/org.eclipse.ui.workbench/Eclipse UI/org/eclipse/ui/internal/ShowPartPaneMenuAction.java

/*******************************************************************************
 * 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.ui.internal;

import org.eclipse.swt.SWT;
import org.eclipse.swt.widgets.Event;
import org.eclipse.ui.IWorkbenchPart;
import org.eclipse.ui.IWorkbenchWindow;
import org.eclipse.ui.actions.ActionFactory;
import org.eclipse.ui.actions.PartEventAction;

/**
 * Show the menu on top of the icon in the
 * view or editor label.
 */
public class ShowPartPaneMenuAction extends PartEventAction implements
        ActionFactory.IWorkbenchAction {

    /**
     * The workbench window; or <code>null</code> if this
     * action has been <code>dispose</code>d.
     */
    private IWorkbenchWindow workbenchWindow;

    private int accelerator;

    /**
     * Constructor for ShowPartPaneMenuAction.
     * 
     * @param window the window
     */
    public ShowPartPaneMenuAction(IWorkbenchWindow window) {
        super(""); //$NON-NLS-1$
        if (window == null) {
            throw new IllegalArgumentException();
        }
        this.workbenchWindow = window;
        // @issue missing action id
        initText();
        workbenchWindow.getPartService().addPartListener(this);
        workbenchWindow.getWorkbench().getHelpSystem().setHelp(this,
				IWorkbenchHelpContextIds.SHOW_PART_PANE_MENU_ACTION);
        setActionDefinitionId("org.eclipse.ui.window.showSystemMenu"); //$NON-NLS-1$
    }

    /**
     * Initialize the menu text and tooltip.
     */
    protected void initText() {
        setText(WorkbenchMessages.ShowPartPaneMenuAction_text); 
        setToolTipText(WorkbenchMessages.ShowPartPaneMenuAction_toolTip); 
    }

    /**
     * Show the pane title menu.
     */
    protected void showMenu(PartPane pane) {
        pane.showSystemMenu();
    }

    /**
     * Updates the enabled state.
     */
    protected void updateState() {
        setEnabled(getActivePart() != null);
    }

    /**
     * See Action
     */
    public void runWithEvent(Event e) {
        if (workbenchWindow == null) {
            // action has been disposed
            return;
        }
        accelerator = e.detail;
        IWorkbenchPart part = getActivePart();
        if (part != null) {
            showMenu(((PartSite) part.getSite()).getPane());
        }
    }

    /**
     * See IPartListener
     */
    public void partOpened(IWorkbenchPart part) {
        super.partOpened(part);
        updateState();
    }

    /**
     * See IPartListener
     */
    public void partClosed(IWorkbenchPart part) {
        super.partClosed(part);
        updateState();
    }

    /**
     * See IPartListener
     */
    public void partActivated(IWorkbenchPart part) {
        super.partActivated(part);
        updateState();
    }

    /**
     * See IPartListener
     */
    public void partDeactivated(IWorkbenchPart part) {
        super.partDeactivated(part);
        updateState();
    }

    public int getAccelerator() {
        int accelerator = this.accelerator;
        accelerator = accelerator & ~SWT.CTRL;
        accelerator = accelerator & ~SWT.SHIFT;
        accelerator = accelerator & ~SWT.ALT;
        return accelerator;
    }

    /* (non-Javadoc)
     * Method declared on ActionFactory.IWorkbenchAction.
     */
    public void dispose() {
        if (workbenchWindow == null) {
            // already disposed
            return;
        }
        workbenchWindow.getPartService().removePartListener(this);
        workbenchWindow = null;
    }

}