blob: 306038d823812f06dacc2eb8b854d17cd51b055e [file] [log] [blame]
<?xml version="1.0" encoding="UTF-8" ?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta name="copyright" content="Copyright (c) 2007, 2022 EclipseSource. This page is made available under license. For full details see the LEGAL in the documentation book that contains this page."/>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"/>
<title>RAP Examples</title>
<link rel="stylesheet" href="../../../PRODUCT_PLUGIN/book.css" type="text/css"/>
</head>
<body>
<h1>RAP Examples</h1>
<h2>Preconditions</h2>
<ul>
<li><a href="setup-ide.html">the RAP Tools are installed</a></li>
<li><a href="target-install.html">a RAP target platform is installed and active</a></li>
</ul>
<p>There are two kinds of example types available.</p>
<h3>Templates</h3>
<p>
To create a RAP plug-in from a template, open the <em>New Project</em> wizard
(<em class="UILabel">File &gt; New &gt; Project</em>) and select
<em class="UILabel">Plug-in Project</em>.
Type a project name (e.g. mail) and click <em class="UILabel">Next</em>.
On the following page, ensure that the option
<em class="UILabel">This plug-in will make contributions to the UI</em>
is selected and no <em class="UILabel">Rich Client Application</em> will be created.
Click <em class="UILabel">Next</em>. Now you should see a page where you can select
a template. Select one of the templates with the RAP prefix (e.g. RAP Mail) and
click <em class="UILabel">Finish</em>.
</p>
<p>
The plug-in comes with a pre-configured launch configuration.
Open the Run dialog (<em class="UILabel">Run &gt; Run Configurations...</em>), select the
<a href="launcher.html#rap-launcher">RAP Launch Configuration</a> that matches your
project name (e.g. mail) and click <em class="UILabel">Run</em> to start.
</p>
<h3>Demo Plug-ins</h3>
<p>
The RAP project comes with three example applications demonstrating the features and
capabilities of RAP.
</p>
<p>
The <q>Examples Demo</q>, demonstrates some key features of the RAP framework.
It requires the following bundles:
</p>
<ul>
<li><em>org.eclipse.rap.examples</em></li>
<li><em>org.eclipse.rap.examples.pages</em></li>
</ul>
<p>
Some <a href="http://eclipse.org/rap/incubator/">RAP Incubator</a> projects also provide
a bundle named after the pattern <em>org.eclipse.rap.demo.&lt;project&gt;</em> or
<em>org.eclipse.rap.&lt;project&gt;.demo.examples</em>. You can add these to the launch
configuration of the examples demo to add more example pages.
</p>
<p>
The <q>Workbench Demo</q>provides a workbench very closely aligned to the RCP workbench.
It requires the following bundles:
</p>
<ul>
<li><em>org.eclipse.rap.demo</em></li>
<li><em>org.eclipse.rap.demo.databinding</em></li>
</ul>
<p>
The <q>Controls Demo</q>, showcases the different widgets
of the RAP Widget Toolkit.
It requires the following bundle:
</p>
<ul>
<li><em>org.eclipse.rap.demo.controls</em></li>
</ul>
<p>
To access and run these demo applications, open the <em class="UILabel">Plug-ins</em> view
and select the corresponding plug-ins. Open the context menu and select
<em class="UILabel">Import as &gt; Source Project</em>.
In the <em class="UILabel">Package Explorer</em>, open the imported plug-in and launch
the demo using the provided
<a href="launcher.html#rap-launcher">launch configuration</a>.
</p>
</body>
</html>