AdvisorUiPlugin.java

/*
 * JBoss, Home of Professional Open Source.
 *
 * See the LEGAL.txt file distributed with this work for information regarding copyright ownership and licensing.
 *
 * See the AUTHORS.txt file distributed with this work for a full listing of individual contributors.
 */
package org.teiid.designer.advisor.ui;

import java.util.MissingResourceException;
import java.util.ResourceBundle;

import org.eclipse.jface.dialogs.IDialogSettings;
import org.eclipse.ui.IWorkbenchPage;
import org.osgi.framework.BundleContext;
import org.teiid.core.designer.PluginUtil;
import org.teiid.core.designer.util.PluginUtilImpl;
import org.teiid.designer.advisor.ui.util.DSPPluginImageHelper;
import org.teiid.designer.advisor.ui.views.status.AdvisorStatusManager;
import org.teiid.designer.ui.common.AbstractUiPlugin;
import org.teiid.designer.ui.common.actions.ActionService;


public class AdvisorUiPlugin extends AbstractUiPlugin implements AdvisorUiConstants {
	// ===========================================================================================================================
	// Static Variables

    private static DSPPluginImageHelper imageHelper;

    private static AdvisorStatusManager manager;
    
	/**
	 * The shared instance of this class.
	 * 
	 * @since 4.2
	 */
	private static AdvisorUiPlugin plugin;

	// ===========================================================================================================================
	// Static Methods

	/**
	 * Gets the shared instance of this class.
	 * 
	 * @return the plugin
	 * @since 4.2
	 */
	public static AdvisorUiPlugin getDefault() {
		return AdvisorUiPlugin.plugin;
	}
	
    /**
     * @return imageHelper
     */
    public static DSPPluginImageHelper getImageHelper() {
        return imageHelper;
    }
    
    /**
     * Returns the string from the plugin's resource bundle, or 'key' if not found.
     */
    public static String getResourceString( String key ) {
        ResourceBundle bundle = AdvisorUiPlugin.getDefault().getResourceBundle();
        try {
            return (bundle != null) ? bundle.getString(key) : key;
        } catch (MissingResourceException e) {
            return key;
        }
    }

	/**
	 * Has the benign side-effect of adding a section for the specified object
	 * to the dialog settings if that section does not already exist.
	 * 
	 * @param object
	 *            the object whose settings are being requested
	 * @return the dialog settings for the specified object
	 * @since 4.2
	 */
	public static IDialogSettings getDialogSettings(Object object) {
		// Get dialog settings, creating section if necessary
		final IDialogSettings settings = getDefault().getDialogSettings();
		final String name = object.getClass().getName();
		IDialogSettings section = settings.getSection(name);

		if (section == null) {
			section = settings.addNewSection(name);
		}

		return section;
	}
	
    // Resource bundle.
    private ResourceBundle resourceBundle;

	// ===========================================================================================================================
	// Constructors

	/**
	 * Constructs a <code>WebserviceUiPlugin</code>.
	 * 
	 * @since 4.2
	 */
	public AdvisorUiPlugin() {
		// Save this instance to be shared via the getDefault() method.
		AdvisorUiPlugin.plugin = this;
	}

	// ===========================================================================================================================
	// Methods

	/**
	 * @see org.teiid.designer.ui.common.AbstractUiPlugin#createActionService(org.eclipse.ui.IWorkbenchPage)
	 * @since 4.2
	 */
    @Override
    protected ActionService createActionService(IWorkbenchPage page) {
//        return new AbstractActionService(this, page) {
//
//            public IAction getDefaultAction(String theActionId) {
//                return null;
//            }
//        };
    	return null;
    }

	/**
	 * @since 4.2
	 */
	public ActionService getActionService() {
		return getActionService(getLastValidPage());
	}

	/**
	 * @see org.teiid.designer.ui.common.AbstractUiPlugin#getPluginUtil()
	 * @since 4.2
	 */
	@Override
	public PluginUtil getPluginUtil() {
		return UTIL;
	}
	
    /**
     * Returns the plugin's resource bundle,
     */
    public ResourceBundle getResourceBundle() {
        return resourceBundle;
    }

	/**
	 * @see org.eclipse.ui.plugin.AbstractUIPlugin#start(org.osgi.framework.BundleContext)
	 * @since 4.3.2
	 */
	@Override
	public void start(BundleContext context) throws Exception {
		super.start(context);
		// Initialize logging/i18n/debugging utility
		((PluginUtilImpl) UTIL).initializePlatformLogger(this);
		
        AdvisorUiPlugin.imageHelper = new DSPPluginImageHelper();
	}

	/**
	 * @see org.eclipse.ui.plugin.AbstractUIPlugin#stop(org.osgi.framework.BundleContext)
	 * @since 5.0
	 */
	@Override
	public void stop(BundleContext context) throws Exception {
		super.stop(context);
	}
	
    /**
     * @return Returns the manager.
     * @since 4.3
     */
    public static AdvisorStatusManager getStatusManager() {
        if (manager == null) {
            manager = new AdvisorStatusManager();
        }
        return manager;
    }
}