platform-ui-home/rcp-proposal/rich_client_platform_facilities.html

Parent Directory Parent Directory | Revision Log Revision Log


Revision 1.19 - (view) (download) (as text)

1 : sarsenau 1.1 <html>
2 :    
3 :     <head>
4 :     <meta http-equiv="Content-Language" content="en-us">
5 :     <meta http-equiv="Content-Type" content="text/html; charset=windows-1252">
6 :     <meta name="GENERATOR" content="Microsoft FrontPage 4.0">
7 :     <meta name="ProgId" content="FrontPage.Editor.Document">
8 : nick 1.14 <link rel="stylesheet" href="http://dev.eclipse.org/default_style.css" type="text/css">
9 : sarsenau 1.1 <title>Rich Client Platform Facilities</title>
10 :     </head>
11 :    
12 :     <body>
13 :    
14 :     <h1>Eclipse Rich Client Platform UI</h1>
15 :     <p>The rich client platform (RCP) is a major theme for Eclipse 3.0. This is the
16 :     main plan item:</p>
17 :     <blockquote>
18 :     <p><b>Enable Eclipse to be used as a rich client platform.</b> Eclipse was
19 :     designed as a universal tool integration platform. However, many facets and
20 :     components of Eclipse are not particularly specific to IDEs and would make
21 :     equal sense in non-IDE applications (e.g., window-based GUI, plug-ins, help
22 :     system, update manager). The Eclipse Platform should factor out and segregate
23 :     IDE-specific facilities (e.g., everything having to do with workspace
24 :     resources) so that a subset of it can be used as a rich client platform for
25 :     building applications. [Platform Core, Platform UI, Platform Update] [Theme:
26 :     Rich client platform] (<a href="http://bugs.eclipse.org/bugs/show_bug.cgi?id=36967">36967</a>)</p>
27 :     </blockquote>
28 :     <p>Additional plan items cover other important issues such as adding and
29 : jeem 1.2 removing plug-ins dynamically.</p>
30 :     <p>Note: The following documents are under active development and are being
31 :     updated by the Eclipse team on an ongoing basis to reflect the latest thinking.
32 :     The goal is to carve a UI for the rich client platform out of the Eclipse
33 :     Platform UI. By the nature of this kind of work, it's difficult to plan
34 :     everything in advance of actually doing the work; so we're not even going to
35 : jeem 1.6 try. Instead, we are revising these documents as we incrementally make our way
36 :     towards a satisfactory solution:</p>
37 : jeem 1.2 <ul>
38 : jeem 1.6 <li><a href="generic_workbench_summary.html">Executive Summary of the Eclipse
39 :     Rich Client Platform UI</a> (includes excerpts from the documents below)</li>
40 : nick 1.5 </ul>
41 : jeem 1.9 These changes are covered in the <a href="http://dev.eclipse.org/viewcvs/index.cgi/~checkout~/org.eclipse.platform.doc.isv/porting/eclipse_3_0_porting_guide.html">Eclipse
42 :     3.0 Porting Guide</a>. The original porting for the generic workbench is <a href="generic_workbench_porting_guide.html">here</a>.
43 : nick 1.16 <h4>FAQs</h4>
44 : nick 1.13 <ul>
45 :     <li><a href="faq.html">Rich Client Platform FAQ</a></li>
46 :     </ul>
47 : nick 1.16 <h4>Articles</h4>
48 : jeem 1.7 <ul>
49 : nick 1.15 <li><a href="http://dev.eclipse.org/viewcvs/index.cgi/%7echeckout%7e/org.eclipse.ui.tutorials.rcp.part1/html/tutorial1.html">Rich Client Platform Tutorial - Part 1</a></li>
50 :     <li><a href="http://dev.eclipse.org/viewcvs/index.cgi/%7echeckout%7e/org.eclipse.ui.tutorials.rcp.part2/html/tutorial2.html">Rich Client Platform Tutorial - Part 2</a></li>
51 :     <li><a href="http://dev.eclipse.org/viewcvs/index.cgi/%7echeckout%7e/org.eclipse.ui.tutorials.rcp.part3/html/tutorial3.html">Rich Client Platform Tutorial - Part 3</a></li>
52 : jeem 1.7 </ul>
53 : nick 1.16 <h4>Design documents</h4>
54 : nick 1.5 <ul>
55 : jeem 1.2 <li><a href="generic_workbench_direction.html">Statement of Direction for the
56 :     Eclipse Rich Client Platform UI</a></li>
57 : jeem 1.4 <li><a href="generic_workbench_approach.html">Eclipse Rich Client Platform UI
58 :     - Proposed Approach</a></li>
59 : jeem 1.2 <li><a href="generic_workbench_overview.html">Overview of the Generic
60 : jeem 1.6 Workbench</a></li>
61 : jeem 1.2 <li><a href="generic_workbench_structure.html">Generic Workbench Plug-in
62 : jeem 1.6 Structure</a></li>
63 : sarsenau 1.1 </ul>
64 : nick 1.19 <h4>Browser Example</h4>
65 : nick 1.16 The RCP Browser Example is an example of a simple RCP app.
66 :     <p>
67 : nick 1.19 To load the browser example source into your workspace, load project <a href="http://dev.eclipse.org/viewcvs/index.cgi/%7Echeckout%7E/org.eclipse.ui.examples.rcp.browser">org.eclipse.ui.examples.rcp.browser</a> from the Eclipse CVS repository.
68 :     <br>
69 :     Click <a href="http://dev.eclipse.org/cvshowto.html">here</a> for instructions on using CVS with Eclipse.
70 :     <p>
71 :     For instructions on running the example, see the
72 :     <a href="http://dev.eclipse.org/viewcvs/index.cgi/%7Echeckout%7E/org.eclipse.ui.examples.rcp.browser/readme.html">readme file</a>.
73 :     <p>
74 :     To run the example in binary form (last updated June 11, 2004 for the 3.0 RC2 build):
75 : nick 1.16 <ol>
76 : nick 1.17 <li>Download the RCP Runtime build from the <a href="http://eclipse.org/downloads/index.php">Downloads</a> page, and extract it to a folder such as <em>c:\browser-example</em>.
77 :     <li>Download the <a href="org.eclipse.ui.examples.rcp.browser_3.0.0.zip">browser plugin zip</a> and extract it to the eclipse/plugins subfolder.
78 : nick 1.16 <li>Replace the eclipse/configuration/config.ini file with the appropriate config file from the browser plugin. For example, on Windows,
79 :     copy eclipse/plugins/org.eclipse.ui.examples.rcp.browser_3.0.0/config_win32.ini to eclipse/configuration/config.ini .
80 :     <li>Run: <code>eclipse.exe</code>.
81 :     </ol>
82 :     </p>
83 : nick 1.19 <h4>Text Editor Example</h4>
84 :     The RCP Text Editor Example is an example of a simple RCP app that makes use of the text editing infrastructure (an optional RCP component).
85 :     <br>
86 :     Click <a href="examples/texteditor/rcp_texteditor_ex.html">here</a> for the documentation for the example.
87 : nick 1.16 <p>
88 : nick 1.19 To load the text editor example source into your workspace:
89 :     <ol>
90 :     <li> Click <a href="examples/texteditor/org.eclipse.ui.workbench.rcp.texteditor.zip">here</a> to download a zip file containing the source
91 :     for the example.
92 :     <li>Extract the zip to your Eclipse SDK workspace directory (your host workspace).
93 :     <li>Choose File > Import > Existing Project Into Workspace.
94 :     <li>Use the Browse button to select the <b>org.eclipse.ui.workbench.rcp.texteditor</b> directory extracted above.
95 :     <li>Press Finish.
96 :     </ol>
97 :     To run the example:
98 :     <ol>
99 :     <li>Choose Run > Debug...
100 :     <li>Under Run-time Workbench, there should be two new configurations: RCP Text Editor (gtk) and RCP Text Editor (win32).
101 :     <li>Edit the appropriate one as follows:
102 :     <ul>
103 :     <li>on the Arguments tab, change the workspace location to some directory with write access (different than your host workspace, and different than the workspace used for other launch configs);
104 :     <li>in the Program to Run group, ensure that the application <b>org.eclipse.ui.workbench.rcp.texteditor.application</b> is selected;
105 :     <li>on the Plug-ins tab, press Deselect All, check org.eclipse.ui.workbench.rcp.texteditor, press Add Required Plug-ins, and also check org.eclipse.update.configurator.
106 :     </ul>
107 :     <li>Press Debug.
108 :     <li>When the RCP Text Editor Example window opens, use File > Open to open a plain text, .xml, or .html file.
109 :     </ol>
110 :    
111 : nick 1.16 <p>
112 :     </p>
113 : sarsenau 1.1 </body>
114 :    
115 :     </html>