com.laex.cg2d.core.ApplicationWorkbenchAdvisor.java Source code

Java tutorial

Introduction

Here is the source code for com.laex.cg2d.core.ApplicationWorkbenchAdvisor.java

Source

/*
 * Copyright (c) 2012, 2013 Hemanta Sapkota.
 * 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:
 * Hemanta Sapkota (laex.pearl@gmail.com)
 */
package com.laex.cg2d.core;

import java.net.URL;
import java.util.ArrayList;
import java.util.Arrays;
import java.util.List;

import org.eclipse.core.resources.IWorkspace;
import org.eclipse.core.resources.ResourcesPlugin;
import org.eclipse.core.runtime.IAdaptable;
import org.eclipse.core.runtime.Platform;
import org.eclipse.core.runtime.dynamichelpers.IExtensionChangeHandler;
import org.eclipse.jface.preference.PreferenceManager;
import org.eclipse.jface.resource.ImageDescriptor;
import org.eclipse.ui.IPerspectiveDescriptor;
import org.eclipse.ui.IPerspectiveRegistry;
import org.eclipse.ui.IWorkbenchPage;
import org.eclipse.ui.IWorkbenchWindow;
import org.eclipse.ui.PlatformUI;
import org.eclipse.ui.application.IWorkbenchConfigurer;
import org.eclipse.ui.application.IWorkbenchWindowConfigurer;
import org.eclipse.ui.application.WorkbenchAdvisor;
import org.eclipse.ui.application.WorkbenchWindowAdvisor;
import org.eclipse.ui.ide.IDE;
import org.eclipse.ui.internal.ide.IDEWorkbenchPlugin;
import org.osgi.framework.Bundle;

/**
 * This workbench advisor creates the window advisor, and specifies the
 * perspective id for the initial window.
 */
public class ApplicationWorkbenchAdvisor extends WorkbenchAdvisor {

    /** The Constant IGNORE_PERSPECTIVES. */
    public static final String[] IGNORE_PERSPECTIVES = new String[] {
            "org.eclipse.team.ui.TeamSynchronizingPerspective" };

    /*
     * (non-Javadoc)
     * 
     * @see
     * org.eclipse.ui.application.WorkbenchAdvisor#createWorkbenchWindowAdvisor
     * (org.eclipse.ui.application.IWorkbenchWindowConfigurer)
     */
    public WorkbenchWindowAdvisor createWorkbenchWindowAdvisor(IWorkbenchWindowConfigurer configurer) {
        return new ApplicationWorkbenchWindowAdvisor(configurer);
    }

    /*
     * (non-Javadoc)
     * 
     * @see org.eclipse.ui.application.WorkbenchAdvisor#initialize(org.eclipse.ui.
     * application.IWorkbenchConfigurer)
     */
    @Override
    public void initialize(IWorkbenchConfigurer configurer) {
        super.initialize(configurer);
        IDE.registerAdapters();
        hackForShowingProjectIconInRCPApplications(configurer);

        removeUnWantedPerspectives();
        removeUnwantedPreferences();
    }

    /**
     * Removes the unwanted preferences.
     */
    private void removeUnwantedPreferences() {
        PreferenceManager pm = PlatformUI.getWorkbench().getPreferenceManager();
        pm.remove("org.eclipse.ui.preferencePages.Workbench");
        pm.remove("org.eclipse.team.ui.TeamPreferences");
        pm.remove("org.eclipse.debug.ui.DebugPreferencePage");

        //    IPreferenceNode[] arr = pm.getRootSubNodes();
        //
        //    for (IPreferenceNode pn : arr) {
        //      System.out.println("Label:" + pn.getLabelText() + " ID:" + pn.getId());
        //    }
    }

    /* (non-Javadoc)
     * @see org.eclipse.ui.application.WorkbenchAdvisor#postWindowCreate(org.eclipse.ui.application.IWorkbenchWindowConfigurer)
     */
    @Override
    public void postWindowCreate(IWorkbenchWindowConfigurer configurer) {
    }

