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


java.lang.Object
   org.eclipse.ui.handlers.HandlerUtil

HandlerUtil
public class HandlerUtil (Code)
Some common utilities for working with handlers in Platform UI.

Note: this class should not be instantiated or extended by clients.


since:
   3.3




Method Summary
public static  CollectiongetActiveContexts(ExecutionEvent event)
     Return the active contexts.
public static  CollectiongetActiveContextsChecked(ExecutionEvent event)
     Return the active contexts.
Parameters:
  event - The execution event that contains the application context a collection of String contextIds.
public static  IEditorPartgetActiveEditor(ExecutionEvent event)
     Return the active editor.
public static  IEditorPartgetActiveEditorChecked(ExecutionEvent event)
     Return the active editor.
Parameters:
  event - The execution event that contains the application context the active editor.
public static  StringgetActiveEditorId(ExecutionEvent event)
     Return the part id of the active editor.
public static  StringgetActiveEditorIdChecked(ExecutionEvent event)
     Return the part id of the active editor.
Parameters:
  event - The execution event that contains the application context the part id of the active editor.
public static  ISelectiongetActiveMenuEditorInput(ExecutionEvent event)
     Return the active menu editor input, if available.
public static  ISelectiongetActiveMenuEditorInputChecked(ExecutionEvent event)
     Return the active menu editor input.
public static  ISelectiongetActiveMenuSelection(ExecutionEvent event)
     Return the active menu selection.
public static  ISelectiongetActiveMenuSelectionChecked(ExecutionEvent event)
     Return the active menu selection.
public static  CollectiongetActiveMenus(ExecutionEvent event)
     Return the menu IDs that were applied to the registered context menu.
public static  CollectiongetActiveMenusChecked(ExecutionEvent event)
     Return the menu IDs that were applied to the registered context menu.
public static  IWorkbenchPartgetActivePart(ExecutionEvent event)
     Return the active part.
public static  IWorkbenchPartgetActivePartChecked(ExecutionEvent event)
     Return the active part.
Parameters:
  event - The execution event that contains the application context the active part.
public static  StringgetActivePartId(ExecutionEvent event)
     Return the part id of the active part.
public static  StringgetActivePartIdChecked(ExecutionEvent event)
     Return the part id of the active part.
Parameters:
  event - The execution event that contains the application context the part id of the active part.
public static  ShellgetActiveShell(ExecutionEvent event)
     Return the active shell.
public static  ShellgetActiveShellChecked(ExecutionEvent event)
     Return the active shell.
public static  IWorkbenchSitegetActiveSite(ExecutionEvent event)
     Return the active part site.
public static  IWorkbenchSitegetActiveSiteChecked(ExecutionEvent event)
     Return the active part site.
Parameters:
  event - The execution event that contains the application context the active part site.
public static  IWorkbenchWindowgetActiveWorkbenchWindow(ExecutionEvent event)
     Return the active workbench window.
public static  IWorkbenchWindowgetActiveWorkbenchWindowChecked(ExecutionEvent event)
     Return the active workbench window.
Parameters:
  event - The execution event that contains the application context the active workbench window.
public static  ISelectiongetCurrentSelection(ExecutionEvent event)
     Return the current selection.
public static  ISelectiongetCurrentSelectionChecked(ExecutionEvent event)
     Return the current selection.
Parameters:
  event - The execution event that contains the application context the current selection.
public static  ObjectgetVariable(ExecutionEvent event, String name)
     Extract the variable.
Parameters:
  event - The execution event that contains the application context
Parameters:
  name - The variable name to extract.
public static  ObjectgetVariableChecked(ExecutionEvent event, String name)
     Extract the variable.
Parameters:
  event - The execution event that contains the application context
Parameters:
  name - The variable name to extract.



Method Detail
getActiveContexts
public static Collection getActiveContexts(ExecutionEvent event)(Code)
Return the active contexts.
Parameters:
  event - The execution event that contains the application context a collection of String contextIds, or null.



getActiveContextsChecked
public static Collection getActiveContextsChecked(ExecutionEvent event) throws ExecutionException(Code)
Return the active contexts.
Parameters:
  event - The execution event that contains the application context a collection of String contextIds. Will not returnnull.
throws:
  ExecutionException - If the context variable is not found.



getActiveEditor
public static IEditorPart getActiveEditor(ExecutionEvent event)(Code)
Return the active editor.
Parameters:
  event - The execution event that contains the application context the active editor, or null.



getActiveEditorChecked
public static IEditorPart getActiveEditorChecked(ExecutionEvent event) throws ExecutionException(Code)
Return the active editor.
Parameters:
  event - The execution event that contains the application context the active editor. Will not return null.
throws:
  ExecutionException - If the active editor variable is not found.



getActiveEditorId
public static String getActiveEditorId(ExecutionEvent event)(Code)
Return the part id of the active editor.
Parameters:
  event - The execution event that contains the application context the part id of the active editor, or null.



getActiveEditorIdChecked
public static String getActiveEditorIdChecked(ExecutionEvent event) throws ExecutionException(Code)
Return the part id of the active editor.
Parameters:
  event - The execution event that contains the application context the part id of the active editor. Will not returnnull.
throws:
  ExecutionException - If the active editor id variable is not found.



getActiveMenuEditorInput
public static ISelection getActiveMenuEditorInput(ExecutionEvent event)(Code)
Return the active menu editor input, if available. The active menu is a registered context menu.
Parameters:
  event - The execution event that contains the application context the active menu editor, or null.



getActiveMenuEditorInputChecked
public static ISelection getActiveMenuEditorInputChecked(ExecutionEvent event) throws ExecutionException(Code)
Return the active menu editor input. The active menu is a registered context menu. Some context menus do not include the editor input which will throw an exception.
Parameters:
  event - The execution event that contains the application context the active menu editor input. Will not return null.
