Overlay.html 11 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281
  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:32 CEST 2014 -->
  6. <title>Overlay (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="Overlay (JFreeChart Class Library (version 1.0.19-fx))";
  16. }
  17. }
  18. catch(err) {
  19. }
  20. //-->
  21. var methods = {"i0":6,"i1":6,"i2":6};
  22. var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],4:["t3","Abstract 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/Overlay.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/panel/CrosshairOverlay.html" title="class in org.jfree.chart.panel"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
  53. <li>Next&nbsp;Class</li>
  54. </ul>
  55. <ul class="navList">
  56. <li><a href="../../../../index.html?org/jfree/chart/panel/Overlay.html" target="_top">Frames</a></li>
  57. <li><a href="Overlay.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>Constr&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>Constr&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.panel</div>
  96. <h2 title="Interface Overlay" class="title">Interface Overlay</h2>
  97. </div>
  98. <div class="contentContainer">
  99. <div class="description">
  100. <ul class="blockList">
  101. <li class="blockList">
  102. <dl>
  103. <dt>All Known Implementing Classes:</dt>
  104. <dd><a href="../../../../org/jfree/chart/panel/CrosshairOverlay.html" title="class in org.jfree.chart.panel">CrosshairOverlay</a></dd>
  105. </dl>
  106. <hr>
  107. <br>
  108. <pre>public interface <a href="../../../../src-html/org/jfree/chart/panel/Overlay.html#line.52">Overlay</a></pre>
  109. <div class="block">Defines the interface for an overlay that can be added to a
  110. <a href="../../../../org/jfree/chart/ChartPanel.html" title="class in org.jfree.chart"><code>ChartPanel</code></a>.</div>
  111. <dl>
  112. <dt><span class="simpleTagLabel">Since:</span></dt>
  113. <dd>1.0.13</dd>
  114. </dl>
  115. </li>
  116. </ul>
  117. </div>
  118. <div class="summary">
  119. <ul class="blockList">
  120. <li class="blockList">
  121. <!-- ========== METHOD SUMMARY =========== -->
  122. <ul class="blockList">
  123. <li class="blockList"><a name="method.summary">
  124. <!-- -->
  125. </a>
  126. <h3>Method Summary</h3>
  127. <table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation">
  128. <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>
  129. <tr>
  130. <th class="colFirst" scope="col">Modifier and Type</th>
  131. <th class="colLast" scope="col">Method and Description</th>
  132. </tr>
  133. <tr id="i0" class="altColor">
  134. <td class="colFirst"><code>void</code></td>
  135. <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/jfree/chart/panel/Overlay.html#addChangeListener-org.jfree.chart.event.OverlayChangeListener-">addChangeListener</a></span>(<a href="../../../../org/jfree/chart/event/OverlayChangeListener.html" title="interface in org.jfree.chart.event">OverlayChangeListener</a>&nbsp;listener)</code>
  136. <div class="block">Registers a change listener with the overlay.</div>
  137. </td>
  138. </tr>
  139. <tr id="i1" class="rowColor">
  140. <td class="colFirst"><code>void</code></td>
  141. <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/jfree/chart/panel/Overlay.html#paintOverlay-java.awt.Graphics2D-org.jfree.chart.ChartPanel-">paintOverlay</a></span>(java.awt.Graphics2D&nbsp;g2,
  142. <a href="../../../../org/jfree/chart/ChartPanel.html" title="class in org.jfree.chart">ChartPanel</a>&nbsp;chartPanel)</code>
  143. <div class="block">Paints the crosshairs in the layer.</div>
  144. </td>
  145. </tr>
  146. <tr id="i2" class="altColor">
  147. <td class="colFirst"><code>void</code></td>
  148. <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/jfree/chart/panel/Overlay.html#removeChangeListener-org.jfree.chart.event.OverlayChangeListener-">removeChangeListener</a></span>(<a href="../../../../org/jfree/chart/event/OverlayChangeListener.html" title="interface in org.jfree.chart.event">OverlayChangeListener</a>&nbsp;listener)</code>
  149. <div class="block">Deregisters a listener from the overlay.</div>
  150. </td>
  151. </tr>
  152. </table>
  153. </li>
  154. </ul>
  155. </li>
  156. </ul>
  157. </div>
  158. <div class="details">
  159. <ul class="blockList">
  160. <li class="blockList">
  161. <!-- ============ METHOD DETAIL ========== -->
  162. <ul class="blockList">
  163. <li class="blockList"><a name="method.detail">
  164. <!-- -->
  165. </a>
  166. <h3>Method Detail</h3>
  167. <a name="paintOverlay-java.awt.Graphics2D-org.jfree.chart.ChartPanel-">
  168. <!-- -->
  169. </a>
  170. <ul class="blockList">
  171. <li class="blockList">
  172. <h4>paintOverlay</h4>
  173. <pre>void&nbsp;<a href="../../../../src-html/org/jfree/chart/panel/Overlay.html#line.60">paintOverlay</a>(java.awt.Graphics2D&nbsp;g2,
  174. <a href="../../../../org/jfree/chart/ChartPanel.html" title="class in org.jfree.chart">ChartPanel</a>&nbsp;chartPanel)</pre>
  175. <div class="block">Paints the crosshairs in the layer.</div>
  176. <dl>
  177. <dt><span class="paramLabel">Parameters:</span></dt>
  178. <dd><code>g2</code> - the graphics target.</dd>
  179. <dd><code>chartPanel</code> - the chart panel.</dd>
  180. </dl>
  181. </li>
  182. </ul>
  183. <a name="addChangeListener-org.jfree.chart.event.OverlayChangeListener-">
  184. <!-- -->
  185. </a>
  186. <ul class="blockList">
  187. <li class="blockList">
  188. <h4>addChangeListener</h4>
  189. <pre>void&nbsp;<a href="../../../../src-html/org/jfree/chart/panel/Overlay.html#line.67">addChangeListener</a>(<a href="../../../../org/jfree/chart/event/OverlayChangeListener.html" title="interface in org.jfree.chart.event">OverlayChangeListener</a>&nbsp;listener)</pre>
  190. <div class="block">Registers a change listener with the overlay.</div>
  191. <dl>
  192. <dt><span class="paramLabel">Parameters:</span></dt>
  193. <dd><code>listener</code> - the listener.</dd>
  194. </dl>
  195. </li>
  196. </ul>
  197. <a name="removeChangeListener-org.jfree.chart.event.OverlayChangeListener-">
  198. <!-- -->
  199. </a>
  200. <ul class="blockListLast">
  201. <li class="blockList">
  202. <h4>removeChangeListener</h4>
  203. <pre>void&nbsp;<a href="../../../../src-html/org/jfree/chart/panel/Overlay.html#line.74">removeChangeListener</a>(<a href="../../../../org/jfree/chart/event/OverlayChangeListener.html" title="interface in org.jfree.chart.event">OverlayChangeListener</a>&nbsp;listener)</pre>
  204. <div class="block">Deregisters a listener from the overlay.</div>
  205. <dl>
  206. <dt><span class="paramLabel">Parameters:</span></dt>
  207. <dd><code>listener</code> - the listener.</dd>
  208. </dl>
  209. </li>
  210. </ul>
  211. </li>
  212. </ul>
  213. </li>
  214. </ul>
  215. </div>
  216. </div>
  217. <!-- ========= END OF CLASS DATA ========= -->
  218. <!-- ======= START OF BOTTOM NAVBAR ====== -->
  219. <div class="bottomNav"><a name="navbar.bottom">
  220. <!-- -->
  221. </a>
  222. <div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div>
  223. <a name="navbar.bottom.firstrow">
  224. <!-- -->
  225. </a>
  226. <ul class="navList" title="Navigation">
  227. <li><a href="../../../../overview-summary.html">Overview</a></li>
  228. <li><a href="package-summary.html">Package</a></li>
  229. <li class="navBarCell1Rev">Class</li>
  230. <li><a href="class-use/Overlay.html">Use</a></li>
  231. <li><a href="package-tree.html">Tree</a></li>
  232. <li><a href="../../../../deprecated-list.html">Deprecated</a></li>
  233. <li><a href="../../../../index-files/index-1.html">Index</a></li>
  234. <li><a href="../../../../help-doc.html">Help</a></li>
  235. </ul>
  236. </div>
  237. <div class="subNav">
  238. <ul class="navList">
  239. <li><a href="../../../../org/jfree/chart/panel/CrosshairOverlay.html" title="class in org.jfree.chart.panel"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
  240. <li>Next&nbsp;Class</li>
  241. </ul>
  242. <ul class="navList">
  243. <li><a href="../../../../index.html?org/jfree/chart/panel/Overlay.html" target="_top">Frames</a></li>
  244. <li><a href="Overlay.html" target="_top">No&nbsp;Frames</a></li>
  245. </ul>
  246. <ul class="navList" id="allclasses_navbar_bottom">
  247. <li><a href="../../../../allclasses-noframe.html">All&nbsp;Classes</a></li>
  248. </ul>
  249. <div>
  250. <script type="text/javascript"><!--
  251. allClassesLink = document.getElementById("allclasses_navbar_bottom");
  252. if(window==top) {
  253. allClassesLink.style.display = "block";
  254. }
  255. else {
  256. allClassesLink.style.display = "none";
  257. }
  258. //-->
  259. </script>
  260. </div>
  261. <div>
  262. <ul class="subNavList">
  263. <li>Summary:&nbsp;</li>
  264. <li>Nested&nbsp;|&nbsp;</li>
  265. <li>Field&nbsp;|&nbsp;</li>
  266. <li>Constr&nbsp;|&nbsp;</li>
  267. <li><a href="#method.summary">Method</a></li>
  268. </ul>
  269. <ul class="subNavList">
  270. <li>Detail:&nbsp;</li>
  271. <li>Field&nbsp;|&nbsp;</li>
  272. <li>Constr&nbsp;|&nbsp;</li>
  273. <li><a href="#method.detail">Method</a></li>
  274. </ul>
  275. </div>
  276. <a name="skip.navbar.bottom">
  277. <!-- -->
  278. </a></div>
  279. <!-- ======== END OF BOTTOM NAVBAR ======= -->
  280. </body>
  281. </html>