ExportUtils.html 17 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441
  1. <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
  2. <!-- NewPage -->
  3. <html lang="en">
  4. <head>
  5. <!-- Generated by javadoc (1.8.0_05) on Thu Jul 31 14:50:41 CEST 2014 -->
  6. <title>ExportUtils (JFreeChart Class Library (version 1.0.19-fx))</title>
  7. <meta name="date" content="2014-07-31">
  8. <link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style">
  9. <script type="text/javascript" src="../../../../script.js"></script>
  10. </head>
  11. <body>
  12. <script type="text/javascript"><!--
  13. try {
  14. if (location.href.indexOf('is-external=true') == -1) {
  15. parent.document.title="ExportUtils (JFreeChart Class Library (version 1.0.19-fx))";
  16. }
  17. }
  18. catch(err) {
  19. }
  20. //-->
  21. var methods = {"i0":9,"i1":9,"i2":9,"i3":9,"i4":9,"i5":9};
  22. var tabs = {65535:["t0","All Methods"],1:["t1","Static Methods"],8:["t4","Concrete Methods"]};
  23. var altColor = "altColor";
  24. var rowColor = "rowColor";
  25. var tableTab = "tableTab";
  26. var activeTableTab = "activeTableTab";
  27. </script>
  28. <noscript>
  29. <div>JavaScript is disabled on your browser.</div>
  30. </noscript>
  31. <!-- ========= START OF TOP NAVBAR ======= -->
  32. <div class="topNav"><a name="navbar.top">
  33. <!-- -->
  34. </a>
  35. <div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div>
  36. <a name="navbar.top.firstrow">
  37. <!-- -->
  38. </a>
  39. <ul class="navList" title="Navigation">
  40. <li><a href="../../../../overview-summary.html">Overview</a></li>
  41. <li><a href="package-summary.html">Package</a></li>
  42. <li class="navBarCell1Rev">Class</li>
  43. <li><a href="class-use/ExportUtils.html">Use</a></li>
  44. <li><a href="package-tree.html">Tree</a></li>
  45. <li><a href="../../../../deprecated-list.html">Deprecated</a></li>
  46. <li><a href="../../../../index-files/index-1.html">Index</a></li>
  47. <li><a href="../../../../help-doc.html">Help</a></li>
  48. </ul>
  49. </div>
  50. <div class="subNav">
  51. <ul class="navList">
  52. <li><a href="../../../../org/jfree/chart/util/DirectionalGradientPaintTransformer.html" title="class in org.jfree.chart.util"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
  53. <li><a href="../../../../org/jfree/chart/util/HexNumberFormat.html" title="class in org.jfree.chart.util"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
  54. </ul>
  55. <ul class="navList">
  56. <li><a href="../../../../index.html?org/jfree/chart/util/ExportUtils.html" target="_top">Frames</a></li>
  57. <li><a href="ExportUtils.html" target="_top">No&nbsp;Frames</a></li>
  58. </ul>
  59. <ul class="navList" id="allclasses_navbar_top">
  60. <li><a href="../../../../allclasses-noframe.html">All&nbsp;Classes</a></li>
  61. </ul>
  62. <div>
  63. <script type="text/javascript"><!--
  64. allClassesLink = document.getElementById("allclasses_navbar_top");
  65. if(window==top) {
  66. allClassesLink.style.display = "block";
  67. }
  68. else {
  69. allClassesLink.style.display = "none";
  70. }
  71. //-->
  72. </script>
  73. </div>
  74. <div>
  75. <ul class="subNavList">
  76. <li>Summary:&nbsp;</li>
  77. <li>Nested&nbsp;|&nbsp;</li>
  78. <li>Field&nbsp;|&nbsp;</li>
  79. <li><a href="#constructor.summary">Constr</a>&nbsp;|&nbsp;</li>
  80. <li><a href="#method.summary">Method</a></li>
  81. </ul>
  82. <ul class="subNavList">
  83. <li>Detail:&nbsp;</li>
  84. <li>Field&nbsp;|&nbsp;</li>
  85. <li><a href="#constructor.detail">Constr</a>&nbsp;|&nbsp;</li>
  86. <li><a href="#method.detail">Method</a></li>
  87. </ul>
  88. </div>
  89. <a name="skip.navbar.top">
  90. <!-- -->
  91. </a></div>
  92. <!-- ========= END OF TOP NAVBAR ========= -->
  93. <!-- ======== START OF CLASS DATA ======== -->
  94. <div class="header">
  95. <div class="subTitle">org.jfree.chart.util</div>
  96. <h2 title="Class ExportUtils" class="title">Class ExportUtils</h2>
  97. </div>
  98. <div class="contentContainer">
  99. <ul class="inheritance">
  100. <li>java.lang.Object</li>
  101. <li>
  102. <ul class="inheritance">
  103. <li>org.jfree.chart.util.ExportUtils</li>
  104. </ul>
  105. </li>
  106. </ul>
  107. <div class="description">
  108. <ul class="blockList">
  109. <li class="blockList">
  110. <hr>
  111. <br>
  112. <pre>public class <a href="../../../../src-html/org/jfree/chart/util/ExportUtils.html#line.64">ExportUtils</a>
  113. extends java.lang.Object</pre>
  114. <div class="block">Utility functions for exporting charts to SVG and PDF format.</div>
  115. <dl>
  116. <dt><span class="simpleTagLabel">Since:</span></dt>
  117. <dd>1.0.18</dd>
  118. </dl>
  119. </li>
  120. </ul>
  121. </div>
  122. <div class="summary">
  123. <ul class="blockList">
  124. <li class="blockList">
  125. <!-- ======== CONSTRUCTOR SUMMARY ======== -->
  126. <ul class="blockList">
  127. <li class="blockList"><a name="constructor.summary">
  128. <!-- -->
  129. </a>
  130. <h3>Constructor Summary</h3>
  131. <table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Constructor Summary table, listing constructors, and an explanation">
  132. <caption><span>Constructors</span><span class="tabEnd">&nbsp;</span></caption>
  133. <tr>
  134. <th class="colOne" scope="col">Constructor and Description</th>
  135. </tr>
  136. <tr class="altColor">
  137. <td class="colOne"><code><span class="memberNameLink"><a href="../../../../org/jfree/chart/util/ExportUtils.html#ExportUtils--">ExportUtils</a></span>()</code>&nbsp;</td>
  138. </tr>
  139. </table>
  140. </li>
  141. </ul>
  142. <!-- ========== METHOD SUMMARY =========== -->
  143. <ul class="blockList">
  144. <li class="blockList"><a name="method.summary">
  145. <!-- -->
  146. </a>
  147. <h3>Method Summary</h3>
  148. <table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation">
  149. <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="t4" class="tableTab"><span><a href="javascript:show(8);">Concrete Methods</a></span><span class="tabEnd">&nbsp;</span></span></caption>
  150. <tr>
  151. <th class="colFirst" scope="col">Modifier and Type</th>
  152. <th class="colLast" scope="col">Method and Description</th>
  153. </tr>
  154. <tr id="i0" class="altColor">
  155. <td class="colFirst"><code>static boolean</code></td>
  156. <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/jfree/chart/util/ExportUtils.html#isJFreeSVGAvailable--">isJFreeSVGAvailable</a></span>()</code>
  157. <div class="block">Returns <code>true</code> if JFreeSVG is on the classpath, and
  158. <code>false</code> otherwise.</div>
  159. </td>
  160. </tr>
  161. <tr id="i1" class="rowColor">
  162. <td class="colFirst"><code>static boolean</code></td>
  163. <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/jfree/chart/util/ExportUtils.html#isOrsonPDFAvailable--">isOrsonPDFAvailable</a></span>()</code>
  164. <div class="block">Returns <code>true</code> if OrsonPDF is on the classpath, and
  165. <code>false</code> otherwise.</div>
  166. </td>
  167. </tr>
  168. <tr id="i2" class="altColor">
  169. <td class="colFirst"><code>static void</code></td>
  170. <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/jfree/chart/util/ExportUtils.html#writeAsJPEG-org.jfree.ui.Drawable-int-int-java.io.File-">writeAsJPEG</a></span>(org.jfree.ui.Drawable&nbsp;drawable,
  171. int&nbsp;w,
  172. int&nbsp;h,
  173. java.io.File&nbsp;file)</code>
  174. <div class="block">Writes the current content to the specified file in JPEG format.</div>
  175. </td>
  176. </tr>
  177. <tr id="i3" class="rowColor">
  178. <td class="colFirst"><code>static void</code></td>
  179. <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/jfree/chart/util/ExportUtils.html#writeAsPDF-org.jfree.ui.Drawable-int-int-java.io.File-">writeAsPDF</a></span>(org.jfree.ui.Drawable&nbsp;drawable,
  180. int&nbsp;w,
  181. int&nbsp;h,
  182. java.io.File&nbsp;file)</code>
  183. <div class="block">Writes a <code>Drawable</code> to the specified file in PDF format.</div>
  184. </td>
  185. </tr>
  186. <tr id="i4" class="altColor">
  187. <td class="colFirst"><code>static void</code></td>
  188. <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/jfree/chart/util/ExportUtils.html#writeAsPNG-org.jfree.ui.Drawable-int-int-java.io.File-">writeAsPNG</a></span>(org.jfree.ui.Drawable&nbsp;drawable,
  189. int&nbsp;w,
  190. int&nbsp;h,
  191. java.io.File&nbsp;file)</code>
  192. <div class="block">Writes the current content to the specified file in PNG format.</div>
  193. </td>
  194. </tr>
  195. <tr id="i5" class="rowColor">
  196. <td class="colFirst"><code>static void</code></td>
  197. <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/jfree/chart/util/ExportUtils.html#writeAsSVG-org.jfree.ui.Drawable-int-int-java.io.File-">writeAsSVG</a></span>(org.jfree.ui.Drawable&nbsp;drawable,
  198. int&nbsp;w,
  199. int&nbsp;h,
  200. java.io.File&nbsp;file)</code>
  201. <div class="block">Writes the current content to the specified file in SVG format.</div>
  202. </td>
  203. </tr>
  204. </table>
  205. <ul class="blockList">
  206. <li class="blockList"><a name="methods.inherited.from.class.java.lang.Object">
  207. <!-- -->
  208. </a>
  209. <h3>Methods inherited from class&nbsp;java.lang.Object</h3>
  210. <code>clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait</code></li>
  211. </ul>
  212. </li>
  213. </ul>
  214. </li>
  215. </ul>
  216. </div>
  217. <div class="details">
  218. <ul class="blockList">
  219. <li class="blockList">
  220. <!-- ========= CONSTRUCTOR DETAIL ======== -->
  221. <ul class="blockList">
  222. <li class="blockList"><a name="constructor.detail">
  223. <!-- -->
  224. </a>
  225. <h3>Constructor Detail</h3>
  226. <a name="ExportUtils--">
  227. <!-- -->
  228. </a>
  229. <ul class="blockListLast">
  230. <li class="blockList">
  231. <h4>ExportUtils</h4>
  232. <pre>public&nbsp;<a href="../../../../src-html/org/jfree/chart/util/ExportUtils.html#line.64">ExportUtils</a>()</pre>
  233. </li>
  234. </ul>
  235. </li>
  236. </ul>
  237. <!-- ============ METHOD DETAIL ========== -->
  238. <ul class="blockList">
  239. <li class="blockList"><a name="method.detail">
  240. <!-- -->
  241. </a>
  242. <h3>Method Detail</h3>
  243. <a name="isJFreeSVGAvailable--">
  244. <!-- -->
  245. </a>
  246. <ul class="blockList">
  247. <li class="blockList">
  248. <h4>isJFreeSVGAvailable</h4>
  249. <pre>public static&nbsp;boolean&nbsp;<a href="../../../../src-html/org/jfree/chart/util/ExportUtils.html#line.73">isJFreeSVGAvailable</a>()</pre>
  250. <div class="block">Returns <code>true</code> if JFreeSVG is on the classpath, and
  251. <code>false</code> otherwise. The JFreeSVG library can be found at
  252. http://www.jfree.org/jfreesvg/</div>
  253. <dl>
  254. <dt><span class="returnLabel">Returns:</span></dt>
  255. <dd>A boolean.</dd>
  256. </dl>
  257. </li>
  258. </ul>
  259. <a name="isOrsonPDFAvailable--">
  260. <!-- -->
  261. </a>
  262. <ul class="blockList">
  263. <li class="blockList">
  264. <h4>isOrsonPDFAvailable</h4>
  265. <pre>public static&nbsp;boolean&nbsp;<a href="../../../../src-html/org/jfree/chart/util/ExportUtils.html#line.90">isOrsonPDFAvailable</a>()</pre>
  266. <div class="block">Returns <code>true</code> if OrsonPDF is on the classpath, and
  267. <code>false</code> otherwise. The OrsonPDF library can be found at
  268. http://www.object-refinery.com/pdf/</div>
  269. <dl>
  270. <dt><span class="returnLabel">Returns:</span></dt>
  271. <dd>A boolean.</dd>
  272. </dl>
  273. </li>
  274. </ul>
  275. <a name="writeAsSVG-org.jfree.ui.Drawable-int-int-java.io.File-">
  276. <!-- -->
  277. </a>
  278. <ul class="blockList">
  279. <li class="blockList">
  280. <h4>writeAsSVG</h4>
  281. <pre>public static&nbsp;void&nbsp;<a href="../../../../src-html/org/jfree/chart/util/ExportUtils.html#line.111">writeAsSVG</a>(org.jfree.ui.Drawable&nbsp;drawable,
  282. int&nbsp;w,
  283. int&nbsp;h,
  284. java.io.File&nbsp;file)</pre>
  285. <div class="block">Writes the current content to the specified file in SVG format. This
  286. will only work when the JFreeSVG library is found on the classpath.
  287. Reflection is used to ensure there is no compile-time dependency on
  288. JFreeSVG.</div>
  289. <dl>
  290. <dt><span class="paramLabel">Parameters:</span></dt>
  291. <dd><code>drawable</code> - the drawable (<code>null</code> not permitted).</dd>
  292. <dd><code>w</code> - the chart width.</dd>
  293. <dd><code>h</code> - the chart height.</dd>
  294. <dd><code>file</code> - the output file (<code>null</code> not permitted).</dd>
  295. </dl>
  296. </li>
  297. </ul>
  298. <a name="writeAsPDF-org.jfree.ui.Drawable-int-int-java.io.File-">
  299. <!-- -->
  300. </a>
  301. <ul class="blockList">
  302. <li class="blockList">
  303. <h4>writeAsPDF</h4>
  304. <pre>public static final&nbsp;void&nbsp;<a href="../../../../src-html/org/jfree/chart/util/ExportUtils.html#line.161">writeAsPDF</a>(org.jfree.ui.Drawable&nbsp;drawable,
  305. int&nbsp;w,
  306. int&nbsp;h,
  307. java.io.File&nbsp;file)</pre>
  308. <div class="block">Writes a <code>Drawable</code> to the specified file in PDF format. This
  309. will only work when the OrsonPDF library is found on the classpath.
  310. Reflection is used to ensure there is no compile-time dependency on
  311. OrsonPDF.</div>
  312. <dl>
  313. <dt><span class="paramLabel">Parameters:</span></dt>
  314. <dd><code>drawable</code> - the drawable (<code>null</code> not permitted).</dd>
  315. <dd><code>w</code> - the chart width.</dd>
  316. <dd><code>h</code> - the chart height.</dd>
  317. <dd><code>file</code> - the output file (<code>null</code> not permitted).</dd>
  318. </dl>
  319. </li>
  320. </ul>
  321. <a name="writeAsPNG-org.jfree.ui.Drawable-int-int-java.io.File-">
  322. <!-- -->
  323. </a>
  324. <ul class="blockList">
  325. <li class="blockList">
  326. <h4>writeAsPNG</h4>
  327. <pre>public static&nbsp;void&nbsp;<a href="../../../../src-html/org/jfree/chart/util/ExportUtils.html#line.209">writeAsPNG</a>(org.jfree.ui.Drawable&nbsp;drawable,
  328. int&nbsp;w,
  329. int&nbsp;h,
  330. java.io.File&nbsp;file)
  331. throws java.io.FileNotFoundException,
  332. java.io.IOException</pre>
  333. <div class="block">Writes the current content to the specified file in PNG format.</div>
  334. <dl>
  335. <dt><span class="paramLabel">Parameters:</span></dt>
  336. <dd><code>drawable</code> - the drawable (<code>null</code> not permitted).</dd>
  337. <dd><code>w</code> - the chart width.</dd>
  338. <dd><code>h</code> - the chart height.</dd>
  339. <dd><code>file</code> - the output file (<code>null</code> not permitted).</dd>
  340. <dt><span class="throwsLabel">Throws:</span></dt>
  341. <dd><code>java.io.FileNotFoundException</code> - if the file is not found.</dd>
  342. <dd><code>java.io.IOException</code> - if there is an I/O problem.</dd>
  343. </dl>
  344. </li>
  345. </ul>
  346. <a name="writeAsJPEG-org.jfree.ui.Drawable-int-int-java.io.File-">
  347. <!-- -->
  348. </a>
  349. <ul class="blockListLast">
  350. <li class="blockList">
  351. <h4>writeAsJPEG</h4>
  352. <pre>public static&nbsp;void&nbsp;<a href="../../../../src-html/org/jfree/chart/util/ExportUtils.html#line.235">writeAsJPEG</a>(org.jfree.ui.Drawable&nbsp;drawable,
  353. int&nbsp;w,
  354. int&nbsp;h,
  355. java.io.File&nbsp;file)
  356. throws java.io.FileNotFoundException,
  357. java.io.IOException</pre>
  358. <div class="block">Writes the current content to the specified file in JPEG format.</div>
  359. <dl>
  360. <dt><span class="paramLabel">Parameters:</span></dt>
  361. <dd><code>drawable</code> - the drawable (<code>null</code> not permitted).</dd>
  362. <dd><code>w</code> - the chart width.</dd>
  363. <dd><code>h</code> - the chart height.</dd>
  364. <dd><code>file</code> - the output file (<code>null</code> not permitted).</dd>
  365. <dt><span class="throwsLabel">Throws:</span></dt>
  366. <dd><code>java.io.FileNotFoundException</code> - if the file is not found.</dd>
  367. <dd><code>java.io.IOException</code> - if there is an I/O problem.</dd>
  368. </dl>
  369. </li>
  370. </ul>
  371. </li>
  372. </ul>
  373. </li>
  374. </ul>
  375. </div>
  376. </div>
  377. <!-- ========= END OF CLASS DATA ========= -->
  378. <!-- ======= START OF BOTTOM NAVBAR ====== -->
  379. <div class="bottomNav"><a name="navbar.bottom">
  380. <!-- -->
  381. </a>
  382. <div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div>
  383. <a name="navbar.bottom.firstrow">
  384. <!-- -->
  385. </a>
  386. <ul class="navList" title="Navigation">
  387. <li><a href="../../../../overview-summary.html">Overview</a></li>
  388. <li><a href="package-summary.html">Package</a></li>
  389. <li class="navBarCell1Rev">Class</li>
  390. <li><a href="class-use/ExportUtils.html">Use</a></li>
  391. <li><a href="package-tree.html">Tree</a></li>
  392. <li><a href="../../../../deprecated-list.html">Deprecated</a></li>
  393. <li><a href="../../../../index-files/index-1.html">Index</a></li>
  394. <li><a href="../../../../help-doc.html">Help</a></li>
  395. </ul>
  396. </div>
  397. <div class="subNav">
  398. <ul class="navList">
  399. <li><a href="../../../../org/jfree/chart/util/DirectionalGradientPaintTransformer.html" title="class in org.jfree.chart.util"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
  400. <li><a href="../../../../org/jfree/chart/util/HexNumberFormat.html" title="class in org.jfree.chart.util"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
  401. </ul>
  402. <ul class="navList">
  403. <li><a href="../../../../index.html?org/jfree/chart/util/ExportUtils.html" target="_top">Frames</a></li>
  404. <li><a href="ExportUtils.html" target="_top">No&nbsp;Frames</a></li>
  405. </ul>
  406. <ul class="navList" id="allclasses_navbar_bottom">
  407. <li><a href="../../../../allclasses-noframe.html">All&nbsp;Classes</a></li>
  408. </ul>
  409. <div>
  410. <script type="text/javascript"><!--
  411. allClassesLink = document.getElementById("allclasses_navbar_bottom");
  412. if(window==top) {
  413. allClassesLink.style.display = "block";
  414. }
  415. else {
  416. allClassesLink.style.display = "none";
  417. }
  418. //-->
  419. </script>
  420. </div>
  421. <div>
  422. <ul class="subNavList">
  423. <li>Summary:&nbsp;</li>
  424. <li>Nested&nbsp;|&nbsp;</li>
  425. <li>Field&nbsp;|&nbsp;</li>
  426. <li><a href="#constructor.summary">Constr</a>&nbsp;|&nbsp;</li>
  427. <li><a href="#method.summary">Method</a></li>
  428. </ul>
  429. <ul class="subNavList">
  430. <li>Detail:&nbsp;</li>
  431. <li>Field&nbsp;|&nbsp;</li>
  432. <li><a href="#constructor.detail">Constr</a>&nbsp;|&nbsp;</li>
  433. <li><a href="#method.detail">Method</a></li>
  434. </ul>
  435. </div>
  436. <a name="skip.navbar.bottom">
  437. <!-- -->
  438. </a></div>
  439. <!-- ======== END OF BOTTOM NAVBAR ======= -->
  440. </body>
  441. </html>