Google Git
Sign in
eclipse / gerrit / www.eclipse.org / nebula / edddf1c46f5aee0e7de034aaa627130ae4d84c93 / . / releases / 2.4.3 / javadoc / org / eclipse / nebula / widgets / stepbar / Stepbar.html
blob: 115377cb85f45a19a3d8246af0287a04b6595854 [file] [log] [blame]
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<!-- NewPage -->
<html lang="en">
<head>
<!-- Generated by javadoc (1.8.0_201) on Thu Jul 23 15:58:32 CEST 2020 -->
<title>Stepbar</title>
<meta name="date" content="2020-07-23">
<link rel="stylesheet" type="text/css" href="../../../../../stylesheet.css" title="Style">
<script type="text/javascript" src="../../../../../script.js"></script>
</head>
<body>
<script type="text/javascript"><!--
try {
if (location.href.indexOf('is-external=true') == -1) {
parent.document.title="Stepbar";
}
}
catch(err) {
}
//-->
var methods = {"i0":10,"i1":10,"i2":10,"i3":10,"i4":10,"i5":10,"i6":10,"i7":10,"i8":10,"i9":10,"i10":10,"i11":10,"i12":10};
var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],8:["t4","Concrete Methods"]};
var altColor = "altColor";
var rowColor = "rowColor";
var tableTab = "tableTab";
var activeTableTab = "activeTableTab";
</script>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
<!-- ========= START OF TOP NAVBAR ======= -->
<div class="topNav"><a name="navbar.top">
<!-- -->
</a>
<div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div>
<a name="navbar.top.firstrow">
<!-- -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../../../../overview-summary.html">Overview</a></li>
<li><a href="package-summary.html">Package</a></li>
<li class="navBarCell1Rev">Class</li>
<li><a href="class-use/Stepbar.html">Use</a></li>
<li><a href="package-tree.html">Tree</a></li>
<li><a href="../../../../../deprecated-list.html">Deprecated</a></li>
<li><a href="../../../../../index-files/index-1.html">Index</a></li>
<li><a href="../../../../../help-doc.html">Help</a></li>
</ul>
</div>
<div class="subNav">
<ul class="navList">
<li>Prev&nbsp;Class</li>
<li>Next&nbsp;Class</li>
</ul>
<ul class="navList">
<li><a href="../../../../../index.html?org/eclipse/nebula/widgets/stepbar/Stepbar.html" target="_top">Frames</a></li>
<li><a href="Stepbar.html" target="_top">No&nbsp;Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_top">
<li><a href="../../../../../allclasses-noframe.html">All&nbsp;Classes</a></li>
</ul>
<div>
<script type="text/javascript"><!--
allClassesLink = document.getElementById("allclasses_navbar_top");
if(window==top) {
allClassesLink.style.display = "block";
}
else {
allClassesLink.style.display = "none";
}
//-->
</script>
</div>
<div>
<ul class="subNavList">
<li>Summary:&nbsp;</li>
<li>Nested&nbsp;|&nbsp;</li>
<li><a href="#fields.inherited.from.class.org.eclipse.swt.widgets.Control">Field</a>&nbsp;|&nbsp;</li>
<li><a href="#constructor.summary">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method.summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li><a href="#constructor.detail">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method.detail">Method</a></li>
</ul>
</div>
<a name="skip.navbar.top">
<!-- -->
</a></div>
<!-- ========= END OF TOP NAVBAR ========= -->
<!-- ======== START OF CLASS DATA ======== -->
<div class="header">
<div class="subTitle">org.eclipse.nebula.widgets.stepbar</div>
<h2 title="Class Stepbar" class="title">Class Stepbar</h2>
</div>
<div class="contentContainer">
<ul class="inheritance">
<li>java.lang.Object</li>
<li>
<ul class="inheritance">
<li>org.eclipse.swt.widgets.Widget</li>
<li>
<ul class="inheritance">
<li>org.eclipse.swt.widgets.Control</li>
<li>
<ul class="inheritance">
<li>org.eclipse.swt.widgets.Scrollable</li>
<li>
<ul class="inheritance">
<li>org.eclipse.swt.widgets.Composite</li>
<li>
<ul class="inheritance">
<li>org.eclipse.swt.widgets.Canvas</li>
<li>
<ul class="inheritance">
<li>org.eclipse.nebula.widgets.stepbar.Stepbar</li>
</ul>
</li>
</ul>
</li>
</ul>
</li>
</ul>
</li>
</ul>
</li>
</ul>
</li>
</ul>
<div class="description">
<ul class="blockList">
<li class="blockList">
<dl>
<dt>All Implemented Interfaces:</dt>
<dd>org.eclipse.swt.graphics.Drawable</dd>
</dl>
<hr>
<br>
<pre>public class <span class="typeNameLabel">Stepbar</span>
extends org.eclipse.swt.widgets.Canvas</pre>
<div class="block">Instances of this class represent a collection of steps, indicating
progress/status in a linear order. Each step has a label. One can select the
current step, and possibly set an error state.
<dl>
<dt><b>Styles:</b></dt>
<dd>SWT.BORDER</dd>
<dd>SWT.TOP or SWT.BOTTOM (vertical location of the text)</dd>
<dt><b>Events:</b></dt>
<dd>(none)</dd>
</dl></div>
</li>
</ul>
</div>
<div class="summary">
<ul class="blockList">
<li class="blockList">
<!-- =========== FIELD SUMMARY =========== -->
<ul class="blockList">
<li class="blockList"><a name="field.summary">
<!-- -->
</a>
<h3>Field Summary</h3>
<ul class="blockList">
<li class="blockList"><a name="fields.inherited.from.class.org.eclipse.swt.widgets.Control">
<!-- -->
</a>
<h3>Fields inherited from class&nbsp;org.eclipse.swt.widgets.Control</h3>
<code>handle</code></li>
</ul>
</li>
</ul>
<!-- ======== CONSTRUCTOR SUMMARY ======== -->
<ul class="blockList">
<li class="blockList"><a name="constructor.summary">
<!-- -->
</a>
<h3>Constructor Summary</h3>
<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Constructor Summary table, listing constructors, and an explanation">
<caption><span>Constructors</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colOne" scope="col">Constructor and Description</th>
</tr>
<tr class="altColor">
<td class="colOne"><code><span class="memberNameLink"><a href="../../../../../org/eclipse/nebula/widgets/stepbar/Stepbar.html#Stepbar-org.eclipse.swt.widgets.Composite-int-">Stepbar</a></span>(org.eclipse.swt.widgets.Composite&nbsp;parent,
int&nbsp;style)</code>
<div class="block">Constructs a new instance of this class given its parent and a style value
describing its behavior and appearance.</div>
</td>
</tr>
</table>
</li>
</ul>
<!-- ========== METHOD SUMMARY =========== -->
<ul class="blockList">
<li class="blockList"><a name="method.summary">
<!-- -->
</a>
<h3>Method Summary</h3>
<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation">
<caption><span id="t0" class="activeTableTab"><span>All Methods</span><span class="tabEnd">&nbsp;</span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd">&nbsp;</span></span><span id="t4" class="tableTab"><span><a href="javascript:show(8);">Concrete Methods</a></span><span class="tabEnd">&nbsp;</span></span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colLast" scope="col">Method and Description</th>
</tr>
<tr id="i0" class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/eclipse/nebula/widgets/stepbar/Stepbar.html#addStep-java.lang.String-">addStep</a></span>(java.lang.String&nbsp;stepText)</code>
<div class="block">Append a step to the existing ones</div>
</td>
</tr>
<tr id="i1" class="rowColor">
<td class="colFirst"><code>org.eclipse.swt.graphics.Point</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/eclipse/nebula/widgets/stepbar/Stepbar.html#computeSize-int-int-boolean-">computeSize</a></span>(int&nbsp;wHint,
int&nbsp;hHint,
boolean&nbsp;changed)</code>&nbsp;</td>
</tr>
<tr id="i2" class="altColor">
<td class="colFirst"><code>int</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/eclipse/nebula/widgets/stepbar/Stepbar.html#getCurrentStep--">getCurrentStep</a></span>()</code>
<div class="block">Returns the receiver's current step.</div>
</td>
</tr>
<tr id="i3" class="rowColor">
<td class="colFirst"><code>java.util.List&lt;java.lang.String&gt;</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/eclipse/nebula/widgets/stepbar/Stepbar.html#getSteps--">getSteps</a></span>()</code>
<div class="block">Returns the receiver's list of steps</div>
</td>
</tr>
<tr id="i4" class="altColor">
<td class="colFirst"><code>org.eclipse.swt.graphics.Color</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/eclipse/nebula/widgets/stepbar/Stepbar.html#getTextColor--">getTextColor</a></span>()</code>
<div class="block">Returns the receiver's color of the text</div>
</td>
</tr>
<tr id="i5" class="rowColor">
<td class="colFirst"><code>org.eclipse.swt.graphics.Color</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/eclipse/nebula/widgets/stepbar/Stepbar.html#getUnselectedColor--">getUnselectedColor</a></span>()</code>
<div class="block">Returns the receiver's color used when the step is not reached</div>
</td>
</tr>
<tr id="i6" class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/eclipse/nebula/widgets/stepbar/Stepbar.html#removeStep-java.lang.String-">removeStep</a></span>(java.lang.String&nbsp;stepText)</code>
<div class="block">Remove a step from the list of the existing ones</div>
</td>
</tr>
<tr id="i7" class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/eclipse/nebula/widgets/stepbar/Stepbar.html#setCurrentStep-int-">setCurrentStep</a></span>(int&nbsp;currentStep)</code>
<div class="block">Remove a step from the list of the existing ones</div>
</td>
</tr>
<tr id="i8" class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/eclipse/nebula/widgets/stepbar/Stepbar.html#setErrorState-boolean-">setErrorState</a></span>(boolean&nbsp;errorState)</code>
<div class="block">Set the error state (on/off) of the selected step</div>
</td>
</tr>
<tr id="i9" class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/eclipse/nebula/widgets/stepbar/Stepbar.html#setSteps-java.util.List-">setSteps</a></span>(java.util.List&lt;java.lang.String&gt;&nbsp;steps)</code>
<div class="block">Set the steps</div>
</td>
</tr>
<tr id="i10" class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/eclipse/nebula/widgets/stepbar/Stepbar.html#setSteps-java.lang.String:A-">setSteps</a></span>(java.lang.String[]&nbsp;steps)</code>
<div class="block">Set the steps</div>
</td>
</tr>
<tr id="i11" class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/eclipse/nebula/widgets/stepbar/Stepbar.html#setTextColor-org.eclipse.swt.graphics.Color-">setTextColor</a></span>(org.eclipse.swt.graphics.Color&nbsp;textColor)</code>
<div class="block">Set the color of the text</div>
</td>
</tr>
<tr id="i12" class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/eclipse/nebula/widgets/stepbar/Stepbar.html#setUnselectedColor-org.eclipse.swt.graphics.Color-">setUnselectedColor</a></span>(org.eclipse.swt.graphics.Color&nbsp;unselectedColor)</code>
<div class="block">Set the color used to draw bars and circles for steps that have not been reached</div>
</td>
</tr>
</table>
<ul class="blockList">
<li class="blockList"><a name="methods.inherited.from.class.org.eclipse.swt.widgets.Canvas">
<!-- -->
</a>
<h3>Methods inherited from class&nbsp;org.eclipse.swt.widgets.Canvas</h3>
<code>drawBackground, getCaret, getIME, scroll, setCaret, setFont, setIME</code></li>
</ul>
<ul class="blockList">
<li class="blockList"><a name="methods.inherited.from.class.org.eclipse.swt.widgets.Composite">
<!-- -->
</a>
<h3>Methods inherited from class&nbsp;org.eclipse.swt.widgets.Composite</h3>
<code>changed, checkSubclass, drawBackground, getBackgroundMode, getChildren, getLayout, getLayoutDeferred, getTabList, isLayoutDeferred, layout, layout, layout, layout, layout, setBackgroundMode, setFocus, setLayout, setLayoutDeferred, setTabList</code></li>
</ul>
<ul class="blockList">
<li class="blockList"><a name="methods.inherited.from.class.org.eclipse.swt.widgets.Scrollable">
<!-- -->
</a>
<h3>Methods inherited from class&nbsp;org.eclipse.swt.widgets.Scrollable</h3>
<code>computeTrim, getClientArea, getHorizontalBar, getScrollbarsMode, getVerticalBar</code></li>
</ul>
<ul class="blockList">
<li class="blockList"><a name="methods.inherited.from.class.org.eclipse.swt.widgets.Control">
<!-- -->
</a>
<h3>Methods inherited from class&nbsp;org.eclipse.swt.widgets.Control</h3>
<code>addControlListener, addDragDetectListener, addFocusListener, addGestureListener, addHelpListener, addKeyListener, addMenuDetectListener, addMouseListener, addMouseMoveListener, addMouseTrackListener, addMouseWheelListener, addPaintListener, addTouchListener, addTraverseListener, computeSize, dragDetect, dragDetect, forceFocus, getAccessible, getBackground, getBackgroundImage, getBorderWidth, getBounds, getCursor, getDragDetect, getEnabled, getFont, getForeground, getLayoutData, getLocation, getMenu, getMonitor, getOrientation, getParent, getRegion, getShell, getSize, getTextDirection, getToolTipText, getTouchEnabled, getVisible, internal_dispose_GC, internal_new_GC, isEnabled, isFocusControl, isReparentable, isVisible, moveAbove, moveBelow, pack, pack, print, redraw, redraw, removeControlListener, removeDragDetectListener, removeFocusListener, removeGestureListener, removeHelpListener, removeKeyListener, removeMenuDetectListener, removeMouseListener, removeMouseMoveListener, removeMouseTrackListener, removeMouseWheelListener, removePaintListener, removeTouchListener, removeTraverseListener, requestLayout, setBackground, setBackgroundImage, setBounds, setBounds, setCapture, setCursor, setDragDetect, setEnabled, setForeground, setLayoutData, setLocation, setLocation, setMenu, setOrientation, setParent, setRedraw, setRegion, setSize, setSize, setTextDirection, setToolTipText, setTouchEnabled, setVisible, toControl, toControl, toDisplay, toDisplay, traverse, traverse, traverse, update</code></li>
</ul>
<ul class="blockList">
<li class="blockList"><a name="methods.inherited.from.class.org.eclipse.swt.widgets.Widget">
<!-- -->
</a>
<h3>Methods inherited from class&nbsp;org.eclipse.swt.widgets.Widget</h3>
<code>addDisposeListener, addListener, checkWidget, dispose, getData, getData, getDisplay, getListeners, getStyle, isAutoDirection, isDisposed, isListening, notifyListeners, removeDisposeListener, removeListener, removeListener, reskin, setData, setData, toString</code></li>
</ul>
<ul class="blockList">
<li class="blockList"><a name="methods.inherited.from.class.java.lang.Object">
<!-- -->
</a>
<h3>Methods inherited from class&nbsp;java.lang.Object</h3>
<code>clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait</code></li>
</ul>
<ul class="blockList">
<li class="blockList"><a name="methods.inherited.from.class.org.eclipse.swt.graphics.Drawable">
<!-- -->
</a>
<h3>Methods inherited from interface&nbsp;org.eclipse.swt.graphics.Drawable</h3>
<code>isAutoScalable</code></li>
</ul>
</li>
</ul>
</li>
</ul>
</div>
<div class="details">
<ul class="blockList">
<li class="blockList">
<!-- ========= CONSTRUCTOR DETAIL ======== -->
<ul class="blockList">
<li class="blockList"><a name="constructor.detail">
<!-- -->
</a>
<h3>Constructor Detail</h3>
<a name="Stepbar-org.eclipse.swt.widgets.Composite-int-">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>Stepbar</h4>
<pre>public&nbsp;Stepbar(org.eclipse.swt.widgets.Composite&nbsp;parent,
int&nbsp;style)</pre>
<div class="block">Constructs a new instance of this class given its parent and a style value
describing its behavior and appearance.
<p>
The style value is either one of the style constants defined in class
<code>SWT</code> which is applicable to instances of this class, or must be
built by <em>bitwise OR</em>'ing together (that is, using the
<code>int</code> "|" operator) two or more of those <code>SWT</code> style
constants. The class description lists the style constants that are
applicable to the class. Style bits are also inherited from superclasses.
</p></div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>parent</code> - a composite control which will be the parent of the new instance (cannot be null)</dd>
<dd><code>style</code> - the style of control to construct</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code>java.lang.IllegalArgumentException</code> - <ul>
<li>ERROR_NULL_ARGUMENT - if the parent is null</li>
</ul></dd>
<dd><code>org.eclipse.swt.SWTException</code> - <ul>
<li>ERROR_THREAD_INVALID_ACCESS - if not called from the
thread that created the parent</li>
<li>ERROR_INVALID_SUBCLASS - if this class is not an allowed
subclass</li>
</ul></dd>
</dl>
</li>
</ul>
</li>
</ul>
<!-- ============ METHOD DETAIL ========== -->
<ul class="blockList">
<li class="blockList"><a name="method.detail">
<!-- -->
</a>
<h3>Method Detail</h3>
<a name="addStep-java.lang.String-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>addStep</h4>
<pre>public&nbsp;void&nbsp;addStep(java.lang.String&nbsp;stepText)</pre>
<div class="block">Append a step to the existing ones</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>stepText</code> - the text associated to the step the user wants to add</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code>org.eclipse.swt.SWTException</code> - <ul>
<li>ERROR_WIDGET_DISPOSED - if the receiver has been
disposed</li>
<li>ERROR_THREAD_INVALID_ACCESS - if not called from the
thread that created the receiver</li>
<li>ERROR_NULL_ARGUMENT - if the stepText is null or
empty</li>
</ul></dd>
</dl>
</li>
</ul>
<a name="computeSize-int-int-boolean-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>computeSize</h4>
<pre>public&nbsp;org.eclipse.swt.graphics.Point&nbsp;computeSize(int&nbsp;wHint,
int&nbsp;hHint,
boolean&nbsp;changed)</pre>
<dl>
<dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
<dd><code>computeSize</code>&nbsp;in class&nbsp;<code>org.eclipse.swt.widgets.Control</code></dd>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><code>Control.computeSize(int, int, boolean)</code></dd>
</dl>
</li>
</ul>
<a name="getCurrentStep--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getCurrentStep</h4>
<pre>public&nbsp;int&nbsp;getCurrentStep()</pre>
<div class="block">Returns the receiver's current step.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the current step (starting index is 0)</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code>org.eclipse.swt.SWTException</code> - <ul>
<li>ERROR_WIDGET_DISPOSED - if the receiver has been
disposed</li>
<li>ERROR_THREAD_INVALID_ACCESS - if not called from the
thread that created the receiver</li>
</ul></dd>
</dl>
</li>
</ul>
<a name="getSteps--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getSteps</h4>
<pre>public&nbsp;java.util.List&lt;java.lang.String&gt;&nbsp;getSteps()</pre>
<div class="block">Returns the receiver's list of steps</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the color</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code>org.eclipse.swt.SWTException</code> - <ul>
<li>ERROR_WIDGET_DISPOSED - if the receiver has been
disposed</li>
<li>ERROR_THREAD_INVALID_ACCESS - if not called from the
thread that created the receiver</li>
</ul></dd>
</dl>
</li>
</ul>
<a name="getTextColor--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getTextColor</h4>
<pre>public&nbsp;org.eclipse.swt.graphics.Color&nbsp;getTextColor()</pre>
<div class="block">Returns the receiver's color of the text</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the color</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code>org.eclipse.swt.SWTException</code> - <ul>
<li>ERROR_WIDGET_DISPOSED - if the receiver has been
disposed</li>
<li>ERROR_THREAD_INVALID_ACCESS - if not called from the
thread that created the receiver</li>
</ul></dd>
</dl>
</li>
</ul>
<a name="getUnselectedColor--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getUnselectedColor</h4>
<pre>public&nbsp;org.eclipse.swt.graphics.Color&nbsp;getUnselectedColor()</pre>
<div class="block">Returns the receiver's color used when the step is not reached</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the color</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code>org.eclipse.swt.SWTException</code> - <ul>
<li>ERROR_WIDGET_DISPOSED - if the receiver has been
disposed</li>
<li>ERROR_THREAD_INVALID_ACCESS - if not called from the
thread that created the receiver</li>
</ul></dd>
</dl>
</li>
</ul>
<a name="removeStep-java.lang.String-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>removeStep</h4>
<pre>public&nbsp;void&nbsp;removeStep(java.lang.String&nbsp;stepText)</pre>
<div class="block">Remove a step from the list of the existing ones</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>stepText</code> - the text associated to the removed step</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code>org.eclipse.swt.SWTException</code> - <ul>
<li>ERROR_WIDGET_DISPOSED - if the receiver has been
disposed</li>
<li>ERROR_THREAD_INVALID_ACCESS - if not called from the
thread that created the receiver</li>
<li>ERROR_NULL_ARGUMENT - if the stepText is null or
empty</li>
</ul></dd>
</dl>
</li>
</ul>
<a name="setCurrentStep-int-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setCurrentStep</h4>
<pre>public&nbsp;void&nbsp;setCurrentStep(int&nbsp;currentStep)</pre>
<div class="block">Remove a step from the list of the existing ones</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>stepText</code> - the text associated to the removed step</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code>org.eclipse.swt.SWTException</code> - <ul>
<li>ERROR_WIDGET_DISPOSED - if the receiver has been
disposed</li>
<li>ERROR_THREAD_INVALID_ACCESS - if not called from the
thread that created the receiver</li>
<li>ERROR_NULL_ARGUMENT - if the stepText is null or
empty</li>
</ul></dd>
</dl>
</li>
</ul>
<a name="setUnselectedColor-org.eclipse.swt.graphics.Color-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setUnselectedColor</h4>
<pre>public&nbsp;void&nbsp;setUnselectedColor(org.eclipse.swt.graphics.Color&nbsp;unselectedColor)</pre>
<div class="block">Set the color used to draw bars and circles for steps that have not been reached</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>unselectedColor</code> - the new color</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code>org.eclipse.swt.SWTException</code> - <ul>
<li>ERROR_WIDGET_DISPOSED - if the receiver has been
disposed</li>
<li>ERROR_THREAD_INVALID_ACCESS - if not called from the
thread that created the receiver</li>
</ul></dd>
</dl>
</li>
</ul>
<a name="setErrorState-boolean-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setErrorState</h4>
<pre>public&nbsp;void&nbsp;setErrorState(boolean&nbsp;errorState)</pre>
<div class="block">Set the error state (on/off) of the selected step</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>errorState</code> - the new error state</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code>org.eclipse.swt.SWTException</code> - <ul>
<li>ERROR_WIDGET_DISPOSED - if the receiver has been
disposed</li>
<li>ERROR_THREAD_INVALID_ACCESS - if not called from the
thread that created the receiver</li>
</ul></dd>
</dl>
</li>
</ul>
<a name="setSteps-java.lang.String:A-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setSteps</h4>
<pre>public&nbsp;void&nbsp;setSteps(java.lang.String[]&nbsp;steps)</pre>
<div class="block">Set the steps</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>steps</code> - an array of steps</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code>org.eclipse.swt.SWTException</code> - <ul>
<li>ERROR_WIDGET_DISPOSED - if the receiver has been
disposed</li>
<li>ERROR_THREAD_INVALID_ACCESS - if not called from the
thread that created the receiver</li>
<li>ERROR_NULL_ARGUMENT - if the array of steps is null</li>
</ul></dd>
</dl>
</li>
</ul>
<a name="setSteps-java.util.List-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setSteps</h4>
<pre>public&nbsp;void&nbsp;setSteps(java.util.List&lt;java.lang.String&gt;&nbsp;steps)</pre>
<div class="block">Set the steps</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>steps</code> - a list of steps</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code>org.eclipse.swt.SWTException</code> - <ul>
<li>ERROR_WIDGET_DISPOSED - if the receiver has been
disposed</li>
<li>ERROR_THREAD_INVALID_ACCESS - if not called from the
thread that created the receiver</li>
<li>ERROR_NULL_ARGUMENT - if the list of steps is null</li>
</ul></dd>
</dl>
</li>
</ul>
<a name="setTextColor-org.eclipse.swt.graphics.Color-">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>setTextColor</h4>
<pre>public&nbsp;void&nbsp;setTextColor(org.eclipse.swt.graphics.Color&nbsp;textColor)</pre>
<div class="block">Set the color of the text</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>textColor</code> - the new color</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code>org.eclipse.swt.SWTException</code> - <ul>
<li>ERROR_WIDGET_DISPOSED - if the receiver has been
disposed</li>
<li>ERROR_THREAD_INVALID_ACCESS - if not called from the
thread that created the receiver</li>
</ul></dd>
</dl>
</li>
</ul>
</li>
</ul>
</li>
</ul>
</div>
</div>
<!-- ========= END OF CLASS DATA ========= -->
<!-- ======= START OF BOTTOM NAVBAR ====== -->
<div class="bottomNav"><a name="navbar.bottom">
<!-- -->
</a>
<div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div>
<a name="navbar.bottom.firstrow">
<!-- -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../../../../overview-summary.html">Overview</a></li>
<li><a href="package-summary.html">Package</a></li>
<li class="navBarCell1Rev">Class</li>
<li><a href="class-use/Stepbar.html">Use</a></li>
<li><a href="package-tree.html">Tree</a></li>
<li><a href="../../../../../deprecated-list.html">Deprecated</a></li>
<li><a href="../../../../../index-files/index-1.html">Index</a></li>
<li><a href="../../../../../help-doc.html">Help</a></li>
</ul>
</div>
<div class="subNav">
<ul class="navList">
<li>Prev&nbsp;Class</li>
<li>Next&nbsp;Class</li>
</ul>
<ul class="navList">
<li><a href="../../../../../index.html?org/eclipse/nebula/widgets/stepbar/Stepbar.html" target="_top">Frames</a></li>
<li><a href="Stepbar.html" target="_top">No&nbsp;Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_bottom">
<li><a href="../../../../../allclasses-noframe.html">All&nbsp;Classes</a></li>
</ul>
<div>
<script type="text/javascript"><!--
allClassesLink = document.getElementById("allclasses_navbar_bottom");
if(window==top) {
allClassesLink.style.display = "block";
}
else {
allClassesLink.style.display = "none";
}
//-->
</script>
</div>
<div>
<ul class="subNavList">
<li>Summary:&nbsp;</li>
<li>Nested&nbsp;|&nbsp;</li>
<li><a href="#fields.inherited.from.class.org.eclipse.swt.widgets.Control">Field</a>&nbsp;|&nbsp;</li>
<li><a href="#constructor.summary">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method.summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li><a href="#constructor.detail">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method.detail">Method</a></li>
</ul>
</div>
<a name="skip.navbar.bottom">
<!-- -->
</a></div>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
</body>
</html>