Attachment 49931 Details for Bug 156928 – Patches CommonWizardDescriptorManager.isVisible() to check the Eclipse Capabilities activation

Some Eclipse Foundation services are deprecated, or will be soon. Please ensure you've read this important communication.

[patch] Patches CommonWizardDescriptorManager.isVisible() to check the Eclipse Capabilities activation

org.eclipse.ui.navigator_bug156928.txt (text/plain), 8.15 KB, created by Michael D. Elder

on 2006-09-12 09:40:37 EDT

(hide)

Description:

Filename:

MIME Type:

Creator: Michael D. Elder

Created: 2006-09-12 09:40:37 EDT

Size: 8.15 KB

patch

obsolete

>### Eclipse Workspace Patch 1.0
>#P org.eclipse.ui.navigator
>Index: src/org/eclipse/ui/internal/navigator/wizards/CommonWizardDescriptor.java
>===================================================================
>RCS file: /home/eclipse/org.eclipse.ui.navigator/src/org/eclipse/ui/internal/navigator/wizards/CommonWizardDescriptor.java,v
>retrieving revision 1.8
>diff -u -r1.8 CommonWizardDescriptor.java
>--- src/org/eclipse/ui/internal/navigator/wizards/CommonWizardDescriptor.java	8 May 2006 20:54:43 -0000	1.8
>+++ src/org/eclipse/ui/internal/navigator/wizards/CommonWizardDescriptor.java	12 Sep 2006 13:43:30 -0000
>@@ -23,6 +23,7 @@
> import org.eclipse.core.runtime.IConfigurationElement;
> import org.eclipse.core.runtime.IStatus;
> import org.eclipse.jface.viewers.IStructuredSelection;
>+import org.eclipse.ui.IPluginContribution;
> import org.eclipse.ui.WorkbenchException;
> import org.eclipse.ui.internal.navigator.NavigatorPlugin;
> import org.eclipse.ui.internal.navigator.extensions.INavigatorContentExtPtConstants;
>@@ -37,7 +38,7 @@
>  * 
>  * @since 3.2
>  */
>-public class CommonWizardDescriptor implements INavigatorContentExtPtConstants {
>+public class CommonWizardDescriptor implements INavigatorContentExtPtConstants, IPluginContribution {
> 	
> 	/** The default menu group id for commonWizards without a menuGroupId attribute. */
> 	public static final String DEFAULT_MENU_GROUP_ID = "all-uncategorized"; //$NON-NLS-1$
>@@ -243,4 +244,17 @@
> 		return "CommonWizardDescriptor["+getId()+", wizardId="+getWizardId()+"]"; //$NON-NLS-1$ //$NON-NLS-2$ //$NON-NLS-3$
> 	}
> 
>+	/* (non-Javadoc)
>+	 * @see org.eclipse.ui.IPluginContribution#getLocalId()
>+	 */
>+	public String getLocalId() {
>+		return getId();
>+	}
>+	
>+	/* (non-Javadoc)
>+	 * @see org.eclipse.ui.IPluginContribution#getPluginId()
>+	 */
>+	public String getPluginId() {
>+        return (configElement != null) ? configElement.getNamespaceIdentifier() : null;
>+	}
> }
>Index: src/org/eclipse/ui/internal/navigator/wizards/CommonWizardDescriptorManager.java
>===================================================================
>RCS file: /home/eclipse/org.eclipse.ui.navigator/src/org/eclipse/ui/internal/navigator/wizards/CommonWizardDescriptorManager.java,v
>retrieving revision 1.7
>diff -u -r1.7 CommonWizardDescriptorManager.java
>--- src/org/eclipse/ui/internal/navigator/wizards/CommonWizardDescriptorManager.java	8 May 2006 20:54:43 -0000	1.7
>+++ src/org/eclipse/ui/internal/navigator/wizards/CommonWizardDescriptorManager.java	12 Sep 2006 13:43:30 -0000
>@@ -20,6 +20,7 @@
> 
> import org.eclipse.core.runtime.IConfigurationElement;
> import org.eclipse.ui.WorkbenchException;
>+import org.eclipse.ui.activities.WorkbenchActivityHelper;
> import org.eclipse.ui.internal.navigator.NavigatorPlugin;
> import org.eclipse.ui.internal.navigator.extensions.NavigatorContentRegistryReader;
> import org.eclipse.ui.navigator.INavigatorContentService;
>@@ -117,7 +118,7 @@
> 					.next();
> 
> 			if (isVisible(aContentService, descriptor)
>-						&& descriptor.isEnabledFor(anElement)) {
>+					&& descriptor.isEnabledFor(anElement)) {
> 				descriptorIds.add(descriptor.getWizardId());
> 			}
> 		}
>@@ -154,7 +155,7 @@
> 					.next();
> 
> 			if (isVisible(aContentService, descriptor)
>-						&& descriptor.isEnabledFor(anElement)) {
>+					&& descriptor.isEnabledFor(anElement)) {
> 				descriptors.add(descriptor);
> 			}
> 		}
>@@ -168,13 +169,14 @@
> 	 * @return True if the descriptor is visible to the given content service.
> 	 */
> 	private boolean isVisible(INavigatorContentService aContentService, CommonWizardDescriptor descriptor) {
>-		return (aContentService == null || 
>-					(descriptor.getId() == null || 
>-						(aContentService.isVisible(descriptor.getId()) && 
>-							aContentService.isActive(descriptor.getId())
>-						)
>-					)
>-				);
>+		return !WorkbenchActivityHelper.filterItem(descriptor) && 
>+					(aContentService == null || 
>+							(descriptor.getId() == null || 
>+									( aContentService.isVisible(descriptor.getId()) && 
>+											aContentService.isActive(descriptor.getId())
>+									)
>+							)
>+					);
> 	}
>   
> 	private class CommonWizardRegistry extends NavigatorContentRegistryReader {
>Index: schema/navigatorContent.exsd
>===================================================================
>RCS file: /home/eclipse/org.eclipse.ui.navigator/schema/navigatorContent.exsd,v
>retrieving revision 1.31.6.2
>diff -u -r1.31.6.2 navigatorContent.exsd
>--- schema/navigatorContent.exsd	12 Jul 2006 21:37:50 -0000	1.31.6.2
>+++ schema/navigatorContent.exsd	12 Sep 2006 13:43:30 -0000
>@@ -319,7 +319,9 @@
>    <element name="commonWizard">
>       <annotation>
>          <documentation>
>-            The extension point provides the ability to contribute to the menu defined by type.
>+            Defines a binding between an existing Eclipse New/Import/Export Wizard and a given set of items. Each valid binding determines which menu items will appear in the submenus for New/Import/Export in the context menu of a Common Navigator Viewer. Since Eclipse 3.2.1, the wizard menu items respect Eclipse Capabilities (see &lt;b&gt;org.eclipse.ui.activites&lt;/b&gt; for more information). 
>+&lt;br&gt;&lt;br&gt;
>+All of the following conditions must be met for a &lt;b&gt;commonWizard&lt;/b&gt; item to appear in the menu: (1) The &lt;b&gt;commonWizard&lt;/b&gt; is NOT filtered by an Eclipse Capability, (2) The identifier of the &lt;b&gt;commonWizard&lt;/b&gt; is NOT null, (3) The associated &lt;b&gt;navigatorContent&lt;/b&gt; extension is &lt;i&gt;visible&lt;/i&gt; for the current content service (the content service used to initialize the &lt;code&gt;NavigatorActionService&lt;/code&gt; or supplied to &lt;code&gt;WizardActionGroup&lt;/code&gt;), (4) The associated &lt;b&gt;navigatorContent&lt;/b&gt; extension is &lt;i&gt;active&lt;/i&gt; for the current content service, and (5) The &lt;b&gt;enablement&lt;/b&gt; of the &lt;b&gt;commonWizard&lt;/b&gt; returns true for the current selection that was supplied to the context menu.
>          </documentation>
>       </annotation>
>       <complexType>
>@@ -360,7 +362,7 @@
>          <attribute name="associatedExtensionId" type="string">
>             <annotation>
>                <documentation>
>-                  A &lt;b&gt;commonWizard&lt;/b&gt; may be defined as the nested child of a &lt;b&gt;navigatorContent&lt;/b&gt; extension point, in which case the &lt;i&gt;associatedExtensionId&lt;/i&gt; is automatically set to the id of its enclosing &lt;b&gt;naviagatorContent&lt;/b&gt; element. However, when specified as a top-level extension, a &lt;b&gt;commonWizard&lt;/b&gt; may indicate an content extension that it should be associated with explicitly. When a &lt;b&gt;commonWizard&lt;/b&gt; is associated with a content extension, it will inherit the &lt;i&gt;visibility&lt;/i&gt; and the &lt;i&gt;activation&lt;/i&gt; of that content extension. 
>+                  A &lt;b&gt;commonWizard&lt;/b&gt; may be defined as the nested child of a &lt;b&gt;navigatorContent&lt;/b&gt; extension point, in which case the &lt;i&gt;associatedExtensionId&lt;/i&gt; is automatically set to the id of its enclosing &lt;b&gt;naviagatorContent&lt;/b&gt; element. However, when specified as a top-level extension, a &lt;b&gt;commonWizard&lt;/b&gt; may indicate an content extension that it should be associated with explicitly. When a &lt;b&gt;commonWizard&lt;/b&gt; is associated with a content extension, it will inherit the &lt;i&gt;visibility&lt;/i&gt; and the &lt;i&gt;activation&lt;/i&gt; of that content extension. It will not inherit the &lt;i&gt;enablement&lt;/i&gt;; so you must specify an &lt;b&gt;enablement&lt;/b&gt; for the wizard menu item to appear.
> &lt;br&gt;&lt;br&gt;
> That is, if the content extension is bound to a Common Navigator (see &lt;b&gt;org.eclipse.ui.navigator.viewer/viewerContentBinding&lt;/b&gt;) and the user has the content extension &lt;i&gt;activated&lt;/i&gt; either by default or through the &quot;Available Extensions&quot; dialog, then the &lt;b&gt;commonWizard&lt;/b&gt; menu option would appear. However, when the user &lt;i&gt;deactivates&lt;/i&gt; that content extension, the &lt;b&gt;commonWizard&lt;/b&gt; menu option would no longer be shown in the menu.
> &lt;br&gt;&lt;br&gt;

Actions: View | Diff

Attachments on bug 156928: 49876 | 49931 | 49932