| /******************************************************************************* |
| * Copyright (c) 2004, 2016 IBM Corporation and others. |
| * 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: |
| * IBM Corporation - initial API and implementation |
| *******************************************************************************/ |
| package org.eclipse.ui.internal.intro.impl; |
| |
| import org.eclipse.core.runtime.IStatus; |
| import org.eclipse.core.runtime.Platform; |
| import org.eclipse.core.runtime.Status; |
| import org.eclipse.jface.resource.ImageRegistry; |
| import org.eclipse.ui.PlatformUI; |
| import org.eclipse.ui.internal.intro.impl.model.IntroModelRoot; |
| import org.eclipse.ui.internal.intro.impl.model.loader.ExtensionPointManager; |
| import org.eclipse.ui.internal.intro.impl.presentations.IntroLaunchBar; |
| import org.eclipse.ui.internal.intro.impl.util.Log; |
| import org.eclipse.ui.intro.IIntroPart; |
| import org.eclipse.ui.plugin.AbstractUIPlugin; |
| import org.osgi.framework.BundleContext; |
| |
| /** |
| * Intro main plugin. |
| */ |
| public class IntroPlugin extends AbstractUIPlugin { |
| public static final String PLUGIN_ID = "org.eclipse.ui.intro"; //$NON-NLS-1$ |
| |
| // Debug control variables |
| public static boolean LOG_WARN = |
| "true".equalsIgnoreCase(Platform.getDebugOption(PLUGIN_ID+"/debug/warn")); //$NON-NLS-1$ //$NON-NLS-2$ |
| public static boolean LOG_INFO = |
| "true".equalsIgnoreCase(Platform.getDebugOption(PLUGIN_ID+"/debug/info")); //$NON-NLS-1$ //$NON-NLS-2$ |
| |
| // The static shared instance. |
| private static IntroPlugin inst; |
| |
| // We must keep track of the launch bar so that we can |
| // close it if intro is opened from the menu. |
| private IntroLaunchBar launchBar; |
| |
| // used for performance logging. Time when the constructor of |
| // CustomizableIntroPart is called. |
| private long uiCreationStartTime; |
| |
| // image registry that can be disposed while the |
| // plug-in is still active. This is important for |
| // switching themes after the plug-in has been loaded. |
| private ImageRegistry volatileImageRegistry; |
| |
| // debug options |
| public static boolean DEBUG = false; |
| public static boolean DEBUG_NO_BROWSER = false; |
| public static boolean DEBUG_TOOLBAR = false; |
| |
| /** |
| * The constructor. |
| */ |
| public IntroPlugin() { |
| super(); |
| } |
| |
| /** |
| * Returns the shared plugin instance. |
| */ |
| public static IntroPlugin getDefault() { |
| return inst; |
| } |
| |
| public ImageRegistry getVolatileImageRegistry() { |
| if (volatileImageRegistry==null) { |
| volatileImageRegistry = createImageRegistry(); |
| initializeImageRegistry(volatileImageRegistry); |
| } |
| return volatileImageRegistry; |
| } |
| |
| public void resetVolatileImageRegistry() { |
| if (volatileImageRegistry!=null) { |
| volatileImageRegistry.dispose(); |
| volatileImageRegistry = null; |
| } |
| } |
| |
| |
| public void closeLaunchBar() { |
| if (launchBar != null) { |
| launchBar.close(); |
| launchBar = null; |
| } |
| IntroLaunchBar.destroyAll(getWorkbench()); |
| } |
| |
| public void setLaunchBar(IntroLaunchBar launchBar) { |
| this.launchBar = launchBar; |
| } |
| |
| |
| /** |
| * @return Returns the extensionPointManager. |
| */ |
| public ExtensionPointManager getExtensionPointManager() { |
| return ExtensionPointManager.getInst(); |
| } |
| |
| /** |
| * Returns the model root. Will always guarantee that model is loaded. |
| * |
| * @return Returns the introModelRoot. |
| */ |
| public IntroModelRoot getIntroModelRoot() { |
| return getExtensionPointManager().getCurrentModel(); |
| } |
| |
| /** |
| * Returns the Intro Part. |
| */ |
| public static IIntroPart getIntro() { |
| IIntroPart introPart = PlatformUI.getWorkbench().getIntroManager() |
| .getIntro(); |
| return introPart; |
| } |
| |
| /** |
| * Returns the Intro Part after forcing an open on it. |
| */ |
| public static IIntroPart showIntro(boolean standby) { |
| IIntroPart introPart = PlatformUI.getWorkbench().getIntroManager() |
| .showIntro(PlatformUI.getWorkbench().getActiveWorkbenchWindow(), |
| standby); |
| return introPart; |
| } |
| |
| /** |
| * Returns the standby state of the Intro Part. If the intro is closed, |
| * retruns false. |
| */ |
| public static boolean isIntroStandby() { |
| return PlatformUI.getWorkbench().getIntroManager().isIntroStandby( |
| getIntro()); |
| } |
| |
| /** |
| * Sets the standby state of the Intro Part. If the intro is closed, retruns |
| * false. |
| */ |
| public static void setIntroStandby(boolean standby) { |
| PlatformUI.getWorkbench().getIntroManager().setIntroStandby(getIntro(), |
| standby); |
| } |
| |
| |
| /** |
| * Returns the standby state of the Intro Part. If the intro is closed, |
| * retruns false. |
| */ |
| public static boolean closeIntro() { |
| // Relies on Workbench. |
| return PlatformUI.getWorkbench().getIntroManager().closeIntro( |
| getIntro()); |
| } |
| |
| |
| @Override |
| public void start(BundleContext context) throws Exception { |
| super.start(context); |
| inst = this; |
| if (Log.logInfo) |
| Log.info("IntroPlugin - calling start on Intro bundle"); //$NON-NLS-1$ |
| // Setup debugging options |
| DEBUG = isDebugging(); |
| if (DEBUG) { |
| DEBUG_NO_BROWSER = "true".equalsIgnoreCase(Platform.getDebugOption(PLUGIN_ID + "/flags/noBrowser")); //$NON-NLS-1$ //$NON-NLS-2$ |
| } |
| if (DEBUG) { |
| DEBUG_TOOLBAR = "true".equalsIgnoreCase(Platform.getDebugOption(PLUGIN_ID + "/debug/toolbar")); //$NON-NLS-1$ //$NON-NLS-2$ |
| } |
| |
| } |
| |
| @Override |
| public void stop(BundleContext context) throws Exception { |
| resetVolatileImageRegistry(); |
| super.stop(context); |
| } |
| |
| public long gettUICreationStartTime() { |
| return uiCreationStartTime; |
| } |
| |
| public void setUICreationStartTime(long uiCreationStartTime) { |
| this.uiCreationStartTime = uiCreationStartTime; |
| } |
| |
| /** |
| * Logs an Error message. To print errors to console, |
| * run eclipse with the -console -consolelog arguments |
| */ |
| public static synchronized void logError(String message) { |
| logError(message,null); |
| } |
| |
| /** |
| * Logs an Error message with an exception. To print errors to console, |
| * run eclipse with the -console -consolelog arguments |
| */ |
| public static synchronized void logError(String message, Throwable ex) { |
| if (message == null){ |
| message = ""; //$NON-NLS-1$ |
| } |
| Status errorStatus = new Status(IStatus.ERROR, PLUGIN_ID, message, ex); |
| IntroPlugin.getDefault().getLog().log(errorStatus); |
| } |
| |
| |
| /** |
| * Logs a Warning message with an exception. To print warnings to console, |
| * run eclipse with the -console -consolelog arguments |
| * |
| * Only logs if the following conditions are true: |
| * -debug switch is enabled at the command line |
| * .options file is placed at the eclipse work directory with the contents: |
| * com.ibm.ccl.welcome.bits/debug=true |
| * com.ibm.ccl.welcome.bits/debug/warn=true |
| */ |
| public static synchronized void logWarning(String message) { |
| logWarning(message,null); |
| } |
| |
| |
| public static synchronized void logWarning(String message,Throwable ex) { |
| if (IntroPlugin.getDefault().isDebugging() && LOG_WARN) { |
| if (message == null) |
| message = ""; //$NON-NLS-1$ |
| Status warningStatus = new Status(IStatus.WARNING, PLUGIN_ID, |
| IStatus.OK, message, ex); |
| getDefault().getLog().log(warningStatus); |
| } |
| } |
| |
| /** |
| * Logs a debug message. To print messages to console, |
| * run eclipse with the -console -consolelog arguments |
| * |
| * Only logs if the following conditions are true: |
| * -debug switch is enabled at the command line |
| * .options file is placed at the eclipse work directory with the contents: |
| * com.ibm.ccl.welcome.bits/debug=true |
| * com.ibm.ccl.welcome.bits/debug/info=true |
| */ |
| public static synchronized void logDebug(String message) { |
| if (IntroPlugin.getDefault().isDebugging() && LOG_INFO) { |
| if (message == null) |
| message = ""; //$NON-NLS-1$ |
| Status status = new Status(IStatus.INFO, PLUGIN_ID,message); |
| getDefault().getLog().log(status); |
| } |
| } |
| |
| } |