Notice: this Wiki will be going read only early in 2024 and edits will no longer be possible. Please see: https://gitlab.eclipse.org/eclipsefdn/helpdesk/-/wikis/Wiki-shutdown-plan for the plan.
Difference between revisions of "Riena/Examples"
< Riena
(→Try the Riena Snippets) |
|||
(6 intermediate revisions by 2 users not shown) | |||
Line 6: | Line 6: | ||
== Try the Riena Snippets == | == Try the Riena Snippets == | ||
− | The [[Riena_Snippets|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. For a | + | The [[Riena_Snippets|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. For a description what Ridgets are, look here http://wiki.eclipse.org/Riena/Custom_Ridgets |
== Try the communication ping pong example == | == Try the communication ping pong example == | ||
− | # | + | # Import the 4 plugins <tt>*.communication.sample.pingpong.*</tt> from the target platform. (See [[#Import a Riena plugin]]) |
− | + | ||
− | + | ||
# In the Run Dialog you can select which of the two components to run (under 'OSGi Framework'). | # In the Run Dialog you can select which of the two components to run (under 'OSGi Framework'). | ||
− | #* | + | #* Select the Bundles <tt>org.eclipse.equinox.console</tt> and <tt>org.apache.felix.gogo.shell</tt> and press the 'Add required Bundles' button for both of them before you start them! |
− | ## First, start the Riena Sample PingPong Server. | + | ## First, start the '''Riena Sample PingPong Server'''. |
− | ##* The server starts | + | ##* The server starts on port 8080, make sure it's not taken. |
− | ## Then start the Riena Sample PingPong Client. | + | ## Then start the '''Riena Sample PingPong Client'''. |
# On success your client will print a message on the console: <tt>PingPong::Client:: [Pong] says = Thx. I got the ping!</tt> | # On success your client will print a message on the console: <tt>PingPong::Client:: [Pong] says = Thx. I got the ping!</tt> | ||
# Switch to the server console; it should show a message like this: <tt>PingPong::Server:: [Ping] says = I ping you and you pong me</tt> | # Switch to the server console; it should show a message like this: <tt>PingPong::Server:: [Ping] says = I ping you and you pong me</tt> | ||
+ | |||
+ | <div id="Import a Riena plugin"> | ||
+ | {{warning2|text= Import a Riena plugin''' | ||
+ | # File -> Import -> Plug-in Development -> Plug-ins and Fragments -> Next. | ||
+ | # Select "Projects with source folders" under "Import As" (since it's more fun with source code) -> Next. | ||
+ | # In the "Plug-ins and Fragments Found" Listbox, select the requested plugins and click Add and then Finish.}} | ||
+ | </div> | ||
== Try the unit tests == | == Try the unit tests == | ||
− | # Import the project <tt>org.eclipse.riena.tests</tt> from the target platform ( | + | # Import the project <tt>org.eclipse.riena.tests</tt> from the target platform. (See [[#Import a Riena plugin]]) |
# There are classes like <tt>AllTests</tt> on various levels that you can run as Junit Plugin Tests. | # There are classes like <tt>AllTests</tt> on various levels that you can run as Junit Plugin Tests. | ||
# You can also run individual tests as JUnit Plugin Tests. | # You can also run individual tests as JUnit Plugin Tests. | ||
− | ; Currently there are more than | + | ; Currently there are more than 3000 tests |
: 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). | : 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). | ||
; Launch Error on starting tests | ; Launch Error on starting tests | ||
Line 41: | Line 46: | ||
== Install the Riena Sample App Server == | == Install the Riena Sample App Server == | ||
− | |||
Simple server with customer search web service: | Simple server with customer search web service: | ||
# Stop any previously started client or server. | # Stop any previously started client or server. | ||
− | # Import the projects <tt>org.eclipse.riena.sample.app.server</tt> | + | # Import the 4 projects <tt>org.eclipse.riena.sample.app.server</tt>, <tt>org.eclipse.riena.sample.app.common</tt>, <tt>org.eclipse.riena.security.services</tt> and <tt>org.eclipse.riena.security.simpleservices</tt> from the target platform. (See [[#Import a Riena plugin]]) |
− | # Start Riena App Server from the Run Dialog: | + | # Start '''Riena App Server''' from the Run Dialog: |
− | #* | + | #* Select the Bundles <tt>org.eclipse.equinox.console</tt> and <tt>org.apache.felix.gogo.shell</tt> and press the 'Add required Bundles' button before you start it! |
#* This server starts on port 8080, make sure that port is not taken. | #* This server starts on port 8080, make sure that port is not taken. | ||
− | # That should bring up a | + | # That should bring up a simple app server with a secured customer search web service. |
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
== Run the Riena Example Client == | == Run the Riena Example Client == | ||
− | # | + | # Import the project <tt>org.eclipse.riena.example.client</tt> from the target platform. (See [[#Import a Riena plugin]]) |
− | + | # In the "Run Dialog -> Eclipse Application", there are five new entries. Depending on the target platform you have to select the right run configuration. | |
− | + | ## For the target platform '''3.x''': | |
− | # In the Run Dialog -> Eclipse Application, there are | + | ### Select the '''SWT ExampleApplication''' or '''SWT ExampleApplication (with alternative LnF)''' configuration. |
− | # | + | ### Add the plug-ins <tt>org.eclipse.riena.navigation.ui.swt.rcp</tt> and <tt>org.eclipse.riena.ui.swt.3x</tt> and press the 'Add required Plug-ins' button before you start them! |
− | # | + | ###* Both launchers start the same application based on the same code, but using two distinct Riena Themes (different colors, fonts etc.). |
− | #* Both launchers start the same application based on the same code, but using two distinct Riena Themes (different colors, fonts etc.). | + | ## For the target platform '''4.x''': |
− | # | + | ### Select the '''SWT ExampleApplication E4''' |
+ | ### Add the plug-ins <tt>org.eclipse.riena.navigation.ui.swt.rcp</tt> and <tt>org.eclipse.riena.ui.swt.e4</tt> and press the 'Add required Plug-ins' button before you start it! | ||
+ | ## For the target platform '''RAP''': | ||
+ | ### Open the plugin.xml in the root folder of the project. | ||
+ | ### Uncomment the extension for RAP at the end of the file. (Line 1721 - 1726) | ||
+ | ### Run the '''Riena Example Client on RAP''' launcher. | ||
− | + | == Run the Riena Example Mail Client == | |
+ | # Import the project <tt>org.eclipse.riena.sample.app.client.mail</tt> from the target platform. (See [[#Import a Riena plugin]]) | ||
+ | # Start '''Mail Sample (Riena UI)''' from the Run Dialog: | ||
+ | ## For the target platform '''3.x''': | ||
+ | ### Select at the Main tab <tt>Run an application</tt> and '''org.eclipse.riena.sample.app.client.mail.mailapp''' | ||
+ | ### Add the plug-ins <tt>org.eclipse.riena.navigation.ui.swt.rcp</tt> and <tt>org.eclipse.riena.ui.swt.3x</tt> and press the 'Add required Plug-ins' button before you start them! | ||
+ | ## For the target platform '''4.x''': | ||
+ | ### Coming soon | ||
+ | ## For the target platform '''RAP''': | ||
+ | ### Open the plugin.xml in the root folder of the project. | ||
+ | ### Add the extension: <code> <extension point="org.eclipse.rap.ui.entrypoint"> <entrypoint id="example.application.entrypoint" applicationId="org.eclipse.riena.sample.app.client.mail.mailapp" path="/rap" /> </extension> </code> | ||
+ | ### Select the '''RAP Mail Sample (Riena UI)''' | ||
+ | ### Add the bundles <tt>org.eclipse.riena.navigation.ui.swt.rap</tt> and <tt>org.eclipse.riena.ui.swt.rap</tt> and press the 'Add required Plug-ins' button before you start it! | ||
== Run the Riena Demo == | == Run the Riena Demo == | ||
− | # | + | # Import the 4 projects <tt>org.eclipse.riena.demo.*</tt> from the target platform. (See [[#Import a Riena plugin]]) |
− | # Select | + | # Select the '''Riena Demo Server''' launcher |
− | # | + | # Add the Bundles <tt>org.eclipse.equinox.console</tt> and <tt>org.apache.felix.gogo.shell</tt> and press the 'Add required Plug-ins' button before you start them! |
− | # | + | # Select the '''Riena Demo Client''' launcher |
− | + | ## For the target platform '''3.x''': | |
+ | ### Select at the Main tab <tt>Run an application</tt> and '''org.eclipse.riena.demo.client.application''' | ||
+ | ### Add the plug-ins <tt>org.eclipse.riena.navigation.ui.swt.rcp</tt> and <tt>org.eclipse.riena.ui.swt.3x</tt> and press the 'Add required Plug-ins' button before you start them! | ||
+ | ## For the target platform '''4.x''': | ||
+ | ### Select at the Main tab <tt>Run a product</tt> and '''org.eclipse.riena.e4.launcher.product''' | ||
+ | ### Add the plug-ins <tt>org.eclipse.riena.navigation.ui.swt.rcp</tt> and <tt>org.eclipse.riena.ui.swt.e4</tt> and press the 'Add required Plug-ins' button before you start them! | ||
+ | ###* The missing icons will throw some Exceptions | ||
+ | |||
== Next Step == | == Next Step == | ||
− | + | Get started with the [[Riena/BaseConcepts|Base concepts of Riena]]. | |
− | Get started with the [[Riena/BaseConcepts| | + |
Latest revision as of 06:13, 12 December 2014
{{#eclipseproject:rt.riena}}
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. For a description what Ridgets are, look here http://wiki.eclipse.org/Riena/Custom_Ridgets
Try the communication ping pong example
- Import the 4 plugins *.communication.sample.pingpong.* from the target platform. (See #Import a Riena plugin)
- In the Run Dialog you can select which of the two components to run (under 'OSGi Framework').
- Select the Bundles org.eclipse.equinox.console and org.apache.felix.gogo.shell and press the 'Add required Bundles' button for both of them before you start them!
- First, start the Riena Sample PingPong Server.
- The server starts on port 8080, make sure it's not taken.
- Then start the Riena Sample PingPong Client.
- On success your client will print a message on the console: PingPong::Client:: [Pong] says = Thx. I got the ping!
- Switch to the server console; it should show a message like this: PingPong::Server:: [Ping] says = I ping you and you pong me
Import a Riena plugin
- File -> Import -> Plug-in Development -> Plug-ins and Fragments -> Next.
- Select "Projects with source folders" under "Import As" (since it's more fun with source code) -> Next.
- In the "Plug-ins and Fragments Found" Listbox, select the requested plugins and click Add and then Finish.
Try the unit tests
- Import the project org.eclipse.riena.tests from the target platform. (See #Import a Riena plugin)
- There are classes like AllTests on various levels that you can run as Junit Plugin Tests.
- You can also run individual tests as JUnit Plugin Tests.
- Currently there are more than 3000 tests
- 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).
- Launch Error on starting tests
- This sometimes happens when you launch a test as JUnit Plugin Test for the first time. => You will need to modify the launch configuration for this class:
- In the "Main" tab, change the field "Run an application" to "[No Application] - Headless Mode".
- In the "Plug-ins" tab:
- Launch with: choose "plug-ins selected below only".
- "Deselect All"
- Check/select the bundle containing the test you want to run.
- "Add Required Plug-ins"
- Apply. Run.
- 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:
- Stop any previously started client or server.
- Import the 4 projects org.eclipse.riena.sample.app.server, org.eclipse.riena.sample.app.common, org.eclipse.riena.security.services and org.eclipse.riena.security.simpleservices from the target platform. (See #Import a Riena plugin)
- Start Riena App Server from the Run Dialog:
- Select the Bundles org.eclipse.equinox.console and org.apache.felix.gogo.shell and press the 'Add required Bundles' button before you start it!
- This server starts on port 8080, make sure that port is not taken.
- That should bring up a simple app server with a secured customer search web service.
Run the Riena Example Client
- Import the project org.eclipse.riena.example.client from the target platform. (See #Import a Riena plugin)
- In the "Run Dialog -> Eclipse Application", there are five new entries. Depending on the target platform you have to select the right run configuration.
- For the target platform 3.x:
- Select the SWT ExampleApplication or SWT ExampleApplication (with alternative LnF) configuration.
- Add the plug-ins org.eclipse.riena.navigation.ui.swt.rcp and org.eclipse.riena.ui.swt.3x and press the 'Add required Plug-ins' button before you start them!
- Both launchers start the same application based on the same code, but using two distinct Riena Themes (different colors, fonts etc.).
- For the target platform 4.x:
- Select the SWT ExampleApplication E4
- Add the plug-ins org.eclipse.riena.navigation.ui.swt.rcp and org.eclipse.riena.ui.swt.e4 and press the 'Add required Plug-ins' button before you start it!
- For the target platform RAP:
- Open the plugin.xml in the root folder of the project.
- Uncomment the extension for RAP at the end of the file. (Line 1721 - 1726)
- Run the Riena Example Client on RAP launcher.
- For the target platform 3.x:
Run the Riena Example Mail Client
- Import the project org.eclipse.riena.sample.app.client.mail from the target platform. (See #Import a Riena plugin)
- Start Mail Sample (Riena UI) from the Run Dialog:
- For the target platform 3.x:
- Select at the Main tab Run an application and org.eclipse.riena.sample.app.client.mail.mailapp
- Add the plug-ins org.eclipse.riena.navigation.ui.swt.rcp and org.eclipse.riena.ui.swt.3x and press the 'Add required Plug-ins' button before you start them!
- For the target platform 4.x:
- Coming soon
- For the target platform RAP:
- Open the plugin.xml in the root folder of the project.
- Add the extension:
<extension point="org.eclipse.rap.ui.entrypoint"> <entrypoint id="example.application.entrypoint" applicationId="org.eclipse.riena.sample.app.client.mail.mailapp" path="/rap" /> </extension>
- Select the RAP Mail Sample (Riena UI)
- Add the bundles org.eclipse.riena.navigation.ui.swt.rap and org.eclipse.riena.ui.swt.rap and press the 'Add required Plug-ins' button before you start it!
- For the target platform 3.x:
Run the Riena Demo
- Import the 4 projects org.eclipse.riena.demo.* from the target platform. (See #Import a Riena plugin)
- Select the Riena Demo Server launcher
- Add the Bundles org.eclipse.equinox.console and org.apache.felix.gogo.shell and press the 'Add required Plug-ins' button before you start them!
- Select the Riena Demo Client launcher
- For the target platform 3.x:
- Select at the Main tab Run an application and org.eclipse.riena.demo.client.application
- Add the plug-ins org.eclipse.riena.navigation.ui.swt.rcp and org.eclipse.riena.ui.swt.3x and press the 'Add required Plug-ins' button before you start them!
- For the target platform 4.x:
- Select at the Main tab Run a product and org.eclipse.riena.e4.launcher.product
- Add the plug-ins org.eclipse.riena.navigation.ui.swt.rcp and org.eclipse.riena.ui.swt.e4 and press the 'Add required Plug-ins' button before you start them!
- The missing icons will throw some Exceptions
- For the target platform 3.x:
Next Step
Get started with the Base concepts of Riena.