Bug 95217 - [Commands] Remove experimental handlerSubmission element from the "org.eclipse.ui.commands" extension point
Summary: [Commands] Remove experimental handlerSubmission element from the "org.eclips...
Status: VERIFIED FIXED
Alias: None
Product: Platform
Classification: Eclipse Project
Component: UI (show other bugs)
Version: 3.1   Edit
Hardware: All All
: P1 normal (vote)
Target Milestone: 3.1 RC1   Edit
Assignee: Douglas Pollock CLA
QA Contact:
URL:
Whiteboard:
Keywords: api
Depends on:
Blocks:
 
Reported: 2005-05-13 15:40 EDT by Douglas Pollock CLA
Modified: 2005-05-26 15:33 EDT (History)
5 users (show)

See Also:


Attachments
Patch to "org.eclipse.core.commands" (1.07 KB, patch)
2005-05-24 14:11 EDT, Douglas Pollock CLA
no flags Details | Diff
Patch to "org.eclipse.ui" (2.57 KB, patch)
2005-05-24 14:12 EDT, Douglas Pollock CLA
no flags Details | Diff
Patch to "org.eclipse.ui.workbench" (6.77 KB, patch)
2005-05-24 14:15 EDT, Douglas Pollock CLA
no flags Details | Diff
Patch to "org.eclipse.platform.doc.isv" (2.02 KB, patch)
2005-05-24 16:05 EDT, Douglas Pollock CLA
no flags Details | Diff

Note You need to log in before you can comment on or make changes to this bug.
Description Douglas Pollock CLA 2005-05-13 15:40:28 EDT
See Bug 95193 for background.

The handlerSubmission element in the "org.eclipse.ui.commands" extension point
was added during the 3.0 development cycle.  It was always marked as
experimental, as was shipped as experimental with 3.0.

Now, a complete replacement for it exists (i.e., the 'org.eclipse.ui.handlers"
extension point) in 3.1.  Is it time to remove the handlerSubmission element
entirely, and make a note in the 3.1 migration guide?
Comment 1 Nick Edgar CLA 2005-05-13 16:11:16 EDT
If it shipped as API in a release, we need to support it.
However if this is going to cause major pain, we can deprecate it and document
it in the migration guide.
Comment 2 Douglas Pollock CLA 2005-05-13 16:13:57 EDT
Jim actually was the one who wanted it removed.
Comment 3 Douglas Pollock CLA 2005-05-13 16:14:18 EDT
Read the background bug.
Comment 4 Nick Edgar CLA 2005-05-13 16:21:40 EDT
Sorry, I missed the background bug, and my initial reaction was the same as yours.
I'm OK with the decision there.
Comment 5 Douglas Pollock CLA 2005-05-24 14:11:51 EDT
Created attachment 21645 [details]
Patch to "org.eclipse.core.commands"

This removes the final keyword from two methods so that the AbstractHandler in
"org.eclipse.ui.workbench" can re-implement them (and thereby extend this
AbstractHandler).
Comment 6 Douglas Pollock CLA 2005-05-24 14:12:57 EDT
Created attachment 21646 [details]
Patch to "org.eclipse.ui"

Removes the handlerSubmission element from the commands extension point.
Comment 7 Douglas Pollock CLA 2005-05-24 14:15:13 EDT
Created attachment 21647 [details]
Patch to "org.eclipse.ui.workbench"

Makes the AbstractHandler in "org.eclipse.ui.workbench" extend the
AbstractHandler in "org.eclipse.core.commands".  This is intended as a response
to Bug 96070 comment #3.
Comment 8 Douglas Pollock CLA 2005-05-24 14:15:55 EDT
I'm looking for approval from my component lead.  Nick?
Comment 9 Nick Edgar CLA 2005-05-24 14:32:33 EDT
+1.  We'll need an entry in the migration guide documenting this change from 3.0.
Comment 10 Douglas Pollock CLA 2005-05-24 16:05:22 EDT
Created attachment 21665 [details]
Patch to "org.eclipse.platform.doc.isv"

A note to the migration guide.
Comment 11 Douglas Pollock CLA 2005-05-25 11:21:57 EDT
Andrea: Can you apply the patch to "org.eclipse.platform.doc.isv"?  I do not
have commit rights to that plug-in.
Comment 12 Andrea CLA 2005-05-25 13:16:44 EDT
I have applied the patch to "org.eclipse.platform.doc.isv".

Thanks,
AC  
Comment 13 Douglas Pollock CLA 2005-05-25 16:24:38 EDT
Patches committed to CVS.
Comment 14 Jim des Rivieres CLA 2005-05-26 09:51:04 EDT
It seems that the API methods core.commands.AbstractHandler.fireHandlerChanged
() and hasListeners() are no longer final. This opens up the possibility that 
any AbstractHandler subclass could override these methods. Was this the 
intent? If so, then they should have subclass contracts that state what 
subclasses are allowed to do with them.
Comment 15 Douglas Pollock CLA 2005-05-26 11:02:51 EDT
It was intentional.  Added additional javadoc to the methods.
Comment 16 Douglas Pollock CLA 2005-05-26 15:33:33 EDT
Verified by looking in the extension point documentation for
org.eclipse.ui.commands.  handlerSubmission is no longer there.