Rayo is a modern Look and Feel that is based on Synth Look and Feel. In [http://en.wikipedia.org/wiki/Synth_Look_and_Feel Synth] all painting is delegated to components without requiring any code to be written.

+

{{ScoutLink|Concepts|Rayo}} is a modern Look and Feel that is based on [http://en.wikipedia.org/wiki/Synth_Look_and_Feel Synth Look and Feel]. All the painting is delegated to components without requiring any code to be written in Rayo: It is a skinnable Look and Feel that is configured in an XML property file.

−

Rayo is a skinnable Look and Feel that can be configured in an XML property file.

+

In this tutorial a simple Scout application will be customized with the Rayo Look and Feel. Depending on the configured Look and Feel property in the config.ini file, the application is started with Rayo or with the default Swing Look and Feel (Nimbus or Windows).

In this tutorial a simple Scout application will be customized with the Rayo Look and Feel. Depending on the configured Look and Feel property in the config.ini file, the application is started with Rayo or with the default Swing Look and Feel (Nimbus or Windows).

First we create a new Scout "Hello World" application as described in [[{{BASEPAGENAME}}/HelloWorld|Hello World tutorial]].

−

http://download.eclipse.org/scout/nightly/update/.

+

== Installation of Rayo using Scout SDK ==

−

+

−

More details on how to do this can be found in the following {{ScoutLink|HowTo|Install Scout SDK|name=How-To}}

+

−

+

−

== Getting started with Rayo ==

+

−

+

−

First we create a new Scout "Hello World" application as described in [[Scout/Tutorial/3.8/HelloWorld]].

+

Switch to the Scout Explorer view and mark the previous created "Hello World" application. In the Scout Object Properties view check the box "Rayo Swing Look and Feel for Eclipse Scout" under Technologies.

Switch to the Scout Explorer view and mark the previous created "Hello World" application. In the Scout Object Properties view check the box "Rayo Swing Look and Feel for Eclipse Scout" under Technologies.

A new dialog will pop up, showing the the changes that will be applied to the "Hello World" project in order to provide the Rayo Look and Feel. These changes will be explained in the following sections.

+

A new dialog will pop up, showing the the changes that will be applied to the "Hello World" project in order to provide the Rayo Look and Feel. These changes will be explained in the section [[{{BASEPAGENAME}}/Rayo_Look_and_Feel#Manual installation of Rayo|Manual installation of Rayo]]

[[Image:install_rayo_using_scout_sdk2.png|thumb|center|200px|Changes applied to the Scout project]]

[[Image:install_rayo_using_scout_sdk2.png|thumb|center|200px|Changes applied to the Scout project]]

−

Click on OK and then on Restart Eclipse to apply the changes.

+

Click on OK.

−

Run the server and client product as explained in [[Scout/Tutorial/3.8/HelloWorl/Run the Empty Scout Application in the Scout SDK]]. The application starts automatically with the Rayo Look and Feel.

+

If this is your first time using Rayo, it is downloaded first (this may take a while) and installed into your Eclipse instance afterwards. In that case you must accept the license after pressing OK [http://wiki.eclipse.org/Image:Scout.rayo.license.accep.png].

−

== Using Rayo ==

+

When the download has been completed, confirm the 'Security Warning' [http://wiki.eclipse.org/Image:Scout.rayo.unsigned.warning.png] dialog with OK to install the Rayo feature. When the installation is finished you are prompten to restart Eclipse. Confirm with 'Yes' to complete the installation.

−

After installation of Rayo the plugin com.bsiag.scout.rt.ui.swing.rayo and the fragment com.bsiag.scout.rt.ui.swing.laf.rayo.fragment are available and will be added to our Scout application later.

+

== Manual installation of Rayo ==

−

=== Create an Eclipse Scout Project ===

+

Instead of using the Scout SDK to download and install Rayo Look and Feel (section above), Rayo can also be downloaded at the [http://marketplace.eclipse.org Eclipse Marketplace] as an alternative. In this section the necessary steps are explained for setting up a Scout application with Rayo. All these single steps are done automatically when using Scout SDK (section above).

−

* As described in this {{ScoutLink|Tutorial|Minicrm/New_Eclipse_Scout_Project|name=tutorial}} we create a simple Scout application "tutorial.rayo" with an outline tree and a table form.

+

=== Download Rayo ===

+

To download Rayo use the dialog "Eclipse Marketplace" in Eclipse under "Help -> Eclipse Marketplace..." and search for "Rayo" or alternatively click on "Help -> Install New Software" and add the URL http://tools.bsiag.com/marketplace/rayo as shown in the pictures.

* Next create a "StandardOutline" in the Scout Explorer similar as shown in this {{ScoutLink|Tutorial|Minicrm/Write_the_first_page#Add_an_Outline_first|name=tutorial}}. Add a CompanyTablePage with some columns in the table to the StandardOutline as described {{ScoutLink|Tutorial|Minicrm/Write_the_first_page#Add_a_Page_to_the_Outline|name=here}}.

[[Image:add_outline_and_tablepage.png|thumb|center|200px|Add an outline and a tablepage to the application]]

+

Check at least the feature "Rayo Look and Feel Feature for Eclipse Scout" and proceed the installation by clicking on the Next button.

−

=== Add required Rayo Plugin ===

+

=== Add Rayo Plugins to the Swing Product ===

−

Open the plugin.xml in tutorial.rayo.ui.swing and add "com.bsiag.scout.rt.ui.swing.rayo" under required plugins in the Dependencies tab.

+

Switch to Scout SDK. Select your Scout project in the Scout Explorer. In the Scout Object Properties view under Product launchers open your Swing client product by clicking on the link. Add the plugin com.bsiag.scout.rt.ui.swing.rayo and the fragment com.bsiag.scout.rt.ui.swing.laf.rayo.fragment as shown in the picture. You may need to do the same change for other products as well.

Open the rayo-swing-client-dev.product file under tutorial.rayo.ui.swing/products/development/. Switch to the Dependencies tab and click on the button "Add Required Plug-ins". The following plugin and fragment should be added automatically:

+

Open the plugin.xml in the ui.swing plugin and add "com.bsiag.scout.rt.ui.swing.rayo" under required plugins in the Dependencies tab.

Run the server and client product as explained in [[{{BASEPAGENAME}}/HelloWorld#Run the Empty Scout Application in the Scout SDK|Run the Empty Scout Application in the Scout SDK]]. The application starts automatically with the Rayo Look and Feel.

−

In tutorial.rayo.ui.swing create the class RayoSwingEnvironmentEx in the package tutorial.rayo.ui.swing that subclasses RayoSwingEnvironment.

Since Rayo build version 3.8.1.201209050944, decorated frames of the Operating Systems can be used like in Nimbus, Metal and Synth in the JRE.

+

Previous Rayo versions were only supporting Look & Feel decorated frames so that most of the Operating System functionalities regarding dialogs and frames were affected due to multiple bugs in the JRE, e.g. resizing, maximizing, minimizing and multiple screens. When using L&F decorated frame and dialog, the Windows+UP/DOWN/LEFT/RIGHT keys do not work anymore. Also resizing issues arise and in general some native OS functions are disabled.

−

In tutorial.rayo.ui.swing modify the class Activator in the package tutorial.rayo.ui.swing so that it inherits from Plugin. Make sure that the super() and stop() methods of the super class are called.

+

To use the decorated frames of the OS, just unset the following flag in the Swing config.ini file:

Add the following line of code to the createSwingEnvironment() method of the class SwingApplication in the package tutorial.rayo.ui.swing:

−

@Override

+

See also {{Bug|388781}}

−

protected ISwingEnvironment createSwingEnvironment() {

+

−

if ("com.bsiag.scout.rt.ui.swing.laf.rayo.Rayo".equals(Activator.getDefault().getBundle().getBundleContext().getProperty("scout.laf"))) {

+

−

return new RayoSwingEnvironmentEx();

+

−

}

+

−

return new SwingEnvironment();

+

−

}

+

−

+

−

== Alternative download ==

+

−

+

−

Instead of using the Scout SDK to download and install Rayo Look and Feel, Rayo can also be downloaded at the [http://marketplace.eclipse.org Eclipse Marketplace] as an alternative. To download Rayo use the Eclipse Marketplace dialog (Help -> Eclipse Marketplace...) and search for "Rayo" or alternatively click on "Help -> Install New Software" in Eclipse and add the URL https://tools.bsiag.com/marketplace/rayo as shown in the pictures.

Introduction

Rayo is a modern Look and Feel that is based on Synth Look and Feel. All the painting is delegated to components without requiring any code to be written in Rayo: It is a skinnable Look and Feel that is configured in an XML property file.

In this tutorial a simple Scout application will be customized with the Rayo Look and Feel. Depending on the configured Look and Feel property in the config.ini file, the application is started with Rayo or with the default Swing Look and Feel (Nimbus or Windows).

Preparation

Installation of Rayo using Scout SDK

Switch to the Scout Explorer view and mark the previous created "Hello World" application. In the Scout Object Properties view check the box "Rayo Swing Look and Feel for Eclipse Scout" under Technologies.

Install Rayo Look and Feel using Scout SDK

A new dialog will pop up, showing the the changes that will be applied to the "Hello World" project in order to provide the Rayo Look and Feel. These changes will be explained in the section Manual installation of Rayo

Changes applied to the Scout project

Click on OK.

If this is your first time using Rayo, it is downloaded first (this may take a while) and installed into your Eclipse instance afterwards. In that case you must accept the license after pressing OK [1].

When the download has been completed, confirm the 'Security Warning' [2] dialog with OK to install the Rayo feature. When the installation is finished you are prompten to restart Eclipse. Confirm with 'Yes' to complete the installation.

Manual installation of Rayo

Instead of using the Scout SDK to download and install Rayo Look and Feel (section above), Rayo can also be downloaded at the Eclipse Marketplace as an alternative. In this section the necessary steps are explained for setting up a Scout application with Rayo. All these single steps are done automatically when using Scout SDK (section above).

Download Rayo

To download Rayo use the dialog "Eclipse Marketplace" in Eclipse under "Help -> Eclipse Marketplace..." and search for "Rayo" or alternatively click on "Help -> Install New Software" and add the URL http://tools.bsiag.com/marketplace/rayo as shown in the pictures.

Rayo URL via Update Site

Installation of Rayo via Update Site

Check at least the feature "Rayo Look and Feel Feature for Eclipse Scout" and proceed the installation by clicking on the Next button.

Add Rayo Plugins to the Swing Product

Switch to Scout SDK. Select your Scout project in the Scout Explorer. In the Scout Object Properties view under Product launchers open your Swing client product by clicking on the link. Add the plugin com.bsiag.scout.rt.ui.swing.rayo and the fragment com.bsiag.scout.rt.ui.swing.laf.rayo.fragment as shown in the picture. You may need to do the same change for other products as well.

Add Rayo Plugin and Fragment to Swing client Product

Add Rayo Plugin to the Swing Manifest

Open the plugin.xml in the ui.swing plugin and add "com.bsiag.scout.rt.ui.swing.rayo" under required plugins in the Dependencies tab.

Add Rayo to required plugins

Change SwingEnvironment

Open the class SwingEnvironment and inherit from com.bsiag.scout.rt.ui.swing.rayo.RayoSwingEnvironment by adding the following line:

Launch the application

Addendum

Since Rayo build version 3.8.1.201209050944, decorated frames of the Operating Systems can be used like in Nimbus, Metal and Synth in the JRE.
Previous Rayo versions were only supporting Look & Feel decorated frames so that most of the Operating System functionalities regarding dialogs and frames were affected due to multiple bugs in the JRE, e.g. resizing, maximizing, minimizing and multiple screens. When using L&F decorated frame and dialog, the Windows+UP/DOWN/LEFT/RIGHT keys do not work anymore. Also resizing issues arise and in general some native OS functions are disabled.

To use the decorated frames of the OS, just unset the following flag in the Swing config.ini file: