RSE
Release 1.0

org.eclipse.rse.processes.ui
Class ProcessesPlugin

java.lang.Object
  extended byorg.eclipse.core.runtime.Plugin
      extended byorg.eclipse.ui.plugin.AbstractUIPlugin
          extended byorg.eclipse.rse.core.SystemBasePlugin
              extended byorg.eclipse.rse.processes.ui.ProcessesPlugin
All Implemented Interfaces:
BundleActivator

public class ProcessesPlugin
extends SystemBasePlugin

The main plugin class to be used in the desktop.


Field Summary
static String HELPPREFIX
           
 
Fields inherited from class org.eclipse.rse.core.SystemBasePlugin
log
 
Fields inherited from class org.eclipse.core.runtime.Plugin
PLUGIN_PREFERENCE_SCOPE, PREFERENCES_DEFAULT_OVERRIDE_BASE_NAME, PREFERENCES_DEFAULT_OVERRIDE_FILE_NAME
 
Constructor Summary
ProcessesPlugin()
          The constructor.
 
Method Summary
static ProcessesPlugin getDefault()
          Returns the shared instance.
 SystemMessageFile getDefaultMessageFile(String messageFileName)
          Load a default message file for this plugin for cases where messages haven't been translated.
 ImageDescriptor getImageDescriptorFromPath(String path)
           
 SystemMessageFile getMessageFile(String messageFileName)
          Load a message file for this plugin.
static SystemMessage getPluginMessage(String msgId)
          Retrieve a message from this plugin's message file
 ResourceBundle getResourceBundle()
          Returns the plugin's resource bundle,
static String getResourceString(String key)
          Returns the string from the plugin's resource bundle, or 'key' if not found.
protected  void initializeImageRegistry()
          Initialize the image registry by declaring all of the required graphics.
 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 org.eclipse.rse.core.SystemBasePlugin
getActiveWorkbenchShell, getActiveWorkbenchWindow, getBaseDefault, getIconPath, getImage, getImageDescriptor, getImageDescriptorFromIDE, getLogger, getMessage, getPluginImage, getPluginImage, getSymbolicName, getWorkbench, getWorkspace, getWorkspaceRoot, isHeadless, loadDefaultMessageFile, loadMessageFile, logDebugMessage, logError, logError, logInfo, logMessage, logMessage, logWarning, printMessages, putImageInRegistry, resolveBundleNameNL, scanForDuplicateMessages
 
Methods inherited from class org.eclipse.ui.plugin.AbstractUIPlugin
createImageRegistry, getDialogSettings, getImageRegistry, getPreferenceStore, 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

HELPPREFIX

public static final String HELPPREFIX
See Also:
Constant Field Values
Constructor Detail

ProcessesPlugin

public ProcessesPlugin()
The constructor.

Method Detail

start

public void start(BundleContext context)
           throws Exception
This method is called upon plug-in activation

Specified by:
start in interface BundleActivator
Overrides:
start in class SystemBasePlugin
Throws:
Exception
See Also:
BundleActivator.start(org.osgi.framework.BundleContext)

stop

public void stop(BundleContext context)
          throws Exception
This method is called when the plug-in is stopped

Specified by:
stop in interface BundleActivator
Overrides:
stop in class SystemBasePlugin
Throws:
Exception
See Also:
BundleActivator.stop(org.osgi.framework.BundleContext)

getDefault

public static ProcessesPlugin getDefault()
Returns the shared instance.


getResourceString

public static String getResourceString(String key)
Returns the string from the plugin's resource bundle, or 'key' if not found.


getResourceBundle

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


getPluginMessage

public static SystemMessage getPluginMessage(String msgId)
Retrieve a message from this plugin's message file

Parameters:
msgId - - the ID of the message to retrieve. This is the concatenation of the message's component abbreviation, subcomponent abbreviation, and message ID as declared in the message xml file.

getMessageFile

public SystemMessageFile getMessageFile(String messageFileName)
Load a message file for this plugin.

Parameters:
messageFileName - - the name of the message xml file. Will look for it in this plugin's install folder.
Returns:
a message file object containing the parsed contents of the message file, or null if not found.

getDefaultMessageFile

public SystemMessageFile getDefaultMessageFile(String messageFileName)
Load a default message file for this plugin for cases where messages haven't been translated.

Parameters:
messageFileName - - the name of the message xml file. Will look for it in this plugin's install folder.
Returns:
a message file object containing the parsed contents of the message file, or null if not found.

getImageDescriptorFromPath

public ImageDescriptor getImageDescriptorFromPath(String path)

initializeImageRegistry

protected void initializeImageRegistry()
Initialize the image registry by declaring all of the required graphics.

Specified by:
initializeImageRegistry in class SystemBasePlugin

RSE
Release 1.0

Copyright (c) IBM Corporation and others 2000, 2006. All Rights Reserved.