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


java.lang.Object
   org.eclipse.ui.activities.WorkbenchActivityHelper

WorkbenchActivityHelper
final public class WorkbenchActivityHelper (Code)
A utility class that contains helpful methods for interacting with the activities API.
since:
   3.0




Method Summary
public static  booleanallowUseOf(Object object)
     Answers whether a given contribution is allowed to be used based on activity enablement.
public static  booleanallowUseOf(ITriggerPoint triggerPoint, Object object)
     Answers whether a given contribution is allowed to be used based on activity enablement.
final public static  StringcreateUnifiedId(IPluginContribution contribution)
     Utility method to create a String containing the plugin and extension ids of a contribution.
public static  SetexpandActivityDependencies(Set baseActivities)
     Return the expanded activities for the given activity set.
final public static  booleanfilterItem(Object object)
     Answers whether the provided object should be filtered from the UI based on activity state.
public static  SetgetActivityIdsForCategory(ICategory category)
     Return the activities directly required by a given category.
final public static  SetgetContainedCategories(IActivityManager activityManager, String categoryId)
     Return a list of category ids that are implicitly contained within the given category.
public static  SetgetDisabledCategories(IActivityManager activityManager, String categoryId)
     Return a list of category ids that will become implicity disabled if the given category becomes disabled Note that the set returned by this set represents the delta of categories that would be enabled - if the category is already enabled then it is omitted.
public static  SetgetEnabledCategories(IActivityManager activityManager, String categoryId)
     Return a list of category ids that will become implicity enabled if the given category becomes enabled Note that the set returned by this set represents the delta of categories that would be enabled - if the category is already enabled then it is omitted.
public static  SetgetEnabledCategories(IActivityManager activityManager)
     Return the set of enabled categories.
public static  SetgetEnabledCategoriesForActivity(IActivityManager activityManager, String activityId)
     Return the number of enabled categories that this activity belongs to.
public static  IIdentifiergetIdentifier(IPluginContribution contribution)
     Return the identifier that maps to the given contribution.
public static  SetgetPartiallyEnabledCategories(IActivityManager activityManager)
     Return the set of partially enabled categories.
public static  SetgetRequiredActivityIds(String activityId)
     Return the activities required for this activity.
public static  booleanisEnabled(IActivityManager activityManager, String categoryId)
     Returns whether the given category is enabled.
final public static  booleanisFiltering()
     Returns whether the UI is set up to filter contributions.
public static  booleanisPartiallyEnabled(IActivityManager activityManager, String categoryId)
     Returns whether the given category is partially enabled.
public static  ICategory[]resolveCategories(IMutableActivityManager activityManager, Set categoryIds)
     Resolve the collection of category ids to an array of ICategory objects.



Method Detail
allowUseOf
public static boolean allowUseOf(Object object)(Code)
Answers whether a given contribution is allowed to be used based on activity enablement. If it is currently disabled, then a dialog is opened and the user is prompted to activate the requried activities. If the user declines their activation then false is returned. In all other cases true is returned.
Parameters:
  object - the contribution to test. whether the contribution is allowed to be used based on activityenablement.
See Also:   WorkbenchActivityHelper.allowUseOf(ITriggerPoint,Object)



allowUseOf
public static boolean allowUseOf(ITriggerPoint triggerPoint, Object object)(Code)
Answers whether a given contribution is allowed to be used based on activity enablement. If it is currently disabled, then a dialog is opened and the user is prompted to activate the requried activities. If the user declines their activation then false is returned. In all other cases true is returned.
Parameters:
  triggerPoint - the trigger point being hit
Parameters:
  object - the contribution to test. whether the contribution is allowed to be used based on activityenablement.



createUnifiedId
final public static String createUnifiedId(IPluginContribution contribution)(Code)
Utility method to create a String containing the plugin and extension ids of a contribution. This will have the form
 pluginId / extensionId
 
. If the IPluginContribution does not define a plugin id then the extension id alone is returned.
Parameters:
  contribution - the contribution to use the unified id



expandActivityDependencies
public static Set expandActivityDependencies(Set baseActivities)(Code)
Return the expanded activities for the given activity set. This will resolve all activity requirement bindings.
Parameters:
  baseActivities - the set of activities to expand the expanded activities
since:
   3.1



