Java Doc for Workbench.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.internal.Workbench

Workbench
final public class Workbench extends EventManager implements IWorkbench(Code)
The workbench class represents the top of the Eclipse user interface. Its primary responsability is the management of workbench windows, dialogs, wizards, and other workbench-related windows.

Note that any code that is run during the creation of a workbench instance should not required access to the display.

Note that this internal class changed significantly between 2.1 and 3.0. Applications that used to define subclasses of this internal class need to be rewritten to use the new workbench advisor API.



Field Summary
final static  StringDEFAULT_WORKBENCH_STATE_FILENAME
    
final public static  StringEARLY_STARTUP_FAMILY
     Family for the early startup job.
final static  StringVERSION_STRING
    


Method Summary
final public  voidaddShowingMenus(Set menuIds, ISelection localSelection, ISelection localEditorInput)
     Adds the ids of a menu that is now showing to the menu source provider.
public  voidaddWindowListener(IWindowListener l)
    
public  voidaddWorkbenchListener(IWorkbenchListener listener)
    
public  booleanclose()
    
 booleanclose(int returnCode, boolean force)
     Closes the workbench, returning the given return code from the run method.
final public static  intcreateAndRunWorkbench(Display display, WorkbenchAdvisor advisor)
     Creates the workbench and associates it with the the given display and workbench advisor, and runs the workbench UI.
public static  DisplaycreateDisplay()
     Creates the Display to be used by the workbench.
public  ILocalWorkingSetManagercreateLocalWorkingSetManager()
    
 voidfirePostShutdown()
     Fire workbench postShutdown event.
 booleanfirePreShutdown(boolean forced)
    
protected  voidfireWindowActivated(IWorkbenchWindow window)
     Fire window activated event.
protected  voidfireWindowClosed(IWorkbenchWindow window)
     Fire window closed event.
protected  voidfireWindowDeactivated(IWorkbenchWindow window)
     Fire window deactivated event.
protected  voidfireWindowOpened(IWorkbenchWindow window)
     Fire window opened event.
public  IWorkbenchWindowgetActiveWorkbenchWindow()
    
public  IWorkbenchActivitySupportgetActivitySupport()
    
final public  ObjectgetAdapter(Class key)
    
 WorkbenchAdvisorgetAdvisor()
     Returns the workbench advisor that created this workbench.

IMPORTANT This method is declared package-private to prevent regular plug-ins from downcasting IWorkbench to Workbench and getting hold of the workbench advisor that would allow them to tamper with the workbench.

public  IWorkbenchBrowserSupportgetBrowserSupport()
    
public  IWorkbenchCommandSupportgetCommandSupport()
    
public  IWorkbenchContextSupportgetContextSupport()
    
public  IDecoratorManagergetDecoratorManager()
    
public  IAdaptablegetDefaultPageInput()
     Returns the default workbench window page input.
public  StringgetDefaultPerspectiveId()
     Returns the default perspective id, which may be null.
public  String[]getDisabledEarlyActivatedPlugins()
     Returns the ids of the early activated plug-ins that have been disabled by the user.
public  DisplaygetDisplay()
    
public  String[]getEarlyActivatedPlugins()
     Returns the ids of all plug-ins that extend the org.eclipse.ui.startup extension point.
public  EditorHistorygetEditorHistory()
    
public  IEditorRegistrygetEditorRegistry()
    
public  IElementFactorygetElementFactory(String factoryId)
    
public  IWizardRegistrygetExportWizardRegistry()
    
public  IExtensionTrackergetExtensionTracker()
    
public  IWorkbenchHelpSystemgetHelpSystem()
    
public  IWizardRegistrygetImportWizardRegistry()
    
final public static  WorkbenchgetInstance()
     Returns the one and only instance of the workbench, if there is one.
public  IntroDescriptorgetIntroDescriptor()
    
public  IIntroManagergetIntroManager()
    
public  StringgetMainPreferencePageId()
     Returns the id of the preference page that should be presented most prominently.
public  IWizardRegistrygetNewWizardRegistry()
    
public  IWorkbenchOperationSupportgetOperationSupport()
    
public  IPerspectiveRegistrygetPerspectiveRegistry()
    
public  PreferenceManagergetPreferenceManager()
    
public  IPreferenceStoregetPreferenceStore()
    
public  StringgetPresentationId()
     Return the presentation ID specified by the preference or the default ID if undefined.
public  IProgressServicegetProgressService()
    
final public  ObjectgetService(Class key)
    
public  ISharedImagesgetSharedImages()
    
public  IThemeManagergetThemeManager()
    
public  IViewRegistrygetViewRegistry()
    
 WindowManagergetWindowManager()
     Returns the window manager for this workbench.
 WorkbenchConfigurergetWorkbenchConfigurer()
     Returns the unique object that applications use to configure the workbench.
 WorkbenchIntroManagergetWorkbenchIntroManager()
    
