| <!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 Mon Dec 23 15:27:37 CET 2019 --> |
| <title>GanttChartPrinter</title> |
| <meta name="date" content="2019-12-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="GanttChartPrinter"; |
| } |
| } |
| 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/GanttChartPrinter.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/CompoundGanttChartPrinter.html" title="class in org.eclipse.nebula.widgets.ganttchart.print"><span class="typeNameLink">Prev Class</span></a></li> |
| <li><a href="../../../../../../org/eclipse/nebula/widgets/ganttchart/print/GanttChartPrintJob.html" title="class in org.eclipse.nebula.widgets.ganttchart.print"><span class="typeNameLink">Next Class</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../../../index.html?org/eclipse/nebula/widgets/ganttchart/print/GanttChartPrinter.html" target="_top">Frames</a></li> |
| <li><a href="GanttChartPrinter.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>Field | </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.ganttchart.print</div> |
| <h2 title="Class GanttChartPrinter" class="title">Class GanttChartPrinter</h2> |
| </div> |
| <div class="contentContainer"> |
| <ul class="inheritance"> |
| <li>java.lang.Object</li> |
| <li> |
| <ul class="inheritance"> |
| <li>org.eclipse.nebula.widgets.ganttchart.print.GanttChartPrinter</li> |
| </ul> |
| </li> |
| </ul> |
| <div class="description"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <dl> |
| <dt>Direct Known Subclasses:</dt> |
| <dd><a href="../../../../../../org/eclipse/nebula/widgets/ganttchart/print/CompoundGanttChartPrinter.html" title="class in org.eclipse.nebula.widgets.ganttchart.print">CompoundGanttChartPrinter</a></dd> |
| </dl> |
| <hr> |
| <br> |
| <pre>public class <span class="typeNameLabel">GanttChartPrinter</span> |
| extends java.lang.Object</pre> |
| <div class="block">This class is used to print a GanttChart. For this it will use the already existing |
| functionality of rendering the GanttChart to an image. |
| <p> |
| There are some configuration parameters that have impact on: |
| <ul> |
| <li>The horizontal range to print - If everything should be printed, by default the range |
| from the earliest event start date to the latest event end date (plus possible text) |
| is used. But configuring a period in the ISettings will also take these values into |
| account for calculating the horizontal range.</li> |
| <li>The vertical range to print - If only the selected part should be printed, by default |
| selection means the visible part of the chart horizontally and vertically. This behavior |
| can be modified so that horizontally only the visible part of the chart will be printed |
| but vertically the whole chart gets printed.</li> |
| <li>The name of the print job</li> |
| <li>Whether a footer should be printed or not</li> |
| <li>The name of the page (can be used for localization)</li> |
| <li>The format of the date in the footer</li> |
| </ul></div> |
| <dl> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="../../../../../../org/eclipse/nebula/widgets/ganttchart/ISettings.html#getPeriodStart--"><code>ISettings.getPeriodStart()</code></a>, |
| <a href="../../../../../../org/eclipse/nebula/widgets/ganttchart/ISettings.html#getPeriodEnd--"><code>ISettings.getPeriodEnd()</code></a>, |
| <a href="../../../../../../org/eclipse/nebula/widgets/ganttchart/ISettings.html#printSelectedVerticallyComplete--"><code>ISettings.printSelectedVerticallyComplete()</code></a>, |
| <a href="../../../../../../org/eclipse/nebula/widgets/ganttchart/ISettings.html#printFooter--"><code>ISettings.printFooter()</code></a>, |
| <a href="../../../../../../org/eclipse/nebula/widgets/ganttchart/ISettings.html#getDateFormat--"><code>ISettings.getDateFormat()</code></a>, |
| <a href="../../../../../../org/eclipse/nebula/widgets/ganttchart/ILanguageManager.html#getPrintJobText--"><code>ILanguageManager.getPrintJobText()</code></a>, |
| <a href="../../../../../../org/eclipse/nebula/widgets/ganttchart/ILanguageManager.html#getPrintPageText--"><code>ILanguageManager.getPrintPageText()</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"> </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/GanttChartPrinter.html#GanttChartPrinter-org.eclipse.nebula.widgets.ganttchart.GanttChart-">GanttChartPrinter</a></span>(<a href="../../../../../../org/eclipse/nebula/widgets/ganttchart/GanttChart.html" title="class in org.eclipse.nebula.widgets.ganttchart">GanttChart</a> ganttChart)</code> |
| <div class="block">Creates a new GanttChartPrinter for the given GanttChart.</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>protected org.eclipse.swt.graphics.Point</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/eclipse/nebula/widgets/ganttchart/print/GanttChartPrinter.html#getFullPageCount-org.eclipse.swt.printing.Printer-">getFullPageCount</a></span>(org.eclipse.swt.printing.Printer printer)</code> |
| <div class="block">Calculates the number of horizontal and vertical pages needed to print the entire chart.</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/GanttChartPrinter.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="i2" class="altColor"> |
| <td class="colFirst"><code>protected org.eclipse.swt.printing.Printer</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/eclipse/nebula/widgets/ganttchart/print/GanttChartPrinter.html#setupPrinter-org.eclipse.swt.widgets.Shell-">setupPrinter</a></span>(org.eclipse.swt.widgets.Shell shell)</code> |
| <div class="block">Opens the PrintDialog to let the user specify the printer and print configurations to use.</div> |
| </td> |
| </tr> |
| </table> |
| <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, 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="GanttChartPrinter-org.eclipse.nebula.widgets.ganttchart.GanttChart-"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>GanttChartPrinter</h4> |
| <pre>public GanttChartPrinter(<a href="../../../../../../org/eclipse/nebula/widgets/ganttchart/GanttChart.html" title="class in org.eclipse.nebula.widgets.ganttchart">GanttChart</a> ganttChart)</pre> |
| <div class="block">Creates a new GanttChartPrinter for the given GanttChart.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>ganttChart</code> - The GanttChart that should be printed by this GanttChartPrinter.</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 void print()</pre> |
| <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> |
| </li> |
| </ul> |
| <a name="setupPrinter-org.eclipse.swt.widgets.Shell-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setupPrinter</h4> |
| <pre>protected org.eclipse.swt.printing.Printer setupPrinter(org.eclipse.swt.widgets.Shell shell)</pre> |
| <div class="block">Opens the PrintDialog to let the user specify the printer and print configurations to use.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>shell</code> - The Shell which should be the parent for the PrintDialog</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>The selected printer with the print configuration made by the user.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getFullPageCount-org.eclipse.swt.printing.Printer-"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>getFullPageCount</h4> |
| <pre>protected org.eclipse.swt.graphics.Point getFullPageCount(org.eclipse.swt.printing.Printer printer)</pre> |
| <div class="block">Calculates the number of horizontal and vertical pages needed to print the entire chart.</div> |
| <dl> |
| <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> |
| </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/GanttChartPrinter.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/CompoundGanttChartPrinter.html" title="class in org.eclipse.nebula.widgets.ganttchart.print"><span class="typeNameLink">Prev Class</span></a></li> |
| <li><a href="../../../../../../org/eclipse/nebula/widgets/ganttchart/print/GanttChartPrintJob.html" title="class in org.eclipse.nebula.widgets.ganttchart.print"><span class="typeNameLink">Next Class</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../../../index.html?org/eclipse/nebula/widgets/ganttchart/print/GanttChartPrinter.html" target="_top">Frames</a></li> |
| <li><a href="GanttChartPrinter.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>Field | </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> |
