PaintAlpha.html 13 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367
  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>PaintAlpha (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="PaintAlpha (JFreeChart Class Library (version 1.0.19-fx))";
  16. }
  17. }
  18. catch(err) {
  19. }
  20. //-->
  21. var methods = {"i0":9,"i1":9,"i2":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/PaintAlpha.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/LogFormat.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/ParamChecks.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/PaintAlpha.html" target="_top">Frames</a></li>
  57. <li><a href="PaintAlpha.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 PaintAlpha" class="title">Class PaintAlpha</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.PaintAlpha</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/PaintAlpha.html#line.83">PaintAlpha</a>
  113. extends java.lang.Object</pre>
  114. <div class="block">This class contains static methods for the manipulation
  115. of objects of type <code>Paint</code>
  116. <p>
  117. The intention is to honour the alpha-channel in the process.
  118. <code>PaintAlpha</code> was originally conceived to improve the
  119. rendering of 3D Shapes with transparent colours and to allow
  120. invisible bars by making them completely transparent.
  121. <p>
  122. In, for example
  123. <a href="../../../../org/jfree/chart/renderer/category/StackedBarRenderer3D.html" title="class in org.jfree.chart.renderer.category"><code>StackedBarRenderer3D</code></a>,
  124. bars are rendered with 6 faces. The front face is rendered with
  125. the <code>Paint</code> requested. The other 5 faces are rendered
  126. darker to achieve the 3D effect.
  127. <p>
  128. Previously <code>Color.darker()</code> was used for this,
  129. which always returns an opaque colour.
  130. <p>
  131. Additionally there are methods to control the behaviour and
  132. in particular a <a href="../../../../org/jfree/chart/util/PaintAlpha.html#cloneImage-java.awt.image.BufferedImage-"><code>cloneImage(..)</code></a>
  133. method which is needed to darken objects of type <code>TexturePaint</code>.</div>
  134. <dl>
  135. <dt><span class="simpleTagLabel">Since:</span></dt>
  136. <dd>1.0.15</dd>
  137. <dt><span class="simpleTagLabel">Author:</span></dt>
  138. <dd>DaveLaw</dd>
  139. </dl>
  140. </li>
  141. </ul>
  142. </div>
  143. <div class="summary">
  144. <ul class="blockList">
  145. <li class="blockList">
  146. <!-- ======== CONSTRUCTOR SUMMARY ======== -->
  147. <ul class="blockList">
  148. <li class="blockList"><a name="constructor.summary">
  149. <!-- -->
  150. </a>
  151. <h3>Constructor Summary</h3>
  152. <table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Constructor Summary table, listing constructors, and an explanation">
  153. <caption><span>Constructors</span><span class="tabEnd">&nbsp;</span></caption>
  154. <tr>
  155. <th class="colOne" scope="col">Constructor and Description</th>
  156. </tr>
  157. <tr class="altColor">
  158. <td class="colOne"><code><span class="memberNameLink"><a href="../../../../org/jfree/chart/util/PaintAlpha.html#PaintAlpha--">PaintAlpha</a></span>()</code>&nbsp;</td>
  159. </tr>
  160. </table>
  161. </li>
  162. </ul>
  163. <!-- ========== METHOD SUMMARY =========== -->
  164. <ul class="blockList">
  165. <li class="blockList"><a name="method.summary">
  166. <!-- -->
  167. </a>
  168. <h3>Method Summary</h3>
  169. <table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation">
  170. <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>
  171. <tr>
  172. <th class="colFirst" scope="col">Modifier and Type</th>
  173. <th class="colLast" scope="col">Method and Description</th>
  174. </tr>
  175. <tr id="i0" class="altColor">
  176. <td class="colFirst"><code>static java.awt.image.BufferedImage</code></td>
  177. <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/jfree/chart/util/PaintAlpha.html#cloneImage-java.awt.image.BufferedImage-">cloneImage</a></span>(java.awt.image.BufferedImage&nbsp;image)</code>
  178. <div class="block">Clone a <code>BufferedImage</code>.</div>
  179. </td>
  180. </tr>
  181. <tr id="i1" class="rowColor">
  182. <td class="colFirst"><code>static java.awt.Paint</code></td>
  183. <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/jfree/chart/util/PaintAlpha.html#darker-java.awt.Paint-">darker</a></span>(java.awt.Paint&nbsp;paint)</code>
  184. <div class="block">Create a new (if possible, darker) <code>Paint</code> of the same Type.</div>
  185. </td>
  186. </tr>
  187. <tr id="i2" class="altColor">
  188. <td class="colFirst"><code>static boolean</code></td>
  189. <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/jfree/chart/util/PaintAlpha.html#setLegacyAlpha-boolean-">setLegacyAlpha</a></span>(boolean&nbsp;legacyAlpha)</code>
  190. <div class="block">Per default <code>PaintAlpha</code> will try to honour alpha-channel
  191. information.</div>
  192. </td>
  193. </tr>
  194. </table>
  195. <ul class="blockList">
  196. <li class="blockList"><a name="methods.inherited.from.class.java.lang.Object">
  197. <!-- -->
  198. </a>
  199. <h3>Methods inherited from class&nbsp;java.lang.Object</h3>
  200. <code>clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait</code></li>
  201. </ul>
  202. </li>
  203. </ul>
  204. </li>
  205. </ul>
  206. </div>
  207. <div class="details">
  208. <ul class="blockList">
  209. <li class="blockList">
  210. <!-- ========= CONSTRUCTOR DETAIL ======== -->
  211. <ul class="blockList">
  212. <li class="blockList"><a name="constructor.detail">
  213. <!-- -->
  214. </a>
  215. <h3>Constructor Detail</h3>
  216. <a name="PaintAlpha--">
  217. <!-- -->
  218. </a>
  219. <ul class="blockListLast">
  220. <li class="blockList">
  221. <h4>PaintAlpha</h4>
  222. <pre>public&nbsp;<a href="../../../../src-html/org/jfree/chart/util/PaintAlpha.html#line.83">PaintAlpha</a>()</pre>
  223. </li>
  224. </ul>
  225. </li>
  226. </ul>
  227. <!-- ============ METHOD DETAIL ========== -->
  228. <ul class="blockList">
  229. <li class="blockList"><a name="method.detail">
  230. <!-- -->
  231. </a>
  232. <h3>Method Detail</h3>
  233. <a name="setLegacyAlpha-boolean-">
  234. <!-- -->
  235. </a>
  236. <ul class="blockList">
  237. <li class="blockList">
  238. <h4>setLegacyAlpha</h4>
  239. <pre>public static&nbsp;boolean&nbsp;<a href="../../../../src-html/org/jfree/chart/util/PaintAlpha.html#line.107">setLegacyAlpha</a>(boolean&nbsp;legacyAlpha)</pre>
  240. <div class="block">Per default <code>PaintAlpha</code> will try to honour alpha-channel
  241. information. In the past this was not the case.
  242. If you wish legacy functionality for your application you can request
  243. this here.</div>
  244. <dl>
  245. <dt><span class="paramLabel">Parameters:</span></dt>
  246. <dd><code>legacyAlpha</code> - boolean</dd>
  247. <dt><span class="returnLabel">Returns:</span></dt>
  248. <dd>the previous setting</dd>
  249. </dl>
  250. </li>
  251. </ul>
  252. <a name="darker-java.awt.Paint-">
  253. <!-- -->
  254. </a>
  255. <ul class="blockList">
  256. <li class="blockList">
  257. <h4>darker</h4>
  258. <pre>public static&nbsp;java.awt.Paint&nbsp;<a href="../../../../src-html/org/jfree/chart/util/PaintAlpha.html#line.122">darker</a>(java.awt.Paint&nbsp;paint)</pre>
  259. <div class="block">Create a new (if possible, darker) <code>Paint</code> of the same Type.
  260. If the Type is not supported, the original <code>Paint</code> is returned.
  261. <p></div>
  262. <dl>
  263. <dt><span class="paramLabel">Parameters:</span></dt>
  264. <dd><code>paint</code> - a <code>Paint</code> implementation
  265. (e.g. <code>Color</code>, <code>GradientPaint</code>, <code>TexturePaint</code>,..)
  266. <p></dd>
  267. <dt><span class="returnLabel">Returns:</span></dt>
  268. <dd>a (usually new, see above) <code>Paint</code></dd>
  269. </dl>
  270. </li>
  271. </ul>
  272. <a name="cloneImage-java.awt.image.BufferedImage-">
  273. <!-- -->
  274. </a>
  275. <ul class="blockListLast">
  276. <li class="blockList">
  277. <h4>cloneImage</h4>
  278. <pre>public static&nbsp;java.awt.image.BufferedImage&nbsp;<a href="../../../../src-html/org/jfree/chart/util/PaintAlpha.html#line.378">cloneImage</a>(java.awt.image.BufferedImage&nbsp;image)</pre>
  279. <div class="block">Clone a <code>BufferedImage</code>.
  280. <p>
  281. Note: when constructing the clone, the original Color Model Object is
  282. reused.<br> That keeps things simple and should not be a problem, as all
  283. known Color Models<br>
  284. (<code>IndexColorModel</code>,
  285. <code>DirectColorModel</code>,
  286. <code>ComponentColorModel</code>) are
  287. immutable.</div>
  288. <dl>
  289. <dt><span class="paramLabel">Parameters:</span></dt>
  290. <dd><code>image</code> - original BufferedImage to clone</dd>
  291. <dt><span class="returnLabel">Returns:</span></dt>
  292. <dd>a new BufferedImage reusing the original's Color Model and
  293. containing a clone of its pixels</dd>
  294. </dl>
  295. </li>
  296. </ul>
  297. </li>
  298. </ul>
  299. </li>
  300. </ul>
  301. </div>
  302. </div>
  303. <!-- ========= END OF CLASS DATA ========= -->
  304. <!-- ======= START OF BOTTOM NAVBAR ====== -->
  305. <div class="bottomNav"><a name="navbar.bottom">
  306. <!-- -->
  307. </a>
  308. <div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div>
  309. <a name="navbar.bottom.firstrow">
  310. <!-- -->
  311. </a>
  312. <ul class="navList" title="Navigation">
  313. <li><a href="../../../../overview-summary.html">Overview</a></li>
  314. <li><a href="package-summary.html">Package</a></li>
  315. <li class="navBarCell1Rev">Class</li>
  316. <li><a href="class-use/PaintAlpha.html">Use</a></li>
  317. <li><a href="package-tree.html">Tree</a></li>
  318. <li><a href="../../../../deprecated-list.html">Deprecated</a></li>
  319. <li><a href="../../../../index-files/index-1.html">Index</a></li>
  320. <li><a href="../../../../help-doc.html">Help</a></li>
  321. </ul>
  322. </div>
  323. <div class="subNav">
  324. <ul class="navList">
  325. <li><a href="../../../../org/jfree/chart/util/LogFormat.html" title="class in org.jfree.chart.util"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
  326. <li><a href="../../../../org/jfree/chart/util/ParamChecks.html" title="class in org.jfree.chart.util"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
  327. </ul>
  328. <ul class="navList">
  329. <li><a href="../../../../index.html?org/jfree/chart/util/PaintAlpha.html" target="_top">Frames</a></li>
  330. <li><a href="PaintAlpha.html" target="_top">No&nbsp;Frames</a></li>
  331. </ul>
  332. <ul class="navList" id="allclasses_navbar_bottom">
  333. <li><a href="../../../../allclasses-noframe.html">All&nbsp;Classes</a></li>
  334. </ul>
  335. <div>
  336. <script type="text/javascript"><!--
  337. allClassesLink = document.getElementById("allclasses_navbar_bottom");
  338. if(window==top) {
  339. allClassesLink.style.display = "block";
  340. }
  341. else {
  342. allClassesLink.style.display = "none";
  343. }
  344. //-->
  345. </script>
  346. </div>
  347. <div>
  348. <ul class="subNavList">
  349. <li>Summary:&nbsp;</li>
  350. <li>Nested&nbsp;|&nbsp;</li>
  351. <li>Field&nbsp;|&nbsp;</li>
  352. <li><a href="#constructor.summary">Constr</a>&nbsp;|&nbsp;</li>
  353. <li><a href="#method.summary">Method</a></li>
  354. </ul>
  355. <ul class="subNavList">
  356. <li>Detail:&nbsp;</li>
  357. <li>Field&nbsp;|&nbsp;</li>
  358. <li><a href="#constructor.detail">Constr</a>&nbsp;|&nbsp;</li>
  359. <li><a href="#method.detail">Method</a></li>
  360. </ul>
  361. </div>
  362. <a name="skip.navbar.bottom">
  363. <!-- -->
  364. </a></div>
  365. <!-- ======== END OF BOTTOM NAVBAR ======= -->
  366. </body>
  367. </html>