Google Git
Sign in
eclipse / gerrit / www.eclipse.org / nebula / edddf1c46f5aee0e7de034aaa627130ae4d84c93 / . / releases / 2.4.3 / javadoc / org / eclipse / nebula / widgets / ganttchart / print / GanttChartPrintJob.html
blob: c1aa5705e9ed0cb39e9a016d0c839b2c3447811d [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:33 CEST 2020 -->
<title>GanttChartPrintJob</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="GanttChartPrintJob";
}
}
catch(err) {
}
//-->
var methods = {"i0":10,"i1":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/GanttChartPrintJob.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/ganttchart/print/GanttChartPrinter.html" title="class in org.eclipse.nebula.widgets.ganttchart.print"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../../../../../../org/eclipse/nebula/widgets/ganttchart/print/PrintUtils.html" title="class in org.eclipse.nebula.widgets.ganttchart.print"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../../index.html?org/eclipse/nebula/widgets/ganttchart/print/GanttChartPrintJob.html" target="_top">Frames</a></li>
<li><a href="GanttChartPrintJob.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>Field&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.ganttchart.print</div>
<h2 title="Class GanttChartPrintJob" class="title">Class GanttChartPrintJob</h2>
</div>
<div class="contentContainer">
<ul class="inheritance">
<li>java.lang.Object</li>
<li>
<ul class="inheritance">
<li>org.eclipse.nebula.widgets.ganttchart.print.GanttChartPrintJob</li>
</ul>
</li>
</ul>
<div class="description">
<ul class="blockList">
<li class="blockList">
<dl>
<dt>All Implemented Interfaces:</dt>
<dd>java.lang.Runnable</dd>
</dl>
<hr>
<br>
<pre>public class <span class="typeNameLabel">GanttChartPrintJob</span>
extends java.lang.Object
implements java.lang.Runnable</pre>
<div class="block">Runnable to print one ore more GanttCharts.</div>
</li>
</ul>
</div>
<div class="summary">
<ul class="blockList">
<li class="blockList">
<!-- ======== 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/ganttchart/print/GanttChartPrintJob.html#GanttChartPrintJob-org.eclipse.swt.printing.Printer-java.lang.String-boolean-org.eclipse.nebula.widgets.ganttchart.GanttChart...-">GanttChartPrintJob</a></span>(org.eclipse.swt.printing.Printer&nbsp;printer,
java.lang.String&nbsp;jobName,
boolean&nbsp;disposePrinter,
<a href="../../../../../../org/eclipse/nebula/widgets/ganttchart/GanttChart.html" title="class in org.eclipse.nebula.widgets.ganttchart">GanttChart</a>...&nbsp;charts)</code>
<div class="block">Creates a new GanttChartPrintJob that uses the given printer and print job name
to print the specified GanttChart(s).</div>
</td>
</tr>
<tr class="rowColor">
<td class="colOne"><code><span class="memberNameLink"><a href="../../../../../../org/eclipse/nebula/widgets/ganttchart/print/GanttChartPrintJob.html#GanttChartPrintJob-org.eclipse.swt.printing.Printer-java.lang.String-org.eclipse.nebula.widgets.ganttchart.GanttChart...-">GanttChartPrintJob</a></span>(org.eclipse.swt.printing.Printer&nbsp;printer,
java.lang.String&nbsp;jobName,
<a href="../../../../../../org/eclipse/nebula/widgets/ganttchart/GanttChart.html" title="class in org.eclipse.nebula.widgets.ganttchart">GanttChart</a>...&nbsp;charts)</code>
<div class="block">Creates a new GanttChartPrintJob that uses the given printer and print job name
to print the specified GanttChart(s).</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/ganttchart/print/GanttChartPrintJob.html#run--">run</a></span>()</code>&nbsp;</td>
</tr>
<tr id="i1" class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/eclipse/nebula/widgets/ganttchart/print/GanttChartPrintJob.html#setDisposePrinter-boolean-">setDisposePrinter</a></span>(boolean&nbsp;dispose)</code>&nbsp;</td>
</tr>
</table>
<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, toString, 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="GanttChartPrintJob-org.eclipse.swt.printing.Printer-java.lang.String-org.eclipse.nebula.widgets.ganttchart.GanttChart...-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>GanttChartPrintJob</h4>
<pre>public&nbsp;GanttChartPrintJob(org.eclipse.swt.printing.Printer&nbsp;printer,
java.lang.String&nbsp;jobName,
<a href="../../../../../../org/eclipse/nebula/widgets/ganttchart/GanttChart.html" title="class in org.eclipse.nebula.widgets.ganttchart">GanttChart</a>...&nbsp;charts)</pre>
<div class="block">Creates a new GanttChartPrintJob that uses the given printer and print job name
to print the specified GanttChart(s). If not changed afterwards, running this job
will dispose the given printer when it is done.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>printer</code> - The printer to use.</dd>
<dd><code>jobName</code> - The job name to use for the print job.</dd>
<dd><code>charts</code> - The GanttCharts that should be printed.</dd>
</dl>
</li>
</ul>
<a name="GanttChartPrintJob-org.eclipse.swt.printing.Printer-java.lang.String-boolean-org.eclipse.nebula.widgets.ganttchart.GanttChart...-">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>GanttChartPrintJob</h4>
<pre>public&nbsp;GanttChartPrintJob(org.eclipse.swt.printing.Printer&nbsp;printer,
java.lang.String&nbsp;jobName,
boolean&nbsp;disposePrinter,
<a href="../../../../../../org/eclipse/nebula/widgets/ganttchart/GanttChart.html" title="class in org.eclipse.nebula.widgets.ganttchart">GanttChart</a>...&nbsp;charts)</pre>
<div class="block">Creates a new GanttChartPrintJob that uses the given printer and print job name
to print the specified GanttChart(s).</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>printer</code> - The printer to use.</dd>
<dd><code>jobName</code> - The job name to use for the print job.</dd>
<dd><code>charts</code> - The GanttCharts that should be printed.</dd>
<dd><code>disposePrinter</code> - Flag to configure whether the given printer should be disposed
after the print job is done. Default is <code>true</code>. Only set this
parameter to <code>false</code> if the printer should be reused for additional
print jobs. You need to ensure that the printer will get disposed yourself
in that case!</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="run--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>run</h4>
<pre>public&nbsp;void&nbsp;run()</pre>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code>run</code>&nbsp;in interface&nbsp;<code>java.lang.Runnable</code></dd>
</dl>
</li>
</ul>
<a name="setDisposePrinter-boolean-">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>setDisposePrinter</h4>
<pre>public&nbsp;void&nbsp;setDisposePrinter(boolean&nbsp;dispose)</pre>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>dispose</code> - <code>true</code> if the printer that is set to this GanttChartPrintJob
should be disposed after the print job is done, <code>false</code> if it should
not be disposed so the printer can be reused for additional tasks.</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/GanttChartPrintJob.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/ganttchart/print/GanttChartPrinter.html" title="class in org.eclipse.nebula.widgets.ganttchart.print"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../../../../../../org/eclipse/nebula/widgets/ganttchart/print/PrintUtils.html" title="class in org.eclipse.nebula.widgets.ganttchart.print"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../../index.html?org/eclipse/nebula/widgets/ganttchart/print/GanttChartPrintJob.html" target="_top">Frames</a></li>
<li><a href="GanttChartPrintJob.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>Field&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>