ChartMouseEvent.html 14 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371
  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:25 CEST 2014 -->
  6. <title>ChartMouseEvent (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="ChartMouseEvent (JFreeChart Class Library (version 1.0.19-fx))";
  16. }
  17. }
  18. catch(err) {
  19. }
  20. //-->
  21. var methods = {"i0":10,"i1":10,"i2":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/ChartMouseEvent.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/ChartHints.Key.html" title="class in org.jfree.chart"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
  53. <li><a href="../../../org/jfree/chart/ChartMouseListener.html" title="interface in org.jfree.chart"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
  54. </ul>
  55. <ul class="navList">
  56. <li><a href="../../../index.html?org/jfree/chart/ChartMouseEvent.html" target="_top">Frames</a></li>
  57. <li><a href="ChartMouseEvent.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><a href="#fields.inherited.from.class.java.util.EventObject">Field</a>&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</div>
  96. <h2 title="Class ChartMouseEvent" class="title">Class ChartMouseEvent</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>java.util.EventObject</li>
  104. <li>
  105. <ul class="inheritance">
  106. <li>org.jfree.chart.ChartMouseEvent</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.io.Serializable</dd>
  118. </dl>
  119. <hr>
  120. <br>
  121. <pre>public class <a href="../../../src-html/org/jfree/chart/ChartMouseEvent.html#line.60">ChartMouseEvent</a>
  122. extends java.util.EventObject
  123. implements java.io.Serializable</pre>
  124. <div class="block">A mouse event for a chart that is displayed in a <a href="../../../org/jfree/chart/ChartPanel.html" title="class in org.jfree.chart"><code>ChartPanel</code></a>.</div>
  125. <dl>
  126. <dt><span class="seeLabel">See Also:</span></dt>
  127. <dd><a href="../../../org/jfree/chart/ChartMouseListener.html" title="interface in org.jfree.chart"><code>ChartMouseListener</code></a>,
  128. <a href="../../../serialized-form.html#org.jfree.chart.ChartMouseEvent">Serialized Form</a></dd>
  129. </dl>
  130. </li>
  131. </ul>
  132. </div>
  133. <div class="summary">
  134. <ul class="blockList">
  135. <li class="blockList">
  136. <!-- =========== FIELD SUMMARY =========== -->
  137. <ul class="blockList">
  138. <li class="blockList"><a name="field.summary">
  139. <!-- -->
  140. </a>
  141. <h3>Field Summary</h3>
  142. <ul class="blockList">
  143. <li class="blockList"><a name="fields.inherited.from.class.java.util.EventObject">
  144. <!-- -->
  145. </a>
  146. <h3>Fields inherited from class&nbsp;java.util.EventObject</h3>
  147. <code>source</code></li>
  148. </ul>
  149. </li>
  150. </ul>
  151. <!-- ======== CONSTRUCTOR SUMMARY ======== -->
  152. <ul class="blockList">
  153. <li class="blockList"><a name="constructor.summary">
  154. <!-- -->
  155. </a>
  156. <h3>Constructor Summary</h3>
  157. <table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Constructor Summary table, listing constructors, and an explanation">
  158. <caption><span>Constructors</span><span class="tabEnd">&nbsp;</span></caption>
  159. <tr>
  160. <th class="colOne" scope="col">Constructor and Description</th>
  161. </tr>
  162. <tr class="altColor">
  163. <td class="colOne"><code><span class="memberNameLink"><a href="../../../org/jfree/chart/ChartMouseEvent.html#ChartMouseEvent-org.jfree.chart.JFreeChart-java.awt.event.MouseEvent-org.jfree.chart.entity.ChartEntity-">ChartMouseEvent</a></span>(<a href="../../../org/jfree/chart/JFreeChart.html" title="class in org.jfree.chart">JFreeChart</a>&nbsp;chart,
  164. java.awt.event.MouseEvent&nbsp;trigger,
  165. <a href="../../../org/jfree/chart/entity/ChartEntity.html" title="class in org.jfree.chart.entity">ChartEntity</a>&nbsp;entity)</code>
  166. <div class="block">Constructs a new event.</div>
  167. </td>
  168. </tr>
  169. </table>
  170. </li>
  171. </ul>
  172. <!-- ========== METHOD SUMMARY =========== -->
  173. <ul class="blockList">
  174. <li class="blockList"><a name="method.summary">
  175. <!-- -->
  176. </a>
  177. <h3>Method Summary</h3>
  178. <table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation">
  179. <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>
  180. <tr>
  181. <th class="colFirst" scope="col">Modifier and Type</th>
  182. <th class="colLast" scope="col">Method and Description</th>
  183. </tr>
  184. <tr id="i0" class="altColor">
  185. <td class="colFirst"><code><a href="../../../org/jfree/chart/JFreeChart.html" title="class in org.jfree.chart">JFreeChart</a></code></td>
  186. <td class="colLast"><code><span class="memberNameLink"><a href="../../../org/jfree/chart/ChartMouseEvent.html#getChart--">getChart</a></span>()</code>
  187. <div class="block">Returns the chart that the mouse event relates to.</div>
  188. </td>
  189. </tr>
  190. <tr id="i1" class="rowColor">
  191. <td class="colFirst"><code><a href="../../../org/jfree/chart/entity/ChartEntity.html" title="class in org.jfree.chart.entity">ChartEntity</a></code></td>
  192. <td class="colLast"><code><span class="memberNameLink"><a href="../../../org/jfree/chart/ChartMouseEvent.html#getEntity--">getEntity</a></span>()</code>
  193. <div class="block">Returns the chart entity (if any) under the mouse point.</div>
  194. </td>
  195. </tr>
  196. <tr id="i2" class="altColor">
  197. <td class="colFirst"><code>java.awt.event.MouseEvent</code></td>
  198. <td class="colLast"><code><span class="memberNameLink"><a href="../../../org/jfree/chart/ChartMouseEvent.html#getTrigger--">getTrigger</a></span>()</code>
  199. <div class="block">Returns the mouse event that triggered this event.</div>
  200. </td>
  201. </tr>
  202. </table>
  203. <ul class="blockList">
  204. <li class="blockList"><a name="methods.inherited.from.class.java.util.EventObject">
  205. <!-- -->
  206. </a>
  207. <h3>Methods inherited from class&nbsp;java.util.EventObject</h3>
  208. <code>getSource, toString</code></li>
  209. </ul>
  210. <ul class="blockList">
  211. <li class="blockList"><a name="methods.inherited.from.class.java.lang.Object">
  212. <!-- -->
  213. </a>
  214. <h3>Methods inherited from class&nbsp;java.lang.Object</h3>
  215. <code>clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait</code></li>
  216. </ul>
  217. </li>
  218. </ul>
  219. </li>
  220. </ul>
  221. </div>
  222. <div class="details">
  223. <ul class="blockList">
  224. <li class="blockList">
  225. <!-- ========= CONSTRUCTOR DETAIL ======== -->
  226. <ul class="blockList">
  227. <li class="blockList"><a name="constructor.detail">
  228. <!-- -->
  229. </a>
  230. <h3>Constructor Detail</h3>
  231. <a name="ChartMouseEvent-org.jfree.chart.JFreeChart-java.awt.event.MouseEvent-org.jfree.chart.entity.ChartEntity-">
  232. <!-- -->
  233. </a>
  234. <ul class="blockListLast">
  235. <li class="blockList">
  236. <h4>ChartMouseEvent</h4>
  237. <pre>public&nbsp;<a href="../../../src-html/org/jfree/chart/ChartMouseEvent.html#line.83">ChartMouseEvent</a>(<a href="../../../org/jfree/chart/JFreeChart.html" title="class in org.jfree.chart">JFreeChart</a>&nbsp;chart,
  238. java.awt.event.MouseEvent&nbsp;trigger,
  239. <a href="../../../org/jfree/chart/entity/ChartEntity.html" title="class in org.jfree.chart.entity">ChartEntity</a>&nbsp;entity)</pre>
  240. <div class="block">Constructs a new event.</div>
  241. <dl>
  242. <dt><span class="paramLabel">Parameters:</span></dt>
  243. <dd><code>chart</code> - the source chart (<code>null</code> not permitted).</dd>
  244. <dd><code>trigger</code> - the mouse event that triggered this event
  245. (<code>null</code> not permitted).</dd>
  246. <dd><code>entity</code> - the chart entity (if any) under the mouse point
  247. (<code>null</code> permitted).</dd>
  248. </dl>
  249. </li>
  250. </ul>
  251. </li>
  252. </ul>
  253. <!-- ============ METHOD DETAIL ========== -->
  254. <ul class="blockList">
  255. <li class="blockList"><a name="method.detail">
  256. <!-- -->
  257. </a>
  258. <h3>Method Detail</h3>
  259. <a name="getChart--">
  260. <!-- -->
  261. </a>
  262. <ul class="blockList">
  263. <li class="blockList">
  264. <h4>getChart</h4>
  265. <pre>public&nbsp;<a href="../../../org/jfree/chart/JFreeChart.html" title="class in org.jfree.chart">JFreeChart</a>&nbsp;<a href="../../../src-html/org/jfree/chart/ChartMouseEvent.html#line.96">getChart</a>()</pre>
  266. <div class="block">Returns the chart that the mouse event relates to.</div>
  267. <dl>
  268. <dt><span class="returnLabel">Returns:</span></dt>
  269. <dd>The chart (never <code>null</code>).</dd>
  270. </dl>
  271. </li>
  272. </ul>
  273. <a name="getTrigger--">
  274. <!-- -->
  275. </a>
  276. <ul class="blockList">
  277. <li class="blockList">
  278. <h4>getTrigger</h4>
  279. <pre>public&nbsp;java.awt.event.MouseEvent&nbsp;<a href="../../../src-html/org/jfree/chart/ChartMouseEvent.html#line.105">getTrigger</a>()</pre>
  280. <div class="block">Returns the mouse event that triggered this event.</div>
  281. <dl>
  282. <dt><span class="returnLabel">Returns:</span></dt>
  283. <dd>The event (never <code>null</code>).</dd>
  284. </dl>
  285. </li>
  286. </ul>
  287. <a name="getEntity--">
  288. <!-- -->
  289. </a>
  290. <ul class="blockListLast">
  291. <li class="blockList">
  292. <h4>getEntity</h4>
  293. <pre>public&nbsp;<a href="../../../org/jfree/chart/entity/ChartEntity.html" title="class in org.jfree.chart.entity">ChartEntity</a>&nbsp;<a href="../../../src-html/org/jfree/chart/ChartMouseEvent.html#line.114">getEntity</a>()</pre>
  294. <div class="block">Returns the chart entity (if any) under the mouse point.</div>
  295. <dl>
  296. <dt><span class="returnLabel">Returns:</span></dt>
  297. <dd>The chart entity (possibly <code>null</code>).</dd>
  298. </dl>
  299. </li>
  300. </ul>
  301. </li>
  302. </ul>
  303. </li>
  304. </ul>
  305. </div>
  306. </div>
  307. <!-- ========= END OF CLASS DATA ========= -->
  308. <!-- ======= START OF BOTTOM NAVBAR ====== -->
  309. <div class="bottomNav"><a name="navbar.bottom">
  310. <!-- -->
  311. </a>
  312. <div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div>
  313. <a name="navbar.bottom.firstrow">
  314. <!-- -->
  315. </a>
  316. <ul class="navList" title="Navigation">
  317. <li><a href="../../../overview-summary.html">Overview</a></li>
  318. <li><a href="package-summary.html">Package</a></li>
  319. <li class="navBarCell1Rev">Class</li>
  320. <li><a href="class-use/ChartMouseEvent.html">Use</a></li>
  321. <li><a href="package-tree.html">Tree</a></li>
  322. <li><a href="../../../deprecated-list.html">Deprecated</a></li>
  323. <li><a href="../../../index-files/index-1.html">Index</a></li>
  324. <li><a href="../../../help-doc.html">Help</a></li>
  325. </ul>
  326. </div>
  327. <div class="subNav">
  328. <ul class="navList">
  329. <li><a href="../../../org/jfree/chart/ChartHints.Key.html" title="class in org.jfree.chart"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
  330. <li><a href="../../../org/jfree/chart/ChartMouseListener.html" title="interface in org.jfree.chart"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
  331. </ul>
  332. <ul class="navList">
  333. <li><a href="../../../index.html?org/jfree/chart/ChartMouseEvent.html" target="_top">Frames</a></li>
  334. <li><a href="ChartMouseEvent.html" target="_top">No&nbsp;Frames</a></li>
  335. </ul>
  336. <ul class="navList" id="allclasses_navbar_bottom">
  337. <li><a href="../../../allclasses-noframe.html">All&nbsp;Classes</a></li>
  338. </ul>
  339. <div>
  340. <script type="text/javascript"><!--
  341. allClassesLink = document.getElementById("allclasses_navbar_bottom");
  342. if(window==top) {
  343. allClassesLink.style.display = "block";
  344. }
  345. else {
  346. allClassesLink.style.display = "none";
  347. }
  348. //-->
  349. </script>
  350. </div>
  351. <div>
  352. <ul class="subNavList">
  353. <li>Summary:&nbsp;</li>
  354. <li>Nested&nbsp;|&nbsp;</li>
  355. <li><a href="#fields.inherited.from.class.java.util.EventObject">Field</a>&nbsp;|&nbsp;</li>
  356. <li><a href="#constructor.summary">Constr</a>&nbsp;|&nbsp;</li>
  357. <li><a href="#method.summary">Method</a></li>
  358. </ul>
  359. <ul class="subNavList">
  360. <li>Detail:&nbsp;</li>
  361. <li>Field&nbsp;|&nbsp;</li>
  362. <li><a href="#constructor.detail">Constr</a>&nbsp;|&nbsp;</li>
  363. <li><a href="#method.detail">Method</a></li>
  364. </ul>
  365. </div>
  366. <a name="skip.navbar.bottom">
  367. <!-- -->
  368. </a></div>
  369. <!-- ======== END OF BOTTOM NAVBAR ======= -->
  370. </body>
  371. </html>