AbstractOverlay.html 14 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353
  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:31 CEST 2014 -->
  6. <title>AbstractOverlay (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="AbstractOverlay (JFreeChart Class Library (version 1.0.19-fx))";
  16. }
  17. }
  18. catch(err) {
  19. }
  20. //-->
  21. var methods = {"i0":10,"i1":10,"i2":10,"i3":10};
  22. var tabs = {65535:["t0","All Methods"],2:["t2","Instance 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/AbstractOverlay.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>Prev&nbsp;Class</li>
  53. <li><a href="../../../../org/jfree/chart/panel/CrosshairOverlay.html" title="class in org.jfree.chart.panel"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
  54. </ul>
  55. <ul class="navList">
  56. <li><a href="../../../../index.html?org/jfree/chart/panel/AbstractOverlay.html" target="_top">Frames</a></li>
  57. <li><a href="AbstractOverlay.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.panel</div>
  96. <h2 title="Class AbstractOverlay" class="title">Class AbstractOverlay</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.panel.AbstractOverlay</li>
  104. </ul>
  105. </li>
  106. </ul>
  107. <div class="description">
  108. <ul class="blockList">
  109. <li class="blockList">
  110. <dl>
  111. <dt>Direct Known Subclasses:</dt>
  112. <dd><a href="../../../../org/jfree/chart/panel/CrosshairOverlay.html" title="class in org.jfree.chart.panel">CrosshairOverlay</a></dd>
  113. </dl>
  114. <hr>
  115. <br>
  116. <pre>public class <a href="../../../../src-html/org/jfree/chart/panel/AbstractOverlay.html#line.56">AbstractOverlay</a>
  117. extends java.lang.Object</pre>
  118. <div class="block">A base class for implementing overlays for a <a href="../../../../org/jfree/chart/ChartPanel.html" title="class in org.jfree.chart"><code>ChartPanel</code></a>.</div>
  119. <dl>
  120. <dt><span class="simpleTagLabel">Since:</span></dt>
  121. <dd>1.0.13</dd>
  122. </dl>
  123. </li>
  124. </ul>
  125. </div>
  126. <div class="summary">
  127. <ul class="blockList">
  128. <li class="blockList">
  129. <!-- ======== CONSTRUCTOR SUMMARY ======== -->
  130. <ul class="blockList">
  131. <li class="blockList"><a name="constructor.summary">
  132. <!-- -->
  133. </a>
  134. <h3>Constructor Summary</h3>
  135. <table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Constructor Summary table, listing constructors, and an explanation">
  136. <caption><span>Constructors</span><span class="tabEnd">&nbsp;</span></caption>
  137. <tr>
  138. <th class="colOne" scope="col">Constructor and Description</th>
  139. </tr>
  140. <tr class="altColor">
  141. <td class="colOne"><code><span class="memberNameLink"><a href="../../../../org/jfree/chart/panel/AbstractOverlay.html#AbstractOverlay--">AbstractOverlay</a></span>()</code>
  142. <div class="block">Default constructor.</div>
  143. </td>
  144. </tr>
  145. </table>
  146. </li>
  147. </ul>
  148. <!-- ========== METHOD SUMMARY =========== -->
  149. <ul class="blockList">
  150. <li class="blockList"><a name="method.summary">
  151. <!-- -->
  152. </a>
  153. <h3>Method Summary</h3>
  154. <table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation">
  155. <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="t4" class="tableTab"><span><a href="javascript:show(8);">Concrete Methods</a></span><span class="tabEnd">&nbsp;</span></span></caption>
  156. <tr>
  157. <th class="colFirst" scope="col">Modifier and Type</th>
  158. <th class="colLast" scope="col">Method and Description</th>
  159. </tr>
  160. <tr id="i0" class="altColor">
  161. <td class="colFirst"><code>void</code></td>
  162. <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/jfree/chart/panel/AbstractOverlay.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>
  163. <div class="block">Registers an object for notification of changes to the overlay.</div>
  164. </td>
  165. </tr>
  166. <tr id="i1" class="rowColor">
  167. <td class="colFirst"><code>void</code></td>
  168. <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/jfree/chart/panel/AbstractOverlay.html#fireOverlayChanged--">fireOverlayChanged</a></span>()</code>
  169. <div class="block">Sends a default <a href="../../../../org/jfree/chart/event/ChartChangeEvent.html" title="class in org.jfree.chart.event"><code>ChartChangeEvent</code></a> to all registered listeners.</div>
  170. </td>
  171. </tr>
  172. <tr id="i2" class="altColor">
  173. <td class="colFirst"><code>protected void</code></td>
  174. <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/jfree/chart/panel/AbstractOverlay.html#notifyListeners-org.jfree.chart.event.OverlayChangeEvent-">notifyListeners</a></span>(<a href="../../../../org/jfree/chart/event/OverlayChangeEvent.html" title="class in org.jfree.chart.event">OverlayChangeEvent</a>&nbsp;event)</code>
  175. <div class="block">Sends a <a href="../../../../org/jfree/chart/event/ChartChangeEvent.html" title="class in org.jfree.chart.event"><code>ChartChangeEvent</code></a> to all registered listeners.</div>
  176. </td>
  177. </tr>
  178. <tr id="i3" class="rowColor">
  179. <td class="colFirst"><code>void</code></td>
  180. <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/jfree/chart/panel/AbstractOverlay.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>
  181. <div class="block">Deregisters an object for notification of changes to the overlay.</div>
  182. </td>
  183. </tr>
  184. </table>
  185. <ul class="blockList">
  186. <li class="blockList"><a name="methods.inherited.from.class.java.lang.Object">
  187. <!-- -->
  188. </a>
  189. <h3>Methods inherited from class&nbsp;java.lang.Object</h3>
  190. <code>clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait</code></li>
  191. </ul>
  192. </li>
  193. </ul>
  194. </li>
  195. </ul>
  196. </div>
  197. <div class="details">
  198. <ul class="blockList">
  199. <li class="blockList">
  200. <!-- ========= CONSTRUCTOR DETAIL ======== -->
  201. <ul class="blockList">
  202. <li class="blockList"><a name="constructor.detail">
  203. <!-- -->
  204. </a>
  205. <h3>Constructor Detail</h3>
  206. <a name="AbstractOverlay--">
  207. <!-- -->
  208. </a>
  209. <ul class="blockListLast">
  210. <li class="blockList">
  211. <h4>AbstractOverlay</h4>
  212. <pre>public&nbsp;<a href="../../../../src-html/org/jfree/chart/panel/AbstractOverlay.html#line.64">AbstractOverlay</a>()</pre>
  213. <div class="block">Default constructor.</div>
  214. </li>
  215. </ul>
  216. </li>
  217. </ul>
  218. <!-- ============ METHOD DETAIL ========== -->
  219. <ul class="blockList">
  220. <li class="blockList"><a name="method.detail">
  221. <!-- -->
  222. </a>
  223. <h3>Method Detail</h3>
  224. <a name="addChangeListener-org.jfree.chart.event.OverlayChangeListener-">
  225. <!-- -->
  226. </a>
  227. <ul class="blockList">
  228. <li class="blockList">
  229. <h4>addChangeListener</h4>
  230. <pre>public&nbsp;void&nbsp;<a href="../../../../src-html/org/jfree/chart/panel/AbstractOverlay.html#line.75">addChangeListener</a>(<a href="../../../../org/jfree/chart/event/OverlayChangeListener.html" title="interface in org.jfree.chart.event">OverlayChangeListener</a>&nbsp;listener)</pre>
  231. <div class="block">Registers an object for notification of changes to the overlay.</div>
  232. <dl>
  233. <dt><span class="paramLabel">Parameters:</span></dt>
  234. <dd><code>listener</code> - the listener (<code>null</code> not permitted).</dd>
  235. <dt><span class="seeLabel">See Also:</span></dt>
  236. <dd><a href="../../../../org/jfree/chart/panel/AbstractOverlay.html#removeChangeListener-org.jfree.chart.event.OverlayChangeListener-"><code>removeChangeListener(OverlayChangeListener)</code></a></dd>
  237. </dl>
  238. </li>
  239. </ul>
  240. <a name="removeChangeListener-org.jfree.chart.event.OverlayChangeListener-">
  241. <!-- -->
  242. </a>
  243. <ul class="blockList">
  244. <li class="blockList">
  245. <h4>removeChangeListener</h4>
  246. <pre>public&nbsp;void&nbsp;<a href="../../../../src-html/org/jfree/chart/panel/AbstractOverlay.html#line.87">removeChangeListener</a>(<a href="../../../../org/jfree/chart/event/OverlayChangeListener.html" title="interface in org.jfree.chart.event">OverlayChangeListener</a>&nbsp;listener)</pre>
  247. <div class="block">Deregisters an object for notification of changes to the overlay.</div>
  248. <dl>
  249. <dt><span class="paramLabel">Parameters:</span></dt>
  250. <dd><code>listener</code> - the listener (<code>null</code> not permitted)</dd>
  251. <dt><span class="seeLabel">See Also:</span></dt>
  252. <dd><a href="../../../../org/jfree/chart/panel/AbstractOverlay.html#addChangeListener-org.jfree.chart.event.OverlayChangeListener-"><code>addChangeListener(OverlayChangeListener)</code></a></dd>
  253. </dl>
  254. </li>
  255. </ul>
  256. <a name="fireOverlayChanged--">
  257. <!-- -->
  258. </a>
  259. <ul class="blockList">
  260. <li class="blockList">
  261. <h4>fireOverlayChanged</h4>
  262. <pre>public&nbsp;void&nbsp;<a href="../../../../src-html/org/jfree/chart/panel/AbstractOverlay.html#line.97">fireOverlayChanged</a>()</pre>
  263. <div class="block">Sends a default <a href="../../../../org/jfree/chart/event/ChartChangeEvent.html" title="class in org.jfree.chart.event"><code>ChartChangeEvent</code></a> to all registered listeners.
  264. <P>
  265. This method is for convenience only.</div>
  266. </li>
  267. </ul>
  268. <a name="notifyListeners-org.jfree.chart.event.OverlayChangeEvent-">
  269. <!-- -->
  270. </a>
  271. <ul class="blockListLast">
  272. <li class="blockList">
  273. <h4>notifyListeners</h4>
  274. <pre>protected&nbsp;void&nbsp;<a href="../../../../src-html/org/jfree/chart/panel/AbstractOverlay.html#line.108">notifyListeners</a>(<a href="../../../../org/jfree/chart/event/OverlayChangeEvent.html" title="class in org.jfree.chart.event">OverlayChangeEvent</a>&nbsp;event)</pre>
  275. <div class="block">Sends a <a href="../../../../org/jfree/chart/event/ChartChangeEvent.html" title="class in org.jfree.chart.event"><code>ChartChangeEvent</code></a> to all registered listeners.</div>
  276. <dl>
  277. <dt><span class="paramLabel">Parameters:</span></dt>
  278. <dd><code>event</code> - information about the event that triggered the
  279. notification.</dd>
  280. </dl>
  281. </li>
  282. </ul>
  283. </li>
  284. </ul>
  285. </li>
  286. </ul>
  287. </div>
  288. </div>
  289. <!-- ========= END OF CLASS DATA ========= -->
  290. <!-- ======= START OF BOTTOM NAVBAR ====== -->
  291. <div class="bottomNav"><a name="navbar.bottom">
  292. <!-- -->
  293. </a>
  294. <div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div>
  295. <a name="navbar.bottom.firstrow">
  296. <!-- -->
  297. </a>
  298. <ul class="navList" title="Navigation">
  299. <li><a href="../../../../overview-summary.html">Overview</a></li>
  300. <li><a href="package-summary.html">Package</a></li>
  301. <li class="navBarCell1Rev">Class</li>
  302. <li><a href="class-use/AbstractOverlay.html">Use</a></li>
  303. <li><a href="package-tree.html">Tree</a></li>
  304. <li><a href="../../../../deprecated-list.html">Deprecated</a></li>
  305. <li><a href="../../../../index-files/index-1.html">Index</a></li>
  306. <li><a href="../../../../help-doc.html">Help</a></li>
  307. </ul>
  308. </div>
  309. <div class="subNav">
  310. <ul class="navList">
  311. <li>Prev&nbsp;Class</li>
  312. <li><a href="../../../../org/jfree/chart/panel/CrosshairOverlay.html" title="class in org.jfree.chart.panel"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
  313. </ul>
  314. <ul class="navList">
  315. <li><a href="../../../../index.html?org/jfree/chart/panel/AbstractOverlay.html" target="_top">Frames</a></li>
  316. <li><a href="AbstractOverlay.html" target="_top">No&nbsp;Frames</a></li>
  317. </ul>
  318. <ul class="navList" id="allclasses_navbar_bottom">
  319. <li><a href="../../../../allclasses-noframe.html">All&nbsp;Classes</a></li>
  320. </ul>
  321. <div>
  322. <script type="text/javascript"><!--
  323. allClassesLink = document.getElementById("allclasses_navbar_bottom");
  324. if(window==top) {
  325. allClassesLink.style.display = "block";
  326. }
  327. else {
  328. allClassesLink.style.display = "none";
  329. }
  330. //-->
  331. </script>
  332. </div>
  333. <div>
  334. <ul class="subNavList">
  335. <li>Summary:&nbsp;</li>
  336. <li>Nested&nbsp;|&nbsp;</li>
  337. <li>Field&nbsp;|&nbsp;</li>
  338. <li><a href="#constructor.summary">Constr</a>&nbsp;|&nbsp;</li>
  339. <li><a href="#method.summary">Method</a></li>
  340. </ul>
  341. <ul class="subNavList">
  342. <li>Detail:&nbsp;</li>
  343. <li>Field&nbsp;|&nbsp;</li>
  344. <li><a href="#constructor.detail">Constr</a>&nbsp;|&nbsp;</li>
  345. <li><a href="#method.detail">Method</a></li>
  346. </ul>
  347. </div>
  348. <a name="skip.navbar.bottom">
  349. <!-- -->
  350. </a></div>
  351. <!-- ======== END OF BOTTOM NAVBAR ======= -->
  352. </body>
  353. </html>