Bug 196258 - some Official Eclipse RCP FAQ answers are now out of date/inaccurate
Summary: some Official Eclipse RCP FAQ answers are now out of date/inaccurate
Status: RESOLVED WONTFIX
Alias: None
Product: Community
Classification: Eclipse Foundation
Component: Wiki (show other bugs)
Version: unspecified   Edit
Hardware: All All
: P3 major (vote)
Target Milestone: ---   Edit
Assignee: Nobody - feel free to take it CLA
QA Contact:
URL: http://wiki.eclipse.org/The_Official_...
Whiteboard:
Keywords: helpwanted
Depends on:
Blocks:
 
Reported: 2007-07-11 23:50 EDT by Mark Powell CLA
Modified: 2008-07-25 16:09 EDT (History)
2 users (show)

See Also:


Attachments

Note You need to log in before you can comment on or make changes to this bug.
Description Mark Powell CLA 2007-07-11 23:50:50 EDT
The Official Eclipse FAQ on the Eclipsepedia Wiki has some out of date items.  In particular, several of the "Generic Editor" and "Workbench IDE" FAQ answers are now erroneous as they refer to classes that no longer exist in 3.3 API.  I am trying to learn how to programmatically open a generic text editor from a file, and these answers would help me a lot if they were updated to Eclipse 3.3. API.

Here are the titles of items I have found to refer to no longer correct API:
# FAQ How do I open an editor programmatically?
# FAQ How do I open an external editor?
# FAQ How do I open an editor on a file in the workspace?
# FAQ How do I open an editor on a file outside the workspace?
Comment 1 Dani Megert CLA 2007-07-12 03:37:15 EDT
I agree that it's outdate. 

>refer to classes that no longer exist in 3.3 API
Which ones?
Comment 2 Mark Powell CLA 2007-07-12 12:10:52 EDT
Well, upon further reading it appears that the classes I thought were no longer around actually are but they are more difficult to find than most.

Classes like FileEditorInput, IFileEditorInput, IStorageEditorInput, etc., that are used in some of these examples are in the org.eclipse.ui.ide plugin, which seems to be discouraged for use in RCP applications.  Further, when I invoke the Open Type action (in Eclipse 3.3) and search for FileEditorInput, IFileEditorInput, and IStorageEditorInput, I don't get them in the search results, which is what first led me to believe that they no longer existed.

Also, I see at least one reference to a method WorkbenchPage.openEditor(EditorInput input).  I don't think that method exists anymore in the API...not without the second argument (String editorId), anyway.

There is a pretty good text editor example here:
http://www.eclipse.org/eclipse/platform-text/development/rcp/examples/texteditor/rcp_texteditor_ex.html

Perhaps reconciling the information from this example with the FAQ answer example would be a good direction to go?
Comment 3 Dani Megert CLA 2007-07-16 05:48:43 EDT
>are in the org.eclipse.ui.ide plugin, which
>seems to be discouraged for use in RCP applications.
This is no longer true as of 3.3 as the problematic portion has been extracted into its own plug-in.

>WorkbenchPage.openEditor(EditorInput input).  I don't think that method exists
>anymore in the API
WorkbenchPage is an internal class - it can changed with each build.

Just to clarify: I also think the doc needs an update. With 3.3 there are now also  APIs to open external files.
Comment 4 Dani Megert CLA 2007-08-09 08:56:21 EDT
>There is a pretty good text editor example here:
>http://www.eclipse.org/eclipse/platform-text/development/rcp/examples/texteditor/rcp_texteditor_ex.html
This one is even better:
http://www.eclipse.org/eclipse/platform-text/development/rcp/examples/index.html

I've updated the Wiki a little bit.
Comment 5 Denis Roy CLA 2007-09-25 13:28:28 EDT
Removing the assignment -- wiki is a community thing.
Comment 6 Eclipse Webmaster CLA 2008-07-16 15:33:09 EDT
It's been almost a year with no updates, is this bug still required or can we close it?

-M.
Comment 7 Eclipse Webmaster CLA 2008-07-25 16:09:56 EDT
Since no one seems to want this bug and the wiki can be updated by any committer closing as wontfix.  If someone wants to fix it they can reopen this bug.

-M.