Eclipse Platform
Release 3.1

org.eclipse.ui.activities
Class WorkbenchActivityHelper

java.lang.Object
  extended byorg.eclipse.ui.activities.WorkbenchActivityHelper

public final class WorkbenchActivityHelper
extends Object

A utility class that contains helpful methods for interacting with the activities API.

Since:
3.0

Method Summary
static boolean allowUseOf(ITriggerPoint triggerPoint, Object object)
          Answers whether a given contribution is allowed to be used based on activity enablement.
static boolean allowUseOf(Object object)
          Deprecated.  
static String createUnifiedId(IPluginContribution contribution)
          Utility method to create a String containing the plugin and extension ids of a contribution.
static Set expandActivityDependencies(Set baseActivities)
          Return the expanded activities for the given activity set.
static boolean filterItem(Object object)
          Answers whether the provided object should be filtered from the UI based on activity state.
static Set getActivityIdsForCategory(ICategory category)
          Return the activities directly required by a given category.
static Set getContainedCategories(IActivityManager activityManager, String categoryId)
          Return a list of category ids that are implicitly contained within the given category.
static Set getDisabledCategories(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.
static Set getEnabledCategories(IActivityManager activityManager)
          Return the set of enabled categories.
static Set getEnabledCategories(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.
static Set getEnabledCategoriesForActivity(IActivityManager activityManager, String activityId)
          Return the number of enabled categories that this activity belongs to.
static IIdentifier getIdentifier(IPluginContribution contribution)
          Return the identifier that maps to the given contribution.
static Set getRequiredActivityIds(String activityId)
          Return the activities required for this activity.
static boolean isEnabled(IActivityManager activityManager, String categoryId)
          Returns whether the given category is enabled.
static boolean isFiltering()
          Returns whether the UI is set up to filter contributions.
static ICategory[] resolveCategories(IMutableActivityManager activityManager, Set categoryIds)
          Resolve the collection of category ids to an array of ICategory objects.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Method Detail

getIdentifier

public static IIdentifier getIdentifier(IPluginContribution contribution)
Return the identifier that maps to the given contribution.

Parameters:
contribution - the contribution
Returns:
the identifier
Since:
3.1

allowUseOf

public static boolean allowUseOf(Object object)
Deprecated.  

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.
Returns:
whether the contribution is allowed to be used based on activity enablement.
See Also:
allowUseOf(ITriggerPoint, Object)

allowUseOf

public static boolean allowUseOf(ITriggerPoint triggerPoint,
                                 Object object)
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
object - the contribution to test.
Returns:
whether the contribution is allowed to be used based on activity enablement.

createUnifiedId

public static final String createUnifiedId(IPluginContribution contribution)
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
Returns:
the unified id

filterItem

public static final boolean filterItem(Object object)
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
Returns:
whether the object should be filtered
See Also:
createUnifiedId(IPluginContribution)

isFiltering

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

Returns:
whether the UI is set up to filter contributions

getEnabledCategories

public static Set getEnabledCategories(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.

Parameters:
activityManager - the activity manager to test against
categoryId - the category to be enabled
Returns:
a list of category ids that will become implicity enabled if the given category becomes enabled
Since:
3.1

expandActivityDependencies

public static Set expandActivityDependencies(Set baseActivities)
Return the expanded activities for the given activity set. This will resolve all activity requirement bindings.

Parameters:
baseActivities - the set of activities to expand
Returns:
the expanded activities
Since:
3.1

getRequiredActivityIds

public static Set getRequiredActivityIds(String activityId)
Return the activities required for this activity.

Parameters:
activityId - the activity id
Returns:
the activities required for this activity
Since:
3.1

getActivityIdsForCategory

public static Set getActivityIdsForCategory(ICategory category)
Return the activities directly required by a given category.

Parameters:
category - the category
Returns:
the activities directly required by a given category
Since:
3.1

getDisabledCategories

public static Set getDisabledCategories(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.

Parameters:
activityManager - the activity manager to test against *
categoryId - the category to be enabled
Returns:
a list of category ids that will become implicity enabled if the given category becomes enabled
Since:
3.1

getContainedCategories

public static final Set getContainedCategories(IActivityManager activityManager,
                                               String categoryId)
Return a list of category ids that are implicitly contained within the given category.

Parameters:
activityManager - the activity manager to test agaisnt
categoryId - the category to be enabled
Returns:
a list of category ids that will become implicity enabled if the given category becomes enabled
Since:
3.1

getEnabledCategories

public static Set getEnabledCategories(IActivityManager activityManager)
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
Returns:
the set of enabled categories.
Since:
3.1

getEnabledCategoriesForActivity

public static Set getEnabledCategoriesForActivity(IActivityManager activityManager,
                                                  String activityId)
Return the number of enabled categories that this activity belongs to.

Parameters:
activityManager - the activity manager to test against *
activityId - the activity id to query on
Returns:
the set of enabled category ids that this activity belongs to
Since:
3.1

isEnabled

public static boolean isEnabled(IActivityManager activityManager,
                                String categoryId)
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
categoryId - the category id
Returns:
whether the category is enabled
Since:
3.1

resolveCategories

public static ICategory[] resolveCategories(IMutableActivityManager activityManager,
                                            Set categoryIds)
Resolve the collection of category ids to an array of ICategory objects.

Parameters:
activityManager - the activity manager to test against
categoryIds - the category ids
Returns:
the array of category ids resolved to ICategory objects
Since:
3.1

Eclipse Platform
Release 3.1

Guidelines for using Eclipse APIs.

Copyright (c) IBM Corp. and others 2000, 2005. All rights reserved.