net.refractions.udig.style.sld
Class SLDPlugin

java.lang.Object
  extended by AbstractUIPlugin
      extended by net.refractions.udig.style.sld.SLDPlugin

public class SLDPlugin
extends AbstractUIPlugin

The main plugin class to be used in the desktop.


Field Summary
static java.lang.String ICONS_PATH
          Icons path (value "icons/")
static java.lang.String ID
          The id of the plug-in
 
Constructor Summary
SLDPlugin()
          The constructor.
 
Method Summary
static SLDPlugin getDefault()
          Returns the shared instance.
 Images getImages()
          Images instance for use with ImageConstants.
 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.
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 e)
          Writes an info log 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, 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

ID

public static final java.lang.String ID
The id of the plug-in

See Also:
Constant Field Values

ICONS_PATH

public static final java.lang.String ICONS_PATH
Icons path (value "icons/")

See Also:
Constant Field Values
Constructor Detail

SLDPlugin

public SLDPlugin()
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 SLDPlugin 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,


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.


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" );
 }


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.

  • Trace.RENDER - trace rendering progress

Parameters:
trace - currently only RENDER is defined

getImages

public Images getImages()
Images instance for use with ImageConstants.

Returns:
Images for use with ImageConstants.