Java Doc for WorkbenchPlugin.java in  » IDE-Eclipse » ui-workbench » org » eclipse » ui » internal » Java Source Code / Java DocumentationJava Source Code and Java Documentation

Java Source Code / Java Documentation
1. 6.0 JDK Core
2. 6.0 JDK Modules
3. 6.0 JDK Modules com.sun
4. 6.0 JDK Modules com.sun.java
5. 6.0 JDK Modules sun
6. 6.0 JDK Platform
7. Ajax
8. Apache Harmony Java SE
9. Aspect oriented
10. Authentication Authorization
11. Blogger System
12. Build
13. Byte Code
14. Cache
15. Chart
16. Chat
17. Code Analyzer
18. Collaboration
19. Content Management System
20. Database Client
21. Database DBMS
22. Database JDBC Connection Pool
23. Database ORM
24. Development
25. EJB Server geronimo
26. EJB Server GlassFish
27. EJB Server JBoss 4.2.1
28. EJB Server resin 3.1.5
29. ERP CRM Financial
30. ESB
31. Forum
32. GIS
33. Graphic Library
34. Groupware
35. HTML Parser
36. IDE
37. IDE Eclipse
38. IDE Netbeans
39. Installer
40. Internationalization Localization
41. Inversion of Control
42. Issue Tracking
43. J2EE
44. JBoss
45. JMS
46. JMX
47. Library
48. Mail Clients
49. Net
50. Parser
51. PDF
52. Portal
53. Profiler
54. Project Management
55. Report
56. RSS RDF
57. Rule Engine
58. Science
59. Scripting
60. Search Engine
61. Security
62. Sevlet Container
63. Source Control
64. Swing Library
65. Template Engine
66. Test Coverage
67. Testing
68. UML
69. Web Crawler
70. Web Framework
71. Web Mail
72. Web Server
73. Web Services
74. Web Services apache cxf 2.0.1
75. Web Services AXIS2
76. Wiki Engine
77. Workflow Engines
78. XML
79. XML UI
Java
Java Tutorial
Java Open Source
Jar File Download
Java Articles
Java Products
Java by API
Photoshop Tutorials
Maya Tutorials
Flash Tutorials
3ds-Max Tutorials
Illustrator Tutorials
GIMP Tutorials
C# / C Sharp
C# / CSharp Tutorial
C# / CSharp Open Source
ASP.Net
ASP.NET Tutorial
JavaScript DHTML
JavaScript Tutorial
JavaScript Reference
HTML / CSS
HTML CSS Reference
C / ANSI-C
C Tutorial
C++
C++ Tutorial
Ruby
PHP
Python
Python Tutorial
Python Open Source
SQL Server / T-SQL
SQL Server / T-SQL Tutorial
Oracle PL / SQL
Oracle PL/SQL Tutorial
PostgreSQL
SQL / MySQL
MySQL Tutorial
VB.Net
VB.Net Tutorial
Flash / Flex / ActionScript
VBA / Excel / Access / Word
XML
XML Tutorial
Microsoft Office PowerPoint 2007 Tutorial
Microsoft Office Excel 2007 Tutorial
Microsoft Office Word 2007 Tutorial
Java Source Code / Java Documentation » IDE Eclipse » ui workbench » org.eclipse.ui.internal 
Source Cross Reference  Class Diagram Java Document (Java Doc) 


org.eclipse.ui.plugin.AbstractUIPlugin
   org.eclipse.ui.internal.WorkbenchPlugin

WorkbenchPlugin
public class WorkbenchPlugin extends AbstractUIPlugin (Code)
This class represents the TOP of the workbench UI world A plugin class is effectively an application wrapper for a plugin & its classes. This class should be thought of as the workbench UI's application class. This class is responsible for tracking various registries font, preference, graphics, dialog store. This class is explicitly referenced by the workbench plugin's "plugin.xml" and places it into the UI start extension point of the main overall application harness When is this class started? When the Application calls createExecutableExtension to create an executable instance of our workbench class.


Field Summary
public static  booleanDEBUG
     Global workbench ui plugin flag.
