com.aptana.ui.actions.DefaultNavigatorActionProvider.java Source code

Introduction

Here is the source code for com.aptana.ui.actions.DefaultNavigatorActionProvider.java

Source

/**
 * Aptana Studio
 * Copyright (c) 2005-2011 by Appcelerator, Inc. All Rights Reserved.
 * Licensed under the terms of the GNU Public License (GPL) v3 (with exceptions).
 * Please see the license.html included with this distribution for details.
 * Any modifications to this file must keep this entire header intact.
 */
package com.aptana.ui.actions;

import org.eclipse.jface.action.IToolBarManager;
import org.eclipse.jface.action.MenuManager;
import org.eclipse.swt.SWT;
import org.eclipse.swt.graphics.Image;
import org.eclipse.swt.graphics.Point;
import org.eclipse.swt.widgets.Menu;
import org.eclipse.swt.widgets.ToolBar;
import org.eclipse.ui.IActionBars;
import org.eclipse.ui.IWorkbenchPartSite;
import org.eclipse.ui.menus.IMenuService;
import org.eclipse.ui.menus.MenuUtil;
import org.eclipse.ui.navigator.CommonActionProvider;
import org.eclipse.ui.navigator.ICommonActionExtensionSite;
import org.eclipse.ui.navigator.ICommonViewerWorkbenchSite;

import com.aptana.ui.util.UIUtils;

public abstract class DefaultNavigatorActionProvider extends CommonActionProvider {

    private IWorkbenchPartSite partSite;
    private DefaultNavigatorContributionItem toolbarItem;
    private boolean isToolbarFilled;
    protected Image disabledImage;

    @Override
    public void init(ICommonActionExtensionSite aSite) {
        super.init(aSite);
        partSite = ((ICommonViewerWorkbenchSite) aSite.getViewSite()).getSite();
    }

    @Override
    public void fillActionBars(IActionBars actionBars) {
        if (!isToolbarFilled) {
            toolbarItem = fillToolbar(actionBars.getToolBarManager());
            actionBars.updateActionBars();
            isToolbarFilled = true;
        }
        toolbarItem.setEnabled(isEnabled());
    }

    public abstract String getActionId();

    protected abstract Image getImage();

    protected Image getHotImage() {
        return null;
    }

    protected Image getDisabledImage() {
        if (getImage() != null && disabledImage == null) {
            disabledImage = new Image(UIUtils.getDisplay(), getImage(), SWT.IMAGE_DISABLE);
        }
        return disabledImage;
    }

    protected abstract String getMenuId();

    protected IWorkbenchPartSite getPartSite() {
        return partSite;
    }

    protected String getToolTip() {
        return null;
    }

    protected boolean isEnabled() {
        return false;
    }

    /**
     * The default behavior is to show the same content as clicking the dropdown arrow. Subclass could override.
     * 
     * @param parent
     *            the parent toolbar
     */
    protected void run(ToolBar parent) {
        if (!isEnabled()) {
            return;
        }
        Point toolbarLocation = parent.getLocation();
        toolbarLocation = parent.getParent().toDisplay(toolbarLocation.x, toolbarLocation.y);
        Point toolbarSize = parent.getSize();
        MenuManager menuManager = new MenuManager(null, getMenuId());
        IMenuService menuService = (IMenuService) partSite.getService(IMenuService.class);
        menuService.populateContributionManager(menuManager, MenuUtil.menuUri(menuManager.getId()));
        fillMenu(menuManager);
        Menu menu = menuManager.createContextMenu(parent);
        menu.setLocation(toolbarLocation.x, toolbarLocation.y + toolbarSize.y + 2);
        menu.setVisible(true);
    }

    /**
     * Subclass could use the method to add additional menus programmatically. The default implementation does nothing.
     * 
     * @param menuManager
     *            the menu manager
     */
    protected void fillMenu(MenuManager menuManager) {
    }

    protected DefaultNavigatorContributionItem fillToolbar(IToolBarManager toolBarManager) {
        DefaultNavigatorContributionItem item = new DefaultNavigatorContributionItem(this);
        toolBarManager.add(item);
        return item;
    }

    @Override
    public void dispose() {
        super.dispose();

        if (disabledImage != null) {
            disabledImage.dispose();
        }
    }
}