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

WorkbenchWindow
public class WorkbenchWindow extends ApplicationWindow implements IWorkbenchWindow(Code)
A window within the workbench.

Inner Class :class PageList

Field Summary
final static  intBAR_SIZE
    
final static  intCLIENT_INSET
    
final static  StringGRP_FAST_VIEWS
    
final static  StringGRP_PAGES
    
final static  StringGRP_PERSPECTIVES
    
final public static  intNEW_WIZARD_SUBMENU
     Constant (bit mask) indicating which the New Wizard submenu is probably present somewhere in this window.
final public static  intOPEN_PERSPECTIVE_SUBMENU
     Constant (bit mask) indicating which the Open Perspective submenu is probably present somewhere in this window.
final public static  StringPROP_COOLBAR_VISIBLE
     Coolbar visibility change property.
final public static  StringPROP_PERSPECTIVEBAR_VISIBLE
     Perspective bar visibility change property.
final public static  intSHOW_VIEW_SUBMENU
     Constant (bit mask) indicating which the Show View submenu is probably present somewhere in this window.
final static  StringTEXT_DELIMITERS
    
final static  intVGAP
    
 ProgressRegionprogressRegion
    

Constructor Summary
public  WorkbenchWindow(int number)
     Creates and initializes a new workbench window.

Method Summary
final  voidaddActionSetsListener(IActionSetsListener listener)
    
 voidaddBackgroundSaveListener(IBackgroundSaveListener listener)
    
public  voidaddPageListener(IPageListener l)
    
protected  voidaddPerspectiveBar(int style)
     Configures this window to have a perspecive bar.
public  voidaddPerspectiveListener(org.eclipse.ui.IPerspectiveListener l)
    
public  voidaddPerspectiveReorderListener(IReorderListener listener)
     Add a listener for perspective reordering.
public  voidaddPropertyChangeListener(IPropertyChangeListener listener)
     Add a generic property listener.
public  voidaddSubmenu(int type)
     Remembers that this window contains the given submenu.
public  voidaddToTrim(IWindowTrim trim, int side)
     Adds the given control to the specified side of this window's trim.
protected  IWorkbenchPagebusyOpenPage(String perspID, IAdaptable input)
     Opens a new page.
protected  booleancanHandleShellCloseEvent()
    
public  booleanclose()
    
public  voidcloseAllPages(boolean save)
     Save and close all of the pages.
protected  booleanclosePage(IWorkbenchPage in, boolean save)
     closePerspective method comment.
protected  voidconfigureShell(Shell shell)
    
protected  voidconstrainShellSize()
    
public  booleancontainsSubmenu(int type)
     Checks to see if this window contains the given type of submenu.
protected  ControlcreateContents(Composite parent)
     Creates the contents of the workbench window, including trim controls and the client composite.
protected  ICoolBarManagercreateCoolBarManager2(int style)
     Returns a new cool bar manager for the window.
public  CustomizePerspectiveDialogcreateCustomizePerspectiveDialog(Perspective persp)
     Creates the perspective customization dialog.
protected  voidcreateDefaultContents(Shell shell)
     Creates the default contents and layout of the shell.
protected  MenuManagercreateMenuManager()
    

Returns a new menu manager for this workbench window.

protected  CompositecreatePageComposite(Composite parent)
     Creates and remembers the client composite, under which workbench pages create their controls.
protected  voidcreateStatusLine(Shell shell)
     Delegate to the presentation factory.
protected  StatusLineManagercreateStatusLineManager()
     Delegate to the presentation factory.
protected  IToolBarManagercreateToolBarManager2(int style)
     Returns a new tool bar manager for the window.
protected  voidcreateTrimWidgets(Shell shell)
    
public  voidfillActionBars(int flags)
     Fills the window's real action bars.