public static  StringPI_WORKBENCH
     The workbench plugin ID.
public static  charPREFERENCE_PAGE_CATEGORY_SEPARATOR
    

Constructor Summary
public  WorkbenchPlugin()
     Create an instance of the WorkbenchPlugin.

Method Summary
 voidaddBundleListener(BundleListener bundleListener)
    
public static  ObjectcreateExtension(IConfigurationElement element, String classAttribute)
     Creates an extension.
protected  ImageRegistrycreateImageRegistry()
     Returns the image registry for this plugin. Where are the images? The images (typically gifs) are found in the same plugins directory.
See Also:   ImageRegistry
See Also:   Note: The workbench uses the standard JFace ImageRegistry to track its
See Also:   images.
public  ActionSetRegistrygetActionSetRegistry()
     Returns the action set registry for the workbench.
public  StringgetAppName()
     Returns the application name.
public  BundleContextgetBundleContext()
     Returns the bundle context associated with the workbench plug-in.
 intgetBundleCount()
    
public static  BundlegetBundleForExecutableExtension(IConfigurationElement element, String extensionName)
     Returns the bundle that contains the class referenced by an executable extension.
public  Bundle[]getBundles()
     Return an array of all bundles contained in this workbench.
public  IPathgetDataLocation()
     FOR INTERNAL WORKBENCH USE ONLY.
public  DecoratorManagergetDecoratorManager()
    
public static  WorkbenchPlugingetDefault()
     Return the default instance of the receiver.
public  IEditorRegistrygetEditorRegistry()
    
public  IElementFactorygetElementFactory(String targetID)
     Answer the element factory for an id, or null
public  IWizardRegistrygetExportWizardRegistry()
     Return the export wizard registry.
public  IWizardRegistrygetImportWizardRegistry()
     Return the import wizard registry.
public  IIntroRegistrygetIntroRegistry()
     Returns the introduction registry.
public  IWizardRegistrygetNewWizardRegistry()
     Return the new wizard registry.
public  IWorkbenchOperationSupportgetOperationSupport()
     Returns the operation support.
public  IPerspectiveRegistrygetPerspectiveRegistry()
     Return the perspective registry. IPerspectiveRegistry.
public  PreferenceManagergetPreferenceManager()
     Get the preference manager.
public  AbstractPresentationFactorygetPresentationFactory(String targetID)
     Returns the presentation factory with the given id, or null if not found.
Parameters:
  targetID - The id of the presentation factory to use.
public  StringgetProductName()
     Returns the name of the product.
public  ISharedImagesgetSharedImages()
     Returns the shared images for the workbench.
 OutputStreamgetSplashStream()
    
public static  IStatusgetStatus(Throwable t)
    
public  IThemeRegistrygetThemeRegistry()
     Returns the theme registry for the workbench.
public  IViewRegistrygetViewRegistry()
     Answer the view registry.
public  ImageDescriptor[]getWindowImages()
     Returns the image descriptors for the window image to use for this product.
public  IWorkbenchgetWorkbench()
     Answer the workbench.
public  IWorkingSetManagergetWorkingSetManager()
    
public  WorkingSetRegistrygetWorkingSetRegistry()
    
public static  booleanhasExecutableExtension(IConfigurationElement element, String extensionName)
     Answers whether the provided element either has an attribute with the given name or a child element with the given name with an attribute called class.
protected  voidinitializeDefaultPreferences(IPreferenceStore store)
     Set default preference values.
public static  booleanisBundleLoadedForExecutableExtension(IConfigurationElement element, String extensionName)
     Checks to see if the provided element has the syntax for an executable extension with a given name that resides in a bundle that is already active.
public  booleanisStarting(Bundle bundle)
    
public static  voidlog(String message)
     Logs the given message to the platform log.
public static  voidlog(Throwable t)
     Log the throwable.
public static  voidlog(String message, Throwable t)
     Logs the given message and throwable to the platform log.
public static  voidlog(Class clazz, String methodName, Throwable t)
     Logs the given throwable to the platform log, indicating the class and method from where it is being logged (this is not necessarily where it occurred).