public static  WorkbenchTestablegetWorkbenchTestable()
     Returns the testable object facade, for use by the test harness.
public  intgetWorkbenchWindowCount()
    
public  IWorkbenchWindow[]getWorkbenchWindows()
    
public  IWorkingSetManagergetWorkingSetManager()
    
final public  booleanhasService(Class key)
    
public  booleanisClosing()
    
public  booleanisRunning()
     Returns true if the workbench is running, false if it has been terminated.
public  booleanisStarting()
     Returns true if the Workbench is in the process of starting.
final public  voidlargeUpdateEnd()
    

Indicates the end of a large update within the workbench.

final public  voidlargeUpdateStart()
    

Indicates the start of a large update within the workbench.

 voidopenFirstTimeWindow()
     Opens the initial workbench window.
public  IWorkbenchWindowopenWorkbenchWindow(IAdaptable input)
    
public  IWorkbenchWindowopenWorkbenchWindow(String perspID, IAdaptable input)
    
final public  voidregisterService(Class api, Object service)
     Registers a service with this locator.
final public  voidremoveShowingMenus(Set menuIds, ISelection localSelection, ISelection localEditorInput)
     Removes the ids of a menu that is now hidden from the menu source provider.
public  voidremoveWindowListener(IWindowListener l)
    
public  voidremoveWorkbenchListener(IWorkbenchListener listener)
    
public  booleanrestart()
    
 IStatusrestoreState()
    
 IWorkbenchWindowrestoreWorkbenchWindow(IMemento memento)
    
public  booleansaveAll(IShellProvider shellProvider, IRunnableContext runnableContext, ISaveableFilter filter, boolean confirm)
    
public  booleansaveAllEditors(boolean confirm)
    
 voidsetActivatedWindow(WorkbenchWindow window)
    
public  voidsetIntroDescriptor(IntroDescriptor descriptor)
     This method exists as a test hook.
public  IWorkbenchPageshowPerspective(String perspectiveId, IWorkbenchWindow window)
    
public  IWorkbenchPageshowPerspective(String perspectiveId, IWorkbenchWindow window, IAdaptable input)
    

Field Detail
DEFAULT_WORKBENCH_STATE_FILENAME
final static String DEFAULT_WORKBENCH_STATE_FILENAME(Code)



EARLY_STARTUP_FAMILY
final public static String EARLY_STARTUP_FAMILY(Code)
Family for the early startup job.



VERSION_STRING
final static String VERSION_STRING(Code)





Method Detail
addShowingMenus
final public void addShowingMenus(Set menuIds, ISelection localSelection, ISelection localEditorInput)(Code)
Adds the ids of a menu that is now showing to the menu source provider. This is used for legacy action-based handlers which need to become active only for the duration of a menu being visible.
Parameters:
  menuIds - The identifiers of the menu that is now showing; must not benull.



addWindowListener
public void addWindowListener(IWindowListener l)(Code)



addWorkbenchListener
public void addWorkbenchListener(IWorkbenchListener listener)(Code)



close
public boolean close()(Code)



close
boolean close(int returnCode, boolean force)(Code)
Closes the workbench, returning the given return code from the run method. If forced, the workbench is closed no matter what.
Parameters:
  returnCode - PlatformUI.RETURN_OK RETURN_OKfor normal exit;PlatformUI.RETURN_RESTART RETURN_RESTARTif theworkbench was terminated with a call toIWorkbench.restart IWorkbench.restart;PlatformUI.RETURN_EMERGENCY_CLOSE for an emergencyshutdownPlatformUI.RETURN_UNSTARTABLE RETURN_UNSTARTABLEifthe workbench could not be started; other values reserved forfuture use
Parameters:
  force - true to force the workbench close, and false for a "soft"close that can be canceled true if the close was successful, and false if the close wascanceled



createAndRunWorkbench
final public static int createAndRunWorkbench(Display display, WorkbenchAdvisor advisor)(Code)
Creates the workbench and associates it with the the given display and workbench advisor, and runs the workbench UI. This entails processing and dispatching events until the workbench is closed or restarted.

This method is intended to be called by PlatformUI. Fails if the workbench UI has already been created.

The display passed in must be the default display.


Parameters:
  display - the display to be used for all UI interactions with theworkbench
Parameters:
  advisor - the application-specific advisor that configures andspecializes the workbench return code PlatformUI.RETURN_OK RETURN_OKfor normalexit; PlatformUI.RETURN_RESTART RETURN_RESTARTif theworkbench was terminated with a call toIWorkbench.restart IWorkbench.restart; other valuesreserved for future use



createDisplay
public static Display createDisplay()(Code)
Creates the Display to be used by the workbench. the display