public  voidfillActionBars(IActionBarConfigurer2 proxyBars, int flags)
     Fills the window's proxy action bars.
 voidfireBackgroundSaveStarted()
    
 voidfirePerspectiveActivated(IWorkbenchPage page, IPerspectiveDescriptor perspective)
    
 voidfirePerspectiveChanged(IWorkbenchPage page, IPerspectiveDescriptor perspective, String changeId)
    
 voidfirePerspectiveChanged(IWorkbenchPage page, IPerspectiveDescriptor perspective, IWorkbenchPartReference partRef, String changeId)
    
 voidfirePerspectiveClosed(IWorkbenchPage page, IPerspectiveDescriptor perspective)
    
 voidfirePerspectiveDeactivated(IWorkbenchPage page, IPerspectiveDescriptor perspective)
     Fires perspective deactivated.
 voidfirePerspectiveOpened(IWorkbenchPage page, IPerspectiveDescriptor perspective)
    
 voidfirePerspectivePreDeactivate(IWorkbenchPage page, IPerspectiveDescriptor perspective)
     Fires perspective deactivated.
 voidfirePerspectiveSavedAs(IWorkbenchPage page, IPerspectiveDescriptor oldPerspective, IPerspectiveDescriptor newPerspective)
     Fires perspective saved as.
 voidfireWindowRestored()
     Notifies interested parties (namely the advisor) that the window has been restored from a previously saved state.
public  IActionBarPresentationFactorygetActionBarPresentationFactory()
     Return the action bar presentation used for creating toolbars.
public  WWinActionBarsgetActionBars()
     Returns the action bars for this window.
public  ActionPresentationgetActionPresentation()
    
public  IWorkbenchPagegetActivePage()
     Returns the active page.
 WorkbenchPagegetActiveWorkbenchPage()
     Returns the active workbench page.
public  booleangetCoolBarVisible()
     whether the cool bar should be shown.
 IAdaptablegetDefaultPageInput()
     Returns the default page input for workbench pages opened in this window.
 ShellPoolgetDetachedWindowPool()
    
public  IExtensionTrackergetExtensionTracker()
    
public  FastViewBargetFastViewBar()
     Returns the fast view bar.
public  booleangetFastViewBarVisible()
     The workbench window take on the fastview bar.
protected  PointgetInitialLocation(Point size)
    
protected  PointgetInitialSize()
     The WorkbenchWindow implementation of this method delegates to the window configurer.
protected  LayoutgetLayout()
     Returns the layout for the shell.
public  MenuManagergetMenuManager()
     Answer the menu manager for this window.
public  intgetNumber()
     Returns the number.
protected  CompositegetPageComposite()
     Returns the page composite, under which the window's pages create their controls.
public  IWorkbenchPage[]getPages()
     Returns an array of the pages in the workbench window.
public  IPartServicegetPartService()
    
public  PerspectiveBarManagergetPerspectiveBar()
     Returns the perspective bar.
public  booleangetPerspectiveBarVisible()
     whether the perspective bar should be shown.
public  ProgressRegiongetProgressRegion()
    
public  ISelectionServicegetSelectionService()
    
final public  ObjectgetService(Class key)
    
public  booleangetShellActivated()
    
public  booleangetShowFastViewBars()
    
public  StatusLineManagergetStatusLineManager()
     Returns the status line manager for this window (if it has one).
public  booleangetStatusLineVisible()
     whether the perspective bar should be shown.
public  StringgetToolbarLabel(String actionSetId)
    
public  ITrimManagergetTrimManager()
    
 WorkbenchWindowConfigurergetWindowConfigurer()
     Returns the unique object that applications use to configure this window.

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

public  IWorkbenchgetWorkbench()
    
final public  booleanhasService(Class key)
    
protected  voidinitializeBounds()
     The WorkbenchWindow implementation of this method has the same logic as Window's implementation, but without the resize check.
public  booleanisApplicationMenu(String menuID)
    
protected  booleanisClosing()
    
