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


org.eclipse.ui.handlers.IHandlerActivation

All known Subclasses:   org.eclipse.ui.internal.handlers.HandlerActivation,
IHandlerActivation
public interface IHandlerActivation extends IEvaluationResultCache,Comparable(Code)

A token representing the activation of a handler. This token can later be used to cancel that activation. Without this token, then handler will only become inactive if the component in which the handler was activated is destroyed.

This interface is not intended to be implemented or extended by clients.


since:
   3.1
See Also:   org.eclipse.ui.ISources
See Also:   org.eclipse.ui.ISourceProvider


Field Summary
final public static  intROOT_DEPTH
     The depth at which the root exists.


Method Summary
public  voidclearActive()
     Clears the cached computation of the isActive method, if any.
public  StringgetCommandId()
     Returns the identifier of the command whose handler is being activated.
public  intgetDepth()
     Returns the depth at which this activation was created within the services hierarchy.
public  IHandlergetHandler()
     Returns the handler that should be activated.
public  IHandlerServicegetHandlerService()
     Returns the handler service from which this activation was requested.
public  booleanisActive(IEvaluationContext context)
     Returns whether this handler activation is currently active -- given the current state of the workbench.

Field Detail
ROOT_DEPTH
final public static int ROOT_DEPTH(Code)
The depth at which the root exists.
since:
   3.2





Method Detail
clearActive
public void clearActive()(Code)
Clears the cached computation of the isActive method, if any. This method is only intended for internal use. It provides a mechanism by which ISourceProvider events can invalidate state on a IHandlerActivation instance. IEvaluationResultCache.clearResult



getCommandId
public String getCommandId()(Code)
Returns the identifier of the command whose handler is being activated. The command identifier; never null.



getDepth
public int getDepth()(Code)
Returns the depth at which this activation was created within the services hierarchy. The root of the hierarchy is at a depth of 1. This is used as the final tie-breaker in the event that no other method can be used to determine a winner. The depth at which the handler was inserted into the serviceshierarchy; should be a positive integer.
since:
   3.2



getHandler
public IHandler getHandler()(Code)
Returns the handler that should be activated. The handler; may be null.



getHandlerService
public IHandlerService getHandlerService()(Code)
Returns the handler service from which this activation was requested. This is used to ensure that an activation can only be retracted from the same service which issued it. The handler service; never null.



isActive
public boolean isActive(IEvaluationContext context)(Code)
Returns whether this handler activation is currently active -- given the current state of the workbench. This method should cache its computation. The cache will be cleared by a call to clearActive.
Parameters:
  context - The context in which this state should be evaluated; must notbe null. true if the activation is currently active;false otherwise.IEvaluationResultCache.evaluate(IEvaluationContext)



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