TooltipHandlerFX.html 16 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325
  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>TooltipHandlerFX (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="TooltipHandlerFX (JFreeChart Class Library (version 1.0.19-fx))";
  16. }
  17. }
  18. catch(err) {
  19. }
  20. //-->
  21. var methods = {"i0":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/TooltipHandlerFX.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/fx/interaction/ScrollHandlerFX.html" title="class in org.jfree.chart.fx.interaction"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
  53. <li><a href="../../../../../org/jfree/chart/fx/interaction/ZoomHandlerFX.html" title="class in org.jfree.chart.fx.interaction"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
  54. </ul>
  55. <ul class="navList">
  56. <li><a href="../../../../../index.html?org/jfree/chart/fx/interaction/TooltipHandlerFX.html" target="_top">Frames</a></li>
  57. <li><a href="TooltipHandlerFX.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.fx.interaction</div>
  96. <h2 title="Class TooltipHandlerFX" class="title">Class TooltipHandlerFX</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/fx/interaction/AbstractMouseHandlerFX.html" title="class in org.jfree.chart.fx.interaction">org.jfree.chart.fx.interaction.AbstractMouseHandlerFX</a></li>
  104. <li>
  105. <ul class="inheritance">
  106. <li>org.jfree.chart.fx.interaction.TooltipHandlerFX</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><a href="../../../../../org/jfree/chart/fx/interaction/MouseHandlerFX.html" title="interface in org.jfree.chart.fx.interaction">MouseHandlerFX</a></dd>
  118. </dl>
  119. <hr>
  120. <br>
  121. <pre>public class <a href="../../../../../src-html/org/jfree/chart/fx/interaction/TooltipHandlerFX.html#line.58">TooltipHandlerFX</a>
  122. extends <a href="../../../../../org/jfree/chart/fx/interaction/AbstractMouseHandlerFX.html" title="class in org.jfree.chart.fx.interaction">AbstractMouseHandlerFX</a>
  123. implements <a href="../../../../../org/jfree/chart/fx/interaction/MouseHandlerFX.html" title="interface in org.jfree.chart.fx.interaction">MouseHandlerFX</a></pre>
  124. <div class="block">Handles the updating of tooltips on a <a href="../../../../../org/jfree/chart/fx/ChartCanvas.html" title="class in org.jfree.chart.fx"><code>ChartCanvas</code></a>.
  125. <p>THE API FOR THIS CLASS IS SUBJECT TO CHANGE IN FUTURE RELEASES. This is
  126. so that we can incorporate feedback on the (new) JavaFX support in
  127. JFreeChart.</p></div>
  128. <dl>
  129. <dt><span class="simpleTagLabel">Since:</span></dt>
  130. <dd>1.0.18</dd>
  131. </dl>
  132. </li>
  133. </ul>
  134. </div>
  135. <div class="summary">
  136. <ul class="blockList">
  137. <li class="blockList">
  138. <!-- ======== CONSTRUCTOR SUMMARY ======== -->
  139. <ul class="blockList">
  140. <li class="blockList"><a name="constructor.summary">
  141. <!-- -->
  142. </a>
  143. <h3>Constructor Summary</h3>
  144. <table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Constructor Summary table, listing constructors, and an explanation">
  145. <caption><span>Constructors</span><span class="tabEnd">&nbsp;</span></caption>
  146. <tr>
  147. <th class="colOne" scope="col">Constructor and Description</th>
  148. </tr>
  149. <tr class="altColor">
  150. <td class="colOne"><code><span class="memberNameLink"><a href="../../../../../org/jfree/chart/fx/interaction/TooltipHandlerFX.html#TooltipHandlerFX-java.lang.String-">TooltipHandlerFX</a></span>(java.lang.String&nbsp;id)</code>
  151. <div class="block">Creates a new instance with the specified ID.</div>
  152. </td>
  153. </tr>
  154. </table>
  155. </li>
  156. </ul>
  157. <!-- ========== METHOD SUMMARY =========== -->
  158. <ul class="blockList">
  159. <li class="blockList"><a name="method.summary">
  160. <!-- -->
  161. </a>
  162. <h3>Method Summary</h3>
  163. <table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation">
  164. <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>
  165. <tr>
  166. <th class="colFirst" scope="col">Modifier and Type</th>
  167. <th class="colLast" scope="col">Method and Description</th>
  168. </tr>
  169. <tr id="i0" class="altColor">
  170. <td class="colFirst"><code>void</code></td>
  171. <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/jfree/chart/fx/interaction/TooltipHandlerFX.html#handleMouseMoved-org.jfree.chart.fx.ChartCanvas-javafx.scene.input.MouseEvent-">handleMouseMoved</a></span>(<a href="../../../../../org/jfree/chart/fx/ChartCanvas.html" title="class in org.jfree.chart.fx">ChartCanvas</a>&nbsp;canvas,
  172. javafx.scene.input.MouseEvent&nbsp;e)</code>
  173. <div class="block">Handles a mouse moved event by updating the tooltip.</div>
  174. </td>
  175. </tr>
  176. </table>
  177. <ul class="blockList">
  178. <li class="blockList"><a name="methods.inherited.from.class.org.jfree.chart.fx.interaction.AbstractMouseHandlerFX">
  179. <!-- -->
  180. </a>
  181. <h3>Methods inherited from class&nbsp;org.jfree.chart.fx.interaction.<a href="../../../../../org/jfree/chart/fx/interaction/AbstractMouseHandlerFX.html" title="class in org.jfree.chart.fx.interaction">AbstractMouseHandlerFX</a></h3>
  182. <code><a href="../../../../../org/jfree/chart/fx/interaction/AbstractMouseHandlerFX.html#getID--">getID</a>, <a href="../../../../../org/jfree/chart/fx/interaction/AbstractMouseHandlerFX.html#handleMouseClicked-org.jfree.chart.fx.ChartCanvas-javafx.scene.input.MouseEvent-">handleMouseClicked</a>, <a href="../../../../../org/jfree/chart/fx/interaction/AbstractMouseHandlerFX.html#handleMouseDragged-org.jfree.chart.fx.ChartCanvas-javafx.scene.input.MouseEvent-">handleMouseDragged</a>, <a href="../../../../../org/jfree/chart/fx/interaction/AbstractMouseHandlerFX.html#handleMousePressed-org.jfree.chart.fx.ChartCanvas-javafx.scene.input.MouseEvent-">handleMousePressed</a>, <a href="../../../../../org/jfree/chart/fx/interaction/AbstractMouseHandlerFX.html#handleMouseReleased-org.jfree.chart.fx.ChartCanvas-javafx.scene.input.MouseEvent-">handleMouseReleased</a>, <a href="../../../../../org/jfree/chart/fx/interaction/AbstractMouseHandlerFX.html#handleScroll-org.jfree.chart.fx.ChartCanvas-javafx.scene.input.ScrollEvent-">handleScroll</a>, <a href="../../../../../org/jfree/chart/fx/interaction/AbstractMouseHandlerFX.html#hasMatchingModifiers-javafx.scene.input.MouseEvent-">hasMatchingModifiers</a>, <a href="../../../../../org/jfree/chart/fx/interaction/AbstractMouseHandlerFX.html#isEnabled--">isEnabled</a>, <a href="../../../../../org/jfree/chart/fx/interaction/AbstractMouseHandlerFX.html#setEnabled-boolean-">setEnabled</a></code></li>
  183. </ul>
  184. <ul class="blockList">
  185. <li class="blockList"><a name="methods.inherited.from.class.java.lang.Object">
  186. <!-- -->
  187. </a>
  188. <h3>Methods inherited from class&nbsp;java.lang.Object</h3>
  189. <code>clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait</code></li>
  190. </ul>
  191. <ul class="blockList">
  192. <li class="blockList"><a name="methods.inherited.from.class.org.jfree.chart.fx.interaction.MouseHandlerFX">
  193. <!-- -->
  194. </a>
  195. <h3>Methods inherited from interface&nbsp;org.jfree.chart.fx.interaction.<a href="../../../../../org/jfree/chart/fx/interaction/MouseHandlerFX.html" title="interface in org.jfree.chart.fx.interaction">MouseHandlerFX</a></h3>
  196. <code><a href="../../../../../org/jfree/chart/fx/interaction/MouseHandlerFX.html#getID--">getID</a>, <a href="../../../../../org/jfree/chart/fx/interaction/MouseHandlerFX.html#handleMouseClicked-org.jfree.chart.fx.ChartCanvas-javafx.scene.input.MouseEvent-">handleMouseClicked</a>, <a href="../../../../../org/jfree/chart/fx/interaction/MouseHandlerFX.html#handleMouseDragged-org.jfree.chart.fx.ChartCanvas-javafx.scene.input.MouseEvent-">handleMouseDragged</a>, <a href="../../../../../org/jfree/chart/fx/interaction/MouseHandlerFX.html#handleMousePressed-org.jfree.chart.fx.ChartCanvas-javafx.scene.input.MouseEvent-">handleMousePressed</a>, <a href="../../../../../org/jfree/chart/fx/interaction/MouseHandlerFX.html#handleMouseReleased-org.jfree.chart.fx.ChartCanvas-javafx.scene.input.MouseEvent-">handleMouseReleased</a>, <a href="../../../../../org/jfree/chart/fx/interaction/MouseHandlerFX.html#handleScroll-org.jfree.chart.fx.ChartCanvas-javafx.scene.input.ScrollEvent-">handleScroll</a>, <a href="../../../../../org/jfree/chart/fx/interaction/MouseHandlerFX.html#hasMatchingModifiers-javafx.scene.input.MouseEvent-">hasMatchingModifiers</a>, <a href="../../../../../org/jfree/chart/fx/interaction/MouseHandlerFX.html#isEnabled--">isEnabled</a></code></li>
  197. </ul>
  198. </li>
  199. </ul>
  200. </li>
  201. </ul>
  202. </div>
  203. <div class="details">
  204. <ul class="blockList">
  205. <li class="blockList">
  206. <!-- ========= CONSTRUCTOR DETAIL ======== -->
  207. <ul class="blockList">
  208. <li class="blockList"><a name="constructor.detail">
  209. <!-- -->
  210. </a>
  211. <h3>Constructor Detail</h3>
  212. <a name="TooltipHandlerFX-java.lang.String-">
  213. <!-- -->
  214. </a>
  215. <ul class="blockListLast">
  216. <li class="blockList">
  217. <h4>TooltipHandlerFX</h4>
  218. <pre>public&nbsp;<a href="../../../../../src-html/org/jfree/chart/fx/interaction/TooltipHandlerFX.html#line.66">TooltipHandlerFX</a>(java.lang.String&nbsp;id)</pre>
  219. <div class="block">Creates a new instance with the specified ID.</div>
  220. <dl>
  221. <dt><span class="paramLabel">Parameters:</span></dt>
  222. <dd><code>id</code> - the handler id (<code>null</code> not permitted).</dd>
  223. </dl>
  224. </li>
  225. </ul>
  226. </li>
  227. </ul>
  228. <!-- ============ METHOD DETAIL ========== -->
  229. <ul class="blockList">
  230. <li class="blockList"><a name="method.detail">
  231. <!-- -->
  232. </a>
  233. <h3>Method Detail</h3>
  234. <a name="handleMouseMoved-org.jfree.chart.fx.ChartCanvas-javafx.scene.input.MouseEvent-">
  235. <!-- -->
  236. </a>
  237. <ul class="blockListLast">
  238. <li class="blockList">
  239. <h4>handleMouseMoved</h4>
  240. <pre>public&nbsp;void&nbsp;<a href="../../../../../src-html/org/jfree/chart/fx/interaction/TooltipHandlerFX.html#line.77">handleMouseMoved</a>(<a href="../../../../../org/jfree/chart/fx/ChartCanvas.html" title="class in org.jfree.chart.fx">ChartCanvas</a>&nbsp;canvas,
  241. javafx.scene.input.MouseEvent&nbsp;e)</pre>
  242. <div class="block">Handles a mouse moved event by updating the tooltip.</div>
  243. <dl>
  244. <dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
  245. <dd><code><a href="../../../../../org/jfree/chart/fx/interaction/MouseHandlerFX.html#handleMouseMoved-org.jfree.chart.fx.ChartCanvas-javafx.scene.input.MouseEvent-">handleMouseMoved</a></code>&nbsp;in interface&nbsp;<code><a href="../../../../../org/jfree/chart/fx/interaction/MouseHandlerFX.html" title="interface in org.jfree.chart.fx.interaction">MouseHandlerFX</a></code></dd>
  246. <dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
  247. <dd><code><a href="../../../../../org/jfree/chart/fx/interaction/AbstractMouseHandlerFX.html#handleMouseMoved-org.jfree.chart.fx.ChartCanvas-javafx.scene.input.MouseEvent-">handleMouseMoved</a></code>&nbsp;in class&nbsp;<code><a href="../../../../../org/jfree/chart/fx/interaction/AbstractMouseHandlerFX.html" title="class in org.jfree.chart.fx.interaction">AbstractMouseHandlerFX</a></code></dd>
  248. <dt><span class="paramLabel">Parameters:</span></dt>
  249. <dd><code>canvas</code> - the chart canvas (<code>null</code> not permitted).</dd>
  250. <dd><code>e</code> - the mouse event.</dd>
  251. </dl>
  252. </li>
  253. </ul>
  254. </li>
  255. </ul>
  256. </li>
  257. </ul>
  258. </div>
  259. </div>
  260. <!-- ========= END OF CLASS DATA ========= -->
  261. <!-- ======= START OF BOTTOM NAVBAR ====== -->
  262. <div class="bottomNav"><a name="navbar.bottom">
  263. <!-- -->
  264. </a>
  265. <div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div>
  266. <a name="navbar.bottom.firstrow">
  267. <!-- -->
  268. </a>
  269. <ul class="navList" title="Navigation">
  270. <li><a href="../../../../../overview-summary.html">Overview</a></li>
  271. <li><a href="package-summary.html">Package</a></li>
  272. <li class="navBarCell1Rev">Class</li>
  273. <li><a href="class-use/TooltipHandlerFX.html">Use</a></li>
  274. <li><a href="package-tree.html">Tree</a></li>
  275. <li><a href="../../../../../deprecated-list.html">Deprecated</a></li>
  276. <li><a href="../../../../../index-files/index-1.html">Index</a></li>
  277. <li><a href="../../../../../help-doc.html">Help</a></li>
  278. </ul>
  279. </div>
  280. <div class="subNav">
  281. <ul class="navList">
  282. <li><a href="../../../../../org/jfree/chart/fx/interaction/ScrollHandlerFX.html" title="class in org.jfree.chart.fx.interaction"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
  283. <li><a href="../../../../../org/jfree/chart/fx/interaction/ZoomHandlerFX.html" title="class in org.jfree.chart.fx.interaction"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
  284. </ul>
  285. <ul class="navList">
  286. <li><a href="../../../../../index.html?org/jfree/chart/fx/interaction/TooltipHandlerFX.html" target="_top">Frames</a></li>
  287. <li><a href="TooltipHandlerFX.html" target="_top">No&nbsp;Frames</a></li>
  288. </ul>
  289. <ul class="navList" id="allclasses_navbar_bottom">
  290. <li><a href="../../../../../allclasses-noframe.html">All&nbsp;Classes</a></li>
  291. </ul>
  292. <div>
  293. <script type="text/javascript"><!--
  294. allClassesLink = document.getElementById("allclasses_navbar_bottom");
  295. if(window==top) {
  296. allClassesLink.style.display = "block";
  297. }
  298. else {
  299. allClassesLink.style.display = "none";
  300. }
  301. //-->
  302. </script>
  303. </div>
  304. <div>
  305. <ul class="subNavList">
  306. <li>Summary:&nbsp;</li>
  307. <li>Nested&nbsp;|&nbsp;</li>
  308. <li>Field&nbsp;|&nbsp;</li>
  309. <li><a href="#constructor.summary">Constr</a>&nbsp;|&nbsp;</li>
  310. <li><a href="#method.summary">Method</a></li>
  311. </ul>
  312. <ul class="subNavList">
  313. <li>Detail:&nbsp;</li>
  314. <li>Field&nbsp;|&nbsp;</li>
  315. <li><a href="#constructor.detail">Constr</a>&nbsp;|&nbsp;</li>
  316. <li><a href="#method.detail">Method</a></li>
  317. </ul>
  318. </div>
  319. <a name="skip.navbar.bottom">
  320. <!-- -->
  321. </a></div>
  322. <!-- ======== END OF BOTTOM NAVBAR ======= -->
  323. </body>
  324. </html>