protected  booleanisCoolBarLocked()
     Return whether or not the coolbar layout is locked.
 booleanisWorkbenchCoolItemId(String id)
     Return whether or not the given id matches the id of the coolitems that the application creates.
final public  voidlargeUpdateEnd()
    

Indicates the end of a large update within this window.

final public  voidlargeUpdateStart()
    

Indicates the start of a large update within this window.

 voidlockCoolBar(boolean lock)
     Locks/unlocks the CoolBar for the workbench.
 voidmakeVisible()
     Makes the window visible and frontmost.
public  booleanokToClose()
     Called when this window is about to be closed.
public  intopen()
    
public  IWorkbenchPageopenPage(String perspId, IAdaptable input)
     Opens a new page.

Note: Since release 2.0, a window is limited to contain at most one page.

public  IWorkbenchPageopenPage(IAdaptable input)
     Opens a new page.

Note: Since release 2.0, a window is limited to contain at most one page.

protected  intperspectiveBarStyle()
     Return the style bits for the shortcut bar.
 voidregisterGlobalAction(IAction globalAction)
    
final  voidremoveActionSetsListener(IActionSetsListener listener)
    
 voidremoveBackgroundSaveListener(IBackgroundSaveListener listener)
    
public  voidremovePageListener(IPageListener l)
    
public  voidremovePerspectiveListener(org.eclipse.ui.IPerspectiveListener l)
    
public  voidremovePropertyChangeListener(IPropertyChangeListener listener)
     Removes a generic property listener.
public  IStatusrestoreState(IMemento memento, IPerspectiveDescriptor activeDescriptor)
    
public  voidrun(boolean fork, boolean cancelable, IRunnableWithProgress runnable)
    
public  IStatussaveState(IMemento memento)
    
public  voidsetActivePage(IWorkbenchPage in)
     Sets the active page within the window.
public  voidsetBannerCurve(boolean square)
     If the perspective bar is drawn on the top right corner of the window, then this method changes its appearance from curved to square.
public  voidsetCoolBarVisible(boolean visible)
    
Parameters:
  visible - whether the cool bar should be shown.
public  voidsetFastViewBarVisible(boolean visible)
     Tell the workbench window a visible state for the fastview bar.
public  voidsetPerspectiveBarLocation(String location)
    
public  voidsetPerspectiveBarVisible(boolean visible)
    
Parameters:
  visible - whether the perspective bar should be shown.
public  voidsetStatusLineVisible(boolean visible)
    
Parameters:
  visible - whether the perspective bar should be shown.
public  voidshowHeapStatus(boolean selection)
    
protected  booleanshowTopSeperator()
    
 voidsubmitGlobalActions()
    

Submits the action handlers for action set actions and global actions. Global actions are given priority, so that if a global action and an action set action both handle the same command, the global action is given priority.

These submissions are submitted as Priority.LEGACY, which means that they are the lowest priority.

public  voidtoggleToolbarVisibility()
     Toggle the visibility of the coolbar/perspective bar.
protected  booleantoolBarChildrenExist()
     Returns whether or not children exist for the Window's toolbar control.
public  voidupdateActionBars()
     update the action bars.
public  voidupdateActionSets()
     Update the visible action sets.
public  voidupdateFastViewBar()
     Updates the fast view bar, if present.

Field Detail
BAR_SIZE
final static int BAR_SIZE(Code)



CLIENT_INSET
final static int CLIENT_INSET(Code)



GRP_FAST_VIEWS
final static String GRP_FAST_VIEWS(Code)



GRP_PAGES
final static String GRP_PAGES(Code)



GRP_PERSPECTIVES
final static String GRP_PERSPECTIVES(Code)



NEW_WIZARD_SUBMENU
final public static int NEW_WIZARD_SUBMENU(Code)
Constant (bit mask) indicating which the New Wizard submenu is probably present somewhere in this window.
See Also:   WorkbenchWindow.addSubmenu
since:
   3.0



