This Bugzilla instance is deprecated, and most Eclipse projects now use GitHub or Eclipse GitLab. Please see the deprecation plan for details.
Bug 134270 - [EFS] FileSystemContributor API has insuffecient information
Summary: [EFS] FileSystemContributor API has insuffecient information
Status: RESOLVED WONTFIX
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.3 M5   Edit
Assignee: Platform-UI-Inbox CLA
QA Contact:
URL:
Whiteboard:
Keywords: api
Depends on:
Blocks: 133867 137879 213621
  Show dependency tree
 
Reported: 2006-03-31 10:40 EST by Tod Creasey CLA
Modified: 2009-08-30 02:24 EDT (History)
12 users (show)

See Also:


Attachments
Patch using the new API (52.35 KB, patch)
2006-04-03 11:31 EDT, Tod Creasey CLA
no flags Details | Diff

Note You need to log in before you can comment on or make changes to this bug.
Description Tod Creasey CLA 2006-03-31 10:40:20 EST
M6

The FileSystemContributor has a method browseFileSystem(String initialPath, Shell shell) which is used to prompt for a location using the browse button.

This method does not give suffecient information. In many cases (including our default case) you need to know the resource type you want to browse for and you may want some other information to seed your browsing method with (a descrption message in our case).

I am proposing that we deprecate the existing API 

/**
 * Browse the file system for a URI to display to the user.
 * @param initialPath The path to initialize the selection with.
 * @param shell The shell to parent any required dialogs from
 * @return URI if the file system is browsed successfully or
 * <code>null</code> if a URI could not be determined.
*/
	
public abstract URI browseFileSystem(String initialPath, Shell shell);

and replace it with

/**
 * Browse the file system for a URI to display to the user.
 * @param initialPath The path to initialize the selection with.
 * @param shell The shell to parent any required dialogs from
 * @param the {@link IResource} type to browse for. One of {@link Resource#PROJECT},
 * 	{@link IResource#FOLDER},{@link IResource#FILE},{@link IResource#ROOT}
 * @return URI if the file system is browsed successfully or
 * <code>null</code> if a URI could not be determined.
 */
	
public URI browseFileSystem(String initialPath, Shell shell,int type,Object properties)
Comment 1 Tod Creasey CLA 2006-04-03 11:30:38 EDT
After talking to John we have decided on a simpler API addition and no deprecation of existing API

/**
	 * Browse the file system for a URI to display to the user.
	 * 
	 * @param shell
	 *            The shell to parent any required dialogs from
	 * @param properties
	 *            The {@link Map} of properties used for browsing.
	 * @return URI if the file system is browsed successfully or
	 *         <code>null</code> if a URI could not be determined.
	 * @see #MESSAGE_PROPERTY
	 * @see #INITIAL_PATH_PROPERTY
	 * @see #FILE_NAME_PROPERTY
	 * @see #TYPE_PROPERTY
	 */
	public URI browseFileSystem(Shell shell, Map properties))
Comment 2 Tod Creasey CLA 2006-04-03 11:31:15 EDT
Created attachment 37537 [details]
Patch using the new API
Comment 3 Tod Creasey CLA 2006-04-05 10:04:25 EDT
Deferred to 3.3 until we have more clients with input so that we can make better API.
Comment 4 John Arthorne CLA 2006-06-23 13:47:15 EDT
*** Bug 137879 has been marked as a duplicate of this bug. ***
Comment 5 Tod Creasey CLA 2006-11-29 15:18:42 EST
Does anyone think we should do anything different than the suggested new API? The API freeze is M5 so this needs to be commited before then.
Comment 6 Tod Creasey CLA 2007-01-16 15:01:12 EST
I am going to hold off on this as no one seems to have an opinion on whether or not we should proceed.
Comment 7 Denis Roy CLA 2009-08-30 02:24:04 EDT
As of now 'LATER' and 'REMIND' resolutions are no longer supported.
Please reopen this bug if it is still valid for you.