Difference between revisions of "Riena/Look and Feel"

From Eclipsepedia

Jump to: navigation, search
m (Sub-Application Switcher: formatting)
m (Shell)
Line 97: Line 97:
(Because it is possible to hide the title bar and border, all the other L&F keys for the Riena shell starts with ''TITLELESS_SHELL_''.)
(Because it is possible to hide the title bar and border, all the other L&F keys for the Riena shell starts with ''TITLELESS_SHELL_''.)
=== Sub-Application Switcher ===
=== Sub-Application Switcher ===

Revision as of 04:24, 26 January 2010

Riena ProjectGetting Started ▶ Look & Feel

Riena provides a Look&Feel for the controls of the navigation. The Riena Look&Feel is similar to the Look&Feel of Swing. A Riena Look&Feel consists of a Look&Feel proper plus a Theme:

The Theme 
provides the colors, fonts, images and some other settings.
In the Look&Feel 
other renderers for some controls can be set.


Custom Look & Feel

In your own Look&Feel you must set your Theme and an ID.

The following steps are necessary:

  1. Extend the class RienaDefaultLnf
  2. Create and set the Theme
  3. Return the ID


public class ExampleLnf extends RienaDefaultLnf {
  public ExampleLnf() {
    setTheme(new ExampleTheme());
  protected String getLnfId() {
    return ExampleLnf;

To set your custom Look&Feel, call the static method LnfManager.setLnf(lnf). We recommend that you call it in the constructor of the Riena Application (SwtApplication):


public SwtExampleApplication() {
  LnfManager.setLnf(new ExampleLnf());

Custom Theme

To write your own Theme you must implement the interface ILnfTheme. The interface has the following four methods, with which you define the colors, fonts, images and settings for the controls of the navigation:

addCustomColors(Map<String, ILnfResource> table)
addCustomFonts(Map<String, ILnfResource> table)
addCustomImages(Map<String, ILnfResource> table)
addCustomSettings(Map<String, Object> table)

It is recommended to extend the default theme of Riena, DefaultRienaTheme. All necessary resources and settings are already defined in the default theme. You must only put your own defaults into the tables of the Look&Feel.

For example, the following line specifies the background color of a sub-module:

table.put(ILnfKeyConstants.SUB_MODULE_BACKGROUND,new ColorLnfResource(186, 193, 225));

You can find all available keys for the Look&Feel in the interface ILnfKeyConstants. Note that it is not possible to add colors from the type org.eclipse.swt.graphics.Color; the colors must be wrapped from an instance of the class ColorLnfResource (this helps with correctly disposing the Look&Feel's resources). Wrappers for fonts and images exist as well.

Custom Renderer

For nearly every control of the navigation there is a renderer responsible for painting it. These renderers can be replaced by own implementations. To write your own renderer please extend an existing default renderer.

To set your own renderer you can use extensions. For this Riena provides an extension point org.eclipse.riena.ui.swt.lnfrenderer

This extension can only have renderer elements. A renderer element has the following three attributes:

Key of the Look&Feel for the renderer (see LnfKeyConstants)
ID of your own Look&Feel (see getLnfId())
Class of the RendererExample
<extension point="org.eclipse.riena.ui.swt.lnfrenderer">
<renderer class="org.eclipse.riena.example. application.ExampleModuleGroupRenderer"

:: lnfid="ExampleLnf" :: lnfkey="ModuleGroup.renderer">


Look&Feel Keys

The class org.eclipse.riena.ui.swt.lnf.LnfKeyConstants defines a set of keys for the Look&Feel. These keys are used to access the color, fonts, images etc. of the Look&Feel.


The shell of the Riena application can be very different from other RCP applications. So it is possible to suppress the title bar and border of the operation system. Therefore the key SHELL_HIDE_OS_BORDER exists.


(Because it is possible to hide the title bar and border, all the other L&F keys for the Riena shell starts with TITLELESS_SHELL_.)

Sub-Application Switcher

The Riena application consists of one or more sub-applications. Only one sub-application can be active. The Sub-Application Switcher in the top of the application window allows you to switch between sub-applications:


Define the position of the switcher. Three values are valid: SWT.LEFT, SWT.CENTER, SWT.RIGHT.
Set to "true" if an icon shall be displayed in front of every switcher's text.

LnfSwitcher.png The image above has some strange colors. This colors are used to highlight the gradients.

The texts of the sub-applications have the foreground color (L&F key: SUB_APPLICATION_SWITCHER_FOREGROUND). If the text is disabled the color defined by SUB_APPLICATION_SWITCHER_DISABLED_FOREGROUND is used.

The backgrounds of active and passive switchers have gradients with start and end color:


The selected (active) tab has an additional gradient at the top. In the L&F only one color is defined: SUB_APPLICATION_SWITCHER_TOP_SELECTION_COLOR. The renderer of this tab calcutates the start and end color.

The border of active and passive tabs are defined with:


If the tab is disabled then the three keys


are important.

Menu Bar / Tool Bar

Define the margin at the top of the menu bar and the tool bar of the Riena application.
Define the amount of space between the bottom of the toolbar and the work area/navigation.



On the left side of a Riena application there is always the navigation view. Set the width of the navigation in the Look&Feel with this constant.
If you change this width, the width of the module-groups, module und and sub-module tree will also be changed; furthermore the width of the working area will be shrunk or grown.

Sub-Module Tree

If a module has more than one sub-module, all sub-modules will be displayed in a tree. This tree is inside the view of the module, below the module's title bar. A sub-module can have children. This children are also displayed in the sub-module tree.


You can define in the Look&Feel what icons should be displayed when a folder is open or closed. Also you can define the icon of a leaf.

will be displayed when a folder is open
will be displayed when a folder is closed
icon of a leaf (node without children)

The leaves in the sub-modules can be marked. Currently are three markers, for which you can define additional icons using the corresponding constants:

values of the sub-module are invalid.
not all required values of the sub-module have been entered.
a process of the sub-module is finished.

By default, marker icons are displayed in front of the corresponding leaf icon in the sub-module tree. If you prefer to have the markers in one place, the following constant can be used to set the global MarkerPosition of markers in a SubModuleTree:

If this property is set, all markers are sorted according to their priority (getPriority() in IMarker) and only the one with the highest priority is painted at the given MarkerPosition.

Markers influence the painting of controls depending on the marker type. Rendering of the DisabledMarker can be configured by the Look and Feel. The following constants are given:

The background for the disabled-state rendering.
The alpha value of the disabled-state rendering for simple Controls (Buttons, Labels, ...).
The alpha value of the disabled-state rendering for more complex Controls (List, Table, Tree ...).


Riena draws an own title bar and border of a dialog, if the setting DIALOG_HIDE_OS_BORDER has the value true.

Title Bar


The picture above shows a dialog with a Riena title bar.

The text of the title bar has the foreground color (L&F key: DIALOG_FOREGROUND).

The background of the title bar is a gradient with start and end color. The keys of the L&F are DIALOG_TITLEBAR_BACKGROUND_START_COLOR and DIALOG_TITLEBAR_BACKGROUND_END_COLOR.

At the top (left) and the bottom (right) of the Riena title bar are three different other colors to simulate a 3D effect:









The the dialog border is a compound of two (one pixel thick) borders. Every border has different colors a the top/left and bottom/right:







The Riena title bar of a Dialog can have three buttons at the right side and for every button the icon must be defined in the Look&Feel:

Close Button

DIALOG_CLOSE_ICON - standard close icon of a dialog

DIALOG_CLOSE_HOVER_ICON - will be displayed when the mouse pointer is over the close button

DIALOG_CLOSE_HOVER_SELECTED_ICON - will be displayed when the mouse pointer is over the close button and the mouse button is pressed

DIALOG_CLOSE_INACTIVE_ICON - will be displayed if a dialog is disabled

Minimize Button

DIALOG_MIN_ICON - standard minimize icon of a dialog

DIALOG_MIN_HOVER_ICON - will be displayed when the mouse pointer is over the minimize button

DIALOG_MIN_HOVER_SELECTED_ICON - will be displayed when the mouse pointer is over the minimize button and the mouse button is pressed

DIALOG_MIN_INACTIVE_ICON - will be displayed if a dialog is disabled

Maximize/Restore Button

DIALOG_MAX_ICON - standard maximize icon of a dialog

DIALOG_MAX_HOVER_ICON - will be displayed when the mouse pointer is over the maximize button

DIALOG_MAX_HOVER_SELECTED_ICON - will be displayed when the mouse pointer is over the maximize button and the mouse button is pressed

DIALOG_MAX_INACTIVE_ICON - will be displayed if a dialog is disabled

DIALOG_RESTORE_ICON - standard restore icon of a dialog

DIALOG_RESTORE_HOVER_ICON - will be displayed when the mouse pointer is over the restore button

DIALOG_RESTORE_HOVER_SELECTED_ICON - will be displayed when the mouse pointer is over the restore button and the mouse button is pressed

DIALOG_RESTORE_INACTIVE_ICON - will be displayed if a dialog is disabled

Embedded Title Bar

Not only the shell of the Riena application or a dialog have a title bar also other parts of the Riena have a title bar. These can be a module in the navigation or the view of the active sub-module. The name of this title bar is Embedded Titlebar.



The text of the title bar has the foreground color (activated: EMBEDDED_TITLEBAR_ACTIVE_FOREGROUND, deactivated: EMBEDDED_TITLEBAR_PASSIVE_FOREGROUND). The L&F key EMBEDDED_TITLEBAR_ACTIVE_BORDER_COLOR defines the color of the border.

The background of the Embbeded Titlebar is a gradient with start and end color. (EMBEDDED_TITLEBAR_ACTIVE_BACKGROUND_START_COLOR and EMBEDDED_TITLEBAR_ACTIVE_BACKGROUND_END_COLOR)


A module can have other states. The following pictures shows the title bar of the same module with different states: active, passive, disabled, active and mouse over, passive and mouse over:







The disabeld title bar is similar to the passive. Only the foreground and the border color can be different: EMBEDDED_TITLEBAR_DISABLED_FOREGROUND, EMBEDDED_TITLEBAR_DISABLED_BORDER_COLOR

When the mouse if over the title bar of a module then the a hover border appears. The top and the bottom of the border has tow different colors: EMBEDDED_TITLEBAR_HOVER_BORDER_TOP_COLOR, EMBEDDED_TITLEBAR_HOVER_BORDER_BOTTOM_COLOR. The left and right side of the hover border is another gradient with a start and end color: EMBEDDED_TITLEBAR_HOVER_BORDER_START_COLOR, EMBEDDED_TITLEBAR_HOVER_BORDER_END_COLOR

Close Icon

The Riena Look&Feel also defines the close icon of the module title bar:


The constants are:

EMBEDDED_TITLEBAR_CLOSE_ICON - standard close icon

EMBEDDED_TITLEBAR_CLOSE_HOVER_ICON - will be displayed when the mouse pointer is over the close button

EMBEDDED_TITLEBAR_CLOSE_HOVER_SELECTED_ICON - will be displayed when the mouse pointer is over the close button and the mouse button is pressed

EMBEDDED_TITLEBAR_CLOSE_INACTIVE_ICON - will be displayed if a module is disabled

Look&Feel and View

Inside working area of the active sub-module almost standard SWT widget are used. The properties of these widgets can also changed by the Riena Look&Feel.

Unfortunately not all changes of these properties have an effect on the apperance of the widget. So on Windows you can the font of every widget, but you can only change the foreground color of some widget: The foreground color of Text can be changed but not the foreground color of a Button.

In the Thema of the Look&Feel you can define for every kind of Widget, the default property values:

public void addCustomColors(Map<String, ILnfResource> table) {
	table.put("Label.background", getPrimaryBackground());
	table.put("Label.foreground", getPrimaryForeground());
	table.put("Text.background", new ColorLnfResource(null));
	table.put("Text.foreground", getPrimaryForeground());
public void addCustomFonts(Map<String, ILnfResource> table) {
	table.put("Button.font", getPrimaryFont());
	table.put("Label.font", getPrimaryFont());
	table.put("Text.font", getPrimaryFont());

So that the Look&Feel set all these property values you must set the system property riena.lnf.update.view=true.

Look&Feel Style

With the Riena L&F you have the possibility to associate the properties of a SWT widget with a simple style of the L&F.

The name of the style will be added to property data of the SWT widget:

Label myLabel = new Label(parent,SWT.NONE);
myLabel.setData(UIControlsFactory.KEY_LNF_STYLE, "sectionLabel");

In the L&F theme the style is defined:

public void addCustomColors(Map<String, ILnfResource> table) {
	table.put("sectionLabel.foreground", new ColorLnfResource(10, 10, 200));
public void addCustomFonts(Map<String, ILnfResource> table) {
	FontData fontData = getPrimaryFont().getFontData();
	table.put("sectionLabel.font", new FontLnfResource(fontData.getName(), fontData.getHeight(), SWT.BOLD));

One prerequisite is necessary: The system property riena.lnf.update.view must set and the value is true.