CrosshairOverlay.html 31 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622
  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>CrosshairOverlay (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="CrosshairOverlay (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,"i4":10,"i5":10,"i6":10,"i7":10,"i8":10,"i9":10,"i10":10,"i11":10,"i12":10,"i13":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/CrosshairOverlay.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/AbstractOverlay.html" title="class in org.jfree.chart.panel"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
  53. <li><a href="../../../../org/jfree/chart/panel/Overlay.html" title="interface 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/CrosshairOverlay.html" target="_top">Frames</a></li>
  57. <li><a href="CrosshairOverlay.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 CrosshairOverlay" class="title">Class CrosshairOverlay</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><a href="../../../../org/jfree/chart/panel/AbstractOverlay.html" title="class in org.jfree.chart.panel">org.jfree.chart.panel.AbstractOverlay</a></li>
  104. <li>
  105. <ul class="inheritance">
  106. <li>org.jfree.chart.panel.CrosshairOverlay</li>
  107. </ul>
  108. </li>
  109. </ul>
  110. </li>
  111. </ul>
  112. <div class="description">
  113. <ul class="blockList">
  114. <li class="blockList">
  115. <dl>
  116. <dt>All Implemented Interfaces:</dt>
  117. <dd>java.beans.PropertyChangeListener, java.io.Serializable, java.lang.Cloneable, java.util.EventListener, <a href="../../../../org/jfree/chart/panel/Overlay.html" title="interface in org.jfree.chart.panel">Overlay</a>, org.jfree.util.PublicCloneable</dd>
  118. </dl>
  119. <hr>
  120. <br>
  121. <pre>public class <a href="../../../../src-html/org/jfree/chart/panel/CrosshairOverlay.html#line.79">CrosshairOverlay</a>
  122. extends <a href="../../../../org/jfree/chart/panel/AbstractOverlay.html" title="class in org.jfree.chart.panel">AbstractOverlay</a>
  123. implements <a href="../../../../org/jfree/chart/panel/Overlay.html" title="interface in org.jfree.chart.panel">Overlay</a>, java.beans.PropertyChangeListener, org.jfree.util.PublicCloneable, java.lang.Cloneable, java.io.Serializable</pre>
  124. <div class="block">An overlay for a <a href="../../../../org/jfree/chart/ChartPanel.html" title="class in org.jfree.chart"><code>ChartPanel</code></a> that draws crosshairs on a plot.</div>
  125. <dl>
  126. <dt><span class="simpleTagLabel">Since:</span></dt>
  127. <dd>1.0.13</dd>
  128. <dt><span class="seeLabel">See Also:</span></dt>
  129. <dd><a href="../../../../serialized-form.html#org.jfree.chart.panel.CrosshairOverlay">Serialized Form</a></dd>
  130. </dl>
  131. </li>
  132. </ul>
  133. </div>
  134. <div class="summary">
  135. <ul class="blockList">
  136. <li class="blockList">
  137. <!-- ======== CONSTRUCTOR SUMMARY ======== -->
  138. <ul class="blockList">
  139. <li class="blockList"><a name="constructor.summary">
  140. <!-- -->
  141. </a>
  142. <h3>Constructor Summary</h3>
  143. <table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Constructor Summary table, listing constructors, and an explanation">
  144. <caption><span>Constructors</span><span class="tabEnd">&nbsp;</span></caption>
  145. <tr>
  146. <th class="colOne" scope="col">Constructor and Description</th>
  147. </tr>
  148. <tr class="altColor">
  149. <td class="colOne"><code><span class="memberNameLink"><a href="../../../../org/jfree/chart/panel/CrosshairOverlay.html#CrosshairOverlay--">CrosshairOverlay</a></span>()</code>
  150. <div class="block">Default constructor.</div>
  151. </td>
  152. </tr>
  153. </table>
  154. </li>
  155. </ul>
  156. <!-- ========== METHOD SUMMARY =========== -->
  157. <ul class="blockList">
  158. <li class="blockList"><a name="method.summary">
  159. <!-- -->
  160. </a>
  161. <h3>Method Summary</h3>
  162. <table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation">
  163. <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>
  164. <tr>
  165. <th class="colFirst" scope="col">Modifier and Type</th>
  166. <th class="colLast" scope="col">Method and Description</th>
  167. </tr>
  168. <tr id="i0" class="altColor">
  169. <td class="colFirst"><code>void</code></td>
  170. <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/jfree/chart/panel/CrosshairOverlay.html#addDomainCrosshair-org.jfree.chart.plot.Crosshair-">addDomainCrosshair</a></span>(<a href="../../../../org/jfree/chart/plot/Crosshair.html" title="class in org.jfree.chart.plot">Crosshair</a>&nbsp;crosshair)</code>
  171. <div class="block">Adds a crosshair against the domain axis and sends an
  172. <a href="../../../../org/jfree/chart/event/OverlayChangeEvent.html" title="class in org.jfree.chart.event"><code>OverlayChangeEvent</code></a> to all registered listeners.</div>
  173. </td>
  174. </tr>
  175. <tr id="i1" class="rowColor">
  176. <td class="colFirst"><code>void</code></td>
  177. <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/jfree/chart/panel/CrosshairOverlay.html#addRangeCrosshair-org.jfree.chart.plot.Crosshair-">addRangeCrosshair</a></span>(<a href="../../../../org/jfree/chart/plot/Crosshair.html" title="class in org.jfree.chart.plot">Crosshair</a>&nbsp;crosshair)</code>
  178. <div class="block">Adds a crosshair against the range axis and sends an
  179. <a href="../../../../org/jfree/chart/event/OverlayChangeEvent.html" title="class in org.jfree.chart.event"><code>OverlayChangeEvent</code></a> to all registered listeners.</div>
  180. </td>
  181. </tr>
  182. <tr id="i2" class="altColor">
  183. <td class="colFirst"><code>void</code></td>
  184. <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/jfree/chart/panel/CrosshairOverlay.html#clearDomainCrosshairs--">clearDomainCrosshairs</a></span>()</code>
  185. <div class="block">Clears all the domain crosshairs from the overlay and sends an
  186. <a href="../../../../org/jfree/chart/event/OverlayChangeEvent.html" title="class in org.jfree.chart.event"><code>OverlayChangeEvent</code></a> to all registered listeners.</div>
  187. </td>
  188. </tr>
  189. <tr id="i3" class="rowColor">
  190. <td class="colFirst"><code>void</code></td>
  191. <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/jfree/chart/panel/CrosshairOverlay.html#clearRangeCrosshairs--">clearRangeCrosshairs</a></span>()</code>
  192. <div class="block">Clears all the range crosshairs from the overlay and sends an
  193. <a href="../../../../org/jfree/chart/event/OverlayChangeEvent.html" title="class in org.jfree.chart.event"><code>OverlayChangeEvent</code></a> to all registered listeners.</div>
  194. </td>
  195. </tr>
  196. <tr id="i4" class="altColor">
  197. <td class="colFirst"><code>java.lang.Object</code></td>
  198. <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/jfree/chart/panel/CrosshairOverlay.html#clone--">clone</a></span>()</code>
  199. <div class="block">Returns a clone of this instance.</div>
  200. </td>
  201. </tr>
  202. <tr id="i5" class="rowColor">
  203. <td class="colFirst"><code>protected void</code></td>
  204. <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/jfree/chart/panel/CrosshairOverlay.html#drawHorizontalCrosshair-java.awt.Graphics2D-java.awt.geom.Rectangle2D-double-org.jfree.chart.plot.Crosshair-">drawHorizontalCrosshair</a></span>(java.awt.Graphics2D&nbsp;g2,
  205. java.awt.geom.Rectangle2D&nbsp;dataArea,
  206. double&nbsp;y,
  207. <a href="../../../../org/jfree/chart/plot/Crosshair.html" title="class in org.jfree.chart.plot">Crosshair</a>&nbsp;crosshair)</code>
  208. <div class="block">Draws a crosshair horizontally across the plot.</div>
  209. </td>
  210. </tr>
  211. <tr id="i6" class="altColor">
  212. <td class="colFirst"><code>protected void</code></td>
  213. <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/jfree/chart/panel/CrosshairOverlay.html#drawVerticalCrosshair-java.awt.Graphics2D-java.awt.geom.Rectangle2D-double-org.jfree.chart.plot.Crosshair-">drawVerticalCrosshair</a></span>(java.awt.Graphics2D&nbsp;g2,
  214. java.awt.geom.Rectangle2D&nbsp;dataArea,
  215. double&nbsp;x,
  216. <a href="../../../../org/jfree/chart/plot/Crosshair.html" title="class in org.jfree.chart.plot">Crosshair</a>&nbsp;crosshair)</code>
  217. <div class="block">Draws a crosshair vertically on the plot.</div>
  218. </td>
  219. </tr>
  220. <tr id="i7" class="rowColor">
  221. <td class="colFirst"><code>boolean</code></td>
  222. <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/jfree/chart/panel/CrosshairOverlay.html#equals-java.lang.Object-">equals</a></span>(java.lang.Object&nbsp;obj)</code>
  223. <div class="block">Tests this overlay for equality with an arbitrary object.</div>
  224. </td>
  225. </tr>
  226. <tr id="i8" class="altColor">
  227. <td class="colFirst"><code>java.util.List</code></td>
  228. <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/jfree/chart/panel/CrosshairOverlay.html#getDomainCrosshairs--">getDomainCrosshairs</a></span>()</code>
  229. <div class="block">Returns a new list containing the domain crosshairs for this overlay.</div>
  230. </td>
  231. </tr>
  232. <tr id="i9" class="rowColor">
  233. <td class="colFirst"><code>java.util.List</code></td>
  234. <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/jfree/chart/panel/CrosshairOverlay.html#getRangeCrosshairs--">getRangeCrosshairs</a></span>()</code>
  235. <div class="block">Returns a new list containing the range crosshairs for this overlay.</div>
  236. </td>
  237. </tr>
  238. <tr id="i10" class="altColor">
  239. <td class="colFirst"><code>void</code></td>
  240. <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/jfree/chart/panel/CrosshairOverlay.html#paintOverlay-java.awt.Graphics2D-org.jfree.chart.ChartPanel-">paintOverlay</a></span>(java.awt.Graphics2D&nbsp;g2,
  241. <a href="../../../../org/jfree/chart/ChartPanel.html" title="class in org.jfree.chart">ChartPanel</a>&nbsp;chartPanel)</code>
  242. <div class="block">Paints the crosshairs in the layer.</div>
  243. </td>
  244. </tr>
  245. <tr id="i11" class="rowColor">
  246. <td class="colFirst"><code>void</code></td>
  247. <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/jfree/chart/panel/CrosshairOverlay.html#propertyChange-java.beans.PropertyChangeEvent-">propertyChange</a></span>(java.beans.PropertyChangeEvent&nbsp;e)</code>
  248. <div class="block">Receives a property change event (typically a change in one of the
  249. crosshairs).</div>
  250. </td>
  251. </tr>
  252. <tr id="i12" class="altColor">
  253. <td class="colFirst"><code>void</code></td>
  254. <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/jfree/chart/panel/CrosshairOverlay.html#removeDomainCrosshair-org.jfree.chart.plot.Crosshair-">removeDomainCrosshair</a></span>(<a href="../../../../org/jfree/chart/plot/Crosshair.html" title="class in org.jfree.chart.plot">Crosshair</a>&nbsp;crosshair)</code>
  255. <div class="block">Removes a domain axis crosshair and sends an <a href="../../../../org/jfree/chart/event/OverlayChangeEvent.html" title="class in org.jfree.chart.event"><code>OverlayChangeEvent</code></a>
  256. to all registered listeners.</div>
  257. </td>
  258. </tr>
  259. <tr id="i13" class="rowColor">
  260. <td class="colFirst"><code>void</code></td>
  261. <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/jfree/chart/panel/CrosshairOverlay.html#removeRangeCrosshair-org.jfree.chart.plot.Crosshair-">removeRangeCrosshair</a></span>(<a href="../../../../org/jfree/chart/plot/Crosshair.html" title="class in org.jfree.chart.plot">Crosshair</a>&nbsp;crosshair)</code>
  262. <div class="block">Removes a range axis crosshair and sends an <a href="../../../../org/jfree/chart/event/OverlayChangeEvent.html" title="class in org.jfree.chart.event"><code>OverlayChangeEvent</code></a>
  263. to all registered listeners.</div>
  264. </td>
  265. </tr>
  266. </table>
  267. <ul class="blockList">
  268. <li class="blockList"><a name="methods.inherited.from.class.org.jfree.chart.panel.AbstractOverlay">
  269. <!-- -->
  270. </a>
  271. <h3>Methods inherited from class&nbsp;org.jfree.chart.panel.<a href="../../../../org/jfree/chart/panel/AbstractOverlay.html" title="class in org.jfree.chart.panel">AbstractOverlay</a></h3>
  272. <code><a href="../../../../org/jfree/chart/panel/AbstractOverlay.html#addChangeListener-org.jfree.chart.event.OverlayChangeListener-">addChangeListener</a>, <a href="../../../../org/jfree/chart/panel/AbstractOverlay.html#fireOverlayChanged--">fireOverlayChanged</a>, <a href="../../../../org/jfree/chart/panel/AbstractOverlay.html#notifyListeners-org.jfree.chart.event.OverlayChangeEvent-">notifyListeners</a>, <a href="../../../../org/jfree/chart/panel/AbstractOverlay.html#removeChangeListener-org.jfree.chart.event.OverlayChangeListener-">removeChangeListener</a></code></li>
  273. </ul>
  274. <ul class="blockList">
  275. <li class="blockList"><a name="methods.inherited.from.class.java.lang.Object">
  276. <!-- -->
  277. </a>
  278. <h3>Methods inherited from class&nbsp;java.lang.Object</h3>
  279. <code>finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait</code></li>
  280. </ul>
  281. <ul class="blockList">
  282. <li class="blockList"><a name="methods.inherited.from.class.org.jfree.chart.panel.Overlay">
  283. <!-- -->
  284. </a>
  285. <h3>Methods inherited from interface&nbsp;org.jfree.chart.panel.<a href="../../../../org/jfree/chart/panel/Overlay.html" title="interface in org.jfree.chart.panel">Overlay</a></h3>
  286. <code><a href="../../../../org/jfree/chart/panel/Overlay.html#addChangeListener-org.jfree.chart.event.OverlayChangeListener-">addChangeListener</a>, <a href="../../../../org/jfree/chart/panel/Overlay.html#removeChangeListener-org.jfree.chart.event.OverlayChangeListener-">removeChangeListener</a></code></li>
  287. </ul>
  288. </li>
  289. </ul>
  290. </li>
  291. </ul>
  292. </div>
  293. <div class="details">
  294. <ul class="blockList">
  295. <li class="blockList">
  296. <!-- ========= CONSTRUCTOR DETAIL ======== -->
  297. <ul class="blockList">
  298. <li class="blockList"><a name="constructor.detail">
  299. <!-- -->
  300. </a>
  301. <h3>Constructor Detail</h3>
  302. <a name="CrosshairOverlay--">
  303. <!-- -->
  304. </a>
  305. <ul class="blockListLast">
  306. <li class="blockList">
  307. <h4>CrosshairOverlay</h4>
  308. <pre>public&nbsp;<a href="../../../../src-html/org/jfree/chart/panel/CrosshairOverlay.html#line.91">CrosshairOverlay</a>()</pre>
  309. <div class="block">Default constructor.</div>
  310. </li>
  311. </ul>
  312. </li>
  313. </ul>
  314. <!-- ============ METHOD DETAIL ========== -->
  315. <ul class="blockList">
  316. <li class="blockList"><a name="method.detail">
  317. <!-- -->
  318. </a>
  319. <h3>Method Detail</h3>
  320. <a name="addDomainCrosshair-org.jfree.chart.plot.Crosshair-">
  321. <!-- -->
  322. </a>
  323. <ul class="blockList">
  324. <li class="blockList">
  325. <h4>addDomainCrosshair</h4>
  326. <pre>public&nbsp;void&nbsp;<a href="../../../../src-html/org/jfree/chart/panel/CrosshairOverlay.html#line.106">addDomainCrosshair</a>(<a href="../../../../org/jfree/chart/plot/Crosshair.html" title="class in org.jfree.chart.plot">Crosshair</a>&nbsp;crosshair)</pre>
  327. <div class="block">Adds a crosshair against the domain axis and sends an
  328. <a href="../../../../org/jfree/chart/event/OverlayChangeEvent.html" title="class in org.jfree.chart.event"><code>OverlayChangeEvent</code></a> to all registered listeners.</div>
  329. <dl>
  330. <dt><span class="paramLabel">Parameters:</span></dt>
  331. <dd><code>crosshair</code> - the crosshair (<code>null</code> not permitted).</dd>
  332. <dt><span class="seeLabel">See Also:</span></dt>
  333. <dd><a href="../../../../org/jfree/chart/panel/CrosshairOverlay.html#removeDomainCrosshair-org.jfree.chart.plot.Crosshair-"><code>removeDomainCrosshair(org.jfree.chart.plot.Crosshair)</code></a>,
  334. <a href="../../../../org/jfree/chart/panel/CrosshairOverlay.html#addRangeCrosshair-org.jfree.chart.plot.Crosshair-"><code>addRangeCrosshair(org.jfree.chart.plot.Crosshair)</code></a></dd>
  335. </dl>
  336. </li>
  337. </ul>
  338. <a name="removeDomainCrosshair-org.jfree.chart.plot.Crosshair-">
  339. <!-- -->
  340. </a>
  341. <ul class="blockList">
  342. <li class="blockList">
  343. <h4>removeDomainCrosshair</h4>
  344. <pre>public&nbsp;void&nbsp;<a href="../../../../src-html/org/jfree/chart/panel/CrosshairOverlay.html#line.121">removeDomainCrosshair</a>(<a href="../../../../org/jfree/chart/plot/Crosshair.html" title="class in org.jfree.chart.plot">Crosshair</a>&nbsp;crosshair)</pre>
  345. <div class="block">Removes a domain axis crosshair and sends an <a href="../../../../org/jfree/chart/event/OverlayChangeEvent.html" title="class in org.jfree.chart.event"><code>OverlayChangeEvent</code></a>
  346. to all registered listeners.</div>
  347. <dl>
  348. <dt><span class="paramLabel">Parameters:</span></dt>
  349. <dd><code>crosshair</code> - the crosshair (<code>null</code> not permitted).</dd>
  350. <dt><span class="seeLabel">See Also:</span></dt>
  351. <dd><a href="../../../../org/jfree/chart/panel/CrosshairOverlay.html#addDomainCrosshair-org.jfree.chart.plot.Crosshair-"><code>addDomainCrosshair(org.jfree.chart.plot.Crosshair)</code></a></dd>
  352. </dl>
  353. </li>
  354. </ul>
  355. <a name="clearDomainCrosshairs--">
  356. <!-- -->
  357. </a>
  358. <ul class="blockList">
  359. <li class="blockList">
  360. <h4>clearDomainCrosshairs</h4>
  361. <pre>public&nbsp;void&nbsp;<a href="../../../../src-html/org/jfree/chart/panel/CrosshairOverlay.html#line.133">clearDomainCrosshairs</a>()</pre>
  362. <div class="block">Clears all the domain crosshairs from the overlay and sends an
  363. <a href="../../../../org/jfree/chart/event/OverlayChangeEvent.html" title="class in org.jfree.chart.event"><code>OverlayChangeEvent</code></a> to all registered listeners.</div>
  364. </li>
  365. </ul>
  366. <a name="getDomainCrosshairs--">
  367. <!-- -->
  368. </a>
  369. <ul class="blockList">
  370. <li class="blockList">
  371. <h4>getDomainCrosshairs</h4>
  372. <pre>public&nbsp;java.util.List&nbsp;<a href="../../../../src-html/org/jfree/chart/panel/CrosshairOverlay.html#line.151">getDomainCrosshairs</a>()</pre>
  373. <div class="block">Returns a new list containing the domain crosshairs for this overlay.</div>
  374. <dl>
  375. <dt><span class="returnLabel">Returns:</span></dt>
  376. <dd>A list of crosshairs.</dd>
  377. </dl>
  378. </li>
  379. </ul>
  380. <a name="addRangeCrosshair-org.jfree.chart.plot.Crosshair-">
  381. <!-- -->
  382. </a>
  383. <ul class="blockList">
  384. <li class="blockList">
  385. <h4>addRangeCrosshair</h4>
  386. <pre>public&nbsp;void&nbsp;<a href="../../../../src-html/org/jfree/chart/panel/CrosshairOverlay.html#line.161">addRangeCrosshair</a>(<a href="../../../../org/jfree/chart/plot/Crosshair.html" title="class in org.jfree.chart.plot">Crosshair</a>&nbsp;crosshair)</pre>
  387. <div class="block">Adds a crosshair against the range axis and sends an
  388. <a href="../../../../org/jfree/chart/event/OverlayChangeEvent.html" title="class in org.jfree.chart.event"><code>OverlayChangeEvent</code></a> to all registered listeners.</div>
  389. <dl>
  390. <dt><span class="paramLabel">Parameters:</span></dt>
  391. <dd><code>crosshair</code> - the crosshair (<code>null</code> not permitted).</dd>
  392. </dl>
  393. </li>
  394. </ul>
  395. <a name="removeRangeCrosshair-org.jfree.chart.plot.Crosshair-">
  396. <!-- -->
  397. </a>
  398. <ul class="blockList">
  399. <li class="blockList">
  400. <h4>removeRangeCrosshair</h4>
  401. <pre>public&nbsp;void&nbsp;<a href="../../../../src-html/org/jfree/chart/panel/CrosshairOverlay.html#line.176">removeRangeCrosshair</a>(<a href="../../../../org/jfree/chart/plot/Crosshair.html" title="class in org.jfree.chart.plot">Crosshair</a>&nbsp;crosshair)</pre>
  402. <div class="block">Removes a range axis crosshair and sends an <a href="../../../../org/jfree/chart/event/OverlayChangeEvent.html" title="class in org.jfree.chart.event"><code>OverlayChangeEvent</code></a>
  403. to all registered listeners.</div>
  404. <dl>
  405. <dt><span class="paramLabel">Parameters:</span></dt>
  406. <dd><code>crosshair</code> - the crosshair (<code>null</code> not permitted).</dd>
  407. <dt><span class="seeLabel">See Also:</span></dt>
  408. <dd><a href="../../../../org/jfree/chart/panel/CrosshairOverlay.html#addRangeCrosshair-org.jfree.chart.plot.Crosshair-"><code>addRangeCrosshair(org.jfree.chart.plot.Crosshair)</code></a></dd>
  409. </dl>
  410. </li>
  411. </ul>
  412. <a name="clearRangeCrosshairs--">
  413. <!-- -->
  414. </a>
  415. <ul class="blockList">
  416. <li class="blockList">
  417. <h4>clearRangeCrosshairs</h4>
  418. <pre>public&nbsp;void&nbsp;<a href="../../../../src-html/org/jfree/chart/panel/CrosshairOverlay.html#line.188">clearRangeCrosshairs</a>()</pre>
  419. <div class="block">Clears all the range crosshairs from the overlay and sends an
  420. <a href="../../../../org/jfree/chart/event/OverlayChangeEvent.html" title="class in org.jfree.chart.event"><code>OverlayChangeEvent</code></a> to all registered listeners.</div>
  421. </li>
  422. </ul>
  423. <a name="getRangeCrosshairs--">
  424. <!-- -->
  425. </a>
  426. <ul class="blockList">
  427. <li class="blockList">
  428. <h4>getRangeCrosshairs</h4>
  429. <pre>public&nbsp;java.util.List&nbsp;<a href="../../../../src-html/org/jfree/chart/panel/CrosshairOverlay.html#line.206">getRangeCrosshairs</a>()</pre>
  430. <div class="block">Returns a new list containing the range crosshairs for this overlay.</div>
  431. <dl>
  432. <dt><span class="returnLabel">Returns:</span></dt>
  433. <dd>A list of crosshairs.</dd>
  434. </dl>
  435. </li>
  436. </ul>
  437. <a name="propertyChange-java.beans.PropertyChangeEvent-">
  438. <!-- -->
  439. </a>
  440. <ul class="blockList">
  441. <li class="blockList">
  442. <h4>propertyChange</h4>
  443. <pre>public&nbsp;void&nbsp;<a href="../../../../src-html/org/jfree/chart/panel/CrosshairOverlay.html#line.217">propertyChange</a>(java.beans.PropertyChangeEvent&nbsp;e)</pre>
  444. <div class="block">Receives a property change event (typically a change in one of the
  445. crosshairs).</div>
  446. <dl>
  447. <dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
  448. <dd><code>propertyChange</code>&nbsp;in interface&nbsp;<code>java.beans.PropertyChangeListener</code></dd>
  449. <dt><span class="paramLabel">Parameters:</span></dt>
  450. <dd><code>e</code> - the event.</dd>
  451. </dl>
  452. </li>
  453. </ul>
  454. <a name="paintOverlay-java.awt.Graphics2D-org.jfree.chart.ChartPanel-">
  455. <!-- -->
  456. </a>
  457. <ul class="blockList">
  458. <li class="blockList">
  459. <h4>paintOverlay</h4>
  460. <pre>public&nbsp;void&nbsp;<a href="../../../../src-html/org/jfree/chart/panel/CrosshairOverlay.html#line.228">paintOverlay</a>(java.awt.Graphics2D&nbsp;g2,
  461. <a href="../../../../org/jfree/chart/ChartPanel.html" title="class in org.jfree.chart">ChartPanel</a>&nbsp;chartPanel)</pre>
  462. <div class="block">Paints the crosshairs in the layer.</div>
  463. <dl>
  464. <dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
  465. <dd><code><a href="../../../../org/jfree/chart/panel/Overlay.html#paintOverlay-java.awt.Graphics2D-org.jfree.chart.ChartPanel-">paintOverlay</a></code>&nbsp;in interface&nbsp;<code><a href="../../../../org/jfree/chart/panel/Overlay.html" title="interface in org.jfree.chart.panel">Overlay</a></code></dd>
  466. <dt><span class="paramLabel">Parameters:</span></dt>
  467. <dd><code>g2</code> - the graphics target.</dd>
  468. <dd><code>chartPanel</code> - the chart panel.</dd>
  469. </dl>
  470. </li>
  471. </ul>
  472. <a name="drawHorizontalCrosshair-java.awt.Graphics2D-java.awt.geom.Rectangle2D-double-org.jfree.chart.plot.Crosshair-">
  473. <!-- -->
  474. </a>
  475. <ul class="blockList">
  476. <li class="blockList">
  477. <h4>drawHorizontalCrosshair</h4>
  478. <pre>protected&nbsp;void&nbsp;<a href="../../../../src-html/org/jfree/chart/panel/CrosshairOverlay.html#line.277">drawHorizontalCrosshair</a>(java.awt.Graphics2D&nbsp;g2,
  479. java.awt.geom.Rectangle2D&nbsp;dataArea,
  480. double&nbsp;y,
  481. <a href="../../../../org/jfree/chart/plot/Crosshair.html" title="class in org.jfree.chart.plot">Crosshair</a>&nbsp;crosshair)</pre>
  482. <div class="block">Draws a crosshair horizontally across the plot.</div>
  483. <dl>
  484. <dt><span class="paramLabel">Parameters:</span></dt>
  485. <dd><code>g2</code> - the graphics target.</dd>
  486. <dd><code>dataArea</code> - the data area.</dd>
  487. <dd><code>y</code> - the y-value in Java2D space.</dd>
  488. <dd><code>crosshair</code> - the crosshair.</dd>
  489. </dl>
  490. </li>
  491. </ul>
  492. <a name="drawVerticalCrosshair-java.awt.Graphics2D-java.awt.geom.Rectangle2D-double-org.jfree.chart.plot.Crosshair-">
  493. <!-- -->
  494. </a>
  495. <ul class="blockList">
  496. <li class="blockList">
  497. <h4>drawVerticalCrosshair</h4>
  498. <pre>protected&nbsp;void&nbsp;<a href="../../../../src-html/org/jfree/chart/panel/CrosshairOverlay.html#line.327">drawVerticalCrosshair</a>(java.awt.Graphics2D&nbsp;g2,
  499. java.awt.geom.Rectangle2D&nbsp;dataArea,
  500. double&nbsp;x,
  501. <a href="../../../../org/jfree/chart/plot/Crosshair.html" title="class in org.jfree.chart.plot">Crosshair</a>&nbsp;crosshair)</pre>
  502. <div class="block">Draws a crosshair vertically on the plot.</div>
  503. <dl>
  504. <dt><span class="paramLabel">Parameters:</span></dt>
  505. <dd><code>g2</code> - the graphics target.</dd>
  506. <dd><code>dataArea</code> - the data area.</dd>
  507. <dd><code>x</code> - the x-value in Java2D space.</dd>
  508. <dd><code>crosshair</code> - the crosshair.</dd>
  509. </dl>
  510. </li>
  511. </ul>
  512. <a name="equals-java.lang.Object-">
  513. <!-- -->
  514. </a>
  515. <ul class="blockList">
  516. <li class="blockList">
  517. <h4>equals</h4>
  518. <pre>public&nbsp;boolean&nbsp;<a href="../../../../src-html/org/jfree/chart/panel/CrosshairOverlay.html#line.559">equals</a>(java.lang.Object&nbsp;obj)</pre>
  519. <div class="block">Tests this overlay for equality with an arbitrary object.</div>
  520. <dl>
  521. <dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
  522. <dd><code>equals</code>&nbsp;in class&nbsp;<code>java.lang.Object</code></dd>
  523. <dt><span class="paramLabel">Parameters:</span></dt>
  524. <dd><code>obj</code> - the object (<code>null</code> permitted).</dd>
  525. <dt><span class="returnLabel">Returns:</span></dt>
  526. <dd>A boolean.</dd>
  527. </dl>
  528. </li>
  529. </ul>
  530. <a name="clone--">
  531. <!-- -->
  532. </a>
  533. <ul class="blockListLast">
  534. <li class="blockList">
  535. <h4>clone</h4>
  536. <pre>public&nbsp;java.lang.Object&nbsp;<a href="../../../../src-html/org/jfree/chart/panel/CrosshairOverlay.html#line.585">clone</a>()
  537. throws java.lang.CloneNotSupportedException</pre>
  538. <div class="block">Returns a clone of this instance.</div>
  539. <dl>
  540. <dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
  541. <dd><code>clone</code>&nbsp;in interface&nbsp;<code>org.jfree.util.PublicCloneable</code></dd>
  542. <dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
  543. <dd><code>clone</code>&nbsp;in class&nbsp;<code>java.lang.Object</code></dd>
  544. <dt><span class="returnLabel">Returns:</span></dt>
  545. <dd>A clone of this instance.</dd>
  546. <dt><span class="throwsLabel">Throws:</span></dt>
  547. <dd><code>java.lang.CloneNotSupportedException</code> - if there is some problem
  548. with the cloning.</dd>
  549. </dl>
  550. </li>
  551. </ul>
  552. </li>
  553. </ul>
  554. </li>
  555. </ul>
  556. </div>
  557. </div>
  558. <!-- ========= END OF CLASS DATA ========= -->
  559. <!-- ======= START OF BOTTOM NAVBAR ====== -->
  560. <div class="bottomNav"><a name="navbar.bottom">
  561. <!-- -->
  562. </a>
  563. <div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div>
  564. <a name="navbar.bottom.firstrow">
  565. <!-- -->
  566. </a>
  567. <ul class="navList" title="Navigation">
  568. <li><a href="../../../../overview-summary.html">Overview</a></li>
  569. <li><a href="package-summary.html">Package</a></li>
  570. <li class="navBarCell1Rev">Class</li>
  571. <li><a href="class-use/CrosshairOverlay.html">Use</a></li>
  572. <li><a href="package-tree.html">Tree</a></li>
  573. <li><a href="../../../../deprecated-list.html">Deprecated</a></li>
  574. <li><a href="../../../../index-files/index-1.html">Index</a></li>
  575. <li><a href="../../../../help-doc.html">Help</a></li>
  576. </ul>
  577. </div>
  578. <div class="subNav">
  579. <ul class="navList">
  580. <li><a href="../../../../org/jfree/chart/panel/AbstractOverlay.html" title="class in org.jfree.chart.panel"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
  581. <li><a href="../../../../org/jfree/chart/panel/Overlay.html" title="interface in org.jfree.chart.panel"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
  582. </ul>
  583. <ul class="navList">
  584. <li><a href="../../../../index.html?org/jfree/chart/panel/CrosshairOverlay.html" target="_top">Frames</a></li>
  585. <li><a href="CrosshairOverlay.html" target="_top">No&nbsp;Frames</a></li>
  586. </ul>
  587. <ul class="navList" id="allclasses_navbar_bottom">
  588. <li><a href="../../../../allclasses-noframe.html">All&nbsp;Classes</a></li>
  589. </ul>
  590. <div>
  591. <script type="text/javascript"><!--
  592. allClassesLink = document.getElementById("allclasses_navbar_bottom");
  593. if(window==top) {
  594. allClassesLink.style.display = "block";
  595. }
  596. else {
  597. allClassesLink.style.display = "none";
  598. }
  599. //-->
  600. </script>
  601. </div>
  602. <div>
  603. <ul class="subNavList">
  604. <li>Summary:&nbsp;</li>
  605. <li>Nested&nbsp;|&nbsp;</li>
  606. <li>Field&nbsp;|&nbsp;</li>
  607. <li><a href="#constructor.summary">Constr</a>&nbsp;|&nbsp;</li>
  608. <li><a href="#method.summary">Method</a></li>
  609. </ul>
  610. <ul class="subNavList">
  611. <li>Detail:&nbsp;</li>
  612. <li>Field&nbsp;|&nbsp;</li>
  613. <li><a href="#constructor.detail">Constr</a>&nbsp;|&nbsp;</li>
  614. <li><a href="#method.detail">Method</a></li>
  615. </ul>
  616. </div>
  617. <a name="skip.navbar.bottom">
  618. <!-- -->
  619. </a></div>
  620. <!-- ======== END OF BOTTOM NAVBAR ======= -->
  621. </body>
  622. </html>