| <!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:54 CEST 2020 --> |
| <title>XViewerWorkbenchJob</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="XViewerWorkbenchJob"; |
| } |
| } |
| catch(err) { |
| } |
| //--> |
| var methods = {"i0":10,"i1":10,"i2":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/XViewerWorkbenchJob.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><a href="../../../../../../../org/eclipse/nebula/widgets/xviewer/util/internal/XViewerWidgetModifiedListener.html" title="interface in org.eclipse.nebula.widgets.xviewer.util.internal"><span class="typeNameLink">Prev Class</span></a></li> |
| <li>Next Class</li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../../../../index.html?org/eclipse/nebula/widgets/xviewer/util/internal/XViewerWorkbenchJob.html" target="_top">Frames</a></li> |
| <li><a href="XViewerWorkbenchJob.html" target="_top">No Frames</a></li> |
| </ul> |
| <ul class="navList" id="allclasses_navbar_top"> |
| <li><a href="../../../../../../../allclasses-noframe.html">All 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: </li> |
| <li>Nested | </li> |
| <li><a href="#fields.inherited.from.class.org.eclipse.core.runtime.jobs.Job">Field</a> | </li> |
| <li><a href="#constructor.summary">Constr</a> | </li> |
| <li><a href="#method.summary">Method</a></li> |
| </ul> |
| <ul class="subNavList"> |
| <li>Detail: </li> |
| <li>Field | </li> |
| <li><a href="#constructor.detail">Constr</a> | </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.xviewer.util.internal</div> |
| <h2 title="Class XViewerWorkbenchJob" class="title">Class XViewerWorkbenchJob</h2> |
| </div> |
| <div class="contentContainer"> |
| <ul class="inheritance"> |
| <li>java.lang.Object</li> |
| <li> |
| <ul class="inheritance"> |
| <li>org.eclipse.core.runtime.PlatformObject</li> |
| <li> |
| <ul class="inheritance"> |
| <li>org.eclipse.core.internal.jobs.InternalJob</li> |
| <li> |
| <ul class="inheritance"> |
| <li>org.eclipse.core.runtime.jobs.Job</li> |
| <li> |
| <ul class="inheritance"> |
| <li><a href="../../../../../../../org/eclipse/nebula/widgets/xviewer/util/internal/XViewerUIJob.html" title="class in org.eclipse.nebula.widgets.xviewer.util.internal">org.eclipse.nebula.widgets.xviewer.util.internal.XViewerUIJob</a></li> |
| <li> |
| <ul class="inheritance"> |
| <li>org.eclipse.nebula.widgets.xviewer.util.internal.XViewerWorkbenchJob</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>java.lang.Comparable, org.eclipse.core.runtime.IAdaptable</dd> |
| </dl> |
| <hr> |
| <br> |
| <pre>public abstract class <span class="typeNameLabel">XViewerWorkbenchJob</span> |
| extends <a href="../../../../../../../org/eclipse/nebula/widgets/xviewer/util/internal/XViewerUIJob.html" title="class in org.eclipse.nebula.widgets.xviewer.util.internal">XViewerUIJob</a></pre> |
| <div class="block">WorkbenchJob is a type of job that implements a done listener and does the shutdown checks before scheduling. This is |
| used if a job is not meant to run when the Workbench is shutdown.</div> |
| <dl> |
| <dt><span class="simpleTagLabel">Since:</span></dt> |
| <dd>3.0</dd> |
| </dl> |
| </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.core.runtime.jobs.Job"> |
| <!-- --> |
| </a> |
| <h3>Fields inherited from class org.eclipse.core.runtime.jobs.Job</h3> |
| <code>ASYNC_FINISH, BUILD, DECORATE, INTERACTIVE, LONG, NONE, RUNNING, SHORT, SLEEPING, WAITING</code></li> |
| </ul> |
| <ul class="blockList"> |
| <li class="blockList"><a name="fields.inherited.from.class.org.eclipse.core.internal.jobs.InternalJob"> |
| <!-- --> |
| </a> |
| <h3>Fields inherited from class org.eclipse.core.internal.jobs.InternalJob</h3> |
| <code>manager</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"> </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/xviewer/util/internal/XViewerWorkbenchJob.html#XViewerWorkbenchJob-org.eclipse.swt.widgets.Display-java.lang.String-">XViewerWorkbenchJob</a></span>(org.eclipse.swt.widgets.Display jobDisplay, |
| java.lang.String name)</code> |
| <div class="block">Create a new instance of the receiver with the supplied display and name.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colOne"><code><span class="memberNameLink"><a href="../../../../../../../org/eclipse/nebula/widgets/xviewer/util/internal/XViewerWorkbenchJob.html#XViewerWorkbenchJob-java.lang.String-">XViewerWorkbenchJob</a></span>(java.lang.String name)</code> |
| <div class="block">Add a new instance of the reciever with the supplied name.</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"> </span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd"> </span></span><span id="t4" class="tableTab"><span><a href="javascript:show(8);">Concrete Methods</a></span><span class="tabEnd"> </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/xviewer/util/internal/XViewerWorkbenchJob.html#performDone-org.eclipse.core.runtime.jobs.IJobChangeEvent-">performDone</a></span>(org.eclipse.core.runtime.jobs.IJobChangeEvent event)</code> |
| <div class="block">Perform done with the supplied event.</div> |
| </td> |
| </tr> |
| <tr id="i1" class="rowColor"> |
| <td class="colFirst"><code>boolean</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../org/eclipse/nebula/widgets/xviewer/util/internal/XViewerWorkbenchJob.html#shouldRun--">shouldRun</a></span>()</code> |
| <div class="block">(non-Javadoc)</div> |
| </td> |
| </tr> |
| <tr id="i2" class="altColor"> |
| <td class="colFirst"><code>boolean</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../org/eclipse/nebula/widgets/xviewer/util/internal/XViewerWorkbenchJob.html#shouldSchedule--">shouldSchedule</a></span>()</code> </td> |
| </tr> |
| </table> |
| <ul class="blockList"> |
| <li class="blockList"><a name="methods.inherited.from.class.org.eclipse.nebula.widgets.xviewer.util.internal.XViewerUIJob"> |
| <!-- --> |
| </a> |
| <h3>Methods inherited from class org.eclipse.nebula.widgets.xviewer.util.internal.<a href="../../../../../../../org/eclipse/nebula/widgets/xviewer/util/internal/XViewerUIJob.html" title="class in org.eclipse.nebula.widgets.xviewer.util.internal">XViewerUIJob</a></h3> |
| <code><a href="../../../../../../../org/eclipse/nebula/widgets/xviewer/util/internal/XViewerUIJob.html#errorStatus-java.lang.Throwable-">errorStatus</a>, <a href="../../../../../../../org/eclipse/nebula/widgets/xviewer/util/internal/XViewerUIJob.html#getDisplay--">getDisplay</a>, <a href="../../../../../../../org/eclipse/nebula/widgets/xviewer/util/internal/XViewerUIJob.html#run-org.eclipse.core.runtime.IProgressMonitor-">run</a>, <a href="../../../../../../../org/eclipse/nebula/widgets/xviewer/util/internal/XViewerUIJob.html#runInUIThread-org.eclipse.core.runtime.IProgressMonitor-">runInUIThread</a>, <a href="../../../../../../../org/eclipse/nebula/widgets/xviewer/util/internal/XViewerUIJob.html#setDisplay-org.eclipse.swt.widgets.Display-">setDisplay</a></code></li> |
| </ul> |
| <ul class="blockList"> |
| <li class="blockList"><a name="methods.inherited.from.class.org.eclipse.core.runtime.jobs.Job"> |
| <!-- --> |
| </a> |
| <h3>Methods inherited from class org.eclipse.core.runtime.jobs.Job</h3> |
| <code>addJobChangeListener, belongsTo, cancel, canceling, create, create, createSystem, createSystem, createSystem, done, getJobGroup, getJobManager, getName, getPriority, getProperty, getResult, getRule, getState, getThread, isBlocking, isSystem, isUser, join, join, removeJobChangeListener, schedule, schedule, setJobGroup, setName, setPriority, setProgressGroup, setProperty, setRule, setSystem, setThread, setUser, sleep, toString, wakeUp, wakeUp, yieldRule</code></li> |
| </ul> |
| <ul class="blockList"> |
| <li class="blockList"><a name="methods.inherited.from.class.org.eclipse.core.internal.jobs.InternalJob"> |
| <!-- --> |
| </a> |
| <h3>Methods inherited from class org.eclipse.core.internal.jobs.InternalJob</h3> |
| <code>compareTo</code></li> |
| </ul> |
| <ul class="blockList"> |
| <li class="blockList"><a name="methods.inherited.from.class.org.eclipse.core.runtime.PlatformObject"> |
| <!-- --> |
| </a> |
| <h3>Methods inherited from class org.eclipse.core.runtime.PlatformObject</h3> |
| <code>getAdapter</code></li> |
| </ul> |
| <ul class="blockList"> |
| <li class="blockList"><a name="methods.inherited.from.class.java.lang.Object"> |
| <!-- --> |
| </a> |
| <h3>Methods inherited from class java.lang.Object</h3> |
| <code>clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait</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="XViewerWorkbenchJob-org.eclipse.swt.widgets.Display-java.lang.String-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>XViewerWorkbenchJob</h4> |
| <pre>public XViewerWorkbenchJob(org.eclipse.swt.widgets.Display jobDisplay, |
| java.lang.String name)</pre> |
| <div class="block">Create a new instance of the receiver with the supplied display and name. Normally this constructor would not be |
| used as it is best to let the job find the display from the workbench</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>jobDisplay</code> - Display. The display to run the job with.</dd> |
| <dd><code>name</code> - String</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="XViewerWorkbenchJob-java.lang.String-"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>XViewerWorkbenchJob</h4> |
| <pre>public XViewerWorkbenchJob(java.lang.String name)</pre> |
| <div class="block">Add a new instance of the reciever with the supplied name.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>name</code> - String</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="performDone-org.eclipse.core.runtime.jobs.IJobChangeEvent-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>performDone</h4> |
| <pre>public void performDone(org.eclipse.core.runtime.jobs.IJobChangeEvent event)</pre> |
| <div class="block">Perform done with the supplied event. This will only occur if the returned status was OK. This is called only if |
| the job is finished with an IStatus.OK result and the workbench is still running.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>event</code> - IJobChangeEvent</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="shouldSchedule--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>shouldSchedule</h4> |
| <pre>public boolean shouldSchedule()</pre> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Overrides:</span></dt> |
| <dd><code>shouldSchedule</code> in class <code>org.eclipse.core.runtime.jobs.Job</code></dd> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><code>Job.shouldSchedule()</code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="shouldRun--"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>shouldRun</h4> |
| <pre>public boolean shouldRun()</pre> |
| <div class="block">(non-Javadoc)</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Overrides:</span></dt> |
| <dd><code>shouldRun</code> in class <code>org.eclipse.core.runtime.jobs.Job</code></dd> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><code>Job.shouldRun()</code></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/XViewerWorkbenchJob.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><a href="../../../../../../../org/eclipse/nebula/widgets/xviewer/util/internal/XViewerWidgetModifiedListener.html" title="interface in org.eclipse.nebula.widgets.xviewer.util.internal"><span class="typeNameLink">Prev Class</span></a></li> |
| <li>Next Class</li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../../../../index.html?org/eclipse/nebula/widgets/xviewer/util/internal/XViewerWorkbenchJob.html" target="_top">Frames</a></li> |
| <li><a href="XViewerWorkbenchJob.html" target="_top">No Frames</a></li> |
| </ul> |
| <ul class="navList" id="allclasses_navbar_bottom"> |
| <li><a href="../../../../../../../allclasses-noframe.html">All 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: </li> |
| <li>Nested | </li> |
| <li><a href="#fields.inherited.from.class.org.eclipse.core.runtime.jobs.Job">Field</a> | </li> |
| <li><a href="#constructor.summary">Constr</a> | </li> |
| <li><a href="#method.summary">Method</a></li> |
| </ul> |
| <ul class="subNavList"> |
| <li>Detail: </li> |
| <li>Field | </li> |
| <li><a href="#constructor.detail">Constr</a> | </li> |
| <li><a href="#method.detail">Method</a></li> |
| </ul> |
| </div> |
| <a name="skip.navbar.bottom"> |
| <!-- --> |
| </a></div> |
| <!-- ======== END OF BOTTOM NAVBAR ======= --> |
| </body> |
| </html> |