createLocalWorkingSetManager
public ILocalWorkingSetManager createLocalWorkingSetManager()(Code)



firePostShutdown
void firePostShutdown()(Code)
Fire workbench postShutdown event.
since:
   3.2



firePreShutdown
boolean firePreShutdown(boolean forced)(Code)
Fire workbench preShutdown event, stopping at the first one to veto
Parameters:
  forced - flag indicating whether the shutdown is being forced true to allow the workbench to proceed withshutdown, false to veto a non-forced shutdown
since:
   3.2



fireWindowActivated
protected void fireWindowActivated(IWorkbenchWindow window)(Code)
Fire window activated event.
Parameters:
  window - The window which was just activated; should not benull.



fireWindowClosed
protected void fireWindowClosed(IWorkbenchWindow window)(Code)
Fire window closed event.
Parameters:
  window - The window which just closed; should not be null.



fireWindowDeactivated
protected void fireWindowDeactivated(IWorkbenchWindow window)(Code)
Fire window deactivated event.
Parameters:
  window - The window which was just deactivated; should not benull.



fireWindowOpened
protected void fireWindowOpened(IWorkbenchWindow window)(Code)
Fire window opened event.
Parameters:
  window - The window which just opened; should not be null.



getActiveWorkbenchWindow
public IWorkbenchWindow getActiveWorkbenchWindow()(Code)



getActivitySupport
public IWorkbenchActivitySupport getActivitySupport()(Code)



getAdapter
final public Object getAdapter(Class key)(Code)



getAdvisor
WorkbenchAdvisor getAdvisor()(Code)
Returns the workbench advisor that created this workbench.

IMPORTANT This method is declared package-private to prevent regular plug-ins from downcasting IWorkbench to Workbench and getting hold of the workbench advisor that would allow them to tamper with the workbench. The workbench advisor is internal to the application.




getBrowserSupport
public IWorkbenchBrowserSupport getBrowserSupport()(Code)



getCommandSupport
public IWorkbenchCommandSupport getCommandSupport()(Code)



getContextSupport
public IWorkbenchContextSupport getContextSupport()(Code)



getDecoratorManager
public IDecoratorManager getDecoratorManager()(Code)



getDefaultPageInput
public IAdaptable getDefaultPageInput()(Code)
Returns the default workbench window page input. the default window page input or null if none



getDefaultPerspectiveId
public String getDefaultPerspectiveId()(Code)
Returns the default perspective id, which may be null. the default perspective id, or null



getDisabledEarlyActivatedPlugins
public String[] getDisabledEarlyActivatedPlugins()(Code)
Returns the ids of the early activated plug-ins that have been disabled by the user. the ids of the early activated plug-ins that have been disabledby the user



getDisplay
public Display getDisplay()(Code)



getEarlyActivatedPlugins
public String[] getEarlyActivatedPlugins()(Code)
Returns the ids of all plug-ins that extend the org.eclipse.ui.startup extension point. the ids of all plug-ins containing 1 or more startup extensions



getEditorHistory
public EditorHistory getEditorHistory()(Code)



getEditorRegistry
public IEditorRegistry getEditorRegistry()(Code)



getElementFactory
public IElementFactory getElementFactory(String factoryId)(Code)



getExportWizardRegistry
public IWizardRegistry getExportWizardRegistry()(Code)



getExtensionTracker
public IExtensionTracker getExtensionTracker()(Code)



getHelpSystem
public IWorkbenchHelpSystem getHelpSystem()(Code)



getImportWizardRegistry
public IWizardRegistry getImportWizardRegistry()(Code)



getInstance
final public static Workbench getInstance()(Code)
Returns the one and only instance of the workbench, if there is one. the workbench, or null if the workbench has notbeen created, or has been created and already completed



getIntroDescriptor
public IntroDescriptor getIntroDescriptor()(Code)
the intro extension for this workbench.
since:
   3.0



getIntroManager
public IIntroManager getIntroManager()(Code)



getMainPreferencePageId
public String getMainPreferencePageId()(Code)
Returns the id of the preference page that should be presented most prominently. the id of the preference page, or null if none



getNewWizardRegistry
public IWizardRegistry getNewWizardRegistry()(Code)



getOperationSupport
public IWorkbenchOperationSupport getOperationSupport()(Code)



getPerspectiveRegistry
public IPerspectiveRegistry getPerspectiveRegistry()(Code)



getPreferenceManager
public PreferenceManager getPreferenceManager()(Code)



getPreferenceStore
public IPreferenceStore getPreferenceStore()(Code)



getPresentationId
public String getPresentationId()(Code)
Return the presentation ID specified by the preference or the default ID if undefined. the presentation ID
See Also:   IWorkbenchPreferenceConstants.PRESENTATION_FACTORY_ID



