ChartMouseEvent.html 11 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190
  1. <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
  2. <html lang="en">
  3. <head>
  4. <title>Source code</title>
  5. <link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style">
  6. </head>
  7. <body>
  8. <div class="sourceContainer">
  9. <pre><span class="sourceLineNo">001</span>/* ===========================================================<a name="line.1"></a>
  10. <span class="sourceLineNo">002</span> * JFreeChart : a free chart library for the Java(tm) platform<a name="line.2"></a>
  11. <span class="sourceLineNo">003</span> * ===========================================================<a name="line.3"></a>
  12. <span class="sourceLineNo">004</span> *<a name="line.4"></a>
  13. <span class="sourceLineNo">005</span> * (C) Copyright 2000-2013, by Object Refinery Limited and Contributors.<a name="line.5"></a>
  14. <span class="sourceLineNo">006</span> *<a name="line.6"></a>
  15. <span class="sourceLineNo">007</span> * Project Info: http://www.jfree.org/jfreechart/index.html<a name="line.7"></a>
  16. <span class="sourceLineNo">008</span> *<a name="line.8"></a>
  17. <span class="sourceLineNo">009</span> * This library is free software; you can redistribute it and/or modify it<a name="line.9"></a>
  18. <span class="sourceLineNo">010</span> * under the terms of the GNU Lesser General Public License as published by<a name="line.10"></a>
  19. <span class="sourceLineNo">011</span> * the Free Software Foundation; either version 2.1 of the License, or<a name="line.11"></a>
  20. <span class="sourceLineNo">012</span> * (at your option) any later version.<a name="line.12"></a>
  21. <span class="sourceLineNo">013</span> *<a name="line.13"></a>
  22. <span class="sourceLineNo">014</span> * This library is distributed in the hope that it will be useful, but<a name="line.14"></a>
  23. <span class="sourceLineNo">015</span> * WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY<a name="line.15"></a>
  24. <span class="sourceLineNo">016</span> * or FITNESS FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public<a name="line.16"></a>
  25. <span class="sourceLineNo">017</span> * License for more details.<a name="line.17"></a>
  26. <span class="sourceLineNo">018</span> *<a name="line.18"></a>
  27. <span class="sourceLineNo">019</span> * You should have received a copy of the GNU Lesser General Public<a name="line.19"></a>
  28. <span class="sourceLineNo">020</span> * License along with this library; if not, write to the Free Software<a name="line.20"></a>
  29. <span class="sourceLineNo">021</span> * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301,<a name="line.21"></a>
  30. <span class="sourceLineNo">022</span> * USA.<a name="line.22"></a>
  31. <span class="sourceLineNo">023</span> *<a name="line.23"></a>
  32. <span class="sourceLineNo">024</span> * [Oracle and Java are registered trademarks of Oracle and/or its affiliates. <a name="line.24"></a>
  33. <span class="sourceLineNo">025</span> * Other names may be trademarks of their respective owners.]<a name="line.25"></a>
  34. <span class="sourceLineNo">026</span> *<a name="line.26"></a>
  35. <span class="sourceLineNo">027</span> * --------------------<a name="line.27"></a>
  36. <span class="sourceLineNo">028</span> * ChartMouseEvent.java<a name="line.28"></a>
  37. <span class="sourceLineNo">029</span> * --------------------<a name="line.29"></a>
  38. <span class="sourceLineNo">030</span> * (C) Copyright 2002-2008, by Object Refinery Limited and Contributors.<a name="line.30"></a>
  39. <span class="sourceLineNo">031</span> *<a name="line.31"></a>
  40. <span class="sourceLineNo">032</span> * Original Author: David Gilbert (for Object Refinery Limited);<a name="line.32"></a>
  41. <span class="sourceLineNo">033</span> * Contributor(s): Alex Weber;<a name="line.33"></a>
  42. <span class="sourceLineNo">034</span> *<a name="line.34"></a>
  43. <span class="sourceLineNo">035</span> * Changes<a name="line.35"></a>
  44. <span class="sourceLineNo">036</span> * -------<a name="line.36"></a>
  45. <span class="sourceLineNo">037</span> * 27-May-2002 : Version 1, incorporating code and ideas by Alex Weber (DG);<a name="line.37"></a>
  46. <span class="sourceLineNo">038</span> * 13-Jun-2002 : Added Javadoc comments (DG);<a name="line.38"></a>
  47. <span class="sourceLineNo">039</span> * 26-Sep-2002 : Fixed errors reported by Checkstyle (DG);<a name="line.39"></a>
  48. <span class="sourceLineNo">040</span> * 05-Nov-2002 : Added a reference to the source chart (DG);<a name="line.40"></a>
  49. <span class="sourceLineNo">041</span> * 13-Jul-2004 : Now extends EventObject and implements Serializable (DG);<a name="line.41"></a>
  50. <span class="sourceLineNo">042</span> * ------------- JFREECHART 1.0.x ---------------------------------------------<a name="line.42"></a>
  51. <span class="sourceLineNo">043</span> * 24-May-2007 : Updated API docs (DG);<a name="line.43"></a>
  52. <span class="sourceLineNo">044</span> *<a name="line.44"></a>
  53. <span class="sourceLineNo">045</span> */<a name="line.45"></a>
  54. <span class="sourceLineNo">046</span><a name="line.46"></a>
  55. <span class="sourceLineNo">047</span>package org.jfree.chart;<a name="line.47"></a>
  56. <span class="sourceLineNo">048</span><a name="line.48"></a>
  57. <span class="sourceLineNo">049</span>import java.awt.event.MouseEvent;<a name="line.49"></a>
  58. <span class="sourceLineNo">050</span>import java.io.Serializable;<a name="line.50"></a>
  59. <span class="sourceLineNo">051</span>import java.util.EventObject;<a name="line.51"></a>
  60. <span class="sourceLineNo">052</span><a name="line.52"></a>
  61. <span class="sourceLineNo">053</span>import org.jfree.chart.entity.ChartEntity;<a name="line.53"></a>
  62. <span class="sourceLineNo">054</span><a name="line.54"></a>
  63. <span class="sourceLineNo">055</span>/**<a name="line.55"></a>
  64. <span class="sourceLineNo">056</span> * A mouse event for a chart that is displayed in a {@link ChartPanel}.<a name="line.56"></a>
  65. <span class="sourceLineNo">057</span> *<a name="line.57"></a>
  66. <span class="sourceLineNo">058</span> * @see ChartMouseListener<a name="line.58"></a>
  67. <span class="sourceLineNo">059</span> */<a name="line.59"></a>
  68. <span class="sourceLineNo">060</span>public class ChartMouseEvent extends EventObject implements Serializable {<a name="line.60"></a>
  69. <span class="sourceLineNo">061</span><a name="line.61"></a>
  70. <span class="sourceLineNo">062</span> /** For serialization. */<a name="line.62"></a>
  71. <span class="sourceLineNo">063</span> private static final long serialVersionUID = -682393837314562149L;<a name="line.63"></a>
  72. <span class="sourceLineNo">064</span><a name="line.64"></a>
  73. <span class="sourceLineNo">065</span> /** The chart that the mouse event relates to. */<a name="line.65"></a>
  74. <span class="sourceLineNo">066</span> private JFreeChart chart;<a name="line.66"></a>
  75. <span class="sourceLineNo">067</span><a name="line.67"></a>
  76. <span class="sourceLineNo">068</span> /** The Java mouse event that triggered this event. */<a name="line.68"></a>
  77. <span class="sourceLineNo">069</span> private MouseEvent trigger;<a name="line.69"></a>
  78. <span class="sourceLineNo">070</span><a name="line.70"></a>
  79. <span class="sourceLineNo">071</span> /** The chart entity (if any). */<a name="line.71"></a>
  80. <span class="sourceLineNo">072</span> private ChartEntity entity;<a name="line.72"></a>
  81. <span class="sourceLineNo">073</span><a name="line.73"></a>
  82. <span class="sourceLineNo">074</span> /**<a name="line.74"></a>
  83. <span class="sourceLineNo">075</span> * Constructs a new event.<a name="line.75"></a>
  84. <span class="sourceLineNo">076</span> *<a name="line.76"></a>
  85. <span class="sourceLineNo">077</span> * @param chart the source chart (&lt;code&gt;null&lt;/code&gt; not permitted).<a name="line.77"></a>
  86. <span class="sourceLineNo">078</span> * @param trigger the mouse event that triggered this event<a name="line.78"></a>
  87. <span class="sourceLineNo">079</span> * (&lt;code&gt;null&lt;/code&gt; not permitted).<a name="line.79"></a>
  88. <span class="sourceLineNo">080</span> * @param entity the chart entity (if any) under the mouse point<a name="line.80"></a>
  89. <span class="sourceLineNo">081</span> * (&lt;code&gt;null&lt;/code&gt; permitted).<a name="line.81"></a>
  90. <span class="sourceLineNo">082</span> */<a name="line.82"></a>
  91. <span class="sourceLineNo">083</span> public ChartMouseEvent(JFreeChart chart, MouseEvent trigger,<a name="line.83"></a>
  92. <span class="sourceLineNo">084</span> ChartEntity entity) {<a name="line.84"></a>
  93. <span class="sourceLineNo">085</span> super(chart);<a name="line.85"></a>
  94. <span class="sourceLineNo">086</span> this.chart = chart;<a name="line.86"></a>
  95. <span class="sourceLineNo">087</span> this.trigger = trigger;<a name="line.87"></a>
  96. <span class="sourceLineNo">088</span> this.entity = entity;<a name="line.88"></a>
  97. <span class="sourceLineNo">089</span> }<a name="line.89"></a>
  98. <span class="sourceLineNo">090</span><a name="line.90"></a>
  99. <span class="sourceLineNo">091</span> /**<a name="line.91"></a>
  100. <span class="sourceLineNo">092</span> * Returns the chart that the mouse event relates to.<a name="line.92"></a>
  101. <span class="sourceLineNo">093</span> *<a name="line.93"></a>
  102. <span class="sourceLineNo">094</span> * @return The chart (never &lt;code&gt;null&lt;/code&gt;).<a name="line.94"></a>
  103. <span class="sourceLineNo">095</span> */<a name="line.95"></a>
  104. <span class="sourceLineNo">096</span> public JFreeChart getChart() {<a name="line.96"></a>
  105. <span class="sourceLineNo">097</span> return this.chart;<a name="line.97"></a>
  106. <span class="sourceLineNo">098</span> }<a name="line.98"></a>
  107. <span class="sourceLineNo">099</span><a name="line.99"></a>
  108. <span class="sourceLineNo">100</span> /**<a name="line.100"></a>
  109. <span class="sourceLineNo">101</span> * Returns the mouse event that triggered this event.<a name="line.101"></a>
  110. <span class="sourceLineNo">102</span> *<a name="line.102"></a>
  111. <span class="sourceLineNo">103</span> * @return The event (never &lt;code&gt;null&lt;/code&gt;).<a name="line.103"></a>
  112. <span class="sourceLineNo">104</span> */<a name="line.104"></a>
  113. <span class="sourceLineNo">105</span> public MouseEvent getTrigger() {<a name="line.105"></a>
  114. <span class="sourceLineNo">106</span> return this.trigger;<a name="line.106"></a>
  115. <span class="sourceLineNo">107</span> }<a name="line.107"></a>
  116. <span class="sourceLineNo">108</span><a name="line.108"></a>
  117. <span class="sourceLineNo">109</span> /**<a name="line.109"></a>
  118. <span class="sourceLineNo">110</span> * Returns the chart entity (if any) under the mouse point.<a name="line.110"></a>
  119. <span class="sourceLineNo">111</span> *<a name="line.111"></a>
  120. <span class="sourceLineNo">112</span> * @return The chart entity (possibly &lt;code&gt;null&lt;/code&gt;).<a name="line.112"></a>
  121. <span class="sourceLineNo">113</span> */<a name="line.113"></a>
  122. <span class="sourceLineNo">114</span> public ChartEntity getEntity() {<a name="line.114"></a>
  123. <span class="sourceLineNo">115</span> return this.entity;<a name="line.115"></a>
  124. <span class="sourceLineNo">116</span> }<a name="line.116"></a>
  125. <span class="sourceLineNo">117</span><a name="line.117"></a>
  126. <span class="sourceLineNo">118</span>}<a name="line.118"></a>
  127. </pre>
  128. </div>
  129. </body>
  130. </html>