OPEN_PERSPECTIVE_SUBMENU
final public static int OPEN_PERSPECTIVE_SUBMENU(Code)
Constant (bit mask) indicating which the Open Perspective submenu is probably present somewhere in this window.
See Also:   WorkbenchWindow.addSubmenu
since:
   3.0



PROP_COOLBAR_VISIBLE
final public static String PROP_COOLBAR_VISIBLE(Code)
Coolbar visibility change property.
since:
   3.3



PROP_PERSPECTIVEBAR_VISIBLE
final public static String PROP_PERSPECTIVEBAR_VISIBLE(Code)
Perspective bar visibility change property.
since:
   3.3



SHOW_VIEW_SUBMENU
final public static int SHOW_VIEW_SUBMENU(Code)
Constant (bit mask) indicating which the Show View submenu is probably present somewhere in this window.
See Also:   WorkbenchWindow.addSubmenu
since:
   3.0



TEXT_DELIMITERS
final static String TEXT_DELIMITERS(Code)



VGAP
final static int VGAP(Code)



progressRegion
ProgressRegion progressRegion(Code)




Constructor Detail
WorkbenchWindow
public WorkbenchWindow(int number)(Code)
Creates and initializes a new workbench window.
Parameters:
  number - the number for the window




Method Detail
addActionSetsListener
final void addActionSetsListener(IActionSetsListener listener)(Code)



addBackgroundSaveListener
void addBackgroundSaveListener(IBackgroundSaveListener listener)(Code)



addPageListener
public void addPageListener(IPageListener l)(Code)



addPerspectiveBar
protected void addPerspectiveBar(int style)(Code)
Configures this window to have a perspecive bar. Does nothing if it already has one.



addPerspectiveListener
public void addPerspectiveListener(org.eclipse.ui.IPerspectiveListener l)(Code)

See Also:   org.eclipse.ui.IPageService



addPerspectiveReorderListener
public void addPerspectiveReorderListener(IReorderListener listener)(Code)
Add a listener for perspective reordering.
Parameters:
  listener -



addPropertyChangeListener
public void addPropertyChangeListener(IPropertyChangeListener listener)(Code)
Add a generic property listener.
Parameters:
  listener - the listener to add
since:
   3.3



addSubmenu
public void addSubmenu(int type)(Code)
Remembers that this window contains the given submenu.
Parameters:
  type - the type of submenu, one of:WorkbenchWindow.NEW_WIZARD_SUBMENU NEW_WIZARD_SUBMENU,WorkbenchWindow.OPEN_PERSPECTIVE_SUBMENU OPEN_PERSPECTIVE_SUBMENU,WorkbenchWindow.SHOW_VIEW_SUBMENU SHOW_VIEW_SUBMENU
See Also:   WorkbenchWindow.containsSubmenu
since:
   3.0



addToTrim
public void addToTrim(IWindowTrim trim, int side)(Code)
Adds the given control to the specified side of this window's trim.
Parameters:
  trim - the bar's IWindowTrim
Parameters:
  side - one of SWT.LEFT,SWT.BOTTOM,or SWT.RIGHT (only LEFT has been tested)
since:
   3.0



busyOpenPage
protected IWorkbenchPage busyOpenPage(String perspID, IAdaptable input) throws WorkbenchException(Code)
Opens a new page. Assumes that busy cursor is active.

Note: Since release 2.0, a window is limited to contain at most one page. If a page exist in the window when this method is used, then another window is created for the new page. Callers are strongly recommended to use the IWorkbench.openPerspective APIs to programmatically show a perspective.




canHandleShellCloseEvent
protected boolean canHandleShellCloseEvent()(Code)



close
public boolean close()(Code)

See Also:   IWorkbenchWindow



closeAllPages
public void closeAllPages(boolean save)(Code)
Save and close all of the pages.



closePage
protected boolean closePage(IWorkbenchPage in, boolean save)(Code)
closePerspective method comment.



