Follow Techotopia on Twitter

On-line Guides
All Guides
eBook Store
iOS / Android
Linux for Beginners
Office Productivity
Linux Installation
Linux Security
Linux Utilities
Linux Virtualization
Linux Kernel
System/Network Admin
Programming
Scripting Languages
Development Tools
Web Development
GUI Toolkits/Desktop
Databases
Mail Systems
openSolaris
Eclipse Documentation
Techotopia.com
Virtuatopia.com

How To Guides
Virtualization
General System Admin
Linux Security
Linux Filesystems
Web Servers
Graphics & Desktop
PC Hardware
Windows
Problem Solutions
Privacy Policy

  




 

 

RSE
Release 3.0

org.eclipse.rse.ui
Class RSEUIPlugin

java.lang.Object
  extended by 

org.eclipse.core.runtime.Plugin
      extended by 

org.eclipse.ui.plugin.AbstractUIPlugin
          extended by 

org.eclipse.rse.ui.SystemBasePlugin
              extended by 
org.eclipse.rse.ui.RSEUIPlugin
All Implemented Interfaces:
BundleActivator

public class RSEUIPlugin
extends SystemBasePlugin

Plugin for the core remote systems support.


Field Summary
static  String HELPPREFIX
           
static boolean INCLUDE_LOCAL_NO
           
static boolean INCLUDE_LOCAL_YES
           
static  String PLUGIN_ID
           
 
Fields inherited from class org.eclipse.rse.ui. 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
RSEUIPlugin ()
          Constructor for SystemsPlugin
 
Method Summary
 void closeViews ()
          Close or reset views prior to full refresh after team synch
protected  void disconnectAll (boolean doSave)
          Disconnect all subsystems
static  RSEUIPlugin getDefault ()
          Return singleton.
  SystemMessageFile getDefaultMessageFile ( String messageFileName)
          Load a default message file for this plugin for cases where messages haven't been translated.
 boolean getLoggingSystemMessageLine ()
           
  SystemMessage getMessage ( String msgId)
           
  SystemMessageFile getMessageFile ( String messageFileName)
          Load a message file for this plugin.
  URL getMessageFileDTD ()
           
  IRSEPersistenceManager getPersistenceManager ()
          Deprecated. use RSECorePlugin.getThePersistenceManager()
static  SystemMessage getPluginMessage ( String msgId)
          Retrieve a message from this plugin's message file
static  SystemMessage getPluginMessage ( String msgId, Object subsVar)
          Retrieve a message from this plugin's message file and do single substitution on it.
static  SystemMessage getPluginMessage ( String msgId, Object[] subsVars)
          Retrieve a message from this plugin's message file and do multiple substitution on it.
static  SystemMessageFile getPluginMessageFile ()
          Return this plugin's message file.
  IAdapterFactory getSystemViewAdapterFactory ()
          For fastpath access to our adapters for non-local objects in our model.
static  ISystemProfileManager getTheSystemProfileManager ()
          Deprecated. use RSECorePlugin.getTheSystemProfileManager()
static  ISystemRegistryUI getTheSystemRegistryUI ()
          Return the SystemRegistryUI singleton.
 void initializeDefaultPreferences ()
          Initializes preferences.
protected  void initializeImageRegistry ()
          Initialize the image registry by declaring all of the required graphics.
 boolean isSystemRegistryActive ()
          Deprecated. use RSECorePlugin.isTheSystemRegistryActive()
static boolean isTheSystemRegistryActive ()
          Deprecated. use RSECorePlugin.isTheSystemRegistryActive()
 void openViews ()
          Restore views prior to full refresh after team synch
 void registerViewSupplier ( ISystemViewSupplier vs)
          Register a view supplier so we can ask them to participate in team synchs
 void restart ()
          Restart the whole thing after a team synchronization
 void setLoggingSystemMessageLine (boolean flag)
          Set whether or not to log the messages shown on the system message line for dialogs and wizards.
 void start ( BundleContext context)
           
 void stop ( BundleContext context)
           
 void unRegisterViewSupplier ( ISystemViewSupplier vs)
          UnRegister a previously registered view supplier
 
Methods inherited from class org.eclipse.rse.ui. 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

PLUGIN_ID

public static final 
String PLUGIN_ID
See Also:
Constant Field Values

HELPPREFIX

public static final 
String HELPPREFIX
See Also:
Constant Field Values

INCLUDE_LOCAL_YES

public static final boolean INCLUDE_LOCAL_YES
See Also:
Constant Field Values

INCLUDE_LOCAL_NO

