blob: 9e092e2d1cd23db9e40dbe37c544fcc198602077 [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>CompoundGanttChartPrinter</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="CompoundGanttChartPrinter";
}
}
catch(err) {
}
//-->
var methods = {"i0":10,"i1":10,"i2":10,"i3":10,"i4":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/CompoundGanttChartPrinter.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>Prev&nbsp;Class</li>
<li><a href="../../../../../../org/eclipse/nebula/widgets/ganttchart/print/GanttChartPrinter.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/CompoundGanttChartPrinter.html" target="_top">Frames</a></li>
<li><a href="CompoundGanttChartPrinter.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 CompoundGanttChartPrinter" class="title">Class CompoundGanttChartPrinter</h2>
</div>
<div class="contentContainer">
<ul class="inheritance">
<li>java.lang.Object</li>
<li>
<ul class="inheritance">
<li><a href="../../../../../../org/eclipse/nebula/widgets/ganttchart/print/GanttChartPrinter.html" title="class in org.eclipse.nebula.widgets.ganttchart.print">org.eclipse.nebula.widgets.ganttchart.print.GanttChartPrinter</a></li>
<li>
<ul class="inheritance">
<li>org.eclipse.nebula.widgets.ganttchart.print.CompoundGanttChartPrinter</li>
</ul>
</li>
</ul>
</li>
</ul>
<div class="description">
<ul class="blockList">
<li class="blockList">
<hr>
<br>
<pre>public class <span class="typeNameLabel">CompoundGanttChartPrinter</span>
extends <a href="../../../../../../org/eclipse/nebula/widgets/ganttchart/print/GanttChartPrinter.html" title="class in org.eclipse.nebula.widgets.ganttchart.print">GanttChartPrinter</a></pre>
<div class="block">This class is used to print multiple GanttCharts at once.</div>
<dl>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../../../../../org/eclipse/nebula/widgets/ganttchart/print/GanttChartPrinter.html" title="class in org.eclipse.nebula.widgets.ganttchart.print"><code>GanttChartPrinter</code></a></dd>
</dl>
</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/CompoundGanttChartPrinter.html#CompoundGanttChartPrinter--">CompoundGanttChartPrinter</a></span>()</code>
<div class="block">Creates a new CompoundGanttChartPrinter.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colOne"><code><span class="memberNameLink"><a href="../../../../../../org/eclipse/nebula/widgets/ganttchart/print/CompoundGanttChartPrinter.html#CompoundGanttChartPrinter-java.lang.String-">CompoundGanttChartPrinter</a></span>(java.lang.String&nbsp;jobName)</code>
<div class="block">Creates a new CompoundGanttChartPrinter that uses the given job name as printer job 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="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/CompoundGanttChartPrinter.html#addGanttChart-org.eclipse.nebula.widgets.ganttchart.GanttChart-">addGanttChart</a></span>(<a href="../../../../../../org/eclipse/nebula/widgets/ganttchart/GanttChart.html" title="class in org.eclipse.nebula.widgets.ganttchart">GanttChart</a>&nbsp;ganttChart)</code>
<div class="block">Adds the given GanttChart to the list of GanttCharts that should be
printed by this CompoundGanttChartPrinter.</div>
</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/CompoundGanttChartPrinter.html#addGanttChart-int-org.eclipse.nebula.widgets.ganttchart.GanttChart-">addGanttChart</a></span>(int&nbsp;index,
<a href="../../../../../../org/eclipse/nebula/widgets/ganttchart/GanttChart.html" title="class in org.eclipse.nebula.widgets.ganttchart">GanttChart</a>&nbsp;ganttChart)</code>
<div class="block">Adds the given GanttChart at the specified index to the list of GanttCharts
that should be printed by this CompoundGanttChartPrinter.</div>
</td>
</tr>
<tr id="i2" class="altColor">
<td class="colFirst"><code>protected org.eclipse.swt.graphics.Point</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/eclipse/nebula/widgets/ganttchart/print/CompoundGanttChartPrinter.html#getFullPageCount-org.eclipse.swt.printing.Printer-">getFullPageCount</a></span>(org.eclipse.swt.printing.Printer&nbsp;printer)</code>
<div class="block">Calculates the number of horizontal and vertical pages needed to print the entire chart.</div>
</td>
</tr>
<tr id="i3" class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/eclipse/nebula/widgets/ganttchart/print/CompoundGanttChartPrinter.html#print--">print</a></span>()</code>
<div class="block">First opens the PrintDialog so a user can adjust his print settings and will
then print the chart based on the settings made by the user.</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/ganttchart/print/CompoundGanttChartPrinter.html#removeGanttChart-org.eclipse.nebula.widgets.ganttchart.GanttChart-">removeGanttChart</a></span>(<a href="../../../../../../org/eclipse/nebula/widgets/ganttchart/GanttChart.html" title="class in org.eclipse.nebula.widgets.ganttchart">GanttChart</a>&nbsp;ganttChart)</code>
<div class="block">Removes the given GanttChart from the list of GanttCharts that should be
printed by this CompoundGanttChartPrinter.</div>
</td>
</tr>
</table>
<ul class="blockList">
<li class="blockList"><a name="methods.inherited.from.class.org.eclipse.nebula.widgets.ganttchart.print.GanttChartPrinter">
<!-- -->
</a>
<h3>Methods inherited from class&nbsp;org.eclipse.nebula.widgets.ganttchart.print.<a href="../../../../../../org/eclipse/nebula/widgets/ganttchart/print/GanttChartPrinter.html" title="class in org.eclipse.nebula.widgets.ganttchart.print">GanttChartPrinter</a></h3>
<code><a href="../../../../../../org/eclipse/nebula/widgets/ganttchart/print/GanttChartPrinter.html#setupPrinter-org.eclipse.swt.widgets.Shell-">setupPrinter</a></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, 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="CompoundGanttChartPrinter--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>CompoundGanttChartPrinter</h4>
<pre>public&nbsp;CompoundGanttChartPrinter()</pre>
<div class="block">Creates a new CompoundGanttChartPrinter.
Will use the print job name of the first GanttChart in the list of
GanttCharts to print.</div>
</li>
</ul>
<a name="CompoundGanttChartPrinter-java.lang.String-">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>CompoundGanttChartPrinter</h4>
<pre>public&nbsp;CompoundGanttChartPrinter(java.lang.String&nbsp;jobName)</pre>
<div class="block">Creates a new CompoundGanttChartPrinter that uses the given job name as printer job name.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>jobName</code> - The name that will be used for the print job.</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="print--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>print</h4>
<pre>public&nbsp;void&nbsp;print()</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from class:&nbsp;<code><a href="../../../../../../org/eclipse/nebula/widgets/ganttchart/print/GanttChartPrinter.html#print--">GanttChartPrinter</a></code></span></div>
<div class="block">First opens the PrintDialog so a user can adjust his print settings and will
then print the chart based on the settings made by the user.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
<dd><code><a href="../../../../../../org/eclipse/nebula/widgets/ganttchart/print/GanttChartPrinter.html#print--">print</a></code>&nbsp;in class&nbsp;<code><a href="../../../../../../org/eclipse/nebula/widgets/ganttchart/print/GanttChartPrinter.html" title="class in org.eclipse.nebula.widgets.ganttchart.print">GanttChartPrinter</a></code></dd>
</dl>
</li>
</ul>
<a name="getFullPageCount-org.eclipse.swt.printing.Printer-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getFullPageCount</h4>
<pre>protected&nbsp;org.eclipse.swt.graphics.Point&nbsp;getFullPageCount(org.eclipse.swt.printing.Printer&nbsp;printer)</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from class:&nbsp;<code><a href="../../../../../../org/eclipse/nebula/widgets/ganttchart/print/GanttChartPrinter.html#getFullPageCount-org.eclipse.swt.printing.Printer-">GanttChartPrinter</a></code></span></div>
<div class="block">Calculates the number of horizontal and vertical pages needed to print the entire chart.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
<dd><code><a href="../../../../../../org/eclipse/nebula/widgets/ganttchart/print/GanttChartPrinter.html#getFullPageCount-org.eclipse.swt.printing.Printer-">getFullPageCount</a></code>&nbsp;in class&nbsp;<code><a href="../../../../../../org/eclipse/nebula/widgets/ganttchart/print/GanttChartPrinter.html" title="class in org.eclipse.nebula.widgets.ganttchart.print">GanttChartPrinter</a></code></dd>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>printer</code> - The printer that is used to determine the page count of a full print.</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>The number of horizontal and vertical pages that will be printed.</dd>
</dl>
</li>
</ul>
<a name="addGanttChart-org.eclipse.nebula.widgets.ganttchart.GanttChart-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>addGanttChart</h4>
<pre>public&nbsp;void&nbsp;addGanttChart(<a href="../../../../../../org/eclipse/nebula/widgets/ganttchart/GanttChart.html" title="class in org.eclipse.nebula.widgets.ganttchart">GanttChart</a>&nbsp;ganttChart)</pre>
<div class="block">Adds the given GanttChart to the list of GanttCharts that should be
printed by this CompoundGanttChartPrinter.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>ganttChart</code> - The GanttChart to add to the charts to be printed.</dd>
</dl>
</li>
</ul>
<a name="addGanttChart-int-org.eclipse.nebula.widgets.ganttchart.GanttChart-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>addGanttChart</h4>
<pre>public&nbsp;void&nbsp;addGanttChart(int&nbsp;index,
<a href="../../../../../../org/eclipse/nebula/widgets/ganttchart/GanttChart.html" title="class in org.eclipse.nebula.widgets.ganttchart">GanttChart</a>&nbsp;ganttChart)</pre>
<div class="block">Adds the given GanttChart at the specified index to the list of GanttCharts
that should be printed by this CompoundGanttChartPrinter.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>index</code> - The index at which the given GanttChart should be added.</dd>
<dd><code>ganttChart</code> - The GanttChart to add to the charts to be printed.</dd>
</dl>
</li>
</ul>
<a name="removeGanttChart-org.eclipse.nebula.widgets.ganttchart.GanttChart-">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>removeGanttChart</h4>
<pre>public&nbsp;void&nbsp;removeGanttChart(<a href="../../../../../../org/eclipse/nebula/widgets/ganttchart/GanttChart.html" title="class in org.eclipse.nebula.widgets.ganttchart">GanttChart</a>&nbsp;ganttChart)</pre>
<div class="block">Removes the given GanttChart from the list of GanttCharts that should be
printed by this CompoundGanttChartPrinter.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>ganttChart</code> - The GanttChart to remove from the charts to be printed.</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/CompoundGanttChartPrinter.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>Prev&nbsp;Class</li>
<li><a href="../../../../../../org/eclipse/nebula/widgets/ganttchart/print/GanttChartPrinter.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/CompoundGanttChartPrinter.html" target="_top">Frames</a></li>
<li><a href="CompoundGanttChartPrinter.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>