configureShell
protected void configureShell(Shell shell)(Code)



constrainShellSize
protected void constrainShellSize()(Code)



containsSubmenu
public boolean containsSubmenu(int type)(Code)
Checks to see if this window contains the given type of submenu.
Parameters:
  type - the type of submenu, one of:WorkbenchWindow.NEW_WIZARD_SUBMENU NEW_WIZARD_SUBMENU,WorkbenchWindow.OPEN_PERSPECTIVE_SUBMENU OPEN_PERSPECTIVE_SUBMENU,WorkbenchWindow.SHOW_VIEW_SUBMENU SHOW_VIEW_SUBMENU true if window contains submenu,false otherwise
See Also:   WorkbenchWindow.addSubmenu
since:
   3.0



createContents
protected Control createContents(Composite parent)(Code)
Creates the contents of the workbench window, including trim controls and the client composite. This MUST create the client composite via a call to createClientComposite.
since:
   3.0



createCoolBarManager2
protected ICoolBarManager createCoolBarManager2(int style)(Code)
Returns a new cool bar manager for the window.

Subclasses may override this method to customize the cool bar manager.

a cool bar manager
since:
   3.2



createCustomizePerspectiveDialog
public CustomizePerspectiveDialog createCustomizePerspectiveDialog(Perspective persp)(Code)
Creates the perspective customization dialog.
Parameters:
  persp - perspective to customize a new perspective customization dialog
since:
   3.1



createDefaultContents
protected void createDefaultContents(Shell shell)(Code)
Creates the default contents and layout of the shell.
Parameters:
  shell - the shell



createMenuManager
protected MenuManager createMenuManager()(Code)

Returns a new menu manager for this workbench window. This menu manager will just be a proxy to the new command-based menu service.

Subclasses may override this method to customize the menu manager.

a menu manager for this workbench window; never null.



createPageComposite
protected Composite createPageComposite(Composite parent)(Code)
Creates and remembers the client composite, under which workbench pages create their controls.
since:
   3.0



createStatusLine
protected void createStatusLine(Shell shell)(Code)
Delegate to the presentation factory.
See Also:   org.eclipse.jface.window.ApplicationWindow.createStatusLine
since:
   3.0



createStatusLineManager
protected StatusLineManager createStatusLineManager()(Code)
Delegate to the presentation factory.
See Also:   org.eclipse.jface.window.ApplicationWindow.createStatusLineManager
since:
   3.0



createToolBarManager2
protected IToolBarManager createToolBarManager2(int style)(Code)
Returns a new tool bar manager for the window.

Subclasses may override this method to customize the tool bar manager.

a tool bar manager
since:
   3.2



createTrimWidgets
protected void createTrimWidgets(Shell shell)(Code)



fillActionBars
public void fillActionBars(int flags)(Code)
Fills the window's real action bars.
Parameters:
  flags - indicate which bars to fill



fillActionBars
public void fillActionBars(IActionBarConfigurer2 proxyBars, int flags)(Code)
Fills the window's proxy action bars.
Parameters:
  proxyBars - the proxy configurer
Parameters:
  flags - indicate which bars to fill



fireBackgroundSaveStarted
void fireBackgroundSaveStarted()(Code)



firePerspectiveActivated
void firePerspectiveActivated(IWorkbenchPage page, IPerspectiveDescriptor perspective)(Code)
Fires perspective activated



firePerspectiveChanged
void firePerspectiveChanged(IWorkbenchPage page, IPerspectiveDescriptor perspective, String changeId)(Code)
Fires perspective changed



firePerspectiveChanged
void firePerspectiveChanged(IWorkbenchPage page, IPerspectiveDescriptor perspective, IWorkbenchPartReference partRef, String changeId)(Code)
Fires perspective changed for an affected part



