TPTP 4.7.0 Tracing and Profiling Tools Project
Public API Specification

org.eclipse.tptp.trace.report.birt.ui
Class UiPlugin

java.lang.Object
  extended by org.eclipse.core.runtime.Plugin
      extended by org.eclipse.ui.plugin.AbstractUIPlugin
          extended by org.eclipse.tptp.trace.report.birt.ui.UiPlugin
All Implemented Interfaces:
org.osgi.framework.BundleActivator

public class UiPlugin
extends org.eclipse.ui.plugin.AbstractUIPlugin

The main plugin class to be used in the desktop.


Field Summary
static java.lang.String PLUGIN_ID
           
 
Fields inherited from class org.eclipse.core.runtime.Plugin
PLUGIN_PREFERENCE_SCOPE, PREFERENCES_DEFAULT_OVERRIDE_BASE_NAME, PREFERENCES_DEFAULT_OVERRIDE_FILE_NAME
 
Constructor Summary
UiPlugin()
          The constructor.
 
Method Summary
static UiPlugin getDefault()
          Returns the shared instance.
static java.lang.String getID()
          Returns this plugin's id.
static org.eclipse.jface.resource.ImageDescriptor getImageDescriptor(java.lang.String path)
          Returns an image descriptor for the image file at the given plug-in relative path.
 java.util.ResourceBundle getResourceBundle()
          Returns the plugin's resource bundle,
static void logError(java.lang.Throwable exc)
          Logs an error described by a throwable.
 void start(org.osgi.framework.BundleContext context)
          This method is called upon plug-in activation
 void stop(org.osgi.framework.BundleContext context)
          This method is called when the plug-in is stopped
 
Methods inherited from class org.eclipse.ui.plugin.AbstractUIPlugin
getDialogSettings, getImageRegistry, getPreferenceStore, getWorkbench, imageDescriptorFromPlugin, shutdown, startup
 
Methods inherited from class org.eclipse.core.runtime.Plugin
find, find, getBundle, getDescriptor, getLog, getPluginPreferences, getStateLocation, internalInitializeDefaultPluginPreferences, isDebugging, openStream, openStream, savePluginPreferences, setDebugging, toString
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Field Detail

PLUGIN_ID

public static final java.lang.String PLUGIN_ID
See Also:
Constant Field Values
Constructor Detail

UiPlugin

public UiPlugin()
The constructor.

Method Detail

start

public void start(org.osgi.framework.BundleContext context)
           throws java.lang.Exception
This method is called upon plug-in activation

Specified by:
start in interface org.osgi.framework.BundleActivator
Overrides:
start in class org.eclipse.ui.plugin.AbstractUIPlugin
Throws:
java.lang.Exception

getResourceBundle

public java.util.ResourceBundle getResourceBundle()
Returns the plugin's resource bundle,


stop

public void stop(org.osgi.framework.BundleContext context)
          throws java.lang.Exception
This method is called when the plug-in is stopped

Specified by:
stop in interface org.osgi.framework.BundleActivator
Overrides:
stop in class org.eclipse.ui.plugin.AbstractUIPlugin
Throws:
java.lang.Exception

getDefault

public static UiPlugin getDefault()
Returns the shared instance.


getImageDescriptor

public static org.eclipse.jface.resource.ImageDescriptor getImageDescriptor(java.lang.String path)
Returns an image descriptor for the image file at the given plug-in relative path.

Parameters:
path - the path
Returns:
the image descriptor

logError

public static void logError(java.lang.Throwable exc)
Logs an error described by a throwable.

This method should be used whenever a class in this plugin has to log an error since it adheres to the global logging strategy.

Parameters:
throwable -

getID

public static java.lang.String getID()
Returns this plugin's id.

Returns:
String

TPTP 4.7.0 Tracing and Profiling Tools Project
Public API Specification