View source for Nebula Header

[[Nebula|< Back to Nebula Main Page]]

==Introduction==

[[File:Header.png]]

A widget that display a header, composed of a title, an image and a description.

__TOC__

==Usage==

The header is composed of :
* A title (cf. <code>setTitle</code>), displayed in bold and in blue by default.
** You can change the font and the color by setting the 2 properties <code>titleFont</code> and <code>titleColor</code>
* A description (cf. <code>setDescription</code>)
* An image (optional, cf. <code>setImage</code>)
* A gradient background
** You can change the color by setting the properties <code>gradientStart</code> and <code>gradientEnd</code>

The description can contains some pseudo-HTML tags for formatting :
* <code><nowiki><br/></nowiki></code> for adding a line break
* <code><nowiki><i>...</i></nowiki></code> to render text in italic
* <code><nowiki><u>...</u></nowiki></code> to render text in underline
* <code><nowiki><b>...</b></nowiki></code> to render text in bold
* <code><nowiki><size>...</size></nowiki></code> to increase/decrease text size. You can use the following syntaxes : <code><nowiki><size=10> (10px), <size=+4>, <size=-4></nowiki></code>
* <code><nowiki><color>...</color></nowiki></code> to change foreground color. You can use the following syntaxes : <code><nowiki><color=#FFCCAA></nowiki></code> (HTML color code),  <code><nowiki><color=9,255,10></nowiki></code> (RGB values) and  <code><nowiki><color=aliceblue</nowiki></code>> (HTML color code)
* <code><nowiki><backgroundcolor>...</backgroundcolor></nowiki></code> to change background color. You can use the following syntaxes :  <code><nowiki><backgroundcolor=#FFCCAA></nowiki></code> (HTML color code),  <code><nowiki><backgroundcolor=9,255,10></nowiki></code> (RGB values) and  <code><nowiki><backgroundcolor=aliceblue></nowiki></code> (HTML color code)

 
 final Header header = new Header(shell, SWT.NONE);
 header.setTitle("Header title");
 header.setImage(icon);
 header.setDescription("Description area for the header. You can put all <b>additional</b>, <i>relevant information</i> to the description panel (or <u>jokes</u>, citations, ... what you want !)");

==Example==

An example called HeaderSnippet.java is located in the plugin org.eclipse.nebula.widgets.opal.header.snippets.

This example is also available here : [https://github.com/eclipse/nebula/blob/master/widgets/opal/header/org.eclipse.nebula.widgets.opal.header/src/org/eclipse/nebula/widgets/opal/header/Header.java HeaderSnippet.java]