Google Git
Sign in
eclipse / gerrit / www.eclipse.org / nebula / edddf1c46f5aee0e7de034aaa627130ae4d84c93 / . / releases / 2.4.3 / javadoc / org / eclipse / nebula / widgets / xviewer / util / internal / XViewerUIJob.html
blob: 00246d9d68b091c82751f7a4bac00764cea892ea [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:54 CEST 2020 -->
<title>XViewerUIJob</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="XViewerUIJob";
}
}
catch(err) {
}
//-->
var methods = {"i0":9,"i1":10,"i2":10,"i3":6,"i4":10};
var tabs = {65535:["t0","All Methods"],1:["t1","Static Methods"],2:["t2","Instance Methods"],4:["t3","Abstract 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/XViewerUIJob.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/XViewerTextWidget.html" title="class in org.eclipse.nebula.widgets.xviewer.util.internal"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../../../../../../../org/eclipse/nebula/widgets/xviewer/util/internal/XViewerWidget.html" title="class in org.eclipse.nebula.widgets.xviewer.util.internal"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../../../index.html?org/eclipse/nebula/widgets/xviewer/util/internal/XViewerUIJob.html" target="_top">Frames</a></li>
<li><a href="XViewerUIJob.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.core.runtime.jobs.Job">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.xviewer.util.internal</div>
<h2 title="Class XViewerUIJob" class="title">Class XViewerUIJob</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>org.eclipse.nebula.widgets.xviewer.util.internal.XViewerUIJob</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>
<dl>
<dt>Direct Known Subclasses:</dt>
<dd><a href="../../../../../../../org/eclipse/nebula/widgets/xviewer/util/internal/XViewerWorkbenchJob.html" title="class in org.eclipse.nebula.widgets.xviewer.util.internal">XViewerWorkbenchJob</a></dd>
</dl>
<hr>
<br>
<pre>public abstract class <span class="typeNameLabel">XViewerUIJob</span>
extends org.eclipse.core.runtime.jobs.Job</pre>
<div class="block">The UIJob is a Job that runs within the UI Thread via an asyncExec.</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&nbsp;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&nbsp;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">&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/xviewer/util/internal/XViewerUIJob.html#XViewerUIJob-org.eclipse.swt.widgets.Display-java.lang.String-">XViewerUIJob</a></span>(org.eclipse.swt.widgets.Display&nbsp;jobDisplay,
java.lang.String&nbsp;name)</code>
<div class="block">Create a new instance of the receiver with the supplied Display.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colOne"><code><span class="memberNameLink"><a href="../../../../../../../org/eclipse/nebula/widgets/xviewer/util/internal/XViewerUIJob.html#XViewerUIJob-java.lang.String-">XViewerUIJob</a></span>(java.lang.String&nbsp;name)</code>
<div class="block">Create a new instance of the receiver 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">&nbsp;</span></span><span id="t1" class="tableTab"><span><a href="javascript:show(1);">Static Methods</a></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="t3" class="tableTab"><span><a href="javascript:show(4);">Abstract 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>static org.eclipse.core.runtime.IStatus</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../org/eclipse/nebula/widgets/xviewer/util/internal/XViewerUIJob.html#errorStatus-java.lang.Throwable-">errorStatus</a></span>(java.lang.Throwable&nbsp;exception)</code>
<div class="block">Convenience method to return a status for an exception.</div>
</td>
</tr>
<tr id="i1" class="rowColor">
<td class="colFirst"><code>org.eclipse.swt.widgets.Display</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../org/eclipse/nebula/widgets/xviewer/util/internal/XViewerUIJob.html#getDisplay--">getDisplay</a></span>()</code>
<div class="block">Returns the display for use by the receiver when running in an asyncExec.</div>
</td>
</tr>
<tr id="i2" class="altColor">
<td class="colFirst"><code>org.eclipse.core.runtime.IStatus</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../org/eclipse/nebula/widgets/xviewer/util/internal/XViewerUIJob.html#run-org.eclipse.core.runtime.IProgressMonitor-">run</a></span>(org.eclipse.core.runtime.IProgressMonitor&nbsp;monitor)</code>&nbsp;</td>
</tr>
<tr id="i3" class="rowColor">
<td class="colFirst"><code>abstract org.eclipse.core.runtime.IStatus</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../org/eclipse/nebula/widgets/xviewer/util/internal/XViewerUIJob.html#runInUIThread-org.eclipse.core.runtime.IProgressMonitor-">runInUIThread</a></span>(org.eclipse.core.runtime.IProgressMonitor&nbsp;monitor)</code>
<div class="block">Run the job in the UI Thread.</div>
</td>
</tr>
<tr id="i4" 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/XViewerUIJob.html#setDisplay-org.eclipse.swt.widgets.Display-">setDisplay</a></span>(org.eclipse.swt.widgets.Display&nbsp;runDisplay)</code>
<div class="block">Sets the display to execute the asyncExec in.</div>
</td>
</tr>
</table>
<ul class="blockList">
<li class="blockList"><a name="methods.inherited.from.class.org.eclipse.core.runtime.jobs.Job">
<!-- -->
</a>
<h3>Methods inherited from class&nbsp;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, shouldRun, shouldSchedule, 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&nbsp;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&nbsp;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&nbsp;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="XViewerUIJob-java.lang.String-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>XViewerUIJob</h4>
<pre>public&nbsp;XViewerUIJob(java.lang.String&nbsp;name)</pre>
<div class="block">Create a new instance of the receiver with the supplied name. The display used will be the one from the workbench
if this is available. UIJobs with this constructor will determine their display at runtime.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>name</code> - the job name</dd>
</dl>
</li>
</ul>
<a name="XViewerUIJob-org.eclipse.swt.widgets.Display-java.lang.String-">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>XViewerUIJob</h4>
<pre>public&nbsp;XViewerUIJob(org.eclipse.swt.widgets.Display&nbsp;jobDisplay,
java.lang.String&nbsp;name)</pre>
<div class="block">Create a new instance of the receiver with the supplied Display.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>jobDisplay</code> - the display</dd>
<dd><code>name</code> - the job name</dd>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><code>Job</code></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="errorStatus-java.lang.Throwable-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>errorStatus</h4>
<pre>public static&nbsp;org.eclipse.core.runtime.IStatus&nbsp;errorStatus(java.lang.Throwable&nbsp;exception)</pre>
<div class="block">Convenience method to return a status for an exception.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>exception</code> - </dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>IStatus an error status built from the exception</dd>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><code>Job</code></dd>
</dl>
</li>
</ul>
<a name="run-org.eclipse.core.runtime.IProgressMonitor-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>run</h4>
<pre>public final&nbsp;org.eclipse.core.runtime.IStatus&nbsp;run(org.eclipse.core.runtime.IProgressMonitor&nbsp;monitor)</pre>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code>run</code>&nbsp;in class&nbsp;<code>org.eclipse.core.runtime.jobs.Job</code></dd>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><code>Note: this message is marked
final. Implementors should use runInUIThread() instead.</code></dd>
</dl>
</li>
</ul>
<a name="runInUIThread-org.eclipse.core.runtime.IProgressMonitor-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>runInUIThread</h4>
<pre>public abstract&nbsp;org.eclipse.core.runtime.IStatus&nbsp;runInUIThread(org.eclipse.core.runtime.IProgressMonitor&nbsp;monitor)</pre>
<div class="block">Run the job in the UI Thread.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>monitor</code> - </dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>IStatus</dd>
</dl>
</li>
</ul>
<a name="setDisplay-org.eclipse.swt.widgets.Display-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setDisplay</h4>
<pre>public&nbsp;void&nbsp;setDisplay(org.eclipse.swt.widgets.Display&nbsp;runDisplay)</pre>
<div class="block">Sets the display to execute the asyncExec in. Generally this is not' used if there is a valid display available
via PlatformUI.isWorkbenchRunning().</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>runDisplay</code> - Display</dd>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../../../../../../org/eclipse/nebula/widgets/xviewer/util/internal/XViewerUIJob.html#getDisplay--"><code>getDisplay()</code></a>,
<code>PlatformUI.isWorkbenchRunning()</code></dd>
</dl>
</li>
</ul>
<a name="getDisplay--">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>getDisplay</h4>
<pre>public&nbsp;org.eclipse.swt.widgets.Display&nbsp;getDisplay()</pre>
<div class="block">Returns the display for use by the receiver when running in an asyncExec. If it is not set then the display set in
the workbench is used. If the display is null the job will not be run.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>Display or <code>null</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/XViewerUIJob.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/XViewerTextWidget.html" title="class in org.eclipse.nebula.widgets.xviewer.util.internal"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../../../../../../../org/eclipse/nebula/widgets/xviewer/util/internal/XViewerWidget.html" title="class in org.eclipse.nebula.widgets.xviewer.util.internal"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../../../index.html?org/eclipse/nebula/widgets/xviewer/util/internal/XViewerUIJob.html" target="_top">Frames</a></li>
<li><a href="XViewerUIJob.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.core.runtime.jobs.Job">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>