Jump to: navigation, search

Difference between revisions of "Riena Getting started"

m (Install the Riena Sample App Server)
m (Run the Riena Example Client)
Line 172: Line 172:
  
 
=== Run the Riena Example Client ===
 
=== Run the Riena Example Client ===
* File -> Import -> Plug-in Development -> Plug-ins and Fragments -> Next
+
# File -> Import -> Plug-in Development -> Plug-ins and Fragments -> Next.
* Select "Projects with source folders" unter Import As (since its more fun with source code) -> Next
+
# Select "Projects with source folders" unter 'Import As' (since it's more fun with source code) -> Next.
* Select in the Plug-ins Listbox the 1 plugin org.eclipse.riena.example.client and click Add and then Finish
+
# In the Plug-ins Listbox, select the plugin <tt>org.eclipse.riena.example.client</tt>, click 'Add' and then 'Finish'.
* In The Run Dialog -> Eclipse Application there are two entries "SWT ExampleApplication" and "SWT ExampleApplication (with alternative Lnf)".
+
# In the Run Dialog -> Eclipse Application, there are two entries "SWT ExampleApplication" and "SWT ExampleApplication (with alternative Lnf)".
* You can launch them both (dont forget to click on Add Required Plug-ins in the Plug-ins Tab. Both launchers start the same application based on the same code using two different Riena Themes (different color, fonts etc.)
+
# You can launch them both:
* Play with it :-)
+
#* Don't forget to click on Add Required Plug-ins in the Plug-ins Tab.
* There is also a project org.eclipse.riena.sample.app.client.mail that you can import and start the same way. (launcher is "Mail Sample (Riena UI)")
+
#* Both launchers start the same application based on the same code, but using two distinct Riena Themes (different colors, fonts etc.).
 +
# Play with it :-)
 +
 
 +
There is also a project <tt>org.eclipse.riena.sample.app.client.mail</tt> that you can import and start the same way. (The launcher is "Mail Sample (Riena UI)".)
  
 
=== Run the Riena Demo ===
 
=== Run the Riena Demo ===

Revision as of 05:18, 15 January 2010

Riena Project > Install & Getting Started

How to install Riena, set-up the Riena Target Platform, get started with code examples.

Installation

All Platforms
  1. First install Equinox project SDK and RCP SDK - see instructions below.
  2. Download the target platform from one of the software update sites given below.
    • Important note: Only install into your target platform, not into your Eclipse IDE directly!
Windows users
can alternatively install a complete target platform from the links marked "Complete target platform" below.

Links for RELEASE (1.2.0.0)

Version Update site Alternative download, for Windows users only
1.2.0.0 http://download.eclipse.org/rt/riena/1.2.0.0/update/ Complete target platform

Links for older milestones

Version Update site Alternative download, for Windows users only
1.2.0.RC1 http://download.eclipse.org/rt/riena/1.2.0.RC1/update/ Complete target platform
1.2.0.M3 http://download.eclipse.org/rt/riena/1.2.0.M3/update/ Complete target platform
1.2.0.M2 http://download.eclipse.org/rt/riena/1.2.0.M2/update/ Complete target platform
1.2.0.M1 http://download.eclipse.org/rt/riena/1.2.0.M1/update/ Complete target platform
1.1.0.0 http://download.eclipse.org/rt/riena/1.1.0.0/update/ Complete target platform

Setup for writing apps based on Riena

For a Riena-based application to compile, a certain set of bundles (plug-ins) must be available at compile time. This set of bundles is known as a target platform.

Follow the steps outlined in either of the following two sections to set up the target platform for Riena applications (based on Riena 1.2.0).

Beginners: Use the New Target Wizard

  1. Download Eclipse IDE 3.5.x for your platform
  2. Install the Riena Templates Feature from http://download.eclipse.org/rt/riena/updatesites/rienawizard
    • You might need to uncheck 'Group items by category' to see the Riena Wizard item.
  3. Select a project in your workspace
    • If your workspace is empty, create a new General project first (File > New > Project > General > Project > Next > Enter any name > Finish)
  4. Create the Riena target definition (File > New > Other… > Plug-in Development > Target Definition > Next. File Name: riena.target, Template: Riena Target 1.2.0.0. Finish).
    • Riena new target wiz.png
  5. The Target Definition editor will open. Wait for the "Resolving Target Definition…" job in the status bar (bottom right) to finish. Then click on 'Set as Target Platform'.
    • Riena target.png
  6. Done.

Experts: Manual Setup

  1. Download Eclipse IDE 3.5.x for your platform and start with a blank workspace.
  2. Create a new Target Platform definition that contains "Equinox Project SDK" and "Eclipse RCP SDK" from the Galileo Software Site (the RCP SDK will be only visible if you uncheck "Group by Category")
    • If you'd like to install Riena 1.1.0 from the Galileo Repository add Riena Core SDK and Riena SDK Samples.
    • If you'd like to install Riena 1.2.0. from the above update site then there are two entries for "Riena Core SDK" and "Riena SDK Samples" (a temporaray problem). Please select all four entries and add them to your target platform.
  3. Activate the platform.
  4. Done.

Code Templates and Examples

Try the 'new project' templates

  1. Install the Riena Templates Feature from http://download.eclipse.org/rt/riena/updatesites/rienawizard
  2. Create a new Plug-in Project (File > New > Plug-in Project > Next)
  3. Choose a project name > Next
  4. On the Content page:
    1. "This plug-in will make contributions to the UI" => Yes
    2. "Would you like to create a rich client application?" => Yes
  5. The Templates page offers three "Riena" templates (picture below). Choose either one and hit Next or Finish.
    • Riena pde templates.png
