org.eclipse.gmt.weaver.plugin
Class WeaverPlugin

java.lang.Object
  org.eclipse.core.runtime.Plugin
      org.eclipse.ui.plugin.AbstractUIPlugin
          org.eclipse.gmt.weaver.plugin.WeaverPlugin

All Implemented Interfaces:

org.osgi.framework.BundleActivator

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

The main plugin class to be used in the desktop.

Since:

1.0

Field Summary

java.util.Map

images

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

PLUGIN_PREFERENCE_SCOPE, PREFERENCES_DEFAULT_OVERRIDE_BASE_NAME, PREFERENCES_DEFAULT_OVERRIDE_FILE_NAME

Constructor Summary

WeaverPlugin()
Returns the singleton instance of the Eclipse plugin

Method Summary

protected java.lang.Object	doGetImage(java.lang.String key) Does the work of fetching the image associated with the key.
static WeaverPlugin	getDefault() Returns the shared instance.
org.eclipse.swt.graphics.Image	getImage(java.lang.String key) This get a .gif from the image registry, which caches the icons folder.
org.eclipse.jface.resource.ImageDescriptor	getImageDescriptor(java.lang.String key) This gets a .gif from the icons folder.
java.lang.Object	getImageObj(java.lang.String key)
static WeaverPlugin	getPlugin() Get the singleton instance.
java.util.ResourceBundle	getResourceBundle() Returns the plugin's resource bundle,
static java.lang.String	getResourceString(java.lang.String key) Returns the string from the plugin's resource bundle, or 'key' if not found.
java.lang.String	getString(java.lang.String key)
java.lang.String	getString(java.lang.String key, java.lang.Object s1)
java.lang.String	getString(java.lang.String key, java.lang.Object[] array)
java.lang.String	getString(java.lang.String key, java.lang.Object s1, java.lang.Object s2)
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

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

Field Detail

images

public java.util.Map images

Constructor Detail

WeaverPlugin

public WeaverPlugin()

Returns the singleton instance of the Eclipse plugin.

Method Detail

getPlugin

public static WeaverPlugin getPlugin()

Get the singleton instance.

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

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 WeaverPlugin getDefault()

Returns the shared instance.

getResourceString

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

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

getResourceBundle

public java.util.ResourceBundle getResourceBundle()

Returns the plugin's resource bundle,

getString

public java.lang.String getString(java.lang.String key)

getString

public java.lang.String getString(java.lang.String key,
                                  java.lang.Object s1)

getString

public java.lang.String getString(java.lang.String key,
                                  java.lang.Object s1,
                                  java.lang.Object s2)

getString

public java.lang.String getString(java.lang.String key,
                                  java.lang.Object[] array)

getImageDescriptor

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

This gets a .gif from the icons folder.

getImage

public org.eclipse.swt.graphics.Image getImage(java.lang.String key)

This get a .gif from the image registry, which caches the icons folder.

getImageObj

public java.lang.Object getImageObj(java.lang.String key)

doGetImage

protected java.lang.Object doGetImage(java.lang.String key)
                               throws java.io.IOException

Does the work of fetching the image associated with the key. It ensures that the image exists.

Parameters:

key - the key of the image to fetch.

Returns:

the description of the image associated with the key.

Throws:

java.io.IOException - if an image doesn't exist.