net.refractions.udig.printing.model
Class PrintingModelPlugin

java.lang.Object
  extended by Plugin
      extended by net.refractions.udig.printing.model.PrintingModelPlugin

public class PrintingModelPlugin
extends Plugin

The main plugin class to be used in the desktop.


Field Summary
static java.lang.String BOX_PRINTER_EXTENSION_ID
           
static java.lang.String ID
          Plugin ID
 
Constructor Summary
PrintingModelPlugin()
          The constructor.
 
Method Summary
static PrintingModelPlugin getDefault()
          Returns the shared instance.
 java.util.ResourceBundle getResourceBundle()
          Returns the plugin's resource bundle
static java.lang.String getResourceString(java.lang.String key)
           
static boolean isDebugging(java.lang.String trace)
          Performs the Platform.getDebugOption true check on the provided trace
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
static void trace(java.lang.String message)
           
static void trace(java.lang.String message, java.lang.Throwable e)
          Messages that only engage if getDefault().isDebugging()
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

BOX_PRINTER_EXTENSION_ID

public static final java.lang.String BOX_PRINTER_EXTENSION_ID
See Also:
Constant Field Values

ID

public static final java.lang.String ID
Plugin ID

See Also:
Constant Field Values
Constructor Detail

PrintingModelPlugin

public PrintingModelPlugin()
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 PrintingModelPlugin getDefault()
Returns the shared instance.

Returns:
the PrintingModelPlugin instance

getResourceString

public static java.lang.String getResourceString(java.lang.String key)
Parameters:
key - string used to look up the resource
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

Returns:
Returns the plugin's resource bundle

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:

Parameters:
message -
t -

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 -

trace

public static void trace(java.lang.String message)

isDebugging

public static boolean isDebugging(java.lang.String trace)
Performs the Platform.getDebugOption true check on the provided trace

Note: ProjectUIPlugin.getDefault().isDebugging() must also be on.

Parameters:
trace - currently only RENDER is defined
Returns:
true if -debug is on for this plugin