Java Doc for NavigatorActionService.java in  » IDE-Eclipse » ui » org » eclipse » ui » navigator » 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 » org.eclipse.ui.navigator 
Source Cross Reference  Class Diagram Java Document (Java Doc) 


org.eclipse.ui.navigator.NavigatorActionService

NavigatorActionService
final public class NavigatorActionService extends ActionGroup implements IMementoAware(Code)

Provides context menu items and IActionBars contributions for a particular abstract viewer. The interface matches that of ActionGroup and may be used in the same manner. Clients must call NavigatorActionService.prepareMenuForPlatformContributions(MenuManagerISelectionProviderboolean) when using this class to allow object or viewer contributions. The org.eclipse.ui.navigator.viewer/viewer/popupMenu element may override whether platform contributions are allowed to the menu with its allowsPlatformContributions attribute. "Platform Contributions" are menu items that are added through the org.eclipse.ui.popupMenus extension point.

A CommonActionProvider has opportunities to contribute to the context menu and org.eclipse.ui.IActionBars whenever the selection in the viewer changes. Action Providers are selected based on the enablement expressions of their associated content extension or their own enablement expression if it is declared as a top-level <actionProvider /> element (of the org.eclipse.ui.navigator.navigatorContent extension point). See the schema documentation of org.eclipse.ui.navigator.navigatorContent for more information on how to specify an Action Provider.

Clients that reuse this service outside of an instance of CommonNavigator must be sure that { NavigatorActionService.fillActionBars(IActionBars) is called whenever the selection changes. The retargetable actions for each selection could change, based on who contributed the items.
since:
   3.2




Constructor Summary
public  NavigatorActionService(ICommonViewerSite aCommonViewerSite, StructuredViewer aStructuredViewer, INavigatorContentService aContentService)
    
Parameters:
  aCommonViewerSite - A site that provides information about the context for extensions.
Parameters:
  aStructuredViewer - The associated StructuredViewer.

Method Summary
public  voiddispose()
     Dispose of any state or resources held by the service.
public  voidfillActionBars(IActionBars theActionBars)
     Request that the service invoke extensions to fill the given IActionBars with retargetable actions or view menu contributions from Action Providers that are interested in the given selection.
public  voidfillContextMenu(IMenuManager aMenu)
     Requests that the service invoke extensions to fill the given menu with Action Providers that are interested in elements from the given selection.
public  voidprepareMenuForPlatformContributions(MenuManager menu, ISelectionProvider aSelectionProvider, boolean force)
     Prepares the menu for object contributions, if the option is set in the extension.
public  voidrestoreState(IMemento aMemento)
     Use the given memento to restore the state of each Action Provider as it is initialized.
public  voidsaveState(IMemento aMemento)
     Request that Action Providers save any state that they find interesting.


Constructor Detail
NavigatorActionService
public NavigatorActionService(ICommonViewerSite aCommonViewerSite, StructuredViewer aStructuredViewer, INavigatorContentService aContentService)(Code)

Parameters:
  aCommonViewerSite - A site that provides information about the context for extensions.
Parameters:
  aStructuredViewer - The associated StructuredViewer. Used to initialize extensions. May NOT benull.
Parameters:
  aContentService - The associated INavigatorContentService (for extensions that coordinate behaviorwith content extensions -- either nested or top-level action providers). MayNOT be null.




Method Detail
dispose
public void dispose()(Code)
Dispose of any state or resources held by the service.
See Also:   ActionGroup.dispose



fillActionBars
public void fillActionBars(IActionBars theActionBars)(Code)
Request that the service invoke extensions to fill the given IActionBars with retargetable actions or view menu contributions from Action Providers that are interested in the given selection.
Parameters:
  theActionBars - The action bars in use by the current view site.
See Also:   ActionGroup.fillActionBars(IActionBars)



fillContextMenu
public void fillContextMenu(IMenuManager aMenu)(Code)
Requests that the service invoke extensions to fill the given menu with Action Providers that are interested in elements from the given selection.

Object contributions (see org.eclipes.ui.popupMenus) may also respected by this method if toRespectObjectContributions is true.


Parameters:
  aMenu - The menu being presented to the user.
See Also:   ActionGroup.fillContextMenu(IMenuManager)



prepareMenuForPlatformContributions
public void prepareMenuForPlatformContributions(MenuManager menu, ISelectionProvider aSelectionProvider, boolean force)(Code)
Prepares the menu for object contributions, if the option is set in the extension. The option is controlled by the &lgt;popupMenu /> element's 'allowPlatformContributions' attribute. Clients may choose to ignore this setting by supplying a value of true for the force attribute.
Parameters:
  menu - The context menu of the IViewPart
Parameters:
  aSelectionProvider - The selection provider that will supplement actions with a valid, currentselection.
Parameters:
  force - A value of 'true' forces the menu to be registered for object/view contributions.Otherwise, the option from the extension point will be respected. Seeorg.eclipse.ui.navigator.viewer/viewer for more information.



restoreState
public void restoreState(IMemento aMemento)(Code)
Use the given memento to restore the state of each Action Provider as it is initialized.
Parameters:
  aMemento - The memento retrieved from the dialog settings



saveState
public void saveState(IMemento aMemento)(Code)
Request that Action Providers save any state that they find interesting.
Parameters:
  aMemento - The memento retrieved from the dialog settings



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