ImageEncoderFactory.html 16 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383
  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:30 CEST 2014 -->
  6. <title>ImageEncoderFactory (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="ImageEncoderFactory (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};
  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/ImageEncoderFactory.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/encoders/ImageEncoder.html" title="interface in org.jfree.chart.encoders"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
  53. <li><a href="../../../../org/jfree/chart/encoders/ImageFormat.html" title="interface in org.jfree.chart.encoders"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
  54. </ul>
  55. <ul class="navList">
  56. <li><a href="../../../../index.html?org/jfree/chart/encoders/ImageEncoderFactory.html" target="_top">Frames</a></li>
  57. <li><a href="ImageEncoderFactory.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.encoders</div>
  96. <h2 title="Class ImageEncoderFactory" class="title">Class ImageEncoderFactory</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.encoders.ImageEncoderFactory</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/encoders/ImageEncoderFactory.html#line.55">ImageEncoderFactory</a>
  113. extends java.lang.Object</pre>
  114. <div class="block">Factory class for returning <a href="../../../../org/jfree/chart/encoders/ImageEncoder.html" title="interface in org.jfree.chart.encoders"><code>ImageEncoder</code></a>s for different
  115. <a href="../../../../org/jfree/chart/encoders/ImageFormat.html" title="interface in org.jfree.chart.encoders"><code>ImageFormat</code></a>s.</div>
  116. </li>
  117. </ul>
  118. </div>
  119. <div class="summary">
  120. <ul class="blockList">
  121. <li class="blockList">
  122. <!-- ======== CONSTRUCTOR SUMMARY ======== -->
  123. <ul class="blockList">
  124. <li class="blockList"><a name="constructor.summary">
  125. <!-- -->
  126. </a>
  127. <h3>Constructor Summary</h3>
  128. <table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Constructor Summary table, listing constructors, and an explanation">
  129. <caption><span>Constructors</span><span class="tabEnd">&nbsp;</span></caption>
  130. <tr>
  131. <th class="colOne" scope="col">Constructor and Description</th>
  132. </tr>
  133. <tr class="altColor">
  134. <td class="colOne"><code><span class="memberNameLink"><a href="../../../../org/jfree/chart/encoders/ImageEncoderFactory.html#ImageEncoderFactory--">ImageEncoderFactory</a></span>()</code>&nbsp;</td>
  135. </tr>
  136. </table>
  137. </li>
  138. </ul>
  139. <!-- ========== METHOD SUMMARY =========== -->
  140. <ul class="blockList">
  141. <li class="blockList"><a name="method.summary">
  142. <!-- -->
  143. </a>
  144. <h3>Method Summary</h3>
  145. <table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation">
  146. <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>
  147. <tr>
  148. <th class="colFirst" scope="col">Modifier and Type</th>
  149. <th class="colLast" scope="col">Method and Description</th>
  150. </tr>
  151. <tr id="i0" class="altColor">
  152. <td class="colFirst"><code>static <a href="../../../../org/jfree/chart/encoders/ImageEncoder.html" title="interface in org.jfree.chart.encoders">ImageEncoder</a></code></td>
  153. <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/jfree/chart/encoders/ImageEncoderFactory.html#newInstance-java.lang.String-">newInstance</a></span>(java.lang.String&nbsp;format)</code>
  154. <div class="block">Used to retrieve an ImageEncoder for a specific image format.</div>
  155. </td>
  156. </tr>
  157. <tr id="i1" class="rowColor">
  158. <td class="colFirst"><code>static <a href="../../../../org/jfree/chart/encoders/ImageEncoder.html" title="interface in org.jfree.chart.encoders">ImageEncoder</a></code></td>
  159. <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/jfree/chart/encoders/ImageEncoderFactory.html#newInstance-java.lang.String-boolean-">newInstance</a></span>(java.lang.String&nbsp;format,
  160. boolean&nbsp;encodingAlpha)</code>
  161. <div class="block">Used to retrieve an ImageEncoder for a specific image format.</div>
  162. </td>
  163. </tr>
  164. <tr id="i2" class="altColor">
  165. <td class="colFirst"><code>static <a href="../../../../org/jfree/chart/encoders/ImageEncoder.html" title="interface in org.jfree.chart.encoders">ImageEncoder</a></code></td>
  166. <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/jfree/chart/encoders/ImageEncoderFactory.html#newInstance-java.lang.String-float-">newInstance</a></span>(java.lang.String&nbsp;format,
  167. float&nbsp;quality)</code>
  168. <div class="block">Used to retrieve an ImageEncoder for a specific image format.</div>
  169. </td>
  170. </tr>
  171. <tr id="i3" class="rowColor">
  172. <td class="colFirst"><code>static <a href="../../../../org/jfree/chart/encoders/ImageEncoder.html" title="interface in org.jfree.chart.encoders">ImageEncoder</a></code></td>
  173. <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/jfree/chart/encoders/ImageEncoderFactory.html#newInstance-java.lang.String-float-boolean-">newInstance</a></span>(java.lang.String&nbsp;format,
  174. float&nbsp;quality,
  175. boolean&nbsp;encodingAlpha)</code>
  176. <div class="block">Used to retrieve an ImageEncoder for a specific image format.</div>
  177. </td>
  178. </tr>
  179. <tr id="i4" class="altColor">
  180. <td class="colFirst"><code>static void</code></td>
  181. <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/jfree/chart/encoders/ImageEncoderFactory.html#setImageEncoder-java.lang.String-java.lang.String-">setImageEncoder</a></span>(java.lang.String&nbsp;format,
  182. java.lang.String&nbsp;imageEncoderClassName)</code>
  183. <div class="block">Used to set additional encoders or replace default ones.</div>
  184. </td>
  185. </tr>
  186. </table>
  187. <ul class="blockList">
  188. <li class="blockList"><a name="methods.inherited.from.class.java.lang.Object">
  189. <!-- -->
  190. </a>
  191. <h3>Methods inherited from class&nbsp;java.lang.Object</h3>
  192. <code>clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait</code></li>
  193. </ul>
  194. </li>
  195. </ul>
  196. </li>
  197. </ul>
  198. </div>
  199. <div class="details">
  200. <ul class="blockList">
  201. <li class="blockList">
  202. <!-- ========= CONSTRUCTOR DETAIL ======== -->
  203. <ul class="blockList">
  204. <li class="blockList"><a name="constructor.detail">
  205. <!-- -->
  206. </a>
  207. <h3>Constructor Detail</h3>
  208. <a name="ImageEncoderFactory--">
  209. <!-- -->
  210. </a>
  211. <ul class="blockListLast">
  212. <li class="blockList">
  213. <h4>ImageEncoderFactory</h4>
  214. <pre>public&nbsp;<a href="../../../../src-html/org/jfree/chart/encoders/ImageEncoderFactory.html#line.55">ImageEncoderFactory</a>()</pre>
  215. </li>
  216. </ul>
  217. </li>
  218. </ul>
  219. <!-- ============ METHOD DETAIL ========== -->
  220. <ul class="blockList">
  221. <li class="blockList"><a name="method.detail">
  222. <!-- -->
  223. </a>
  224. <h3>Method Detail</h3>
  225. <a name="setImageEncoder-java.lang.String-java.lang.String-">
  226. <!-- -->
  227. </a>
  228. <ul class="blockList">
  229. <li class="blockList">
  230. <h4>setImageEncoder</h4>
  231. <pre>public static&nbsp;void&nbsp;<a href="../../../../src-html/org/jfree/chart/encoders/ImageEncoderFactory.html#line.80">setImageEncoder</a>(java.lang.String&nbsp;format,
  232. java.lang.String&nbsp;imageEncoderClassName)</pre>
  233. <div class="block">Used to set additional encoders or replace default ones.</div>
  234. <dl>
  235. <dt><span class="paramLabel">Parameters:</span></dt>
  236. <dd><code>format</code> - The image format name.</dd>
  237. <dd><code>imageEncoderClassName</code> - The name of the ImageEncoder class.</dd>
  238. </dl>
  239. </li>
  240. </ul>
  241. <a name="newInstance-java.lang.String-">
  242. <!-- -->
  243. </a>
  244. <ul class="blockList">
  245. <li class="blockList">
  246. <h4>newInstance</h4>
  247. <pre>public static&nbsp;<a href="../../../../org/jfree/chart/encoders/ImageEncoder.html" title="interface in org.jfree.chart.encoders">ImageEncoder</a>&nbsp;<a href="../../../../src-html/org/jfree/chart/encoders/ImageEncoderFactory.html#line.92">newInstance</a>(java.lang.String&nbsp;format)</pre>
  248. <div class="block">Used to retrieve an ImageEncoder for a specific image format.</div>
  249. <dl>
  250. <dt><span class="paramLabel">Parameters:</span></dt>
  251. <dd><code>format</code> - The image format required.</dd>
  252. <dt><span class="returnLabel">Returns:</span></dt>
  253. <dd>The ImageEncoder or <code>null</code> if none available.</dd>
  254. </dl>
  255. </li>
  256. </ul>
  257. <a name="newInstance-java.lang.String-float-">
  258. <!-- -->
  259. </a>
  260. <ul class="blockList">
  261. <li class="blockList">
  262. <h4>newInstance</h4>
  263. <pre>public static&nbsp;<a href="../../../../org/jfree/chart/encoders/ImageEncoder.html" title="interface in org.jfree.chart.encoders">ImageEncoder</a>&nbsp;<a href="../../../../src-html/org/jfree/chart/encoders/ImageEncoderFactory.html#line.117">newInstance</a>(java.lang.String&nbsp;format,
  264. float&nbsp;quality)</pre>
  265. <div class="block">Used to retrieve an ImageEncoder for a specific image format.</div>
  266. <dl>
  267. <dt><span class="paramLabel">Parameters:</span></dt>
  268. <dd><code>format</code> - The image format required.</dd>
  269. <dd><code>quality</code> - The quality to be set before returning.</dd>
  270. <dt><span class="returnLabel">Returns:</span></dt>
  271. <dd>The ImageEncoder or <code>null</code> if none available.</dd>
  272. </dl>
  273. </li>
  274. </ul>
  275. <a name="newInstance-java.lang.String-boolean-">
  276. <!-- -->
  277. </a>
  278. <ul class="blockList">
  279. <li class="blockList">
  280. <h4>newInstance</h4>
  281. <pre>public static&nbsp;<a href="../../../../org/jfree/chart/encoders/ImageEncoder.html" title="interface in org.jfree.chart.encoders">ImageEncoder</a>&nbsp;<a href="../../../../src-html/org/jfree/chart/encoders/ImageEncoderFactory.html#line.131">newInstance</a>(java.lang.String&nbsp;format,
  282. boolean&nbsp;encodingAlpha)</pre>
  283. <div class="block">Used to retrieve an ImageEncoder for a specific image format.</div>
  284. <dl>
  285. <dt><span class="paramLabel">Parameters:</span></dt>
  286. <dd><code>format</code> - The image format required.</dd>
  287. <dd><code>encodingAlpha</code> - Sets whether alpha transparency should be encoded.</dd>
  288. <dt><span class="returnLabel">Returns:</span></dt>
  289. <dd>The ImageEncoder or <code>null</code> if none available.</dd>
  290. </dl>
  291. </li>
  292. </ul>
  293. <a name="newInstance-java.lang.String-float-boolean-">
  294. <!-- -->
  295. </a>
  296. <ul class="blockListLast">
  297. <li class="blockList">
  298. <h4>newInstance</h4>
  299. <pre>public static&nbsp;<a href="../../../../org/jfree/chart/encoders/ImageEncoder.html" title="interface in org.jfree.chart.encoders">ImageEncoder</a>&nbsp;<a href="../../../../src-html/org/jfree/chart/encoders/ImageEncoderFactory.html#line.147">newInstance</a>(java.lang.String&nbsp;format,
  300. float&nbsp;quality,
  301. boolean&nbsp;encodingAlpha)</pre>
  302. <div class="block">Used to retrieve an ImageEncoder for a specific image format.</div>
  303. <dl>
  304. <dt><span class="paramLabel">Parameters:</span></dt>
  305. <dd><code>format</code> - The image format required.</dd>
  306. <dd><code>quality</code> - The quality to be set before returning.</dd>
  307. <dd><code>encodingAlpha</code> - Sets whether alpha transparency should be encoded.</dd>
  308. <dt><span class="returnLabel">Returns:</span></dt>
  309. <dd>The ImageEncoder or <code>null</code> if none available.</dd>
  310. </dl>
  311. </li>
  312. </ul>
  313. </li>
  314. </ul>
  315. </li>
  316. </ul>
  317. </div>
  318. </div>
  319. <!-- ========= END OF CLASS DATA ========= -->
  320. <!-- ======= START OF BOTTOM NAVBAR ====== -->
  321. <div class="bottomNav"><a name="navbar.bottom">
  322. <!-- -->
  323. </a>
  324. <div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div>
  325. <a name="navbar.bottom.firstrow">
  326. <!-- -->
  327. </a>
  328. <ul class="navList" title="Navigation">
  329. <li><a href="../../../../overview-summary.html">Overview</a></li>
  330. <li><a href="package-summary.html">Package</a></li>
  331. <li class="navBarCell1Rev">Class</li>
  332. <li><a href="class-use/ImageEncoderFactory.html">Use</a></li>
  333. <li><a href="package-tree.html">Tree</a></li>
  334. <li><a href="../../../../deprecated-list.html">Deprecated</a></li>
  335. <li><a href="../../../../index-files/index-1.html">Index</a></li>
  336. <li><a href="../../../../help-doc.html">Help</a></li>
  337. </ul>
  338. </div>
  339. <div class="subNav">
  340. <ul class="navList">
  341. <li><a href="../../../../org/jfree/chart/encoders/ImageEncoder.html" title="interface in org.jfree.chart.encoders"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
  342. <li><a href="../../../../org/jfree/chart/encoders/ImageFormat.html" title="interface in org.jfree.chart.encoders"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
  343. </ul>
  344. <ul class="navList">
  345. <li><a href="../../../../index.html?org/jfree/chart/encoders/ImageEncoderFactory.html" target="_top">Frames</a></li>
  346. <li><a href="ImageEncoderFactory.html" target="_top">No&nbsp;Frames</a></li>
  347. </ul>
  348. <ul class="navList" id="allclasses_navbar_bottom">
  349. <li><a href="../../../../allclasses-noframe.html">All&nbsp;Classes</a></li>
  350. </ul>
  351. <div>
  352. <script type="text/javascript"><!--
  353. allClassesLink = document.getElementById("allclasses_navbar_bottom");
  354. if(window==top) {
  355. allClassesLink.style.display = "block";
  356. }
  357. else {
  358. allClassesLink.style.display = "none";
  359. }
  360. //-->
  361. </script>
  362. </div>
  363. <div>
  364. <ul class="subNavList">
  365. <li>Summary:&nbsp;</li>
  366. <li>Nested&nbsp;|&nbsp;</li>
  367. <li>Field&nbsp;|&nbsp;</li>
  368. <li><a href="#constructor.summary">Constr</a>&nbsp;|&nbsp;</li>
  369. <li><a href="#method.summary">Method</a></li>
  370. </ul>
  371. <ul class="subNavList">
  372. <li>Detail:&nbsp;</li>
  373. <li>Field&nbsp;|&nbsp;</li>
  374. <li><a href="#constructor.detail">Constr</a>&nbsp;|&nbsp;</li>
  375. <li><a href="#method.detail">Method</a></li>
  376. </ul>
  377. </div>
  378. <a name="skip.navbar.bottom">
  379. <!-- -->
  380. </a></div>
  381. <!-- ======== END OF BOTTOM NAVBAR ======= -->
  382. </body>
  383. </html>