NameBrowserPlugin.java

/** 
 * This file is protected by Copyright. 
 * Please refer to the COPYRIGHT file distributed with this source distribution.
 * 
 * This file is part of REDHAWK IDE.
 * 
 * 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.
 *
 */
package gov.redhawk.ui.views.namebrowser;

import org.eclipse.core.runtime.IStatus;
import org.eclipse.core.runtime.Status;
import org.eclipse.jface.resource.ImageRegistry;
import org.eclipse.swt.widgets.Display;
import org.eclipse.ui.plugin.AbstractUIPlugin;
import org.osgi.framework.BundleContext;
import org.osgi.util.tracker.ServiceTracker;

/**
 * The activator class controls the plug-in life cycle
 * 
 * @since 1.1
 */
public class NameBrowserPlugin extends AbstractUIPlugin {

	// The plug-in ID
	public static final String PLUGIN_ID = "gov.redhawk.ui.views.namebrowser";

	public static final String ADD = "add";
	public static final String CONNECT = "connect";
	public static final String CONTEXT = "context";
	public static final String DISCONNECT = "disconnect";
	public static final String NAMESERVER = "nameserver";
	public static final String OBJECT = "object";

	// The shared instance
	private static NameBrowserPlugin plugin;

	private ServiceTracker<IDisplayHolder, IDisplayHolder> displayHolderService;

	private Display display;

	/**
	 * The constructor
	 */
	public NameBrowserPlugin() {
	}

	/*
	 * (non-Javadoc)
	 * 
	 * @see org.eclipse.ui.plugin.AbstractUIPlugin#start(org.osgi.framework.BundleContext )
	 */
	@Override
	public void start(final BundleContext context) throws Exception {
		super.start(context);
		NameBrowserPlugin.plugin = this;
		this.displayHolderService = new ServiceTracker<IDisplayHolder, IDisplayHolder>(getBundle().getBundleContext(), IDisplayHolder.class, null);
		this.displayHolderService.open();
	}

	/*
	 * (non-Javadoc)
	 * 
	 * @see org.eclipse.ui.plugin.AbstractUIPlugin#stop(org.osgi.framework.BundleContext )
	 */
	@Override
	public void stop(final BundleContext context) throws Exception {
		NameBrowserPlugin.plugin = null;
		super.stop(context);
		if (this.displayHolderService != null) {
			this.displayHolderService.close();
			this.displayHolderService = null;
		}
	}

	/**
	 * @since 1.3
	 */
	public void setSessionDisplay(Display display) {
		/**
		 * We save the reference to <code>display</code> because
		 * we need it to retrieve the session singleton instance
		 * of DisplayHolder in <code>getDisplay</code>.
		 */
		this.display = display;
		if (this.displayHolderService != null && this.displayHolderService.getService() != null) {
			this.displayHolderService.getService().setSessionDisplay(display);
		}
	}

	/**
	 * @since 1.3
	 */
	public Display getDisplay() {
		if (this.displayHolderService != null && this.displayHolderService.getService() != null) {
			return this.displayHolderService.getService().getSessionDisplay(this.display);
		}
		return Display.getCurrent();
	}

	/**
	 * Returns the shared instance
	 * 
	 * @return the shared instance
	 */
	public static NameBrowserPlugin getDefault() {
		return NameBrowserPlugin.plugin;
	}

	@Override
	protected ImageRegistry createImageRegistry() {
		final ImageRegistry registry = super.createImageRegistry();
		registry.put(NameBrowserPlugin.ADD, AbstractUIPlugin.imageDescriptorFromPlugin(NameBrowserPlugin.PLUGIN_ID, "icons/add.png"));
		registry.put(NameBrowserPlugin.CONNECT, AbstractUIPlugin.imageDescriptorFromPlugin(NameBrowserPlugin.PLUGIN_ID, "icons/connect.png"));
		registry.put(NameBrowserPlugin.DISCONNECT, AbstractUIPlugin.imageDescriptorFromPlugin(NameBrowserPlugin.PLUGIN_ID, "icons/disconnect.png"));
		registry.put(NameBrowserPlugin.CONTEXT, AbstractUIPlugin.imageDescriptorFromPlugin(NameBrowserPlugin.PLUGIN_ID, "icons/NSContext.gif"));
		registry.put(NameBrowserPlugin.NAMESERVER, AbstractUIPlugin.imageDescriptorFromPlugin(NameBrowserPlugin.PLUGIN_ID, "icons/nameServer.gif"));
		registry.put(NameBrowserPlugin.OBJECT, AbstractUIPlugin.imageDescriptorFromPlugin(NameBrowserPlugin.PLUGIN_ID, "icons/NSObject.gif"));
		return registry;
	}

	/**
	 * Log error.
	 * 
	 * @param msg the msg
	 * @param e the e
	 */
	public static void logError(final String msg, final Throwable e) {
		NameBrowserPlugin.getDefault().getLog().log(new Status(IStatus.ERROR, NameBrowserPlugin.PLUGIN_ID, msg, e));
	}
}