Difference between revisions of "Riena/E4"

From Eclipsepedia

Jump to: navigation, search
m (Set up target platform for Riena apps)
(45 intermediate revisions by 3 users not shown)
Line 1: Line 1:
This page is a start page that describes the current situation of Riena running on E4.
+
Riena supports the new E4 concepts to simplify the implementation of Riena applications in turn. Therefore there is a new branch '''rienaOnE4''' in the [http://git.eclipse.org/c/riena/org.eclipse.riena.git/ Riena Git Repository] where all Riena E4 development happens. (learn more about [[E4]])
  
'''Setup Targetplatforms'''
+
E4 offers a compatibility layer for existing Eclipse 3.x applications. Riena does not make use of this compatibility layer, but brings native E4 support. Even so, Riena applications built on Eclipse 3.x basis will work with Riena on E4.
* Start an Eclipse IDE with an empty workspace
+
* Go to Target Platform in Preferences and setup two Target Platforms
+
** '''3.8.M5'''
+
** update site is http://download.eclipse.org/eclipse/updates/3.8milestones/S-3.8M5-201201251800
+
** switch off "Group by category" and sitch off "Include required Software"
+
** Select Equinox Target components
+
** Select Eclipse RCP and Eclipse RCP SDK
+
** click OK and wait for it to download and install (takes some minutes, I hadd 258 plugins in the target platform after that)
+
** '''4.2.M5''' as second target platform
+
** update site is http://download.eclipse.org/eclipse/updates/3.8milestones
+
** select Equinox Target components
+
** click ok and wait for it to resolve and download
+
** update site is http://download.eclipse.org/eclipse/updates/4.2milestones/S-4.2M5-201201271145
+
** Select Eclipse RCP / Eclipse RCP SDK and "Eclipse e4 Rich Client Platform" / "Eclipse e4 Rich Client Platform Developer Resources"
+
** click OK and wait for it to resolve and download
+
  
 +
The following guide will walk through the necessary steps to setup your environment in minutes.
  
'''Setup workspace'''
 
* Select 3.8 as your active target platform
 
* Clone the Riena Repo from Git using the URL git://git.eclipse.org/gitroot/riena/org.eclipse.riena.git
 
* open the org.eclipse.riena.releng projectSet.psf file and checkout the projects that are listed there into your workspace
 
* all the remaining "compile errors" are because there is no API baseline set, you can change the warning for that to ignore (in the Preferences) and you should have a workspace with no compile errors for 3.8
 
  
'''Start the Riena example based on 3.8'''
+
== Set up target platform for Riena apps ==
* Target Platform 3.8 is still the activated one (from the setup)
+
* Start the launcher "SWT Example Application", make sure you switch to the plugins tab and click "Add required plug-ins"
+
* If all goes well that should bring up a working Riena example client
+
* You can click in the navigation (left and top) and see the Riena navigation as it is supposed to work
+
  
''' Start the Riena example based on 4.2'''
+
The screenshots in this section were made with the Riena 4 setup, but are also valid for Riena 5.
* Switch the Target Platform to 4.2
+
 
* You get compile errors.
+
* Download the Eclipse Kepler IDE for your platform and start with a blank workspace. [http://www.eclipse.org/downloads/index-developer.php Eclipse Developer Builds]
** Open SubApplicationView
+
 
** comment out the line in error (we use an internal Workbench method :-) and the if statement around it
+
* Download the [http://git.eclipse.org/c/riena/org.eclipse.riena.setup.git/snapshot/RienaSetup_5.0.0.0.zip RienaSetup] project and import it into your workspace.
* Start SWT Example Application launcher as above (click on Add requireed plug-ins)
+
[[Image:import_project_RienaSetup.png]]
 +
 
 +
 
 +
* In the imported project, open the file "Riena_5.0.0.0-4x.target" and set the target Platform
 +
[[Image:target_platform_editor_RienaSetup.png]]
 +
 
 +
 
 +
* Open the "Plug-Ins" view and import "org.eclipse.riena.example.client" as source project.
 +
[[Image:import_source_project_RienaSetup.png]]
 +
 
 +
 
 +
* Select launch configuration "SWT ExampleApplication E4" and add required plug-ins, then Run it.
 +
** Before adding required plug-ins, also check "Include optional dependencies when computing required plug-ins"
 +
* Now explore the code and plugin.xml in the example project
 +
 
 +
== Manual target platform setup ==
 +
 
 +
* Create a new target platform under Window => Preferences => Target Platform => Add => Nothing: Start with an empty target platform => Next
 +
* Provide a name like Riena 5.0.0
 +
* Click Add => Software Site
 +
* Select the repository: http://download.eclipse.org/releases/kepler
 +
* Uncheck "Group by Category" otherwise you can't see all components.
 +
* Select following components:
 +
** Equinox Target Components
 +
** Eclipse RCP
 +
** Eclipse RCP SDK
 +
** Eclipse RCP Plug-in Developer Resources
 +
* Activate target platform
 +
 
 +
== Get Riena Source Code  ==
 +
 
 +
*Clone the Riena Git Repository to any location in your file system
 +
 
 +
<source lang="bash">
 +
git clone git://git.eclipse.org/gitroot/riena/org.eclipse.riena.git
 +
</source> ''For more information about using the Riena Git Repository checkout [[Riena/Git|Riena on Git]].''  
 +
 
 +
*Import the Git Repository in Eclipse
 +
*Switch to Branch ''rienaOnE4''
 +
*Checkout additional dependencies using the projectset in ''org.eclipse.riena.releng''
 +
 
 +
''If you have problems with the projectset checkout https://bugs.eclipse.org/bugs/show_bug.cgi?id=380375''
 +
 
 +
== Start Your Engines ==
 +
 
 +
*Open the dialog ''Run Configurations...''
 +
*Use the launch configuration ''SWT ExampleApplication '''E4''''' to start the Example Application
 +
**If required, select ''Add Required Plug-Ins'' in the ''Plug-Ins'' tab
 +
 
 +
== Get Riena Target Platform ==
 +
If you do not want to checkout the Riena sources or just want to build a Riena based application, follow this steps to load the target platform.
 +
 
 +
*Open the Target Platform configuration and select the target ''rienaE4'' which you created above
 +
*In addition to the components added above, add the Riena Target components from the Software Site http://download.eclipse.org/releases/kepler
 +
**''Riena Core Target Components''
 +
**''Riena Target Components''
 +
**''Riena Samples Target Components''
 +
* ''Riena Core Target Components'' and ''Riena Target Components'' will appear twice in the list. Though they have the same names, they are different. Make sure, you select only the ones that include "e4" in their identifier (e.g. org.eclipse.riena.build.feature.core.sdk.e4.feature.group). You can check the identifier usind the "Properties..." button below the list and going to "General Information".
 +
 
 +
*Open the ''Plug-Ins'' view, locate the plug-in ''org.eclipse.riena.example.client'' and import it as Source Project into your workspace
 +
**This project contains the Launch Configuration for the Riena example client
 +
**If required, select ''Add Required Plug-Ins'' in the ''Plug-Ins'' tab (also check ''Include optional dependencies when computing required plug-ins'')
 +
 
 +
== TODOs ==
 +
*Verify that Riena works with pure E4 applications (E4 Example Client)
 +
*Use E4 dependency injection (DI) mechanism for the Riena DI implementation
 +
*Migrate Riena Toolbox to E4 (Currently Riena Toolbox on E4 is untested)

Revision as of 13:09, 15 March 2013

Riena supports the new E4 concepts to simplify the implementation of Riena applications in turn. Therefore there is a new branch rienaOnE4 in the Riena Git Repository where all Riena E4 development happens. (learn more about E4)

E4 offers a compatibility layer for existing Eclipse 3.x applications. Riena does not make use of this compatibility layer, but brings native E4 support. Even so, Riena applications built on Eclipse 3.x basis will work with Riena on E4.

The following guide will walk through the necessary steps to setup your environment in minutes.


Contents

Set up target platform for Riena apps

The screenshots in this section were made with the Riena 4 setup, but are also valid for Riena 5.

  • Download the RienaSetup project and import it into your workspace.

Import project RienaSetup.png


  • In the imported project, open the file "Riena_5.0.0.0-4x.target" and set the target Platform

Target platform editor RienaSetup.png


  • Open the "Plug-Ins" view and import "org.eclipse.riena.example.client" as source project.

Import source project RienaSetup.png


  • Select launch configuration "SWT ExampleApplication E4" and add required plug-ins, then Run it.
    • Before adding required plug-ins, also check "Include optional dependencies when computing required plug-ins"
  • Now explore the code and plugin.xml in the example project

Manual target platform setup

  • Create a new target platform under Window => Preferences => Target Platform => Add => Nothing: Start with an empty target platform => Next
  • Provide a name like Riena 5.0.0
  • Click Add => Software Site
  • Select the repository: http://download.eclipse.org/releases/kepler
  • Uncheck "Group by Category" otherwise you can't see all components.
  • Select following components:
    • Equinox Target Components
    • Eclipse RCP
    • Eclipse RCP SDK
    • Eclipse RCP Plug-in Developer Resources
  • Activate target platform

Get Riena Source Code

  • Clone the Riena Git Repository to any location in your file system
 git clone git://git.eclipse.org/gitroot/riena/org.eclipse.riena.git
For more information about using the Riena Git Repository checkout Riena on Git.
  • Import the Git Repository in Eclipse
  • Switch to Branch rienaOnE4
  • Checkout additional dependencies using the projectset in org.eclipse.riena.releng

If you have problems with the projectset checkout https://bugs.eclipse.org/bugs/show_bug.cgi?id=380375

Start Your Engines

  • Open the dialog Run Configurations...
  • Use the launch configuration SWT ExampleApplication E4 to start the Example Application
    • If required, select Add Required Plug-Ins in the Plug-Ins tab

Get Riena Target Platform

If you do not want to checkout the Riena sources or just want to build a Riena based application, follow this steps to load the target platform.

  • Open the Target Platform configuration and select the target rienaE4 which you created above
  • In addition to the components added above, add the Riena Target components from the Software Site http://download.eclipse.org/releases/kepler
    • Riena Core Target Components
    • Riena Target Components
    • Riena Samples Target Components
  • Riena Core Target Components and Riena Target Components will appear twice in the list. Though they have the same names, they are different. Make sure, you select only the ones that include "e4" in their identifier (e.g. org.eclipse.riena.build.feature.core.sdk.e4.feature.group). You can check the identifier usind the "Properties..." button below the list and going to "General Information".
  • Open the Plug-Ins view, locate the plug-in org.eclipse.riena.example.client and import it as Source Project into your workspace
    • This project contains the Launch Configuration for the Riena example client
    • If required, select Add Required Plug-Ins in the Plug-Ins tab (also check Include optional dependencies when computing required plug-ins)

TODOs

  • Verify that Riena works with pure E4 applications (E4 Example Client)
  • Use E4 dependency injection (DI) mechanism for the Riena DI implementation
  • Migrate Riena Toolbox to E4 (Currently Riena Toolbox on E4 is untested)