<html>
<head>
<title>Interface XStatusIndicator</title>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<link rel="stylesheet" type="text/css" href="../../../../idl.css">
</head>
<body>
<div id="adc-idlref">
<a name="_top_"> </a><table class="navimain" border="0" cellpadding="3">
<tr>
<td class="navimain"><a href="../module-ix.html" class="navimain">Overview</a></td>
<td class="navimain"><a href="module-ix.html" class="navimain">Module</a></td>
<td class="navimain"><a href="XStatusIndicator-xref.html" class="navimain">Use</a></td>
<td class="navimainnone">Devguide</td>
<td class="navimain"><a href="../../../../index-files/index-1.html" class="navimain">Index</a></td>
</tr>
</table>
<table class="navisub" border="0" cellpadding="0">
<tr>
<td class="navisub"><a href="#MethodsSummary" class="navisub">Methods' Summary</a></td>
<td class="navisub">Attributes' Summary</td>
<td class="navisub"><a href="#MethodsDetails" class="navisub">Methods' Details</a></td>
<td class="navisub">Attributes' Details</td>
</tr>
</table>
<hr>
<table border="0" width="100%" cellpadding="5" cellspacing="3" class="title-table" style="margin-bottom:6pt;">
<tr>
<td><p class="namechain"><a href="../../../../module-ix.html" class="namechain">::</a> <a href="../../../module-ix.html" class="namechain">com</a> :: <a href="../../module-ix.html" class="namechain">sun</a> :: <a href="../module-ix.html" class="namechain">star</a> :: <a href="module-ix.html" class="namechain">task</a> :: </p>
</td>
</tr>
<tr>
<td class="title">interface XStatusIndicator</td>
</tr>
<tr>
<td/></tr>
<tr>
<td><dl>
<dt><b>Description</b></dt>
<dd>controls a status indicator which displays progress of
longer actions to the user
</dd>
<dd><p>
Such objects are provided by a <a href="XStatusIndicatorFactory.html">XStatusIndicatorFactory</a>.
</p>
</dd>
<dt><b>See also</b></dt>
<dd><a href="XStatusIndicatorFactory.html">XStatusIndicatorFactory</a></dd>
</dl>
</td>
</tr>
</table>
<hr>
<a name="MethodsSummary"/><table border="1" width="100%" cellpadding="5" cellspacing="0" class="subtitle">
<tr>
<td class="subtitle" colspan="2">Methods' Summary</td>
</tr>
<tr>
<td class="imsum_left"><a href="#start">start</a></td>
<td class="imsum_right">initialize and start the progress
</td>
</tr>
<tr>
<td class="imsum_left"><a href="#end">end</a></td>
<td class="imsum_right">stop the progress
</td>
</tr>
<tr>
<td class="imsum_left"><a href="#setText">setText</a></td>
<td class="imsum_right">update progress description
</td>
</tr>
<tr>
<td class="imsum_left"><a href="#setValue">setValue</a></td>
<td class="imsum_right">update progress value
</td>
</tr>
<tr>
<td class="imsum_left"><a href="#reset">reset</a></td>
<td class="imsum_right">clear progress value and description
</td>
</tr>
</table>
<a name="MethodsDetails"/><table border="1" width="100%" cellpadding="5" cellspacing="0" class="subtitle">
<tr>
<td class="subtitle">Methods' Details</td>
</tr>
<tr>
<td class="imdetail"><a name="start" class="membertitle">start</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-method" bgcolor="#ffffff" align="center">
<tr>
<td><table class="table-in-method" border="0">
<tr>
<td valign="top" colspan="3">[oneway] void</td>
</tr>
<tr>
<td valign="top"><b>start</b>(</td>
<td valign="top">[in] string</td>
<td valign="bottom"> Text,</td>
</tr>
<tr>
<td/><td valign="top">[in] long</td>
<td valign="bottom"> Range );</td>
</tr>
</table>
<hr>
<dl>
<dt><b>Description</b></dt>
<dd>initialize and start the progress
</dd>
<dd><p>
It activates a new created or reactivate an already used inidicator
(must be finished by calling <a href="XStatusIndicator.html">XStatusIndicator</a>::<a href="XStatusIndicator.html#end">end()</a>
before!). By the way it's possible to set first progress description
and the possible range of progress value. That means that a progress
can runs from 0 to <var>Range</var>.
</p>
</dd>
<dt><b>Parameter Text</b></dt>
<dd>initial value for progress description for showing
Value can be updated by calling <a href="XStatusIndicator.html">XStatusIndicator</a>::<a href="XStatusIndicator.html#setText">setText()</a>.
</dd>
<dt><b>Parameter Range</b></dt>
<dd>mewns the maximum value of the progress which can be setted by
calling <a href="XStatusIndicator.html">XStatusIndicator</a>::<a href="XStatusIndicator.html#setValue">setValue()</a>.
</dd>
</dl>
</td>
</tr>
</table>
</td>
</tr>
<tr>
<td class="imdetail"><a name="end" class="membertitle">end</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-method" bgcolor="#ffffff" align="center">
<tr>
<td><table class="table-in-method" border="0">
<tr>
<td valign="top" colspan="3">[oneway] void</td>
</tr>
<tr>
<td valign="top"><b>end</b>();</td>
</tr>
</table>
<hr>
<dl>
<dt><b>Description</b></dt>
<dd>stop the progress
</dd>
<dd><p>
Further calls of <a href="XStatusIndicator.html">XStatusIndicator</a>::<a href="XStatusIndicator.html#setText">setText()</a>,
<a href="XStatusIndicator.html">XStatusIndicator</a>::<a href="XStatusIndicator.html#setValue">setValue()</a> or
<a href="XStatusIndicator.html">XStatusIndicator</a>::<a href="XStatusIndicator.html#reset">reset()</a> must be ignored.
Only <a href="XStatusIndicator.html">XStatusIndicator</a>::<a href="XStatusIndicator.html#start">start()</a> can reactivate this
indicator.
It's not allowed to destruct the indicator inside this method.
The instance must be gone by using ref count or disposing.
</p>
</dd>
</dl>
</td>
</tr>
</table>
</td>
</tr>
<tr>
<td class="imdetail"><a name="setText" class="membertitle">setText</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-method" bgcolor="#ffffff" align="center">
<tr>
<td><table class="table-in-method" border="0">
<tr>
<td valign="top" colspan="3">[oneway] void</td>
</tr>
<tr>
<td valign="top"><b>setText</b>(</td>
<td valign="top">[in] string</td>
<td valign="bottom"> Text );</td>
</tr>
</table>
<hr>
<dl>
<dt><b>Description</b></dt>
<dd>update progress description
</dd>
<dd><p>
Initial value can be set during starting of the progress by calling
<a href="XStatusIndicator.html">XStatusIndicator</a>::<a href="XStatusIndicator.html#start">start()</a>.
Stopped indicators must ignore this call.
</p>
</dd>
<dt><b>Parameter Text</b></dt>
<dd>new value for progress description which should be shown now
</dd>
</dl>
</td>
</tr>
</table>
</td>
</tr>
<tr>
<td class="imdetail"><a name="setValue" class="membertitle">setValue</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-method" bgcolor="#ffffff" align="center">
<tr>
<td><table class="table-in-method" border="0">
<tr>
<td valign="top" colspan="3">[oneway] void</td>
</tr>
<tr>
<td valign="top"><b>setValue</b>(</td>
<td valign="top">[in] long</td>
<td valign="bottom"> Value );</td>
</tr>
</table>
<hr>
<dl>
<dt><b>Description</b></dt>
<dd>update progress value
</dd>
<dd><p>
Wrong values must be ignored and stopped indicators must ignore this
call generaly.
</p>
</dd>
<dt><b>Parameter Value</b></dt>
<dd>new value for progress which should be shown now
Must fit the range [0..Range] which was set during
<a href="XStatusIndicator.html">XStatusIndicator</a>::<a href="XStatusIndicator.html#start">start()</a>.
</dd>
</dl>
</td>
</tr>
</table>
</td>
</tr>
<tr>
<td class="imdetail"><a name="reset" class="membertitle">reset</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-method" bgcolor="#ffffff" align="center">
<tr>
<td><table class="table-in-method" border="0">
<tr>
<td valign="top" colspan="3">[oneway] void</td>
</tr>
<tr>
<td valign="top"><b>reset</b>();</td>
</tr>
</table>
<hr>
<dl>
<dt><b>Description</b></dt>
<dd>clear progress value and description
</dd>
<dd><p>
Calling of setValue(0) and setText("") should do the same.
Stopped indicators must ignore this call.
</p>
</dd>
</dl>
</td>
</tr>
</table>
</td>
</tr>
</table>
<a href="#_top_">Top of Page</a><hr size="3"><p class="copyright" align="center">Copyright © 2011, Oracle and/or its affiliates. All rights reserved. Oracle and Java are registered trademarks of Oracle and/or its affiliates. Other names may be trademarks of their respective owners.</p>
</div> <!-- id="adc-idlref" -->
</body>
</html>
distrib
>
Mandriva
>
current
>
i586
>
media
>
main-updates
>
by-pkgid
>
fc480f9d5aabed8eeaffe8ad3401a94c
>
files
>
6620
