org.eclipse.linuxtools.tmf.ui/src/org/eclipse/linuxtools/internal/tmf/ui/Activator.java

   1 /*******************************************************************************
   2  * Copyright (c) 2009, 2013 Ericsson
   3  *
   4  * All rights reserved. This program and the accompanying materials are
   5  * made available under the terms of the Eclipse Public License v1.0 which
   6  * accompanies this distribution, and is available at
   7  * http://www.eclipse.org/legal/epl-v10.html
   8  *
   9  * Contributors:
  10  *   Francois Chouinard - Initial API and implementation
  11  *******************************************************************************/
  12
  13 package org.eclipse.linuxtools.internal.tmf.ui;
  14
  15 import org.eclipse.core.runtime.IStatus;
  16 import org.eclipse.core.runtime.Status;
  17 import org.eclipse.jface.resource.ImageDescriptor;
  18 import org.eclipse.jface.resource.ImageRegistry;
  19 import org.eclipse.linuxtools.tmf.ui.project.model.TmfTraceElement;
  20 import org.eclipse.linuxtools.tmf.ui.properties.TmfTimePreferences;
  21 import org.eclipse.swt.graphics.Image;
  22 import org.eclipse.ui.plugin.AbstractUIPlugin;
  23 import org.osgi.framework.BundleContext;
  24
  25 /**
  26  * The activator class controls the plug-in life cycle.
  27  */
  28 public class Activator extends AbstractUIPlugin {
  29
  30     // ------------------------------------------------------------------------
  31     // Attributes
  32     // ------------------------------------------------------------------------
  33
  34     /**
  35      * The plug-in ID
  36      */
  37     public static final String PLUGIN_ID = "org.eclipse.linuxtools.tmf.ui"; //$NON-NLS-1$
  38
  39     /**
  40      * The shared instance
  41      */
  42     private static Activator plugin;
  43
  44     // ------------------------------------------------------------------------
  45     // Constructors
  46     // ------------------------------------------------------------------------
  47
  48     /**
  49      * Constructor
  50      */
  51     public Activator() {
  52     }
  53
  54     // ------------------------------------------------------------------------
  55     // Accessors
  56     // ------------------------------------------------------------------------
  57
  58     /**
  59      * Returns the TMF UI plug-in instance.
  60      *
  61      * @return the TMF UI plug-in instance.
  62      */
  63     public static Activator getDefault() {
  64         return plugin;
  65     }
  66
  67     // ------------------------------------------------------------------------
  68     // AbstractUIPlugin
  69     // ------------------------------------------------------------------------
  70
  71     @Override
  72     public void start(BundleContext context) throws Exception {
  73         super.start(context);
  74         plugin = this;
  75         TmfUiTracer.init();
  76         TmfTraceElement.init();
  77         TmfTimePreferences.init();
  78     }
  79
  80     @Override
  81     public void stop(BundleContext context) throws Exception {
  82         TmfUiTracer.stop();
  83         plugin = null;
  84         super.stop(context);
  85     }
  86
  87     // ------------------------------------------------------------------------
  88     // Operations
  89     // ------------------------------------------------------------------------
  90
  91     /**
  92      * Gets an image object using given path within plug-in.
  93      *
  94      * @param path
  95      *            path to image file
  96      *
  97      * @return image object
  98      */
  99     public Image getImageFromPath(String path) {
 100         return getImageDescripterFromPath(path).createImage();
 101     }
 102
 103     /**
 104      * Gets an image descriptor using given path within plug-in.
 105      *
 106      * @param path
 107      *            path to image file
 108      *
 109      * @return image descriptor object
 110      */
 111     public ImageDescriptor getImageDescripterFromPath(String path) {
 112         return AbstractUIPlugin.imageDescriptorFromPlugin(PLUGIN_ID, path);
 113     }
 114
 115     /**
 116      * Gets a image object from the image registry based on the given path. If
 117      * the image is not in the registry it will be registered.
 118      *
 119      * @param path
 120      *            to the image file
 121      * @return image object
 122      */
 123     public Image getImageFromImageRegistry(String path) {
 124         Image icon = getImageRegistry().get(path);
 125         if (icon == null) {
 126             icon = getImageDescripterFromPath(path).createImage();
 127             plugin.getImageRegistry().put(path, icon);
 128         }
 129         return icon;
 130     }
 131
 132     @Override
 133     protected void initializeImageRegistry(ImageRegistry reg) {
 134         reg.put(ITmfImageConstants.IMG_UI_ZOOM, getImageFromPath(ITmfImageConstants.IMG_UI_ZOOM));
 135         reg.put(ITmfImageConstants.IMG_UI_ZOOM_IN, getImageFromPath(ITmfImageConstants.IMG_UI_ZOOM_IN));
 136         reg.put(ITmfImageConstants.IMG_UI_ZOOM_OUT, getImageFromPath(ITmfImageConstants.IMG_UI_ZOOM_OUT));
 137         reg.put(ITmfImageConstants.IMG_UI_SEQ_DIAGRAM_OBJ, getImageFromPath(ITmfImageConstants.IMG_UI_SEQ_DIAGRAM_OBJ));
 138         reg.put(ITmfImageConstants.IMG_UI_ARROW_COLLAPSE_OBJ, getImageFromPath(ITmfImageConstants.IMG_UI_ARROW_COLLAPSE_OBJ));
 139         reg.put(ITmfImageConstants.IMG_UI_ARROW_UP_OBJ, getImageFromPath(ITmfImageConstants.IMG_UI_ARROW_UP_OBJ));
 140     }
 141
 142     /**
 143      * Logs a message with severity INFO in the runtime log of the plug-in.
 144      *
 145      * @param message
 146      *            A message to log
 147      */
 148     public void logInfo(String message) {
 149         getLog().log(new Status(IStatus.INFO, PLUGIN_ID, message));
 150     }
 151
 152     /**
 153      * Logs a message and exception with severity INFO in the runtime log of the
 154      * plug-in.
 155      *
 156      * @param message
 157      *            A message to log
 158      * @param exception
 159      *            A exception to log
 160      */
 161     public void logInfo(String message, Throwable exception) {
 162         getLog().log(new Status(IStatus.INFO, PLUGIN_ID, message, exception));
 163     }
 164
 165     /**
 166      * Logs a message and exception with severity WARNING in the runtime log of
 167      * the plug-in.
 168      *
 169      * @param message
 170      *            A message to log
 171      */
 172     public void logWarning(String message) {
 173         getLog().log(new Status(IStatus.WARNING, PLUGIN_ID, message));
 174     }
 175
 176     /**
 177      * Logs a message and exception with severity WARNING in the runtime log of
 178      * the plug-in.
 179      *
 180      * @param message
 181      *            A message to log
 182      * @param exception
 183      *            A exception to log
 184      */
 185     public void logWarning(String message, Throwable exception) {
 186         getLog().log(new Status(IStatus.WARNING, PLUGIN_ID, message, exception));
 187     }
 188
 189     /**
 190      * Logs a message and exception with severity ERROR in the runtime log of
 191      * the plug-in.
 192      *
 193      * @param message
 194      *            A message to log
 195      */
 196     public void logError(String message) {
 197         getLog().log(new Status(IStatus.ERROR, PLUGIN_ID, message));
 198     }
 199
 200     /**
 201      * Logs a message and exception with severity ERROR in the runtime log of
 202      * the plug-in.
 203      *
 204      * @param message
 205      *            A message to log
 206      * @param exception
 207      *            A exception to log
 208      */
 209     public void logError(String message, Throwable exception) {
 210         getLog().log(new Status(IStatus.ERROR, PLUGIN_ID, message, exception));
 211     }
 212 }