com.ibm.xtools.common.ui.reduction.util

Class EditingCapabilitiesUtil

java.lang.Object

com.ibm.xtools.common.ui.reduction.util.EditingCapabilitiesUtil

public class EditingCapabilitiesUtil
extends java.lang.Object

Utility class to manage the editing capabilities annotation.

Constructor Summary

Constructors

Constructor and Description
EditingCapabilitiesUtil()

Method Summary

Modifier and Type	Method and Description
static void	enableActivities(java.lang.Object context) Enables the editing capabilities in the workbench for the given object.
static java.util.Set<java.lang.String>	getEnabledActivityIds(org.eclipse.emf.ecore.EObject eObject) Gets the enabled activity IDs for the given EObject.
static java.util.Set<java.lang.String>	getEnabledAndRequiredActivityIds(org.eclipse.emf.ecore.EObject eObject) Gets the enabled & required activity IDs for the given EObject.
static java.util.Set<java.lang.String>	getRequiredActivityIds(org.eclipse.emf.ecore.EObject eObject) Gets the required activity IDs for the given EObject.
static java.util.Set<java.lang.String>	getUIReductionActivities() Gets all the activities participating in UI reduction.
static java.util.Set<java.lang.String>	getWorkbenchEnabledActivityIds() Return the set of capabilities that are enabled in the workbench capabilities preferences.
static boolean	hasDisabledEditingCapabilities(org.eclipse.emf.ecore.EObject eObject) Return true if the editing capabilities for the given EObject are disabled.
static boolean	hasEnabledEditingCapabilities(org.eclipse.emf.ecore.EObject eObject) Return true if the editing capabilities for the given EObject are enabled.
static void	reenableActivities() Re-enable the editing capabilities in the workbench for the current active context.
static void	removeEditingCapabilities(org.eclipse.emf.ecore.EObject eObject) Removes the editing capabilities for the given EObject.
static void	setEditingCapabilitiesEnabled(org.eclipse.emf.ecore.EObject eObject, boolean enabled) Enable / disable editing capabilities for the given EObject.
static void	setEnabledActivityIds(org.eclipse.emf.ecore.EObject eObject, java.util.Collection<java.lang.String> enabledActivityIds) Sets the given collection of activity IDs to be enabled for the given EObject.
static void	setRequiredActivityIds(org.eclipse.emf.ecore.EObject eObject, java.util.Collection<java.lang.String> requiredActivityIds) Sets the given collection of activity IDs to be required for the given EObject.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

EditingCapabilitiesUtil

public EditingCapabilitiesUtil()

Method Detail

removeEditingCapabilities

public static void removeEditingCapabilities(org.eclipse.emf.ecore.EObject eObject)

Removes the editing capabilities for the given EObject.

This method differs from disabling editing capabilities through setEditingCapabilitiesEnabled in that none of the enabled or required capabilities are preserved.

Parameters:

eObject - the EObject to remove its editing capabilities

setEditingCapabilitiesEnabled

public static void setEditingCapabilitiesEnabled(org.eclipse.emf.ecore.EObject eObject,
                                                 boolean enabled)

Enable / disable editing capabilities for the given EObject.

Parameters:

eObject - the EObject to enable / disable editing capabilities for

hasEnabledEditingCapabilities

public static boolean hasEnabledEditingCapabilities(org.eclipse.emf.ecore.EObject eObject)

Return true if the editing capabilities for the given EObject are enabled.

Note: If no editing capabilities exist for the object or are disabled, this method will return false.

Parameters:

eObject - the EObject to query

Returns:

true if the editing capabilities for the given EObject are enabled, false otherwise

hasDisabledEditingCapabilities

public static boolean hasDisabledEditingCapabilities(org.eclipse.emf.ecore.EObject eObject)

Return true if the editing capabilities for the given EObject are disabled.

Note: If no editing capabilities exist for the object the state is still considered disabled, however this method will return false.

Parameters:

eObject - the EObject to query

Returns:

true if the editing capabilities for the given EObject are disabled, false otherwise

getEnabledActivityIds

public static java.util.Set<java.lang.String> getEnabledActivityIds(org.eclipse.emf.ecore.EObject eObject)

Gets the enabled activity IDs for the given EObject.

Parameters:

eObject -

Returns:

the enabled activity IDs

getRequiredActivityIds

public static java.util.Set<java.lang.String> getRequiredActivityIds(org.eclipse.emf.ecore.EObject eObject)

Gets the required activity IDs for the given EObject.

Parameters:

eObject -

Returns:

the required activity IDs

getEnabledAndRequiredActivityIds

public static java.util.Set<java.lang.String> getEnabledAndRequiredActivityIds(org.eclipse.emf.ecore.EObject eObject)

Gets the enabled & required activity IDs for the given EObject.

Parameters:

eObject -

Returns:

the enabled & required activity IDs

setEnabledActivityIds

public static void setEnabledActivityIds(org.eclipse.emf.ecore.EObject eObject,
                                         java.util.Collection<java.lang.String> enabledActivityIds)

Sets the given collection of activity IDs to be enabled for the given EObject.

Parameters:

eObject - the EObject to modify

enabledActivityIds - the collection of activity IDs to enabled

setRequiredActivityIds

public static void setRequiredActivityIds(org.eclipse.emf.ecore.EObject eObject,
                                          java.util.Collection<java.lang.String> requiredActivityIds)

Sets the given collection of activity IDs to be required for the given EObject.

Parameters:

eObject - the EObject to modify

requiredActivityIds - the collection of activity IDs to require

getWorkbenchEnabledActivityIds

public static java.util.Set<java.lang.String> getWorkbenchEnabledActivityIds()

Return the set of capabilities that are enabled in the workbench capabilities preferences.

Returns:

the set of workbench capabilities

getUIReductionActivities

public static java.util.Set<java.lang.String> getUIReductionActivities()

Gets all the activities participating in UI reduction.

Returns:

the activities participating in UI reduction.

enableActivities

public static void enableActivities(java.lang.Object context)

Enables the editing capabilities in the workbench for the given object.

Parameters:

context - the context object

reenableActivities

public static void reenableActivities()

Re-enable the editing capabilities in the workbench for the current active context.