blob: 86177c7f304ff52e782a1649b6aa2bfa8b1cfb75 [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_181) on Fri Sep 14 11:34:55 BST 2018 -->
<title>S-Index (Progress API)</title>
<meta name="date" content="2018-09-14">
<link rel="stylesheet" type="text/css" href="../javadoc.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="S-Index (Progress API)";
}
}
catch(err) {
}
//-->
</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>Package</li>
<li>Class</li>
<li>Use</li>
<li><a href="../overview-tree.html">Tree</a></li>
<li><a href="../deprecated-list.html">Deprecated</a></li>
<li class="navBarCell1Rev">Index</li>
<li><a href="../help-doc.html">Help</a></li>
</ul>
<div class="aboutLanguage">org.netbeans.api.progress/1 1.49.1 </div>
</div>
<div class="subNav">
<ul class="navList">
<li><a href="index-13.html">Prev Letter</a></li>
<li><a href="index-15.html">Next Letter</a></li>
</ul>
<ul class="navList">
<li><a href="../index.html?index-files/index-14.html" target="_top">Frames</a></li>
<li><a href="index-14.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>
<a name="skip.navbar.top">
<!-- -->
</a></div>
<!-- ========= END OF TOP NAVBAR ========= -->
<div class="contentContainer"><a href="index-1.html">A</a>&nbsp;<a href="index-2.html">B</a>&nbsp;<a href="index-3.html">C</a>&nbsp;<a href="index-4.html">D</a>&nbsp;<a href="index-5.html">E</a>&nbsp;<a href="index-6.html">F</a>&nbsp;<a href="index-7.html">G</a>&nbsp;<a href="index-8.html">I</a>&nbsp;<a href="index-9.html">M</a>&nbsp;<a href="index-10.html">N</a>&nbsp;<a href="index-11.html">O</a>&nbsp;<a href="index-12.html">P</a>&nbsp;<a href="index-13.html">R</a>&nbsp;<a href="index-14.html">S</a>&nbsp;<a href="index-15.html">T</a>&nbsp;<a name="I:S">
<!-- -->
</a>
<h2 class="title">S</h2>
<dl>
<dt><span class="memberNameLink"><a href="../org/netbeans/modules/progress/spi/InternalHandle.html#setController-org.netbeans.modules.progress.spi.Controller-">setController(Controller)</a></span> - Method in class org.netbeans.modules.progress.spi.<a href="../org/netbeans/modules/progress/spi/InternalHandle.html" title="class in org.netbeans.modules.progress.spi">InternalHandle</a></dt>
<dd>&nbsp;</dd>
<dt><span class="memberNameLink"><a href="../org/netbeans/api/progress/aggregate/AggregateProgressHandle.html#setDisplayName-java.lang.String-">setDisplayName(String)</a></span> - Method in class org.netbeans.api.progress.aggregate.<a href="../org/netbeans/api/progress/aggregate/AggregateProgressHandle.html" title="class in org.netbeans.api.progress.aggregate">AggregateProgressHandle</a></dt>
<dd>
<div class="block">change the display name of the progress task.</div>
</dd>
<dt><span class="memberNameLink"><a href="../org/netbeans/api/progress/ProgressHandle.html#setDisplayName-java.lang.String-">setDisplayName(String)</a></span> - Method in class org.netbeans.api.progress.<a href="../org/netbeans/api/progress/ProgressHandle.html" title="class in org.netbeans.api.progress">ProgressHandle</a></dt>
<dd>
<div class="block">Change the display name of the progress task.</div>
</dd>
<dt><span class="memberNameLink"><a href="../org/netbeans/api/progress/aggregate/AggregateProgressHandle.html#setInitialDelay-int-">setInitialDelay(int)</a></span> - Method in class org.netbeans.api.progress.aggregate.<a href="../org/netbeans/api/progress/aggregate/AggregateProgressHandle.html" title="class in org.netbeans.api.progress.aggregate">AggregateProgressHandle</a></dt>
<dd>
<div class="block">allows to set a custom initial delay for the progress task to appear in the
status bar.</div>
</dd>
<dt><span class="memberNameLink"><a href="../org/netbeans/api/progress/ProgressHandle.html#setInitialDelay-int-">setInitialDelay(int)</a></span> - Method in class org.netbeans.api.progress.<a href="../org/netbeans/api/progress/ProgressHandle.html" title="class in org.netbeans.api.progress">ProgressHandle</a></dt>
<dd>
<div class="block">Set a custom initial delay for the progress task to appear in the status bar.</div>
</dd>
<dt><span class="memberNameLink"><a href="../org/netbeans/modules/progress/spi/InternalHandle.html#setInitialDelay-int-">setInitialDelay(int)</a></span> - Method in class org.netbeans.modules.progress.spi.<a href="../org/netbeans/modules/progress/spi/InternalHandle.html" title="class in org.netbeans.modules.progress.spi">InternalHandle</a></dt>
<dd>&nbsp;</dd>
<dt><span class="memberNameLink"><a href="../org/netbeans/modules/progress/spi/ProgressUIWorkerWithModel.html#setModel-org.netbeans.modules.progress.spi.TaskModel-">setModel(TaskModel)</a></span> - Method in interface org.netbeans.modules.progress.spi.<a href="../org/netbeans/modules/progress/spi/ProgressUIWorkerWithModel.html" title="interface in org.netbeans.modules.progress.spi">ProgressUIWorkerWithModel</a></dt>
<dd>&nbsp;</dd>
<dt><span class="memberNameLink"><a href="../org/netbeans/api/progress/aggregate/AggregateProgressHandle.html#setMonitor-org.netbeans.api.progress.aggregate.ProgressMonitor-">setMonitor(ProgressMonitor)</a></span> - Method in class org.netbeans.api.progress.aggregate.<a href="../org/netbeans/api/progress/aggregate/AggregateProgressHandle.html" title="class in org.netbeans.api.progress.aggregate">AggregateProgressHandle</a></dt>
<dd>
<div class="block">allow to watch the incoming events from the individual progress contributors.</div>
</dd>
<dt><span class="memberNameLink"><a href="../org/netbeans/modules/progress/spi/ProgressUIWorkerWithModel.html#showPopup--">showPopup()</a></span> - Method in interface org.netbeans.modules.progress.spi.<a href="../org/netbeans/modules/progress/spi/ProgressUIWorkerWithModel.html" title="interface in org.netbeans.modules.progress.spi">ProgressUIWorkerWithModel</a></dt>
<dd>&nbsp;</dd>
<dt><span class="memberNameLink"><a href="../org/netbeans/api/progress/BaseProgressUtils.html#showProgressDialogAndRun-java.lang.Runnable-org.netbeans.api.progress.ProgressHandle-boolean-">showProgressDialogAndRun(Runnable, ProgressHandle, boolean)</a></span> - Static method in class org.netbeans.api.progress.<a href="../org/netbeans/api/progress/BaseProgressUtils.html" title="class in org.netbeans.api.progress">BaseProgressUtils</a></dt>
<dd>
<div class="block">Show a modal progress dialog that blocks the main window and all other
currently displayed frames or dialogs, while running the passed runnable
on a background thread.</div>
</dd>
<dt><span class="memberNameLink"><a href="../org/netbeans/api/progress/BaseProgressUtils.html#showProgressDialogAndRun-org.netbeans.api.progress.ProgressRunnable-java.lang.String-boolean-">showProgressDialogAndRun(ProgressRunnable&lt;T&gt;, String, boolean)</a></span> - Static method in class org.netbeans.api.progress.<a href="../org/netbeans/api/progress/BaseProgressUtils.html" title="class in org.netbeans.api.progress">BaseProgressUtils</a></dt>
<dd>
<div class="block">Show a modal progress dialog that blocks the main window and all other
currently displayed frames or dialogs, while running the passed runnable
on a background thread.</div>
</dd>
<dt><span class="memberNameLink"><a href="../org/netbeans/api/progress/BaseProgressUtils.html#showProgressDialogAndRun-java.lang.Runnable-java.lang.String-">showProgressDialogAndRun(Runnable, String)</a></span> - Static method in class org.netbeans.api.progress.<a href="../org/netbeans/api/progress/BaseProgressUtils.html" title="class in org.netbeans.api.progress">BaseProgressUtils</a></dt>
<dd>
<div class="block">Show a modal progress dialog that blocks the main window and all other
currently displayed frames or dialogs, while running the passed runnable
on a background thread with an indeterminate-state progress bar.</div>
</dd>
<dt><span class="memberNameLink"><a href="../org/netbeans/modules/progress/spi/RunOffEDTProvider.Progress.html#showProgressDialogAndRun-java.lang.Runnable-org.netbeans.api.progress.ProgressHandle-boolean-">showProgressDialogAndRun(Runnable, ProgressHandle, boolean)</a></span> - Method in interface org.netbeans.modules.progress.spi.<a href="../org/netbeans/modules/progress/spi/RunOffEDTProvider.Progress.html" title="interface in org.netbeans.modules.progress.spi">RunOffEDTProvider.Progress</a></dt>
<dd>
<div class="block">Show a modal progress dialog that blocks the main window while running
a background process.</div>
</dd>
<dt><span class="memberNameLink"><a href="../org/netbeans/modules/progress/spi/RunOffEDTProvider.Progress.html#showProgressDialogAndRun-org.netbeans.api.progress.ProgressRunnable-java.lang.String-boolean-">showProgressDialogAndRun(ProgressRunnable&lt;T&gt;, String, boolean)</a></span> - Method in interface org.netbeans.modules.progress.spi.<a href="../org/netbeans/modules/progress/spi/RunOffEDTProvider.Progress.html" title="interface in org.netbeans.modules.progress.spi">RunOffEDTProvider.Progress</a></dt>
<dd>
<div class="block">Show a modal progress dialog that blocks the main window while running
a background process.</div>
</dd>
<dt><span class="memberNameLink"><a href="../org/netbeans/api/progress/BaseProgressUtils.html#showProgressDialogAndRunLater-org.netbeans.api.progress.ProgressRunnable-org.netbeans.api.progress.ProgressHandle-boolean-">showProgressDialogAndRunLater(ProgressRunnable&lt;T&gt;, ProgressHandle, boolean)</a></span> - Static method in class org.netbeans.api.progress.<a href="../org/netbeans/api/progress/BaseProgressUtils.html" title="class in org.netbeans.api.progress">BaseProgressUtils</a></dt>
<dd>
<div class="block">Show a modal progress dialog that blocks the main window and all other
currently displayed frames or dialogs while running a background process.</div>
</dd>
<dt><span class="memberNameLink"><a href="../org/netbeans/modules/progress/spi/RunOffEDTProvider.Progress.html#showProgressDialogAndRunLater-org.netbeans.api.progress.ProgressRunnable-org.netbeans.api.progress.ProgressHandle-boolean-">showProgressDialogAndRunLater(ProgressRunnable&lt;T&gt;, ProgressHandle, boolean)</a></span> - Method in interface org.netbeans.modules.progress.spi.<a href="../org/netbeans/modules/progress/spi/RunOffEDTProvider.Progress.html" title="interface in org.netbeans.modules.progress.spi">RunOffEDTProvider.Progress</a></dt>
<dd>
<div class="block">Show a modal progress dialog that blocks the main window while running
a background process.</div>
</dd>
<dt><span class="memberNameLink"><a href="../org/netbeans/api/progress/aggregate/AggregateProgressHandle.html#start--">start()</a></span> - Method in class org.netbeans.api.progress.aggregate.<a href="../org/netbeans/api/progress/aggregate/AggregateProgressHandle.html" title="class in org.netbeans.api.progress.aggregate">AggregateProgressHandle</a></dt>
<dd>
<div class="block">start the progress indication for the task, shows the progress in the UI, events from the contributors are
expected after this call.</div>
</dd>
<dt><span class="memberNameLink"><a href="../org/netbeans/api/progress/aggregate/AggregateProgressHandle.html#start-long-">start(long)</a></span> - Method in class org.netbeans.api.progress.aggregate.<a href="../org/netbeans/api/progress/aggregate/AggregateProgressHandle.html" title="class in org.netbeans.api.progress.aggregate">AggregateProgressHandle</a></dt>
<dd>
<div class="block">start the progress indication for the task with an initial time estimate, shows the progress in the UI, events from the contributors are
expected after this call.</div>
</dd>
<dt><span class="memberNameLink"><a href="../org/netbeans/api/progress/aggregate/ProgressContributor.html#start-int-">start(int)</a></span> - Method in class org.netbeans.api.progress.aggregate.<a href="../org/netbeans/api/progress/aggregate/ProgressContributor.html" title="class in org.netbeans.api.progress.aggregate">ProgressContributor</a></dt>
<dd>
<div class="block">start the progress indication for a task with known number of steps.</div>
</dd>
<dt><span class="memberNameLink"><a href="../org/netbeans/api/progress/ProgressHandle.html#start--">start()</a></span> - Method in class org.netbeans.api.progress.<a href="../org/netbeans/api/progress/ProgressHandle.html" title="class in org.netbeans.api.progress">ProgressHandle</a></dt>
<dd>
<div class="block">start the progress indication for indeterminate task.</div>
</dd>
<dt><span class="memberNameLink"><a href="../org/netbeans/api/progress/ProgressHandle.html#start-int-">start(int)</a></span> - Method in class org.netbeans.api.progress.<a href="../org/netbeans/api/progress/ProgressHandle.html" title="class in org.netbeans.api.progress">ProgressHandle</a></dt>
<dd>
<div class="block">start the progress indication for a task with known number of steps.</div>
</dd>
<dt><span class="memberNameLink"><a href="../org/netbeans/api/progress/ProgressHandle.html#start-int-long-">start(int, long)</a></span> - Method in class org.netbeans.api.progress.<a href="../org/netbeans/api/progress/ProgressHandle.html" title="class in org.netbeans.api.progress">ProgressHandle</a></dt>
<dd>
<div class="block">start the progress indication for a task with known number of steps and known
time estimate for completing the task.</div>
</dd>
<dt><span class="memberNameLink"><a href="../org/netbeans/modules/progress/spi/InternalHandle.html#start-java.lang.String-int-long-">start(String, int, long)</a></span> - Method in class org.netbeans.modules.progress.spi.<a href="../org/netbeans/modules/progress/spi/InternalHandle.html" title="class in org.netbeans.modules.progress.spi">InternalHandle</a></dt>
<dd>
<div class="block">start the progress indication for a task with known number of steps and known
time estimate for completing the task.</div>
</dd>
<dt><span class="memberNameLink"><a href="../org/netbeans/api/progress/aggregate/ProgressMonitor.html#started-org.netbeans.api.progress.aggregate.ProgressContributor-">started(ProgressContributor)</a></span> - Method in interface org.netbeans.api.progress.aggregate.<a href="../org/netbeans/api/progress/aggregate/ProgressMonitor.html" title="interface in org.netbeans.api.progress.aggregate">ProgressMonitor</a></dt>
<dd>
<div class="block">the given contributor started it's work.</div>
</dd>
<dt><span class="memberNameLink"><a href="../org/netbeans/modules/progress/spi/InternalHandle.html#STATE_FINISHED">STATE_FINISHED</a></span> - Static variable in class org.netbeans.modules.progress.spi.<a href="../org/netbeans/modules/progress/spi/InternalHandle.html" title="class in org.netbeans.modules.progress.spi">InternalHandle</a></dt>
<dd>&nbsp;</dd>
<dt><span class="memberNameLink"><a href="../org/netbeans/modules/progress/spi/InternalHandle.html#STATE_INITIALIZED">STATE_INITIALIZED</a></span> - Static variable in class org.netbeans.modules.progress.spi.<a href="../org/netbeans/modules/progress/spi/InternalHandle.html" title="class in org.netbeans.modules.progress.spi">InternalHandle</a></dt>
<dd>&nbsp;</dd>
<dt><span class="memberNameLink"><a href="../org/netbeans/modules/progress/spi/InternalHandle.html#STATE_REQUEST_STOP">STATE_REQUEST_STOP</a></span> - Static variable in class org.netbeans.modules.progress.spi.<a href="../org/netbeans/modules/progress/spi/InternalHandle.html" title="class in org.netbeans.modules.progress.spi">InternalHandle</a></dt>
<dd>&nbsp;</dd>
<dt><span class="memberNameLink"><a href="../org/netbeans/modules/progress/spi/InternalHandle.html#STATE_RUNNING">STATE_RUNNING</a></span> - Static variable in class org.netbeans.modules.progress.spi.<a href="../org/netbeans/modules/progress/spi/InternalHandle.html" title="class in org.netbeans.modules.progress.spi">InternalHandle</a></dt>
<dd>&nbsp;</dd>
<dt><span class="memberNameLink"><a href="../org/netbeans/api/progress/aggregate/AggregateProgressHandle.html#suspend-java.lang.String-">suspend(String)</a></span> - Method in class org.netbeans.api.progress.aggregate.<a href="../org/netbeans/api/progress/aggregate/AggregateProgressHandle.html" title="class in org.netbeans.api.progress.aggregate">AggregateProgressHandle</a></dt>
<dd>
<div class="block">Currently running task can switch to silent suspend mode where the progress bar
stops moving, hides completely or partially.</div>
</dd>
<dt><span class="memberNameLink"><a href="../org/netbeans/api/progress/ProgressHandle.html#suspend-java.lang.String-">suspend(String)</a></span> - Method in class org.netbeans.api.progress.<a href="../org/netbeans/api/progress/ProgressHandle.html" title="class in org.netbeans.api.progress">ProgressHandle</a></dt>
<dd>
<div class="block">Current task can switch to silent suspend mode where the progress bar stops moving, hides completely or partially.</div>
</dd>
<dt><span class="memberNameLink"><a href="../org/netbeans/api/progress/ProgressHandle.html#switchToDeterminate-int-">switchToDeterminate(int)</a></span> - Method in class org.netbeans.api.progress.<a href="../org/netbeans/api/progress/ProgressHandle.html" title="class in org.netbeans.api.progress">ProgressHandle</a></dt>
<dd>
<div class="block">Currently indeterminate task can be switched to show percentage completed.</div>
</dd>
<dt><span class="memberNameLink"><a href="../org/netbeans/api/progress/ProgressHandle.html#switchToDeterminate-int-long-">switchToDeterminate(int, long)</a></span> - Method in class org.netbeans.api.progress.<a href="../org/netbeans/api/progress/ProgressHandle.html" title="class in org.netbeans.api.progress">ProgressHandle</a></dt>
<dd>
<div class="block">Currently indeterminate task can be switched to show the time estimate til completion.</div>
</dd>
<dt><span class="memberNameLink"><a href="../org/netbeans/api/progress/ProgressHandle.html#switchToIndeterminate--">switchToIndeterminate()</a></span> - Method in class org.netbeans.api.progress.<a href="../org/netbeans/api/progress/ProgressHandle.html" title="class in org.netbeans.api.progress">ProgressHandle</a></dt>
<dd>
<div class="block">Currently determinate task (with percentage or time estimate) can be
switched to indeterminate mode.</div>
</dd>
</dl>
<a href="index-1.html">A</a>&nbsp;<a href="index-2.html">B</a>&nbsp;<a href="index-3.html">C</a>&nbsp;<a href="index-4.html">D</a>&nbsp;<a href="index-5.html">E</a>&nbsp;<a href="index-6.html">F</a>&nbsp;<a href="index-7.html">G</a>&nbsp;<a href="index-8.html">I</a>&nbsp;<a href="index-9.html">M</a>&nbsp;<a href="index-10.html">N</a>&nbsp;<a href="index-11.html">O</a>&nbsp;<a href="index-12.html">P</a>&nbsp;<a href="index-13.html">R</a>&nbsp;<a href="index-14.html">S</a>&nbsp;<a href="index-15.html">T</a>&nbsp;</div>
<!-- ======= 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>Package</li>
<li>Class</li>
<li>Use</li>
<li><a href="../overview-tree.html">Tree</a></li>
<li><a href="../deprecated-list.html">Deprecated</a></li>
<li class="navBarCell1Rev">Index</li>
<li><a href="../help-doc.html">Help</a></li>
</ul>
<div class="aboutLanguage">org.netbeans.api.progress/1 1.49.1 </div>
</div>
<div class="subNav">
<ul class="navList">
<li><a href="index-13.html">Prev Letter</a></li>
<li><a href="index-15.html">Next Letter</a></li>
</ul>
<ul class="navList">
<li><a href="../index.html?index-files/index-14.html" target="_top">Frames</a></li>
<li><a href="index-14.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>
<a name="skip.navbar.bottom">
<!-- -->
</a></div>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
<p class="legalCopy"><small><span class="footnote">Built on September 14 2018.&nbsp;&nbsp;|&nbsp;&nbsp; Copyright &#169; 2017-2018 Apache Software Foundation. All Rights Reserved.</span></small></p>
</body>
</html>