throws:
  ExecutionException - If the active menu editor input variable is not found.



getActiveMenuSelection
public static ISelection getActiveMenuSelection(ExecutionEvent event)(Code)
Return the active menu selection. The active menu is a registered context menu.
Parameters:
  event - The execution event that contains the application context the active menu selection, or null.



getActiveMenuSelectionChecked
public static ISelection getActiveMenuSelectionChecked(ExecutionEvent event) throws ExecutionException(Code)
Return the active menu selection. The active menu is a registered context menu.
Parameters:
  event - The execution event that contains the application context the active menu selection. Will not return null.
throws:
  ExecutionException - If the active menu selection variable is not found.



getActiveMenus
public static Collection getActiveMenus(ExecutionEvent event)(Code)
Return the menu IDs that were applied to the registered context menu. For example, #CompilationUnitEditorContext.
Parameters:
  event - The execution event that contains the application context the menu IDs, or null.



getActiveMenusChecked
public static Collection getActiveMenusChecked(ExecutionEvent event) throws ExecutionException(Code)
Return the menu IDs that were applied to the registered context menu. For example, #CompilationUnitEditorContext.
Parameters:
  event - The execution event that contains the application context the menu IDs. Will not return null.
throws:
  ExecutionException - If the active menus variable is not found.



getActivePart
public static IWorkbenchPart getActivePart(ExecutionEvent event)(Code)
Return the active part.
Parameters:
  event - The execution event that contains the application context the active part, or null.



getActivePartChecked
public static IWorkbenchPart getActivePartChecked(ExecutionEvent event) throws ExecutionException(Code)
Return the active part.
Parameters:
  event - The execution event that contains the application context the active part. Will not return null.
throws:
  ExecutionException - If the active part variable is not found.



getActivePartId
public static String getActivePartId(ExecutionEvent event)(Code)
Return the part id of the active part.
Parameters:
  event - The execution event that contains the application context the part id of the active part, or null.



getActivePartIdChecked
public static String getActivePartIdChecked(ExecutionEvent event) throws ExecutionException(Code)
Return the part id of the active part.
Parameters:
  event - The execution event that contains the application context the part id of the active part. Will not return null.
throws:
  ExecutionException - If the active part id variable is not found.



getActiveShell
public static Shell getActiveShell(ExecutionEvent event)(Code)
Return the active shell. Is not necessarily the active workbench window shell.
Parameters:
  event - The execution event that contains the application context the active shell, or null.



getActiveShellChecked
public static Shell getActiveShellChecked(ExecutionEvent event) throws ExecutionException(Code)
Return the active shell. Is not necessarily the active workbench window shell.
Parameters:
  event - The execution event that contains the application context the active shell. Will not return null.
throws:
  ExecutionException - If the active shell variable is not found.



getActiveSite
public static IWorkbenchSite getActiveSite(ExecutionEvent event)(Code)
Return the active part site.
Parameters:
  event - The execution event that contains the application context the active part site, or null.



getActiveSiteChecked
public static IWorkbenchSite getActiveSiteChecked(ExecutionEvent event) throws ExecutionException(Code)
Return the active part site.
Parameters:
  event - The execution event that contains the application context the active part site. Will not return null.
throws:
  ExecutionException - If the active part site variable is not found.



getActiveWorkbenchWindow
public static IWorkbenchWindow getActiveWorkbenchWindow(ExecutionEvent event)(Code)
Return the active workbench window.
Parameters:
  event - The execution event that contains the application context the active workbench window, or null.



getActiveWorkbenchWindowChecked
public static IWorkbenchWindow getActiveWorkbenchWindowChecked(ExecutionEvent event) throws ExecutionException(Code)
Return the active workbench window.
Parameters:
  event - The execution event that contains the application context the active workbench window. Will not return null.
throws:
  ExecutionException - If the active workbench window variable is not found.



getCurrentSelection
public static ISelection getCurrentSelection(ExecutionEvent event)(Code)
Return the current selection.
Parameters:
  event - The execution event that contains the application context the current selection, or null.



getCurrentSelectionChecked
public static ISelection getCurrentSelectionChecked(ExecutionEvent event) throws ExecutionException(Code)
Return the current selection.
Parameters:
  event - The execution event that contains the application context the current selection. Will not return null.
throws:
  ExecutionException - If the current selection variable is not found.



getVariable
public static Object getVariable(ExecutionEvent event, String name)(Code)
Extract the variable.
Parameters:
  event - The execution event that contains the application context
Parameters:
  name - The variable name to extract. The object from the application context, or nullif it could not be found.



getVariableChecked
public static Object getVariableChecked(ExecutionEvent event, String name) throws ExecutionException(Code)
Extract the variable.
Parameters:
  event - The execution event that contains the application context
Parameters:
  name - The variable name to extract. The object from the application context. Will not returnnull.
throws:
  ExecutionException - if the variable is not found.



Methods inherited from java.lang.Object
native protected Object clone() throws CloneNotSupportedException(Code)(Java Doc)
public boolean equals(Object obj)(Code)(Java Doc)
protected void finalize() throws Throwable(Code)(Java Doc)
final native public Class getClass()(Code)(Java Doc)
native public int hashCode()(Code)(Java Doc)
final native public void notify()(Code)(Java Doc)
final native public void notifyAll()(Code)(Java Doc)
public String toString()(Code)(Java Doc)
final native public void wait(long timeout) throws InterruptedException(Code)(Java Doc)
final public void wait(long timeout, int nanos) throws InterruptedException(Code)(Java Doc)
final public void wait() throws InterruptedException(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.