firePerspectiveClosed
void firePerspectiveClosed(IWorkbenchPage page, IPerspectiveDescriptor perspective)(Code)
Fires perspective closed



firePerspectiveDeactivated
void firePerspectiveDeactivated(IWorkbenchPage page, IPerspectiveDescriptor perspective)(Code)
Fires perspective deactivated.
since:
   3.1



firePerspectiveOpened
void firePerspectiveOpened(IWorkbenchPage page, IPerspectiveDescriptor perspective)(Code)
Fires perspective opened



firePerspectivePreDeactivate
void firePerspectivePreDeactivate(IWorkbenchPage page, IPerspectiveDescriptor perspective)(Code)
Fires perspective deactivated.
since:
   3.2



firePerspectiveSavedAs
void firePerspectiveSavedAs(IWorkbenchPage page, IPerspectiveDescriptor oldPerspective, IPerspectiveDescriptor newPerspective)(Code)
Fires perspective saved as.
since:
   3.1



fireWindowRestored
void fireWindowRestored() throws WorkbenchException(Code)
Notifies interested parties (namely the advisor) that the window has been restored from a previously saved state.
throws:
  WorkbenchException - passed through from the advisor
since:
   3.1



getActionBarPresentationFactory
public IActionBarPresentationFactory getActionBarPresentationFactory()(Code)
Return the action bar presentation used for creating toolbars. This is for internal use only, used for consistency with the window. the presentation used.



getActionBars
public WWinActionBars getActionBars()(Code)
Returns the action bars for this window.



getActionPresentation
public ActionPresentation getActionPresentation()(Code)
Returns the action presentation for dynamic UI action presentation



getActivePage
public IWorkbenchPage getActivePage()(Code)
Returns the active page. the active page



getActiveWorkbenchPage
WorkbenchPage getActiveWorkbenchPage()(Code)
Returns the active workbench page. the active workbench page



getCoolBarVisible
public boolean getCoolBarVisible()(Code)
whether the cool bar should be shown. This is only applicable ifthe window configurer also wishes either the cool bar to bevisible.
since:
   3.0



getDefaultPageInput
IAdaptable getDefaultPageInput()(Code)
Returns the default page input for workbench pages opened in this window. the default page input or null if none
since:
   3.1



getDetachedWindowPool
ShellPool getDetachedWindowPool()(Code)



getExtensionTracker
public IExtensionTracker getExtensionTracker()(Code)



getFastViewBar
public FastViewBar getFastViewBar()(Code)
Returns the fast view bar.



getFastViewBarVisible
public boolean getFastViewBarVisible()(Code)
The workbench window take on the fastview bar. This is only applicable if the window configurer also wishes the fast view bar to be visible. true if the workbench window thinks the fastviewbar should be visible.
since:
   3.2



getInitialLocation
protected Point getInitialLocation(Point size)(Code)



getInitialSize
protected Point getInitialSize()(Code)
The WorkbenchWindow implementation of this method delegates to the window configurer.
since:
   3.0



getLayout
protected Layout getLayout()(Code)
Returns the layout for the shell. the layout for the shell



getMenuManager
public MenuManager getMenuManager()(Code)
Answer the menu manager for this window.



getNumber
public int getNumber()(Code)
Returns the number. This corresponds to a page number in a window or a window number in the workbench.



getPageComposite
protected Composite getPageComposite()(Code)
Returns the page composite, under which the window's pages create their controls.



getPages
public IWorkbenchPage[] getPages()(Code)
Returns an array of the pages in the workbench window. an array of pages



getPartService
public IPartService getPartService()(Code)

See Also:   IWorkbenchWindow



getPerspectiveBar
public PerspectiveBarManager getPerspectiveBar()(Code)
Returns the perspective bar. Returns the perspective bar, or null if it has notbeen initialized.



getPerspectiveBarVisible
public boolean getPerspectiveBarVisible()(Code)
whether the perspective bar should be shown. This is onlyapplicable if the window configurer also wishes either theperspective bar to be visible.
since:
   3.0