getProgressService
public IProgressService getProgressService()(Code)



getService
final public Object getService(Class key)(Code)



getSharedImages
public ISharedImages getSharedImages()(Code)



getThemeManager
public IThemeManager getThemeManager()(Code)



getViewRegistry
public IViewRegistry getViewRegistry()(Code)



getWindowManager
WindowManager getWindowManager()(Code)
Returns the window manager for this workbench. the window manager



getWorkbenchConfigurer
WorkbenchConfigurer getWorkbenchConfigurer()(Code)
Returns the unique object that applications use to configure the workbench.

IMPORTANT This method is declared package-private to prevent regular plug-ins from downcasting IWorkbench to Workbench and getting hold of the workbench configurer that would allow them to tamper with the workbench. The workbench configurer is available only to the application.




getWorkbenchIntroManager
WorkbenchIntroManager getWorkbenchIntroManager()(Code)
the workbench intro manager
since:
   3.0



getWorkbenchTestable
public static WorkbenchTestable getWorkbenchTestable()(Code)
Returns the testable object facade, for use by the test harness. the testable object facade
since:
   3.0



getWorkbenchWindowCount
public int getWorkbenchWindowCount()(Code)



getWorkbenchWindows
public IWorkbenchWindow[] getWorkbenchWindows()(Code)



getWorkingSetManager
public IWorkingSetManager getWorkingSetManager()(Code)



hasService
final public boolean hasService(Class key)(Code)



isClosing
public boolean isClosing()(Code)



isRunning
public boolean isRunning()(Code)
Returns true if the workbench is running, false if it has been terminated. true if the workbench is running,false if it has been terminated.



isStarting
public boolean isStarting()(Code)
Returns true if the Workbench is in the process of starting. true if the Workbench is starting, but not yetrunning the event loop.



largeUpdateEnd
final public void largeUpdateEnd()(Code)

Indicates the end of a large update within the workbench. This is used to re-enable services that were temporarily disabled in the midst of large changes. This method should always be called in tandem with largeUpdateStart, and the event loop should not be allowed to spin before this method is called.

Important: always protect this call by using finally!




largeUpdateStart
final public void largeUpdateStart()(Code)

Indicates the start of a large update within the workbench. This is used to disable CPU-intensive, change-sensitive services that were temporarily disabled in the midst of large changes. This method should always be called in tandem with largeUpdateEnd, and the event loop should not be allowed to spin before that method is called.

Important: always use with largeUpdateEnd!




openFirstTimeWindow
void openFirstTimeWindow()(Code)
Opens the initial workbench window.



openWorkbenchWindow
public IWorkbenchWindow openWorkbenchWindow(IAdaptable input) throws WorkbenchException(Code)



openWorkbenchWindow
public IWorkbenchWindow openWorkbenchWindow(String perspID, IAdaptable input) throws WorkbenchException(Code)



registerService
final public void registerService(Class api, Object service)(Code)
Registers a service with this locator. If there is an existing service matching the same api and it implements IDisposable , it will be disposed.
Parameters:
  api - This is the interface that the service implements. Must not benull.
Parameters:
  service - The service to register. This must be some implementation ofapi. This value must not be null.



removeShowingMenus
final public void removeShowingMenus(Set menuIds, ISelection localSelection, ISelection localEditorInput)(Code)
Removes the ids of a menu that is now hidden from the menu source provider. This is used for legacy action-based handlers which need to become active only for the duration of a menu being visible.
Parameters:
  menuIds - The identifiers of the menu that is now hidden; must not benull.



removeWindowListener
public void removeWindowListener(IWindowListener l)(Code)



removeWorkbenchListener
public void removeWorkbenchListener(IWorkbenchListener listener)(Code)



restart
public boolean restart()(Code)



restoreState
IStatus restoreState()(Code)



restoreWorkbenchWindow
IWorkbenchWindow restoreWorkbenchWindow(IMemento memento) throws WorkbenchException(Code)



saveAll
public boolean saveAll(IShellProvider shellProvider, IRunnableContext runnableContext, ISaveableFilter filter, boolean confirm)(Code)



saveAllEditors
public boolean saveAllEditors(boolean confirm)(Code)



setActivatedWindow
void setActivatedWindow(WorkbenchWindow window)(Code)



setIntroDescriptor
public void setIntroDescriptor(IntroDescriptor descriptor)(Code)
This method exists as a test hook. This method should NEVER be called by clients.
Parameters:
  descriptor - The intro descriptor to use.
since:
   3.0



showPerspective
public IWorkbenchPage showPerspective(String perspectiveId, IWorkbenchWindow window) throws WorkbenchException(Code)



showPerspective
public IWorkbenchPage showPerspective(String perspectiveId, IWorkbenchWindow window, IAdaptable input) throws WorkbenchException(Code)



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