    @Override
    public void postWindowOpen(IWorkbenchWindowConfigurer configurer) {
        //    super.postWindowOpen(configurer);

        // remove unwanted UI contributions that eclipse makes by default
        IWorkbenchWindow[] windows = PlatformUI.getWorkbench().getWorkbenchWindows();

        for (int i = 0; i < windows.length; ++i) {
            IWorkbenchPage page = windows[i].getActivePage();
            if (page != null) {
                // hide generic 'File' commands
                page.hideActionSet("org.eclipse.ui.actionSet.openFiles");

                // hide 'Convert Line Delimiters To...'
                page.hideActionSet("org.eclipse.ui.edit.text.actionSet.convertLineDelimitersTo");

                // hide 'Search' commands
                page.hideActionSet("org.eclipse.search.searchActionSet");

                // hide 'Annotation' commands
                page.hideActionSet("org.eclipse.ui.edit.text.actionSet.annotationNavigation");

                // hide 'Forward/Back' type navigation commands
                page.hideActionSet("org.eclipse.ui.edit.text.actionSet.navigation");
            }
        }
    }

    /*
     * (non-Javadoc)
     * 
     * @see
     * org.eclipse.ui.application.WorkbenchAdvisor#getInitialWindowPerspectiveId()
     */
    public String getInitialWindowPerspectiveId() {
        return Perspective.ID;
    }

    /*
     * (non-Javadoc)
     * 
     * @see org.eclipse.ui.application.WorkbenchAdvisor#getDefaultPageInput()
     */
    @Override
    public IAdaptable getDefaultPageInput() {
        IWorkspace workspace = ResourcesPlugin.getWorkspace();
        return workspace.getRoot();
    }

    /**
     * Hack taken from
     * <url>http://francisu.wordpress.com/2008/05/27/magic-required
     * -to-use-the-common-navigator-in-an-rcp-application/</url> Hopefully it will
     * be solved on Indigo.
     * 
     * @param configurer
     *          the configurer
     */
    private void hackForShowingProjectIconInRCPApplications(IWorkbenchConfigurer configurer) {
        final String ICONS_PATH = "icons/full/";
        final String PATH_OBJECT = ICONS_PATH + "obj16/";
        Bundle ideBundle = Platform.getBundle(IDEWorkbenchPlugin.IDE_WORKBENCH);
        declareWorkbenchImage(configurer, ideBundle, IDE.SharedImages.IMG_OBJ_PROJECT, PATH_OBJECT + "prj_obj.gif",
                true);
        declareWorkbenchImage(configurer, ideBundle, IDE.SharedImages.IMG_OBJ_PROJECT_CLOSED,
                PATH_OBJECT + "cprj_obj.gif", true);
    }

    /**
     * Declare workbench image.
     * 
     * @param configurer_p
     *          the configurer_p
     * @param ideBundle
     *          the ide bundle
     * @param symbolicName
     *          the symbolic name
     * @param path
     *          the path
     * @param shared
     *          the shared
     */
    private void declareWorkbenchImage(IWorkbenchConfigurer configurer_p, Bundle ideBundle, String symbolicName,
            String path, boolean shared) {
        URL url = ideBundle.getEntry(path);
        ImageDescriptor desc = ImageDescriptor.createFromURL(url);
        configurer_p.declareImage(symbolicName, desc, shared);
    }

    /**
     * Removes the un wanted perspectives.
     */
    private void removeUnWantedPerspectives() {
        IPerspectiveRegistry perspectiveRegistry = PlatformUI.getWorkbench().getPerspectiveRegistry();
        IPerspectiveDescriptor[] perspectiveDescriptors = perspectiveRegistry.getPerspectives();
        List ignoredPerspectives = Arrays.asList(IGNORE_PERSPECTIVES);
        List removePerspectiveDesc = new ArrayList();

        // Add the perspective descriptors with the matching perspective ids to the
        // list
        for (IPerspectiveDescriptor perspectiveDescriptor : perspectiveDescriptors) {
            if (ignoredPerspectives.contains(perspectiveDescriptor.getId())) {
                removePerspectiveDesc.add(perspectiveDescriptor);
            }
        }

        // If the list is non-empty then remove all such perspectives from the
        // IExtensionChangeHandler
        if (perspectiveRegistry instanceof IExtensionChangeHandler && !removePerspectiveDesc.isEmpty()) {
            IExtensionChangeHandler extChgHandler = (IExtensionChangeHandler) perspectiveRegistry;
            extChgHandler.removeExtension(null, removePerspectiveDesc.toArray());
        }
    }

}