getProgressRegion
public ProgressRegion getProgressRegion()(Code)
Returns the progressRegion.



getSelectionService
public ISelectionService getSelectionService()(Code)

See Also:   IWorkbenchWindow



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



getShellActivated
public boolean getShellActivated()(Code)
Returns true when the window's shell is activated, false when it's shell is deactivated boolean true when shell activated,false when shell deactivated



getShowFastViewBars
public boolean getShowFastViewBars()(Code)



getStatusLineManager
public StatusLineManager getStatusLineManager()(Code)
Returns the status line manager for this window (if it has one). the status line manager, or null if this windowdoes not have a status line
See Also:   ApplicationWindow.addStatusLine



getStatusLineVisible
public boolean getStatusLineVisible()(Code)
whether the perspective bar should be shown. This is onlyapplicable if the window configurer also wishes either theperspective bar to be visible.
since:
   3.0



getToolbarLabel
public String getToolbarLabel(String actionSetId)(Code)



getTrimManager
public ITrimManager getTrimManager()(Code)



getWindowConfigurer
WorkbenchWindowConfigurer getWindowConfigurer()(Code)
Returns the unique object that applications use to configure this window.

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




getWorkbench
public IWorkbench getWorkbench()(Code)

See Also:   IWorkbenchWindow



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



initializeBounds
protected void initializeBounds()(Code)
The WorkbenchWindow implementation of this method has the same logic as Window's implementation, but without the resize check. We don't want to skip setting the bounds if the shell has been resized since a free resize event occurs on Windows when the menubar is set in configureShell.



isApplicationMenu
public boolean isApplicationMenu(String menuID)(Code)

See Also:   IWorkbenchWindow



isClosing
protected boolean isClosing()(Code)



isCoolBarLocked
protected boolean isCoolBarLocked()(Code)
Return whether or not the coolbar layout is locked.



isWorkbenchCoolItemId
boolean isWorkbenchCoolItemId(String id)(Code)
Return whether or not the given id matches the id of the coolitems that the application creates.



largeUpdateEnd
final public void largeUpdateEnd()(Code)

Indicates the end of a large update within this window. 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!


since:
   3.1



largeUpdateStart
final public void largeUpdateStart()(Code)

Indicates the start of a large update within this window. 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!


since:
   3.1



lockCoolBar
void lockCoolBar(boolean lock)(Code)
Locks/unlocks the CoolBar for the workbench.
Parameters:
  lock - whether the CoolBar should be locked or unlocked



makeVisible
void makeVisible()(Code)
Makes the window visible and frontmost.



okToClose
public boolean okToClose()(Code)
Called when this window is about to be closed. Subclasses may overide to add code that returns false to prevent closing under certain conditions.



open
public int open()(Code)

See Also:   Window



openPage
public IWorkbenchPage openPage(String perspId, IAdaptable input) throws WorkbenchException(Code)
Opens a new page.

Note: Since release 2.0, a window is limited to contain at most one page. If a page exist in the window when this method is used, then another window is created for the new page. Callers are strongly recommended to use the IWorkbench.openPerspective APIs to programmatically show a perspective.




openPage
public IWorkbenchPage openPage(IAdaptable input) throws WorkbenchException(Code)
Opens a new page.

Note: Since release 2.0, a window is limited to contain at most one page. If a page exist in the window when this method is used, then another window is created for the new page. Callers are strongly recommended to use the IWorkbench.openPerspective APIs to programmatically show a perspective.




perspectiveBarStyle
protected int perspectiveBarStyle()(Code)
Return the style bits for the shortcut bar. int



registerGlobalAction
void registerGlobalAction(IAction globalAction)(Code)



removeActionSetsListener
final void removeActionSetsListener(IActionSetsListener listener)(Code)



removeBackgroundSaveListener
void removeBackgroundSaveListener(IBackgroundSaveListener listener)(Code)



