Attachment #49931 for bug #156928

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




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;

 * 
 * @since 3.2
 */
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$

		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;
	}
}





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;

					.next();

			if (isVisible(aContentService, descriptor)
					&& descriptor.isEnabledFor(anElement)) {
				descriptorIds.add(descriptor.getWizardId());
			}
		}

					.next();

			if (isVisible(aContentService, descriptor)
					&& descriptor.isEnabledFor(anElement)) {
				descriptors.add(descriptor);
			}
		}

	 * @return True if the descriptor is visible to the given content service.
	 */
	private boolean isVisible(INavigatorContentService aContentService, CommonWizardDescriptor descriptor) {
		return !WorkbenchActivityHelper.filterItem(descriptor) && 
					(aContentService == null || 
							(descriptor.getId() == null || 
									( aContentService.isVisible(descriptor.getId()) && 
											aContentService.isActive(descriptor.getId())
									)
							)
					);
	}
  
	private class CommonWizardRegistry extends NavigatorContentRegistryReader {

Lines 319-325 Link Here

(-)schema/navigatorContent.exsd (-2 / +4 lines)
319	<element name="commonWizard">	319	<element name="commonWizard">
320	<annotation>	320	<annotation>
321	<documentation>	321	<documentation>
322	The extension point provides the ability to contribute to the menu defined by type.	322	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 <b>org.eclipse.ui.activites</b> for more information).
		323	<br><br>
		324	All of the following conditions must be met for a <b>commonWizard</b> item to appear in the menu: (1) The <b>commonWizard</b> is NOT filtered by an Eclipse Capability, (2) The identifier of the <b>commonWizard</b> is NOT null, (3) The associated <b>navigatorContent</b> extension is <i>visible</i> for the current content service (the content service used to initialize the <code>NavigatorActionService</code> or supplied to <code>WizardActionGroup</code>), (4) The associated <b>navigatorContent</b> extension is <i>active</i> for the current content service, and (5) The <b>enablement</b> of the <b>commonWizard</b> returns true for the current selection that was supplied to the context menu.
323	</documentation>	325	</documentation>
324	</annotation>	326	</annotation>
325	<complexType>	327	<complexType>
Lines 360-366 Link Here
360	<attribute name="associatedExtensionId" type="string">	362	<attribute name="associatedExtensionId" type="string">
361	<annotation>	363	<annotation>
362	<documentation>	364	<documentation>
363	A <b>commonWizard</b> may be defined as the nested child of a <b>navigatorContent</b> extension point, in which case the <i>associatedExtensionId</i> is automatically set to the id of its enclosing <b>naviagatorContent</b> element. However, when specified as a top-level extension, a <b>commonWizard</b> may indicate an content extension that it should be associated with explicitly. When a <b>commonWizard</b> is associated with a content extension, it will inherit the <i>visibility</i> and the <i>activation</i> of that content extension.	365	A <b>commonWizard</b> may be defined as the nested child of a <b>navigatorContent</b> extension point, in which case the <i>associatedExtensionId</i> is automatically set to the id of its enclosing <b>naviagatorContent</b> element. However, when specified as a top-level extension, a <b>commonWizard</b> may indicate an content extension that it should be associated with explicitly. When a <b>commonWizard</b> is associated with a content extension, it will inherit the <i>visibility</i> and the <i>activation</i> of that content extension. It will not inherit the <i>enablement</i>; so you must specify an <b>enablement</b> for the wizard menu item to appear.
364	<br><br>	366	<br><br>
365	That is, if the content extension is bound to a Common Navigator (see <b>org.eclipse.ui.navigator.viewer/viewerContentBinding</b>) and the user has the content extension <i>activated</i> either by default or through the "Available Extensions" dialog, then the <b>commonWizard</b> menu option would appear. However, when the user <i>deactivates</i> that content extension, the <b>commonWizard</b> menu option would no longer be shown in the menu.	367	That is, if the content extension is bound to a Common Navigator (see <b>org.eclipse.ui.navigator.viewer/viewerContentBinding</b>) and the user has the content extension <i>activated</i> either by default or through the "Available Extensions" dialog, then the <b>commonWizard</b> menu option would appear. However, when the user <i>deactivates</i> that content extension, the <b>commonWizard</b> menu option would no longer be shown in the menu.
366	<br><br>	368	<br><br>

Return to bug 156928

Lines 20-25 Link Here

(-)src/org/eclipse/ui/internal/navigator/wizards/CommonWizardDescriptorManager.java (-9 / +11 lines)
20		20
21	import org.eclipse.core.runtime.IConfigurationElement;	21	import org.eclipse.core.runtime.IConfigurationElement;
22	import org.eclipse.ui.WorkbenchException;	22	import org.eclipse.ui.WorkbenchException;
		23	import org.eclipse.ui.activities.WorkbenchActivityHelper;
23	import org.eclipse.ui.internal.navigator.NavigatorPlugin;	24	import org.eclipse.ui.internal.navigator.NavigatorPlugin;
24	import org.eclipse.ui.internal.navigator.extensions.NavigatorContentRegistryReader;	25	import org.eclipse.ui.internal.navigator.extensions.NavigatorContentRegistryReader;
25	import org.eclipse.ui.navigator.INavigatorContentService;	26	import org.eclipse.ui.navigator.INavigatorContentService;
Lines 117-123 Link Here
117	.next();	118	.next();
118		119
119	if (isVisible(aContentService, descriptor)	120	if (isVisible(aContentService, descriptor)
120	&& descriptor.isEnabledFor(anElement)) {	121	&& descriptor.isEnabledFor(anElement)) {
121	descriptorIds.add(descriptor.getWizardId());	122	descriptorIds.add(descriptor.getWizardId());
122	}	123	}
123	}	124	}
Lines 154-160 Link Here
154	.next();	155	.next();
155		156
156	if (isVisible(aContentService, descriptor)	157	if (isVisible(aContentService, descriptor)
157	&& descriptor.isEnabledFor(anElement)) {	158	&& descriptor.isEnabledFor(anElement)) {
158	descriptors.add(descriptor);	159	descriptors.add(descriptor);
159	}	160	}
160	}	161	}
Lines 168-180 Link Here
168	* @return True if the descriptor is visible to the given content service.	169	* @return True if the descriptor is visible to the given content service.
169	*/	170	*/
170	private boolean isVisible(INavigatorContentService aContentService, CommonWizardDescriptor descriptor) {	171	private boolean isVisible(INavigatorContentService aContentService, CommonWizardDescriptor descriptor) {
171	return (aContentService == null \|\|	172	return !WorkbenchActivityHelper.filterItem(descriptor) &&
172	(descriptor.getId() == null \|\|	173	(aContentService == null \|\|
173	(aContentService.isVisible(descriptor.getId()) &&	174	(descriptor.getId() == null \|\|
174	aContentService.isActive(descriptor.getId())	175	( aContentService.isVisible(descriptor.getId()) &&
175	)	176	aContentService.isActive(descriptor.getId())
176	)	177	)
177	);	178	)
		179	);
178	}	180	}
179		181
180	private class CommonWizardRegistry extends NavigatorContentRegistryReader {	182	private class CommonWizardRegistry extends NavigatorContentRegistryReader {