View source for Nebula SegmentedBar

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

==Introduction==

[[File:Segmentedbar.png]]

A widget that displays a horizontal bar that visualizes the segmentation of a total value. It consists of several segments, each segment representing a value.
The sum of all values is the total value of the bar.

__TOC__

==Usage==

The first thing to do is to instantiate the widget, then you add segment(s) (by calling the methods <code>setSegments</code> or <code>addSegment</code>).

 SegmentedBar sb1 = new SegmentedBar(shell, SWT.NONE);
 sb1.addSegment(Segment.create().setBackground(blue).setValue(10d));
 sb1.addSegment(Segment.create().setBackground(blue).setValue(10d));
 sb1.addSegment(Segment.create().setBackground(blue).setValue(10d));
 sb1.addSegment(Segment.create().setBackground(blue).setValue(20d));
 sb1.addSegment(Segment.create().setBackground(blue).setValue(50d));

The spacing between different segments can changed by using the method <code>setSpacing</code> on the '''SegmentedBar''' widget.


You can customize also a segment :
* Specify a text : <code>setText()</code>
* Specify a tooltip : <code>setTooltip()</code>
* Specify a numeric (Double) value : <code>setValue()</code>
* Specify a font : <code>setFont()</code>
* Specify a background color : <code>setBackground()</code>
* Specify a foreground color (for the text) : <code>setForeground()</code>


You can also store data : <code>setData(Object value)</code> and <code>setData(String key, Object value)</code>

Segment is based on the '''Builder''' pattern, so you chain setters. 

==Example==

An example called SegmentedBarSnippet.java is located in the plugin org.eclipse.nebula.widgets.segmentedbar.snippets.

This example is also available here : [https://raw.githubusercontent.com/eclipse/nebula/master/widgets/segmentedbar/org.eclipse.nebula.widgets.segmentedbar.snippets/src/org/eclipse/nebula/widgets/segmentedbar/SegmentedBarSnippet.java SegmentedBarSnippet.java]