net.refractions.udig.legend
Class LegendPlugin

java.lang.Object
  AbstractUIPlugin
      net.refractions.udig.legend.LegendPlugin

public class LegendPlugin
extends AbstractUIPlugin

The main plugin class to be used in the desktop.

Field Summary

static java.lang.String

ID

Constructor Summary

LegendPlugin()
The constructor.

Method Summary

static LegendPlugin	getDefault() Returns the shared instance.
static ImageDescriptor	getImageDescriptor(java.lang.String path) Returns an image descriptor for the image file at the given plug-in relative path.
static void	log(java.lang.String message, java.lang.Throwable t) Logs the Throwable in the plugin's log.
void	start(BundleContext context) This method is called upon plug-in activation
void	stop(BundleContext context) This method is called when the plug-in is stopped

Methods inherited from class java.lang.Object

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

Field Detail

ID

public static final java.lang.String ID

See Also:

Constant Field Values

Constructor Detail

LegendPlugin

public LegendPlugin()

The constructor.

Method Detail

start

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

This method is called upon plug-in activation

Throws:

java.lang.Exception

stop

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

This method is called when the plug-in is stopped

Throws:

java.lang.Exception

getDefault

public static LegendPlugin getDefault()

Returns the shared instance.

getImageDescriptor

public static 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 t)

Logs the Throwable in the plugin's log.

This will be a user visable ERROR iff:

• t is an Exception we are assuming it is human readable or if a message is provided

Parameters:

message -

t -