za.co.bluesphere.sens.ui
Class UiPlugin

java.lang.Object
  org.eclipse.core.runtime.Plugin
      org.eclipse.ui.plugin.AbstractUIPlugin
          za.co.bluesphere.sens.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

ICONS_PATH Icons path (value "icons/")

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

org.eclipse.jface.resource.ImageDescriptor	create(java.lang.String id) Creates an image descriptor for later use.
static UiPlugin	getDefault() Returns the shared instance.
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.
Images	getImages() Images instance for use with ImageConstants.
SENSMenuBuilder	getMenuFactory() Get the MenuFactory which will create the menus for this plugin
static void	log(java.lang.String message, java.lang.Throwable e) Writes an info log in the plugin's log.
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
static void	trace(java.lang.String message, java.lang.Throwable e) Messages that only engage if getDefault().isDebugging()

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

ICONS_PATH

public static final java.lang.String ICONS_PATH

Icons path (value "icons/")

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

Parameters:

context -

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

Parameters:

context -

Throws:

java.lang.Exception

getDefault

public static UiPlugin getDefault()

Returns the shared instance.

Returns:

UiPlugin

getImages

public Images getImages()

Images instance for use with ImageConstants.

Returns:

Images for use with ImageConstants.

create

public org.eclipse.jface.resource.ImageDescriptor create(java.lang.String id)

Creates an image descriptor for later use.

Parameters:

id -

Returns:

ImageDescriptor

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

log

public static void log(java.lang.String message,
                       java.lang.Throwable e)

Writes an info log in the plugin's log.

This should be used for user level messages.

Parameters:

message -

e -

trace

public static void trace(java.lang.String message,
                         java.lang.Throwable e)

Messages that only engage if getDefault().isDebugging()

It is much prefered to do this:

 private static final String RENDERING = "net.refractions.udig.project/render/trace";
 if (ProjectUIPlugin.getDefault().isDebugging() && "true".equalsIgnoreCase(RENDERING)) {
     System.out.println("your message here");
 }


Parameters:
message - 
e - 

getMenuFactory

public SENSMenuBuilder getMenuFactory()

Get the MenuFactory which will create the menus for this plugin

Returns:

The MenuFactory singleton