public static  voidlog(String message, IStatus status)
     Logs the given message and status to the platform log. This convenience method is for internal use by the Workbench only and must not be called outside the Workbench.
Parameters:
  message - A high level UI message describing when the problem happened.May be null.
Parameters:
  status - The status describing the problem.
public static  voidlog(IStatus status)
     Log the status to the default log.
public static  IStatusnewError(String message, Throwable t)
     Create a new error from the message and the throwable.
 voidremoveBundleListener(BundleListener bundleListener)
    
 voidreset()
     Unload all members.
public  voidstart(BundleContext context)
    
public  voidstop(BundleContext context)
    

Field Detail
DEBUG
public static boolean DEBUG(Code)
Global workbench ui plugin flag. Only workbench implementation is allowed to use this flag All other plugins, examples, or test cases must *not* use this flag.



PI_WORKBENCH
public static String PI_WORKBENCH(Code)
The workbench plugin ID.



PREFERENCE_PAGE_CATEGORY_SEPARATOR
public static char PREFERENCE_PAGE_CATEGORY_SEPARATOR(Code)
The character used to separate preference page category ids




Constructor Detail
WorkbenchPlugin
public WorkbenchPlugin()(Code)
Create an instance of the WorkbenchPlugin. The workbench plugin is effectively the "application" for the workbench UI. The entire UI operates as a good plugin citizen.




Method Detail
addBundleListener
void addBundleListener(BundleListener bundleListener)(Code)



createExtension
public static Object createExtension(IConfigurationElement element, String classAttribute) throws CoreException(Code)
Creates an extension. If the extension plugin has not been loaded a busy cursor will be activated during the duration of the load.
Parameters:
  element - the config element defining the extension
Parameters:
  classAttribute - the name of the attribute carrying the class the extension object
throws:
  CoreException - if the extension cannot be created



createImageRegistry
protected ImageRegistry createImageRegistry()(Code)
Returns the image registry for this plugin. Where are the images? The images (typically gifs) are found in the same plugins directory.
See Also:   ImageRegistry
See Also:   Note: The workbench uses the standard JFace ImageRegistry to track its
See Also:   images. In addition the class WorkbenchGraphicResources provides
See Also:   convenience access to the graphics resources and fast field access for
See Also:   some of the commonly used graphical images.



getActionSetRegistry
public ActionSetRegistry getActionSetRegistry()(Code)
Returns the action set registry for the workbench. the workbench action set registry



getAppName
public String getAppName()(Code)
Returns the application name.

Note this is never shown to the user. It is used to initialize the SWT Display. On Motif, for example, this can be used to set the name used for resource lookup.

the application name, or null
See Also:   org.eclipse.swt.widgets.Display.setAppName
since:
   3.0



getBundleContext
public BundleContext getBundleContext()(Code)
Returns the bundle context associated with the workbench plug-in. the bundle context
since:
   3.1



getBundleCount
int getBundleCount()(Code)



getBundleForExecutableExtension
public static Bundle getBundleForExecutableExtension(IConfigurationElement element, String extensionName)(Code)
Returns the bundle that contains the class referenced by an executable extension. Determining the bundle happens in one of two ways:
  • The element has an attribute with the specified name or element text in the form bundle.id/class.name[:optional attributes]
  • The element has a child element with the specified name that has a plugin attribute

Parameters:
  element - the element to test
Parameters:
  extensionName - the name of the extension to test for the bundle referenced by the extension. If that bundle cannot bedetermined the bundle that declared the element is returned. Notethat this may be null.
since:
   3.3



getBundles
public Bundle[] getBundles()(Code)
Return an array of all bundles contained in this workbench. an array of bundles in the workbench or an empty array if none
since:
   3.0



getDataLocation
public IPath getDataLocation()(Code)
FOR INTERNAL WORKBENCH USE ONLY. Returns the path to a location in the file system that can be used to persist/restore state between workbench invocations. If the location did not exist prior to this call it will be created. Returns null if no such location is available. path to a location in the file system where this plug-in canpersist data between sessions, or null if no suchlocation is available.
since:
   3.1