If you picked the "Riena Hello World" or "Riena Mail Template"
start the resulting project with Run As -> Eclipse Application.
If you picked the "Riena Client/Server Template"
use the launch configurations that are included in the project. Start the server first, then the client.

Look at the code in the projects and have fun.

If you prefer to roll your own

Ralf Ebert has written an excellent tutorial on the first steps of how to build a Riena client application from scratch.

Try the Riena Snippets

The Riena Snippets page contains a growing collection of self-contained code examples that show you how to use ridgets ("Riena widgets") and what you can do with them.

What are ridgets?

A ridget wraps an actual UI widget but offers a higher level of abstraction and it is independent from the UI toolkit (SWT). The idea is to separate the UI (view) from the logic behind it, which is moved to a view controller. The view controller interacts with the actual UI widgets through the ridgets. It should be possible to reuse a view controller with a view that is based on a different UI toolkit (e.g. Swing).

A ridget offers the most commonly-used functionality (like setText(String) of a text field) along with some extra convenience functionality like markers. A textfield can be marked as error by adding an ErrorMarker. The marking itself (changing color, setting icons, etc.) is handled by the Riena framework. Another example is the bindToModel(...) method for a simple databinding with a JavaBean.

The overall intention is to reduce the complexity for the application developer and to ensure a common look & feel across the application. If the functionality offered by the ridget's interface is not sufficient the developer can always access the actual UI widget. (Then of course he loses the independence from the UI toolkit). The set of ridgets is constantly getting bigger. If necessary it should be possible for applications to add its own ridgets.

In the view you create SWT controls as always and register them with Riena (addUIControl(...)). The ridgets will be injected into the controller, where you then have access to the corresponding ridgets.

(Adapted from a discussion on riena-dev.) See also Ridget Design Principles.

Try the communication ping pong example

  1. File -> Import -> Plug-in Development -> Plug-ins and Fragments -> Next.
  2. Select "Projects with source folders" unter Import As (since it's more fun with source code) -> Next.
  3. In the Plug-ins Listbox, select the 4 plugins *.communication.sample.pingpong.* and click Add and then Finish.
  4. In the Run Dialog you can select which of the two components to run (under 'OSGi Framework').
    • Don't forget to press the 'Add required Bundles' button for both of them before you start them!
    1. First, start the Riena Sample PingPong Server.
      • The server starts at port 8080, make sure it's not taken.
    2. Then start the Riena Sample PingPong Client.
  5. On success your client will print a message on the console: PingPong::Client:: [Pong] says = Thx. I got the ping!
  6. Switch to the server console; it should show a message like this: PingPong::Server:: [Ping] says = I ping you and you pong me

Try the unit tests

  1. Import the project org.eclipse.riena.tests from the target platform (same as above).
  2. There are classes like AllTests on various levels that you can run as Junit Plugin Tests.
  3. You can also run individual tests as JUnit Plugin Tests.
  • Currently there are about 1300 tests and they should all work. Some of them fail if you click or move the mouse while the tests are running (e.g. focus or UI tests).
  • Sometimes when you launch AllTests as JUnit Plugin Test for the first time you get a "Launch Error". Simply say "No" in the dialog and modify the launch entry in the dialog for this class: in the "Main" tab, change the field "Run an application" from "org.eclipse.ui.ide.workbench", which is the default, to "[No Application] - Headless Mode".
  • Classes ending with *ITest require a server. That's the Riena App Sample Server (explained in the next step).

Install the Riena Sample App Server

Simple server with customer search web service:

  1. Stop any previously started client or server.
  2. Import the projects org.eclipse.riena.sample.app.server and org.eclipse.riena.sample.app.common from the target platform.
  3. Start Riena App Server from the Run Dialog:
    • Don't forget to press the button "Add required bundles".
    • This server starts on port 8080, make sure that port is not taken.
  4. That should bring up a relativly simple app server with just the customer search web service.


Server with many more services:

  1. Stop the server again.
  2. Bring up the Run Dialog again, select Riena App Server and select the bundles org.eclipse.riena.security.services and org.eclipse.riena.security.simpleservices (both found in the target platform).
  3. Press "Add required bundles".
  4. Run it.
  5. Now you can see in the console a lot more (security-related) web services.
  6. Now you can also run the *ITests from the tests bundle, e.g. SessionServiceITest.

Run the Riena Example Client

  1. File -> Import -> Plug-in Development -> Plug-ins and Fragments -> Next.
  2. Select "Projects with source folders" unter 'Import As' (since it's more fun with source code) -> Next.
  3. In the Plug-ins Listbox, select the plugin org.eclipse.riena.example.client, click 'Add' and then 'Finish'.
  4. In the Run Dialog -> Eclipse Application, there are two entries "SWT ExampleApplication" and "SWT ExampleApplication (with alternative Lnf)".
  5. You can launch them both:
    • Don't forget to click on Add Required Plug-ins in the Plug-ins Tab.
    • Both launchers start the same application based on the same code, but using two distinct Riena Themes (different colors, fonts etc.).
  6. Play with it :-)

There is also a project org.eclipse.riena.sample.app.client.mail that you can import and start the same way. (The launcher is "Mail Sample (Riena UI)".)

Run the Riena Demo

  • File -> Import -> Plug-in Development -> Plug-ins and Fragments -> Next
  • Select "Projects with source folders" unter Import As (since its more fun with source code) -> Next
  • Select in the Plug-ins Listbox the 3 plugin org.eclipse.riena.demo.* and click Add and then Finish
  • Run Riena Demo Server launcher (dont forget Add Required Plug-ins)
  • Run riena Demo Client launcher (dont forget Add Required Plug-ins)


Next Steps

Get started with the key concepts and features of Riena.