WizardsPlugin.java

/* ====================================================================
 *
 * The ObjectStyle Group Software License, Version 1.0
 *
 * Copyright (c) 2002 -2006 The ObjectStyle Group
 * and individual authors of the software.  All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions
 * are met:
 *
 * 1. Redistributions of source code must retain the above copyright
 *    notice, this list of conditions and the following disclaimer.
 *
 * 2. Redistributions in binary form must reproduce the above copyright
 *    notice, this list of conditions and the following disclaimer in
 *    the documentation and/or other materials provided with the
 *    distribution.
 *
 * 3. The end-user documentation included with the redistribution, if
 *    any, must include the following acknowlegement:
 *       "This product includes software developed by the
 *        ObjectStyle Group (http://objectstyle.org/)."
 *    Alternately, this acknowlegement may appear in the software itself,
 *    if and wherever such third-party acknowlegements normally appear.
 *
 * 4. The names "ObjectStyle Group" and "Cayenne"
 *    must not be used to endorse or promote products derived
 *    from this software without prior written permission. For written
 *    permission, please contact andrus@objectstyle.org.
 *
 * 5. Products derived from this software may not be called "ObjectStyle"
 *    nor may "ObjectStyle" appear in their names without prior written
 *    permission of the ObjectStyle Group.
 *
 * THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED OR IMPLIED
 * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
 * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
 * DISCLAIMED.  IN NO EVENT SHALL THE OBJECTSTYLE GROUP OR
 * ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
 * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF
 * USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
 * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
 * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
 * OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
 * SUCH DAMAGE.
 * ====================================================================
 *
 * This software consists of voluntary contributions made by many
 * individuals on behalf of the ObjectStyle Group.  For more
 * information on the ObjectStyle Group, please see
 * <http://objectstyle.org/>.
 *
 */
/*Portions of this code are Copyright Apple Inc. 2008 and licensed under the
ObjectStyle Group Software License, version 1.0.  This license from Apple
applies solely to the actual code contributed by Apple and to no other code.
No other license or rights are granted by Apple, explicitly, by implication,
by estoppel, or otherwise.  All rights reserved.*/
package org.objectstyle.wolips.wizards;

import org.eclipse.core.resources.IFile;
import org.eclipse.core.resources.IResource;
import org.eclipse.jface.resource.ImageDescriptor;
import org.eclipse.ui.plugin.AbstractUIPlugin;
import org.eclipse.ui.wizards.newresource.BasicNewResourceWizard;
import org.objectstyle.wolips.baseforuiplugins.AbstractBaseUIActivator;
import org.objectstyle.wolips.baseforuiplugins.utils.WorkbenchUtilities;
import org.osgi.framework.BundleContext;

/**
 * The main plugin class to be used in the desktop.
 */
public class WizardsPlugin extends AbstractBaseUIActivator {
	// The shared instance.
	private static WizardsPlugin plugin;

	private static ImageDescriptor WOCOMPONENT_WIZARD_BANNER;


	private static ImageDescriptor WOPROJECT_WIZARD_BANNER;

	private static ImageDescriptor EOMODEL_ICON;

	private static ImageDescriptor D2W_BASIC_ICON;

	private static ImageDescriptor D2W_NEU_ICON;

	private static ImageDescriptor D2W_WOL_ICON;

	private static ImageDescriptor D2W_CLASSIC_ICON;

	private static ImageDescriptor D2W_WONDER_ICON;


	/**
	 * Wrap bindings of WebObjects version to a display string
	 */
	enum WO_VERSION {
		/**
		 * 5.4.x
		 */
		WO_54("5.4"),
		/**
		 * 5.3.x
		 */
		WO_53 ("5.3"),
		/**
		 * 5.2.x
		 */
		WO_52("5.2");


		private String _displayString;

		WO_VERSION(String displayString) {
			_displayString = displayString;
		}

		String getDisplayString() {
			return _displayString;
		}
	}






	/**
	 * Returns an image descriptor for the image file at the given plug-in
	 * relative path.
	 *
	 * @param path
	 * 		the path
	 * 
	 * @return 
	 * 		the image descriptor
	 */
	public static ImageDescriptor getImageDescriptor(String path) {
		return AbstractUIPlugin.imageDescriptorFromPlugin("org.objectstyle.wolips.wizards", path);
	}

