com.ibm.carma.ui
Class CarmaUIPlugin

java.lang.Object
  extended by org.eclipse.core.runtime.Plugin
      extended by org.eclipse.ui.plugin.AbstractUIPlugin
          extended by com.ibm.carma.ui.CarmaUIPlugin
All Implemented Interfaces:
ICarmaPreferenceConstants, org.osgi.framework.BundleActivator

public class CarmaUIPlugin
extends org.eclipse.ui.plugin.AbstractUIPlugin
implements ICarmaPreferenceConstants

The main plugin class to be used in the desktop.

Note: This class is intended to be used internal to the plugin and is subject to change


Nested Class Summary
 
Nested classes/interfaces inherited from interface com.ibm.carma.ui.property.ICarmaPreferenceConstants
ICarmaPreferenceConstants.ParameterOrder
 
Field Summary
static org.eclipse.core.runtime.QualifiedName CARMA_ID
          Deprecated. migrated to mapping framework to PropertyReference
static java.lang.String COPYRIGHT
           
static java.lang.String EXTENSION_POINT_CLASS
           
static java.lang.String EXTENSION_POINT_ICON
           
static java.lang.String EXTENSION_POINT_ID
           
static java.lang.String EXTENSION_POINT_NAME
           
static java.lang.String PLUGIN_ID
          Plugin identifier
static org.eclipse.core.runtime.QualifiedName REMOTE_RESOURCE_ID
          Deprecated. migrated to mapping framework to PropertyReference
static org.eclipse.core.runtime.QualifiedName REMOTE_RESOURCE_TYPE
          Deprecated. migrated to mapping framework to PropertyReference
static org.eclipse.core.runtime.QualifiedName REPOSITORY_INSTANCE_ID
          Deprecated. migrated to mapping framework to PropertyReference
static org.eclipse.core.runtime.QualifiedName REPOSITORY_MANAGER_TYPE
          Deprecated. migrated to mapping framework to PropertyReference
static java.lang.String TEAM_ID
          Identifier of the team provider for CARMA associated projects
 
Fields inherited from class org.eclipse.core.runtime.Plugin
PLUGIN_PREFERENCE_SCOPE, PREFERENCES_DEFAULT_OVERRIDE_BASE_NAME, PREFERENCES_DEFAULT_OVERRIDE_FILE_NAME
 
Fields inherited from interface com.ibm.carma.ui.property.ICarmaPreferenceConstants
PREF_ACTION_UNSUPPORTED, PREF_DELETE_CONFIRM, PREF_EDIT_UPLOAD_CHECK, PREF_META_DISPLAY, PREF_META_RETRIEVE, PREF_PARAM_ORDER, PREF_PARAM_ORDER_DEFAULT_ID, PREF_PARAM_ORDER_LABELS, PREF_PARAM_ORDER_METADATA_ID, PREF_PARAM_ORDER_USER_ID, PREF_PARAM_PROMPT, PREF_REMOTE_COPY, PREF_REMOTE_COPY_CONFIRM, PREF_REMOTE_DELETE, PREF_REMOTE_DELETE_CONFIRM, PREF_REMOTE_MOVE, PREF_REMOTE_MOVE_CONFIRM
 
Constructor Summary
CarmaUIPlugin()
          Should not be called by clients.
 
Method Summary
 java.util.Hashtable getBidiDataHandler()
           
static CarmaUIPlugin getDefault()
          Returns the shared instance of CarmaUIPlugin.
 org.eclipse.jface.preference.IPreferenceStore getPreferenceStore()
           
 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 java.lang.String getResourceString(java.lang.String key, java.lang.Object[] args)
          Returns the string from the plugin's resource bundle formatted with the arguments or '!key!' if not found.
static boolean isDebugMode()
          Deprecated. use Plugin.isDebugging()
 void setBidiDataHandler(java.util.Hashtable table)
           
 void start(org.osgi.framework.BundleContext context)
          This method is called upon plug-in activation and loads the CarmaRegistry.
 void stop(org.osgi.framework.BundleContext context)
          This method is called when the plug-in is stopped and persists CarmaRegistry to a file
static void trace(java.lang.Object obj, java.lang.String message, java.lang.Throwable t)
          Deprecated. Use the TraceUtil.trace(Object, String, Throwable) method
 
Methods inherited from class org.eclipse.ui.plugin.AbstractUIPlugin
getDialogSettings, getImageRegistry, getWorkbench, imageDescriptorFromPlugin, 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
equals, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Field Detail

COPYRIGHT

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

TEAM_ID

public static final java.lang.String TEAM_ID
Identifier of the team provider for CARMA associated projects

See Also:
Constant Field Values

PLUGIN_ID

public static final java.lang.String PLUGIN_ID
Plugin identifier

See Also:
Constant Field Values

EXTENSION_POINT_ID

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

EXTENSION_POINT_CLASS

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

EXTENSION_POINT_NAME

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

EXTENSION_POINT_ICON

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

CARMA_ID

@Deprecated
public static final org.eclipse.core.runtime.QualifiedName CARMA_ID
Deprecated. migrated to mapping framework to PropertyReference

REPOSITORY_MANAGER_TYPE

@Deprecated
public static final org.eclipse.core.runtime.QualifiedName REPOSITORY_MANAGER_TYPE
Deprecated. migrated to mapping framework to PropertyReference

REMOTE_RESOURCE_TYPE

@Deprecated
public static final org.eclipse.core.runtime.QualifiedName REMOTE_RESOURCE_TYPE
Deprecated. migrated to mapping framework to PropertyReference

REPOSITORY_INSTANCE_ID

@Deprecated
public static final org.eclipse.core.runtime.QualifiedName REPOSITORY_INSTANCE_ID
Deprecated. migrated to mapping framework to PropertyReference

REMOTE_RESOURCE_ID

@Deprecated
public static final org.eclipse.core.runtime.QualifiedName REMOTE_RESOURCE_ID
Deprecated. migrated to mapping framework to PropertyReference
Constructor Detail

CarmaUIPlugin

public CarmaUIPlugin()
Should not be called by clients. Clients should instead call CarmaUIPlugin.getDefault()

Method Detail

start

public void start(org.osgi.framework.BundleContext context)
           throws java.lang.Exception
This method is called upon plug-in activation and loads the CarmaRegistry.

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 and persists CarmaRegistry to a file

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


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.


getResourceString

public static java.lang.String getResourceString(java.lang.String key,
                                                 java.lang.Object[] args)
Returns the string from the plugin's resource bundle formatted with the arguments or '!key!' if not found.


getResourceBundle

public java.util.ResourceBundle getResourceBundle()
Returns the plugin's resource bundle,


isDebugMode

@Deprecated
public static boolean isDebugMode()
Deprecated. use Plugin.isDebugging()

Determines if the plugin is in "debug" (tracing) mode or not

Returns:
true if the plugin is tracing, false otherwise

trace

@Deprecated
public static void trace(java.lang.Object obj,
                                    java.lang.String message,
                                    java.lang.Throwable t)
Deprecated. Use the TraceUtil.trace(Object, String, Throwable) method

Prints the given message to the trace file

Parameters:
obj - the object the trace message comes from
message - the message to print out
t - the throwable that should be included in the trace file

getPreferenceStore

public org.eclipse.jface.preference.IPreferenceStore getPreferenceStore()
Overrides:
getPreferenceStore in class org.eclipse.ui.plugin.AbstractUIPlugin

setBidiDataHandler

public void setBidiDataHandler(java.util.Hashtable table)

getBidiDataHandler

public java.util.Hashtable getBidiDataHandler()