Bug 135991 - [CommonNavigator] Allow Context Menu Wizards to be filtered by id
Summary: [CommonNavigator] Allow Context Menu Wizards to be filtered by id
Status: RESOLVED FIXED
Alias: None
Product: Platform
Classification: Eclipse Project
Component: UI (show other bugs)
Version: 3.2   Edit
Hardware: PC Windows XP
: P3 normal (vote)
Target Milestone: 3.2 RC1   Edit
Assignee: Michael D. Elder CLA
QA Contact:
URL:
Whiteboard:
Keywords: api
Depends on:
Blocks:
 
Reported: 2006-04-10 15:46 EDT by Michael D. Elder CLA
Modified: 2006-04-15 21:40 EDT (History)
2 users (show)

See Also:


Attachments
The changes for navigator and navigator.resources (20.97 KB, patch)
2006-04-10 15:46 EDT, Michael D. Elder CLA
no flags Details | Diff

Note You need to log in before you can comment on or make changes to this bug.
Description Michael D. Elder CLA 2006-04-10 15:46:01 EDT
This change requires a minor API change:

Additional constructor to WizardActionGroup:

	/**
	 * 
	 * @param aWindow
	 *            The window that will be used to acquire a Shell and a
	 *            Selection Service
	 * @param aWizardRegistry
	 *            The wizard registry will be used to locate the correct wizard
	 *            descriptions.
	 * @param aType
	 *            Indicates the value of the type attribute of the commonWizard
	 *            extension point. Use any of the TYPE_XXX constants defined on
	 *            this class.
	 * @param aContentService 
	 * 			 The content service to use when deciding visibility.         
	 * @see PlatformUI#getWorkbench()
	 * @see IWorkbench#getNewWizardRegistry()
	 * @see IWorkbench#getImportWizardRegistry()
	 * @see IWorkbench#getExportWizardRegistry()
	 */
	public WizardActionGroup(IWorkbenchWindow aWindow,
			IWizardRegistry aWizardRegistry, String aType, INavigatorContentService aContentService) {
		this(aWindow, aWizardRegistry, aType);
		contentService = aContentService;

	}

Existing clients will not be affected by this API addition.

This change also requires the small modification of the schema:

org.eclipse.ui.navigator.navigatorContent:
   navigatorContent:
       + commonWizard (0..*)

Existing extensions will not be broken. The change here allows a client to group commonWizard extensions with a navigatorContent extension. Clients may choose not to take advantage of this feature. 

This is a low risk change that will remove options from the menu when the user has indicated they do not want to see content of a particular type. Existing extensions which take advantage of the current approach will not be broken by this change. I think the improvement in the UI experience merits its approval, even at this stage in the game.
Comment 1 Michael D. Elder CLA 2006-04-10 15:46:32 EDT
Created attachment 38206 [details]
The changes for navigator and navigator.resources
Comment 2 Boris Bokowski CLA 2006-04-11 11:07:35 EDT
The API change is non-breaking and looks OK to me.
Comment 3 Mike Wilson CLA 2006-04-11 11:08:25 EDT
+1. ok to proceed.
Comment 4 Michael D. Elder CLA 2006-04-11 13:45:44 EDT
Released.