Home Explore Help
Sign In
jonas.rehn
/
praktikum-holons
forked from carlos.garcia/praktikum-holons
1
0
Fork 0
Files
Tree: f87d359898
Branches Tags
praktikum-ho...
/
jars
/
jfreechart-1.0.19
/
jfreechart-1.0.19-fx-javadocs
/
org
/
jfree
/
chart
/
encoders
/
ImageEncoder.html

ImageEncoder.html 13 KB
History Raw

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349 
  1. <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
    2. 

  2. <!-- NewPage -->
    3. 

  3. <html lang="en">
    4. 

  4. <head>
    5. 

  5. <!-- Generated by javadoc (1.8.0_05) on Thu Jul 31 14:50:30 CEST 2014 -->
    6. 

  6. <title>ImageEncoder (JFreeChart Class Library (version 1.0.19-fx))</title>
    7. 

  7. <meta name="date" content="2014-07-31">
    8. 

  8. <link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style">
    9. 

  9. <script type="text/javascript" src="../../../../script.js"></script>
    10. 

  10. </head>
    11. 

  11. <body>
    12. 

  12. <script type="text/javascript"><!--
    13. 

  13.     try {
    14. 

  14.         if (location.href.indexOf('is-external=true') == -1) {
    15. 

  15.             parent.document.title="ImageEncoder (JFreeChart Class Library (version 1.0.19-fx))";
    16. 

  16.         }
    17. 

  17.     }
    18. 

  18.     catch(err) {
    19. 

  19.     }
    20. 

  20. //-->
    21. 

  21. var methods = {"i0":6,"i1":6,"i2":6,"i3":6,"i4":6,"i5":6};
    22. 

  22. var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],4:["t3","Abstract Methods"]};
    23. 

  23. var altColor = "altColor";
    24. 

  24. var rowColor = "rowColor";
    25. 

  25. var tableTab = "tableTab";
    26. 

  26. var activeTableTab = "activeTableTab";
    27. 

  27. </script>
    28. 

  28. <noscript>
    29. 

  29. <div>JavaScript is disabled on your browser.</div>
    30. 

  30. </noscript>
    31. 

  31. <!-- ========= START OF TOP NAVBAR ======= -->
    32. 

  32. <div class="topNav"><a name="navbar.top">
    33. 

  33. <!--   -->
    34. 

  34. </a>
    35. 

  35. <div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div>
    36. 

  36. <a name="navbar.top.firstrow">
    37. 

  37. <!--   -->
    38. 

  38. </a>
    39. 

  39. <ul class="navList" title="Navigation">
    40. 

  40. <li><a href="../../../../overview-summary.html">Overview</a></li>
    41. 

  41. <li><a href="package-summary.html">Package</a></li>
    42. 

  42. <li class="navBarCell1Rev">Class</li>
    43. 

  43. <li><a href="class-use/ImageEncoder.html">Use</a></li>
    44. 

  44. <li><a href="package-tree.html">Tree</a></li>
    45. 

  45. <li><a href="../../../../deprecated-list.html">Deprecated</a></li>
    46. 

  46. <li><a href="../../../../index-files/index-1.html">Index</a></li>
    47. 

  47. <li><a href="../../../../help-doc.html">Help</a></li>
    48. 

  48. </ul>
    49. 

  49. </div>
    50. 

  50. <div class="subNav">
    51. 

  51. <ul class="navList">
    52. 

  52. <li><a href="../../../../org/jfree/chart/encoders/EncoderUtil.html" title="class in org.jfree.chart.encoders"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
    53. 

  53. <li><a href="../../../../org/jfree/chart/encoders/ImageEncoderFactory.html" title="class in org.jfree.chart.encoders"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
    54. 

  54. </ul>
    55. 

  55. <ul class="navList">
    56. 

  56. <li><a href="../../../../index.html?org/jfree/chart/encoders/ImageEncoder.html" target="_top">Frames</a></li>
    57. 

  57. <li><a href="ImageEncoder.html" target="_top">No&nbsp;Frames</a></li>
    58. 

  58. </ul>
    59. 

  59. <ul class="navList" id="allclasses_navbar_top">
    60. 

  60. <li><a href="../../../../allclasses-noframe.html">All&nbsp;Classes</a></li>
    61. 

  61. </ul>
    62. 

  62. <div>
    63. 

  63. <script type="text/javascript"><!--
    64. 

  64.   allClassesLink = document.getElementById("allclasses_navbar_top");
    65. 

  65.   if(window==top) {
    66. 

  66.     allClassesLink.style.display = "block";
    67. 

  67.   }
    68. 

  68.   else {
    69. 

  69.     allClassesLink.style.display = "none";
    70. 

  70.   }
    71. 

  71.   //-->
    72. 

  72. </script>
    73. 

  73. </div>
    74. 

  74. <div>
    75. 

  75. <ul class="subNavList">
    76. 

  76. <li>Summary:&nbsp;</li>
    77. 

  77. <li>Nested&nbsp;|&nbsp;</li>
    78. 

  78. <li>Field&nbsp;|&nbsp;</li>
    79. 

  79. <li>Constr&nbsp;|&nbsp;</li>
    80. 

  80. <li><a href="#method.summary">Method</a></li>
    81. 

  81. </ul>
    82. 

  82. <ul class="subNavList">
    83. 

  83. <li>Detail:&nbsp;</li>
    84. 

  84. <li>Field&nbsp;|&nbsp;</li>
    85. 

  85. <li>Constr&nbsp;|&nbsp;</li>
    86. 

  86. <li><a href="#method.detail">Method</a></li>
    87. 

  87. </ul>
    88. 

  88. </div>
    89. 

  89. <a name="skip.navbar.top">
    90. 

  90. <!--   -->
    91. 

  91. </a></div>
    92. 

  92. <!-- ========= END OF TOP NAVBAR ========= -->
    93. 

  93. <!-- ======== START OF CLASS DATA ======== -->
    94. 

  94. <div class="header">
    95. 

  95. <div class="subTitle">org.jfree.chart.encoders</div>
    96. 

  96. <h2 title="Interface ImageEncoder" class="title">Interface ImageEncoder</h2>
    97. 

  97. </div>
    98. 

  98. <div class="contentContainer">
    99. 

  99. <div class="description">
    100. 

  100. <ul class="blockList">
    101. 

  101. <li class="blockList">
    102. 

  102. <dl>
    103. 

  103. <dt>All Known Implementing Classes:</dt>
    104. 

  104. <dd><a href="../../../../org/jfree/chart/encoders/KeypointPNGEncoderAdapter.html" title="class in org.jfree.chart.encoders">KeypointPNGEncoderAdapter</a>, <a href="../../../../org/jfree/chart/encoders/SunJPEGEncoderAdapter.html" title="class in org.jfree.chart.encoders">SunJPEGEncoderAdapter</a>, <a href="../../../../org/jfree/chart/encoders/SunPNGEncoderAdapter.html" title="class in org.jfree.chart.encoders">SunPNGEncoderAdapter</a></dd>
    105. 

  105. </dl>
    106. 

  106. <hr>
    107. 

  107. <br>
    108. 

  108. <pre>public interface <a href="../../../../src-html/org/jfree/chart/encoders/ImageEncoder.html#line.51">ImageEncoder</a></pre>
    109. 

  109. <div class="block">Interface for abstracting different types of image encoders.</div>
    110. 

  110. </li>
    111. 

  111. </ul>
    112. 

  112. </div>
    113. 

  113. <div class="summary">
    114. 

  114. <ul class="blockList">
    115. 

  115. <li class="blockList">
    116. 

  116. <!-- ========== METHOD SUMMARY =========== -->
    117. 

  117. <ul class="blockList">
    118. 

  118. <li class="blockList"><a name="method.summary">
    119. 

  119. <!--   -->
    120. 

  120. </a>
    121. 

  121. <h3>Method Summary</h3>
    122. 

  122. <table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation">
    123. 

  123. <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="t3" class="tableTab"><span><a href="javascript:show(4);">Abstract Methods</a></span><span class="tabEnd">&nbsp;</span></span></caption>
    124. 

  124. <tr>
    125. 

  125. <th class="colFirst" scope="col">Modifier and Type</th>
    126. 

  126. <th class="colLast" scope="col">Method and Description</th>
    127. 

  127. </tr>
    128. 

  128. <tr id="i0" class="altColor">
    129. 

  129. <td class="colFirst"><code>byte[]</code></td>
    130. 

  130. <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/jfree/chart/encoders/ImageEncoder.html#encode-java.awt.image.BufferedImage-">encode</a></span>(java.awt.image.BufferedImage&nbsp;bufferedImage)</code>
    131. 

  131. <div class="block">Encodes an image in a particular format.</div>
    132. 

  132. </td>
    133. 

  133. </tr>
    134. 

  134. <tr id="i1" class="rowColor">
    135. 

  135. <td class="colFirst"><code>void</code></td>
    136. 

  136. <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/jfree/chart/encoders/ImageEncoder.html#encode-java.awt.image.BufferedImage-java.io.OutputStream-">encode</a></span>(java.awt.image.BufferedImage&nbsp;bufferedImage,
    137. 

  137.       java.io.OutputStream&nbsp;outputStream)</code>
    138. 

  138. <div class="block">Encodes an image in a particular format and writes it to an OutputStream.</div>
    139. 

  139. </td>
    140. 

  140. </tr>
    141. 

  141. <tr id="i2" class="altColor">
    142. 

  142. <td class="colFirst"><code>float</code></td>
    143. 

  143. <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/jfree/chart/encoders/ImageEncoder.html#getQuality--">getQuality</a></span>()</code>
    144. 

  144. <div class="block">Get the quality of the image encoding.</div>
    145. 

  145. </td>
    146. 

  146. </tr>
    147. 

  147. <tr id="i3" class="rowColor">
    148. 

  148. <td class="colFirst"><code>boolean</code></td>
    149. 

  149. <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/jfree/chart/encoders/ImageEncoder.html#isEncodingAlpha--">isEncodingAlpha</a></span>()</code>
    150. 

  150. <div class="block">Get whether the encoder should encode alpha transparency.</div>
    151. 

  151. </td>
    152. 

  152. </tr>
    153. 

  153. <tr id="i4" class="altColor">
    154. 

  154. <td class="colFirst"><code>void</code></td>
    155. 

  155. <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/jfree/chart/encoders/ImageEncoder.html#setEncodingAlpha-boolean-">setEncodingAlpha</a></span>(boolean&nbsp;encodingAlpha)</code>
    156. 

  156. <div class="block">Set whether the encoder should encode alpha transparency (not
    157. 

  157.  supported by all ImageEncoders).</div>
    158. 

  158. </td>
    159. 

  159. </tr>
    160. 

  160. <tr id="i5" class="rowColor">
    161. 

  161. <td class="colFirst"><code>void</code></td>
    162. 

  162. <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/jfree/chart/encoders/ImageEncoder.html#setQuality-float-">setQuality</a></span>(float&nbsp;quality)</code>
    163. 

  163. <div class="block">Set the quality of the image encoding (not supported by all
    164. 

  164.  ImageEncoders).</div>
    165. 

  165. </td>
    166. 

  166. </tr>
    167. 

  167. </table>
    168. 

  168. </li>
    169. 

  169. </ul>
    170. 

  170. </li>
    171. 

  171. </ul>
    172. 

  172. </div>
    173. 

  173. <div class="details">
    174. 

  174. <ul class="blockList">
    175. 

  175. <li class="blockList">
    176. 

  176. <!-- ============ METHOD DETAIL ========== -->
    177. 

  177. <ul class="blockList">
    178. 

  178. <li class="blockList"><a name="method.detail">
    179. 

  179. <!--   -->
    180. 

  180. </a>
    181. 

  181. <h3>Method Detail</h3>
    182. 

  182. <a name="encode-java.awt.image.BufferedImage-">
    183. 

  183. <!--   -->
    184. 

  184. </a>
    185. 

  185. <ul class="blockList">
    186. 

  186. <li class="blockList">
    187. 

  187. <h4>encode</h4>
    188. 

  188. <pre>byte[]&nbsp;<a href="../../../../src-html/org/jfree/chart/encoders/ImageEncoder.html#line.62">encode</a>(java.awt.image.BufferedImage&nbsp;bufferedImage)
    189. 

  189.        throws java.io.IOException</pre>
    190. 

  190. <div class="block">Encodes an image in a particular format.</div>
    191. 

  191. <dl>
    192. 

  192. <dt><span class="paramLabel">Parameters:</span></dt>
    193. 

  193. <dd><code>bufferedImage</code> - The image to be encoded.</dd>
    194. 

  194. <dt><span class="returnLabel">Returns:</span></dt>
    195. 

  195. <dd>The byte[] that is the encoded image.</dd>
    196. 

  196. <dt><span class="throwsLabel">Throws:</span></dt>
    197. 

  197. <dd><code>java.io.IOException</code> - if there is an IO problem.</dd>
    198. 

  198. </dl>
    199. 

  199. </li>
    200. 

  200. </ul>
    201. 

  201. <a name="encode-java.awt.image.BufferedImage-java.io.OutputStream-">
    202. 

  202. <!--   -->
    203. 

  203. </a>
    204. 

  204. <ul class="blockList">
    205. 

  205. <li class="blockList">
    206. 

  206. <h4>encode</h4>
    207. 

  207. <pre>void&nbsp;<a href="../../../../src-html/org/jfree/chart/encoders/ImageEncoder.html#line.71">encode</a>(java.awt.image.BufferedImage&nbsp;bufferedImage,
    208. 

  208.             java.io.OutputStream&nbsp;outputStream)
    209. 

  209.      throws java.io.IOException</pre>
    210. 

  210. <div class="block">Encodes an image in a particular format and writes it to an OutputStream.</div>
    211. 

  211. <dl>
    212. 

  212. <dt><span class="paramLabel">Parameters:</span></dt>
    213. 

  213. <dd><code>bufferedImage</code> - The image to be encoded.</dd>
    214. 

  214. <dd><code>outputStream</code> - The OutputStream to write the encoded image to.</dd>
    215. 

  215. <dt><span class="throwsLabel">Throws:</span></dt>
    216. 

  216. <dd><code>java.io.IOException</code> - if there is an IO problem.</dd>
    217. 

  217. </dl>
    218. 

  218. </li>
    219. 

  219. </ul>
    220. 

  220. <a name="getQuality--">
    221. 

  221. <!--   -->
    222. 

  222. </a>
    223. 

  223. <ul class="blockList">
    224. 

  224. <li class="blockList">
    225. 

  225. <h4>getQuality</h4>
    226. 

  226. <pre>float&nbsp;<a href="../../../../src-html/org/jfree/chart/encoders/ImageEncoder.html#line.79">getQuality</a>()</pre>
    227. 

  227. <div class="block">Get the quality of the image encoding.</div>
    228. 

  228. <dl>
    229. 

  229. <dt><span class="returnLabel">Returns:</span></dt>
    230. 

  230. <dd>A float representing the quality.</dd>
    231. 

  231. </dl>
    232. 

  232. </li>
    233. 

  233. </ul>
    234. 

  234. <a name="setQuality-float-">
    235. 

  235. <!--   -->
    236. 

  236. </a>
    237. 

  237. <ul class="blockList">
    238. 

  238. <li class="blockList">
    239. 

  239. <h4>setQuality</h4>
    240. 

  240. <pre>void&nbsp;<a href="../../../../src-html/org/jfree/chart/encoders/ImageEncoder.html#line.87">setQuality</a>(float&nbsp;quality)</pre>
    241. 

  241. <div class="block">Set the quality of the image encoding (not supported by all
    242. 

  242.  ImageEncoders).</div>
    243. 

  243. <dl>
    244. 

  244. <dt><span class="paramLabel">Parameters:</span></dt>
    245. 

  245. <dd><code>quality</code> - A float representing the quality.</dd>
    246. 

  246. </dl>
    247. 

  247. </li>
    248. 

  248. </ul>
    249. 

  249. <a name="isEncodingAlpha--">
    250. 

  250. <!--   -->
    251. 

  251. </a>
    252. 

  252. <ul class="blockList">
    253. 

  253. <li class="blockList">
    254. 

  254. <h4>isEncodingAlpha</h4>
    255. 

  255. <pre>boolean&nbsp;<a href="../../../../src-html/org/jfree/chart/encoders/ImageEncoder.html#line.94">isEncodingAlpha</a>()</pre>
    256. 

  256. <div class="block">Get whether the encoder should encode alpha transparency.</div>
    257. 

  257. <dl>
    258. 

  258. <dt><span class="returnLabel">Returns:</span></dt>
    259. 

  259. <dd>Whether the encoder is encoding alpha transparency.</dd>
    260. 

  260. </dl>
    261. 

  261. </li>
    262. 

  262. </ul>
    263. 

  263. <a name="setEncodingAlpha-boolean-">
    264. 

  264. <!--   -->
    265. 

  265. </a>
    266. 

  266. <ul class="blockListLast">
    267. 

  267. <li class="blockList">
    268. 

  268. <h4>setEncodingAlpha</h4>
    269. 

  269. <pre>void&nbsp;<a href="../../../../src-html/org/jfree/chart/encoders/ImageEncoder.html#line.103">setEncodingAlpha</a>(boolean&nbsp;encodingAlpha)</pre>
    270. 

  270. <div class="block">Set whether the encoder should encode alpha transparency (not
    271. 

  271.  supported by all ImageEncoders).</div>
    272. 

  272. <dl>
    273. 

  273. <dt><span class="paramLabel">Parameters:</span></dt>
    274. 

  274. <dd><code>encodingAlpha</code> - Whether the encoder should encode alpha
    275. 

  275.                        transparency.</dd>
    276. 

  276. </dl>
    277. 

  277. </li>
    278. 

  278. </ul>
    279. 

  279. </li>
    280. 

  280. </ul>
    281. 

  281. </li>
    282. 

  282. </ul>
    283. 

  283. </div>
    284. 

  284. </div>
    285. 

  285. <!-- ========= END OF CLASS DATA ========= -->
    286. 

  286. <!-- ======= START OF BOTTOM NAVBAR ====== -->
    287. 

  287. <div class="bottomNav"><a name="navbar.bottom">
    288. 

  288. <!--   -->
    289. 

  289. </a>
    290. 

  290. <div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div>
    291. 

  291. <a name="navbar.bottom.firstrow">
    292. 

  292. <!--   -->
    293. 

  293. </a>
    294. 

  294. <ul class="navList" title="Navigation">
    295. 

  295. <li><a href="../../../../overview-summary.html">Overview</a></li>
    296. 

  296. <li><a href="package-summary.html">Package</a></li>
    297. 

  297. <li class="navBarCell1Rev">Class</li>
    298. 

  298. <li><a href="class-use/ImageEncoder.html">Use</a></li>
    299. 

  299. <li><a href="package-tree.html">Tree</a></li>
    300. 

  300. <li><a href="../../../../deprecated-list.html">Deprecated</a></li>
    301. 

  301. <li><a href="../../../../index-files/index-1.html">Index</a></li>
    302. 

  302. <li><a href="../../../../help-doc.html">Help</a></li>
    303. 

  303. </ul>
    304. 

  304. </div>
    305. 

  305. <div class="subNav">
    306. 

  306. <ul class="navList">
    307. 

  307. <li><a href="../../../../org/jfree/chart/encoders/EncoderUtil.html" title="class in org.jfree.chart.encoders"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
    308. 

  308. <li><a href="../../../../org/jfree/chart/encoders/ImageEncoderFactory.html" title="class in org.jfree.chart.encoders"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
    309. 

  309. </ul>
    310. 

  310. <ul class="navList">
    311. 

  311. <li><a href="../../../../index.html?org/jfree/chart/encoders/ImageEncoder.html" target="_top">Frames</a></li>
    312. 

  312. <li><a href="ImageEncoder.html" target="_top">No&nbsp;Frames</a></li>
    313. 

  313. </ul>
    314. 

  314. <ul class="navList" id="allclasses_navbar_bottom">
    315. 

  315. <li><a href="../../../../allclasses-noframe.html">All&nbsp;Classes</a></li>
    316. 

  316. </ul>
    317. 

  317. <div>
    318. 

  318. <script type="text/javascript"><!--
    319. 

  319.   allClassesLink = document.getElementById("allclasses_navbar_bottom");
    320. 

  320.   if(window==top) {
    321. 

  321.     allClassesLink.style.display = "block";
    322. 

  322.   }
    323. 

  323.   else {
    324. 

  324.     allClassesLink.style.display = "none";
    325. 

  325.   }
    326. 

  326.   //-->
    327. 

  327. </script>
    328. 

  328. </div>
    329. 

  329. <div>
    330. 

  330. <ul class="subNavList">
    331. 

  331. <li>Summary:&nbsp;</li>
    332. 

  332. <li>Nested&nbsp;|&nbsp;</li>
    333. 

  333. <li>Field&nbsp;|&nbsp;</li>
    334. 

  334. <li>Constr&nbsp;|&nbsp;</li>
    335. 

  335. <li><a href="#method.summary">Method</a></li>
    336. 

  336. </ul>
    337. 

  337. <ul class="subNavList">
    338. 

  338. <li>Detail:&nbsp;</li>
    339. 

  339. <li>Field&nbsp;|&nbsp;</li>
    340. 

  340. <li>Constr&nbsp;|&nbsp;</li>
    341. 

  341. <li><a href="#method.detail">Method</a></li>
    342. 

  342. </ul>
    343. 

  343. </div>
    344. 

  344. <a name="skip.navbar.bottom">
    345. 

  345. <!--   -->
    346. 

  346. </a></div>
    347. 

  347. <!-- ======== END OF BOTTOM NAVBAR ======= -->
    348. 

  348. </body>
    349. 

  349. </html>
    350.