Bug 255456 - [DND] IDragAndDropService needs to improve its javadoc
Summary: [DND] IDragAndDropService needs to improve its javadoc
Status: NEW
Alias: None
Product: Platform
Classification: Eclipse Project
Component: UI (show other bugs)
Version: 3.5   Edit
Hardware: All All
: P3 normal (vote)
Target Milestone: ---   Edit
Assignee: Platform UI Triaged CLA
QA Contact:
URL:
Whiteboard:
Keywords:
Depends on:
Blocks:
 
Reported: 2008-11-16 08:30 EST by Remy Suen CLA
Modified: 2019-09-06 15:37 EDT (History)
0 users

See Also:


Attachments

Note You need to log in before you can comment on or make changes to this bug.
Description Remy Suen CLA 2008-11-16 08:30:23 EST
IDragAndDropService's class level javadoc states the following:

"Authors should access this service using the PartSite's getService method, passing this interface as the argument."

It is implied that the scope of this service is only available at the part site level (similar to IWorkbenchSiteProgressService) but this is not made explicit. This should be corrected. It should be noted that it is only for editors and not for views (which is somewhat implied in its methods' javadocs).

Its addMergedDropTarget(Control, int, Transfer[], DropTargetListener) method states the following:

"NOTE: Site authors must use this method to add drop behaviour; directly adding drop targets using SWT onto a site will cause the standard site behaviour (i.e. dragging files / markers into the EditorSite...) to not work when that editor is active."

It is not clear what "authors" means in this context (or is this a general Eclipse "word")? The word "author" seems to imply that it's for people that are creating/implementing part sites. However, this interpretation appears to contradict IWorkbenchSite and all its subinterfaces' specification as they are all spec'ed with @noimplement.
Comment 1 Eric Moffatt CLA 2008-11-24 11:03:35 EST
See also bug 255457.
Comment 2 Eric Moffatt CLA 2008-11-24 11:05:01 EST
See bug 255457.
Comment 3 Eclipse Webmaster CLA 2019-09-06 15:30:54 EDT
This bug hasn't had any activity in quite some time. Maybe the problem got resolved, was a duplicate of something else, or became less pressing for some reason - or maybe it's still relevant but just hasn't been looked at yet.

If you have further information on the current state of the bug, please add it. The information can be, for example, that the problem still occurs, that you still want the feature, that more information is needed, or that the bug is (for whatever reason) no longer relevant.
Comment 4 Eclipse Webmaster CLA 2019-09-06 15:37:04 EDT
This bug hasn't had any activity in quite some time. Maybe the problem got resolved, was a duplicate of something else, or became less pressing for some reason - or maybe it's still relevant but just hasn't been looked at yet.

If you have further information on the current state of the bug, please add it. The information can be, for example, that the problem still occurs, that you still want the feature, that more information is needed, or that the bug is (for whatever reason) no longer relevant.