ptolemy.backtrack.eclipse.plugin

Class EclipsePlugin

java.lang.Object

org.eclipse.core.runtime.Plugin

org.eclipse.ui.plugin.AbstractUIPlugin

ptolemy.backtrack.eclipse.plugin.EclipsePlugin

All Implemented Interfaces:

org.osgi.framework.BundleActivator

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

Main class for the Eclipse plugin. This class initializes the Eclipse plugin.

Since:

Ptolemy II 5.1

Version:

$Id: EclipsePlugin.java 65763 2013-03-07 01:54:37Z cxh $

Author:

Thomas Feng

Accepted Rating:

Red (tfeng)

Proposed Rating:

Red (tfeng)

Field Summary

Fields inherited from class org.eclipse.core.runtime.Plugin

PLUGIN_PREFERENCE_SCOPE, PREFERENCES_DEFAULT_OVERRIDE_BASE_NAME, PREFERENCES_DEFAULT_OVERRIDE_FILE_NAME

Constructor Summary

Constructors

Constructor and Description
EclipsePlugin() Construct a plugin object.

Method Summary

Modifier and Type	Method and Description
ptolemy.backtrack.eclipse.plugin.console.OutputConsole	getConsole() Return the console for this plugin.
static EclipsePlugin	getDefault() Return the only instance of this plugin.
static org.eclipse.jface.resource.ImageDescriptor	getImageDescriptor(java.lang.String path) Return an image descriptor for the image file at the given plugin relative path.
java.util.ResourceBundle	getResourceBundle() Return the plugin's resource bundle.
static java.lang.String	getResourceString(java.lang.String key) Return the string from the plugin's resource bundle, or the key itself if not found.
static org.eclipse.swt.widgets.Display	getStandardDisplay() Return the current Eclipse process's standard display.
void	start(org.osgi.framework.BundleContext context) Start the plugin.
void	stop(org.osgi.framework.BundleContext context) Stop the plugin.

Methods inherited from class org.eclipse.ui.plugin.AbstractUIPlugin

createImageRegistry, getDialogSettings, getImageRegistry, getPreferenceStore, getWorkbench, imageDescriptorFromPlugin, initializeDefaultPluginPreferences, initializeDefaultPreferences, initializeImageRegistry, loadDialogSettings, loadPreferenceStore, refreshPluginActions, saveDialogSettings, savePreferenceStore, 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

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

EclipsePlugin

public EclipsePlugin()

Construct a plugin object. Within one Eclipse process, there should be only one such plugin object

Method Detail

getConsole

public ptolemy.backtrack.eclipse.plugin.console.OutputConsole getConsole()

Return the console for this plugin.

Returns:

The console.

getDefault

public static EclipsePlugin getDefault()

Return the only instance of this plugin.

Returns:

The instance of this plugin created in the current Eclipse process.

getImageDescriptor

public static org.eclipse.jface.resource.ImageDescriptor getImageDescriptor(java.lang.String path)

Return an image descriptor for the image file at the given plugin relative path.

Parameters:

path - The path to the image descriptor.

Returns:

The image descriptor

getResourceBundle

public java.util.ResourceBundle getResourceBundle()

Return the plugin's resource bundle.

Returns:

The resource bundle for this plugin, or null if none.

getResourceString

public static java.lang.String getResourceString(java.lang.String key)

Return the string from the plugin's resource bundle, or the key itself if not found.

Parameters:

key - The key of the resource string.

Returns:

The resource string, or the key itself.

getStandardDisplay

public static org.eclipse.swt.widgets.Display getStandardDisplay()

Return the current Eclipse process's standard display. This standard display can be used to synchronize user interface operations.

Returns:

The standard display.

start

public void start(org.osgi.framework.BundleContext context)
           throws java.lang.Exception

Start the plugin. This method is called upon plugin activation.

Specified by:

start in interface org.osgi.framework.BundleActivator

Overrides:

start in class org.eclipse.ui.plugin.AbstractUIPlugin

Parameters:

context - The context where this plugin is started.

Throws:

java.lang.Exception - If the start method of the superclass throws an Exception.

stop

public void stop(org.osgi.framework.BundleContext context)
          throws java.lang.Exception

Stop the plugin. This method is called when the plugin is stopped. After the plugin is stopped, it cannot be started again, unless a new instance of plugin is created.

Specified by:

stop in interface org.osgi.framework.BundleActivator

Overrides:

stop in class org.eclipse.ui.plugin.AbstractUIPlugin

Parameters:

context - The context where this plugin has been started.

Throws:

java.lang.Exception - If the stop method of the superclass throws an Exception.