removePageListener
public void removePageListener(IPageListener l)(Code)



removePerspectiveListener
public void removePerspectiveListener(org.eclipse.ui.IPerspectiveListener l)(Code)

See Also:   org.eclipse.ui.IPageService



removePropertyChangeListener
public void removePropertyChangeListener(IPropertyChangeListener listener)(Code)
Removes a generic property listener.
Parameters:
  listener - the listener to remove
since:
   3.3



restoreState
public IStatus restoreState(IMemento memento, IPerspectiveDescriptor activeDescriptor)(Code)



run
public void run(boolean fork, boolean cancelable, IRunnableWithProgress runnable) throws InvocationTargetException, InterruptedException(Code)



saveState
public IStatus saveState(IMemento memento)(Code)

See Also:   IPersistable



setActivePage
public void setActivePage(IWorkbenchPage in)(Code)
Sets the active page within the window.
Parameters:
  in - identifies the new active page, or null for noactive page



setBannerCurve
public void setBannerCurve(boolean square)(Code)
If the perspective bar is drawn on the top right corner of the window, then this method changes its appearance from curved to square. This should have its own preference, but for now it piggy-backs on the SHOW_TRADITIONAL_STYLE_TABS preference.
Parameters:
  square - true for a square banner and false otherwise



setCoolBarVisible
public void setCoolBarVisible(boolean visible)(Code)

Parameters:
  visible - whether the cool bar should be shown. This is only applicableif the window configurer also wishes either the cool bar to bevisible.
since:
   3.0



setFastViewBarVisible
public void setFastViewBarVisible(boolean visible)(Code)
Tell the workbench window a visible state for the fastview bar. This is only applicable if the window configurer also wishes the fast view bar to be visible.
Parameters:
  visible - true or false
since:
   3.2



setPerspectiveBarLocation
public void setPerspectiveBarLocation(String location)(Code)
Set the perspective bar location
Parameters:
  location - the location to place the bar



setPerspectiveBarVisible
public void setPerspectiveBarVisible(boolean visible)(Code)

Parameters:
  visible - whether the perspective bar should be shown. This is onlyapplicable if the window configurer also wishes either theperspective bar to be visible.
since:
   3.0



setStatusLineVisible
public void setStatusLineVisible(boolean visible)(Code)

Parameters:
  visible - whether the perspective bar should be shown. This is onlyapplicable if the window configurer also wishes either theperspective bar to be visible.
since:
   3.0



showHeapStatus
public void showHeapStatus(boolean selection)(Code)
Show the heap status
Parameters:
  selection -



showTopSeperator
protected boolean showTopSeperator()(Code)



submitGlobalActions
void submitGlobalActions()(Code)

Submits the action handlers for action set actions and global actions. Global actions are given priority, so that if a global action and an action set action both handle the same command, the global action is given priority.

These submissions are submitted as Priority.LEGACY, which means that they are the lowest priority. This means that if a higher priority submission handles the same command under the same conditions, that that submission will become the handler.




toggleToolbarVisibility
public void toggleToolbarVisibility()(Code)
Toggle the visibility of the coolbar/perspective bar. This method respects the window configurer and will only toggle visibility if the item in question was originally declared visible by the window advisor.
since:
   3.3



toolBarChildrenExist
protected boolean toolBarChildrenExist()(Code)
Returns whether or not children exist for the Window's toolbar control. Overridden for coolbar support.

boolean true if children exist, false otherwise




updateActionBars
public void updateActionBars()(Code)
update the action bars.



updateActionSets
public void updateActionSets()(Code)
Update the visible action sets. This method is typically called from a page when the user changes the visible action sets within the prespective.



updateFastViewBar
public void updateFastViewBar()(Code)
Updates the fast view bar, if present. TODO: The fast view bar should update itself as necessary. All calls to this should be cleaned up.
since:
   3.0



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