getDecoratorManager
public DecoratorManager getDecoratorManager()(Code)
Get the decorator manager for the receiver DecoratorManager the decorator managerfor the receiver.



getDefault
public static WorkbenchPlugin getDefault()(Code)
Return the default instance of the receiver. This represents the runtime plugin. WorkbenchPlugin
See Also:   AbstractUIPlugin
See Also:    for the typical implementation pattern for plugin classes.



getEditorRegistry
public IEditorRegistry getEditorRegistry()(Code)
Answer the manager that maps resource types to a the description of the editor to use IEditorRegistry the editor registry usedby this plug-in.



getElementFactory
public IElementFactory getElementFactory(String targetID)(Code)
Answer the element factory for an id, or nullParameters:
  targetID - IElementFactory



getExportWizardRegistry
public IWizardRegistry getExportWizardRegistry()(Code)
Return the export wizard registry. the export wizard registry
since:
   3.1



getImportWizardRegistry
public IWizardRegistry getImportWizardRegistry()(Code)
Return the import wizard registry. the import wizard registry
since:
   3.1



getIntroRegistry
public IIntroRegistry getIntroRegistry()(Code)
Returns the introduction registry. the introduction registry.
since:
   3.0



getNewWizardRegistry
public IWizardRegistry getNewWizardRegistry()(Code)
Return the new wizard registry. the new wizard registry
since:
   3.1



getOperationSupport
public IWorkbenchOperationSupport getOperationSupport()(Code)
Returns the operation support. the workbench operation support.
since:
   3.1



getPerspectiveRegistry
public IPerspectiveRegistry getPerspectiveRegistry()(Code)
Return the perspective registry. IPerspectiveRegistry. The registry for the receiver.



getPreferenceManager
public PreferenceManager getPreferenceManager()(Code)
Get the preference manager. PreferenceManager the preference manager forthe receiver.



getPresentationFactory
public AbstractPresentationFactory getPresentationFactory(String targetID)(Code)
Returns the presentation factory with the given id, or null if not found.
Parameters:
  targetID - The id of the presentation factory to use. AbstractPresentationFactory or nullif not factory matches that id.



getProductName
public String getProductName()(Code)
Returns the name of the product. the product name, or null if none
since:
   3.0



getSharedImages
public ISharedImages getSharedImages()(Code)
Returns the shared images for the workbench. the shared image manager



getSplashStream
OutputStream getSplashStream()(Code)



getStatus
public static IStatus getStatus(Throwable t)(Code)
Return the status from throwable
Parameters:
  t - throwable IStatus



getThemeRegistry
public IThemeRegistry getThemeRegistry()(Code)
Returns the theme registry for the workbench. the theme registry



getViewRegistry
public IViewRegistry getViewRegistry()(Code)
Answer the view registry. IViewRegistry the view registry for thereceiver.



getWindowImages
public ImageDescriptor[] getWindowImages()(Code)
Returns the image descriptors for the window image to use for this product. an array of the image descriptors for the window image, ornull if none
since:
   3.0



getWorkbench
public IWorkbench getWorkbench()(Code)
Answer the workbench.



getWorkingSetManager
public IWorkingSetManager getWorkingSetManager()(Code)
Returns the working set manager the working set manager
since:
   2.0



getWorkingSetRegistry
public WorkingSetRegistry getWorkingSetRegistry()(Code)
Returns the working set registry the working set registry
since:
   2.0



hasExecutableExtension
public static boolean hasExecutableExtension(IConfigurationElement element, String extensionName)(Code)
Answers whether the provided element either has an attribute with the given name or a child element with the given name with an attribute called class.
Parameters:
  element - the element to test
Parameters:
  extensionName - the name of the extension to test for whether or not the extension is declared
since:
   3.3



initializeDefaultPreferences
protected void initializeDefaultPreferences(IPreferenceStore store)(Code)
Set default preference values. This method must be called whenever the preference store is initially loaded because the default values are not stored in the preference store.