	public static ImageDescriptor tbComponentControllerBanner() {
		if (_tbComponentControllerBanner == null) {
			_tbComponentControllerBanner = getImageDescriptor("icons/tbwizard/add-component-controller.png");
		}
		return _tbComponentControllerBanner;
	}
	private static ImageDescriptor _tbComponentControllerBanner;

	public static ImageDescriptor tbComponentImageDescriptor() {
		if (_tbComponentImageDescriptor == null) {
			_tbComponentImageDescriptor = getImageDescriptor("icons/tbwizard/component.png");
		}
		return _tbComponentImageDescriptor;		
	}
	private static ImageDescriptor _tbComponentImageDescriptor;

















	/**
	 * The constructor.
	 */
	public WizardsPlugin() {
		super();
		plugin = this;
	}

	public void start(BundleContext context) throws Exception {
		super.start(context);
	}

	/**
	 * This method is called when the plug-in is stopped
	 * @param context
	 * @throws Exception
	 */
	public void stop(BundleContext context) throws Exception {
		super.stop(context);
		plugin = null;
	}

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


	/**
	 * @return Returns the image descriptor.
	 */
	public static ImageDescriptor WOCOMPONENT_WIZARD_BANNER() {
		if (WOCOMPONENT_WIZARD_BANNER == null)
			WOCOMPONENT_WIZARD_BANNER = getImageDescriptor("icons/wizban/webobjects_wiz.gif");
		return WOCOMPONENT_WIZARD_BANNER;
	}


	/**
	 * @return Returns the image descriptor.
	 */
	public static final ImageDescriptor WOPROJECT_WIZARD_BANNER() {
		if (WOPROJECT_WIZARD_BANNER == null)
			WOPROJECT_WIZARD_BANNER = getImageDescriptor("icons/wizban/webobjects_wiz.gif");
		return WOPROJECT_WIZARD_BANNER;
	}

	public static final ImageDescriptor EOMODEL_ICON() {
		if (EOMODEL_ICON == null)
			EOMODEL_ICON = getImageDescriptor("icons/woproject/eoModel.png");
		return EOMODEL_ICON;
	}

	public static final ImageDescriptor D2W_BASIC_ICON() {
		if (D2W_BASIC_ICON == null)
			D2W_BASIC_ICON = getImageDescriptor("icons/woproject/d2w_basic.gif");
		return D2W_BASIC_ICON;
	}

	public static final ImageDescriptor D2W_WOL_ICON() {
		if (D2W_WOL_ICON == null)
			D2W_WOL_ICON = getImageDescriptor("icons/woproject/d2w_wol.gif");
		return D2W_WOL_ICON;
	}

	public static final ImageDescriptor D2W_NEU_ICON() {
		if (D2W_NEU_ICON == null)
			D2W_NEU_ICON = getImageDescriptor("icons/woproject/d2w_neu.gif");
		return D2W_NEU_ICON;
	}

	public static final ImageDescriptor D2W_CLASSIC_ICON() {
		if (D2W_CLASSIC_ICON == null)
			D2W_CLASSIC_ICON = getImageDescriptor("icons/woproject/d2w_classic.gif");
		return D2W_CLASSIC_ICON;
	}

	public static final ImageDescriptor D2W_WONDER_ICON() {
		if (D2W_WONDER_ICON == null)
			D2W_WONDER_ICON = getImageDescriptor("icons/woproject/d2w_wonder.png");
		return D2W_WONDER_ICON;
	}

	public static void selectAndReveal(IResource[] resources) {
		if (resources != null) {
			for (int i = 0; i < resources.length; i++) {
				selectAndReveal(resources[i]);
			}
		}
	}

	public static void selectAndReveal(IResource newResource) {
		if (newResource != null) {
			BasicNewResourceWizard.selectAndReveal(newResource, WorkbenchUtilities.getActiveWorkbenchWindow());
			if (newResource.getType() == IResource.FILE)
				WorkbenchUtilities.open((IFile) newResource);
		}
	}
}