filterItem
final public static boolean filterItem(Object object)(Code)
Answers whether the provided object should be filtered from the UI based on activity state. Returns false except when the object is an instance of IPluginContribution whos unified id matches an IIdentifier that is currently disabled.
Parameters:
  object - the object to test whether the object should be filtered
See Also:   WorkbenchActivityHelper.createUnifiedId(IPluginContribution)



getActivityIdsForCategory
public static Set getActivityIdsForCategory(ICategory category)(Code)
Return the activities directly required by a given category.
Parameters:
  category - the category the activities directly required by a given category
since:
   3.1



getContainedCategories
final public static Set getContainedCategories(IActivityManager activityManager, String categoryId)(Code)
Return a list of category ids that are implicitly contained within the given category.
Parameters:
  activityManager - the activity manager to test agaisnt
Parameters:
  categoryId - the category to be enabled a list of category ids that will become implicity enabled if thegiven category becomes enabled
since:
   3.1



getDisabledCategories
public static Set getDisabledCategories(IActivityManager activityManager, String categoryId)(Code)
Return a list of category ids that will become implicity disabled if the given category becomes disabled Note that the set returned by this set represents the delta of categories that would be enabled - if the category is already enabled then it is omitted.
Parameters:
  activityManager - the activity manager to test against
Parameters:
  categoryId - the category to be enabled a list of category ids that will become implicity enabled if thegiven category becomes enabled
since:
   3.1



getEnabledCategories
public static Set getEnabledCategories(IActivityManager activityManager, String categoryId)(Code)
Return a list of category ids that will become implicity enabled if the given category becomes enabled Note that the set returned by this set represents the delta of categories that would be enabled - if the category is already enabled then it is omitted.
Parameters:
  activityManager - the activity manager to test against
Parameters:
  categoryId - the category to be enabled a list of category ids that will become implicity enabled if thegiven category becomes enabled
since:
   3.1



getEnabledCategories
public static Set getEnabledCategories(IActivityManager activityManager)(Code)
Return the set of enabled categories. An enabled category is one in which all contained activities are enabled.
Parameters:
  activityManager - the activity manager to test against the set of enabled categories.
since:
   3.1



getEnabledCategoriesForActivity
public static Set getEnabledCategoriesForActivity(IActivityManager activityManager, String activityId)(Code)
Return the number of enabled categories that this activity belongs to.
Parameters:
  activityManager - the activity manager to test against *
Parameters:
  activityId - the activity id to query on the set of enabled category ids that this activity belongs to
since:
   3.1



getIdentifier
public static IIdentifier getIdentifier(IPluginContribution contribution)(Code)
Return the identifier that maps to the given contribution.
Parameters:
  contribution - the contribution the identifier
since:
   3.1



getPartiallyEnabledCategories
public static Set getPartiallyEnabledCategories(IActivityManager activityManager)(Code)
Return the set of partially enabled categories.
Parameters:
  activityManager - the activity manager to test against the set of partially enabled categories
since:
   3.2



getRequiredActivityIds
public static Set getRequiredActivityIds(String activityId)(Code)
Return the activities required for this activity.
Parameters:
  activityId - the activity id the activities required for this activity
since:
   3.1



isEnabled
public static boolean isEnabled(IActivityManager activityManager, String categoryId)(Code)
Returns whether the given category is enabled. A category is enabled if all of its activities are enabled.
Parameters:
  activityManager - the activity manager to test against
Parameters:
  categoryId - the category id whether the category is enabled
since:
   3.1



isFiltering
final public static boolean isFiltering()(Code)
Returns whether the UI is set up to filter contributions. This is the case if there are defined activities. whether the UI is set up to filter contributions



isPartiallyEnabled
public static boolean isPartiallyEnabled(IActivityManager activityManager, String categoryId)(Code)
Returns whether the given category is partially enabled. A partially enabled category is one in which the number of enabled activites is both non-zero and less than the total number of activities in the category.
Parameters:
  activityManager - the activity manager to test against
Parameters:
  categoryId - the category id whether the category is enabled
since:
   3.2



resolveCategories
public static ICategory[] resolveCategories(IMutableActivityManager activityManager, Set categoryIds)(Code)
Resolve the collection of category ids to an array of ICategory objects.
Parameters:
  activityManager - the activity manager to test against
Parameters:
  categoryIds - the category ids the array of category ids resolved to ICategoryobjects
since:
   3.1



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.