isBundleLoadedForExecutableExtension
public static boolean isBundleLoadedForExecutableExtension(IConfigurationElement element, String extensionName)(Code)
Checks to see if the provided element has the syntax for an executable extension with a given name that resides in a bundle that is already active. Determining the bundle happens in one of two ways:
  • The element has an attribute with the specified name or element text in the form bundle.id/class.name[:optional attributes]
  • The element has a child element with the specified name that has a plugin attribute

Parameters:
  element - the element to test
Parameters:
  extensionName - the name of the extension to test for whether or not the bundle expressed by the above criteria isactive. If the bundle cannot be determined then the state of thebundle that declared the element is returned.
since:
   3.3



isStarting
public boolean isStarting(Bundle bundle)(Code)



log
public static void log(String message)(Code)
Logs the given message to the platform log. If you have an exception in hand, call log(String, Throwable) instead. If you have a status object in hand call log(String, IStatus) instead. This convenience method is for internal use by the Workbench only and must not be called outside the Workbench.
Parameters:
  message - A high level UI message describing when the problem happened.



log
public static void log(Throwable t)(Code)
Log the throwable.
Parameters:
  t -



log
public static void log(String message, Throwable t)(Code)
Logs the given message and throwable to the platform log. If you have a status object in hand call log(String, IStatus) instead. This convenience method is for internal use by the Workbench only and must not be called outside the Workbench.
Parameters:
  message - A high level UI message describing when the problem happened.
Parameters:
  t - The throwable from where the problem actually occurred.



log
public static void log(Class clazz, String methodName, Throwable t)(Code)
Logs the given throwable to the platform log, indicating the class and method from where it is being logged (this is not necessarily where it occurred). This convenience method is for internal use by the Workbench only and must not be called outside the Workbench.
Parameters:
  clazz - The calling class.
Parameters:
  methodName - The calling method name.
Parameters:
  t - The throwable from where the problem actually occurred.



log
public static void log(String message, IStatus status)(Code)
Logs the given message and status to the platform log. This convenience method is for internal use by the Workbench only and must not be called outside the Workbench.
Parameters:
  message - A high level UI message describing when the problem happened.May be null.
Parameters:
  status - The status describing the problem. Must not be null.



log
public static void log(IStatus status)(Code)
Log the status to the default log.
Parameters:
  status -



newError
public static IStatus newError(String message, Throwable t)(Code)
Create a new error from the message and the throwable.
Parameters:
  message -
Parameters:
  t - IStatus



removeBundleListener
void removeBundleListener(BundleListener bundleListener)(Code)



reset
void reset()(Code)
Unload all members. This can be used to run a second instance of a workbench.
since:
   3.0



start
public void start(BundleContext context) throws Exception(Code)



stop
public void stop(BundleContext context) throws Exception(Code)



Methods inherited from org.eclipse.ui.plugin.AbstractUIPlugin
protected ImageRegistry createImageRegistry()(Code)(Java Doc)
public IDialogSettings getDialogSettings()(Code)(Java Doc)
public ImageRegistry getImageRegistry()(Code)(Java Doc)
public IPreferenceStore getPreferenceStore()(Code)(Java Doc)
public IWorkbench getWorkbench()(Code)(Java Doc)
public static ImageDescriptor imageDescriptorFromPlugin(String pluginId, String imageFilePath)(Code)(Java Doc)
protected void initializeDefaultPluginPreferences()(Code)(Java Doc)
protected void initializeDefaultPreferences(IPreferenceStore store)(Code)(Java Doc)
protected void initializeImageRegistry(ImageRegistry reg)(Code)(Java Doc)
protected void loadDialogSettings()(Code)(Java Doc)
protected void loadPreferenceStore()(Code)(Java Doc)
protected void refreshPluginActions()(Code)(Java Doc)
protected void saveDialogSettings()(Code)(Java Doc)
protected void savePreferenceStore()(Code)(Java Doc)
public void shutdown() throws CoreException(Code)(Java Doc)
public void start(BundleContext context) throws Exception(Code)(Java Doc)
public void startup() throws CoreException(Code)(Java Doc)
public void stop(BundleContext context) throws Exception(Code)(Java Doc)

www.java2java.com | Contact Us
Copyright 2009 - 12 Demo Source and Support. All rights reserved.
All other trademarks are property of their respective owners.