public static final boolean INCLUDE_LOCAL_NO
See Also:
Constant Field Values
Constructor Detail

RSEUIPlugin

public RSEUIPlugin()
Constructor for SystemsPlugin

Method Detail

getDefault

public static 
RSEUIPlugin getDefault()
Return singleton. Same as inherited getBaseDefault but returned object is typed as RSEUIPlugin versus SystemBasePlugin.


initializeDefaultPreferences

public void initializeDefaultPreferences()
Initializes preferences.


setLoggingSystemMessageLine

public void setLoggingSystemMessageLine(boolean flag)
Set whether or not to log the messages shown on the system message line for dialogs and wizards. These message are typically validation messages for fields. These are logged using the RSE logging settings. The default is to not log these messages.

Parameters:
flag - true if logging of these messages is desired, false otherwise.

getLoggingSystemMessageLine

public boolean getLoggingSystemMessageLine()
Returns:
true if we are logging messages displayed on the system message line.

initializeImageRegistry

protected void initializeImageRegistry()
Description copied from class: SystemBasePlugin
Initialize the image registry by declaring all of the required graphics. Typically this is a series of calls to putImageInRegistry. Use getIconPath() to qualify the file name of the icons with their relative path.

Specified by:
initializeImageRegistry in class SystemBasePlugin

start

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

getSystemViewAdapterFactory

public 
IAdapterFactory getSystemViewAdapterFactory()
For fastpath access to our adapters for non-local objects in our model. Exploits the knowledge we use singleton adapters.

Since:
3.0 returning IAdapterFactory rather than SystemViewAdapterFactory

restart

public void restart()
Restart the whole thing after a team synchronization


closeViews

public void closeViews()
Close or reset views prior to full refresh after team synch


openViews

public void openViews()
Restore views prior to full refresh after team synch


stop

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

disconnectAll

protected void disconnectAll(boolean doSave)
Disconnect all subsystems


isSystemRegistryActive

public boolean isSystemRegistryActive()
Deprecated. use RSECorePlugin.isTheSystemRegistryActive()

Test if the SystemRegistry has been instantiated already. Use this when you don't want to start the system registry as a side effect of retrieving it.

Returns:
true if the System Registry has been instantiated already.

getPersistenceManager

public 
IRSEPersistenceManager getPersistenceManager()
Deprecated. use RSECorePlugin.getThePersistenceManager()

Return the persistence manager used for persisting RSE profiles.

Returns:
the persistence manager used for persisting RSE profiles

getTheSystemRegistryUI

public static 
ISystemRegistryUI getTheSystemRegistryUI()
Return the SystemRegistryUI singleton.

Returns:
the SystemRegistryUI singleton.

getTheSystemProfileManager

public static 
ISystemProfileManager getTheSystemProfileManager()
Deprecated. use RSECorePlugin.getTheSystemProfileManager()

Return the master profile manager singleton.

Returns:
the RSE Profile Manager Singleton.

isTheSystemRegistryActive

public static boolean isTheSystemRegistryActive()
Deprecated. use RSECorePlugin.isTheSystemRegistryActive()

Check if the SystemRegistry has been instantiated already. Use this when you don't want to start the system registry as a side effect of retrieving it.

Returns:
true if the System Registry has been instantiated already.

getMessageFileDTD

public 
URL getMessageFileDTD()
Returns:
The URL to the message file DTD. Null if it is not found.

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.

getPluginMessageFile

public static 
SystemMessageFile getPluginMessageFile()
Return this plugin's message file. Assumes it has already been loaded via a call to getMessageFile.


getMessage

public 
SystemMessage getMessage(
String msgId)

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.

getPluginMessage

public static 
SystemMessage getPluginMessage(
String msgId,
                                             
Object[] subsVars)
Retrieve a message from this plugin's message file and do multiple substitution on it.

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.
subsVars - - an array of objects to substitute in for %1, %2, etc

getPluginMessage

public static 
SystemMessage getPluginMessage(
String msgId,
                                             
Object subsVar)
Retrieve a message from this plugin's message file and do single substitution on it.

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.
subsVar - - an array of objects to substitute in for %1, %2, etc.
Returns:
the message.

registerViewSupplier

public void registerViewSupplier(
ISystemViewSupplier vs)
Register a view supplier so we can ask them to participate in team synchs


unRegisterViewSupplier

public void unRegisterViewSupplier(
ISystemViewSupplier vs)
UnRegister a previously registered view supplier


RSE
Release 3.0

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

 
 
  Published under the terms of the Eclipse Public License Version 1.0 ("EPL") Design by Interspire