XYDataImageAnnotation.html 32 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656
  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:27 CEST 2014 -->
  6. <title>XYDataImageAnnotation (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="XYDataImageAnnotation (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};
  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/XYDataImageAnnotation.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/annotations/XYBoxAnnotation.html" title="class in org.jfree.chart.annotations"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
  53. <li><a href="../../../../org/jfree/chart/annotations/XYDrawableAnnotation.html" title="class in org.jfree.chart.annotations"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
  54. </ul>
  55. <ul class="navList">
  56. <li><a href="../../../../index.html?org/jfree/chart/annotations/XYDataImageAnnotation.html" target="_top">Frames</a></li>
  57. <li><a href="XYDataImageAnnotation.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.annotations</div>
  96. <h2 title="Class XYDataImageAnnotation" class="title">Class XYDataImageAnnotation</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/annotations/AbstractAnnotation.html" title="class in org.jfree.chart.annotations">org.jfree.chart.annotations.AbstractAnnotation</a></li>
  104. <li>
  105. <ul class="inheritance">
  106. <li><a href="../../../../org/jfree/chart/annotations/AbstractXYAnnotation.html" title="class in org.jfree.chart.annotations">org.jfree.chart.annotations.AbstractXYAnnotation</a></li>
  107. <li>
  108. <ul class="inheritance">
  109. <li>org.jfree.chart.annotations.XYDataImageAnnotation</li>
  110. </ul>
  111. </li>
  112. </ul>
  113. </li>
  114. </ul>
  115. </li>
  116. </ul>
  117. <div class="description">
  118. <ul class="blockList">
  119. <li class="blockList">
  120. <dl>
  121. <dt>All Implemented Interfaces:</dt>
  122. <dd>java.io.Serializable, java.lang.Cloneable, <a href="../../../../org/jfree/chart/annotations/Annotation.html" title="interface in org.jfree.chart.annotations">Annotation</a>, <a href="../../../../org/jfree/chart/annotations/XYAnnotation.html" title="interface in org.jfree.chart.annotations">XYAnnotation</a>, <a href="../../../../org/jfree/chart/annotations/XYAnnotationBoundsInfo.html" title="interface in org.jfree.chart.annotations">XYAnnotationBoundsInfo</a>, org.jfree.util.PublicCloneable</dd>
  123. </dl>
  124. <hr>
  125. <br>
  126. <pre>public class <a href="../../../../src-html/org/jfree/chart/annotations/XYDataImageAnnotation.html#line.71">XYDataImageAnnotation</a>
  127. extends <a href="../../../../org/jfree/chart/annotations/AbstractXYAnnotation.html" title="class in org.jfree.chart.annotations">AbstractXYAnnotation</a>
  128. implements java.lang.Cloneable, org.jfree.util.PublicCloneable, <a href="../../../../org/jfree/chart/annotations/XYAnnotationBoundsInfo.html" title="interface in org.jfree.chart.annotations">XYAnnotationBoundsInfo</a></pre>
  129. <div class="block">An annotation that allows an image to be placed within a rectangle specified
  130. in data coordinates on an <a href="../../../../org/jfree/chart/plot/XYPlot.html" title="class in org.jfree.chart.plot"><code>XYPlot</code></a>. Note that this annotation
  131. is not currently serializable, so don't use it if you plan on serializing
  132. your chart(s).</div>
  133. <dl>
  134. <dt><span class="simpleTagLabel">Since:</span></dt>
  135. <dd>1.0.11</dd>
  136. <dt><span class="seeLabel">See Also:</span></dt>
  137. <dd><a href="../../../../serialized-form.html#org.jfree.chart.annotations.XYDataImageAnnotation">Serialized Form</a></dd>
  138. </dl>
  139. </li>
  140. </ul>
  141. </div>
  142. <div class="summary">
  143. <ul class="blockList">
  144. <li class="blockList">
  145. <!-- ======== CONSTRUCTOR SUMMARY ======== -->
  146. <ul class="blockList">
  147. <li class="blockList"><a name="constructor.summary">
  148. <!-- -->
  149. </a>
  150. <h3>Constructor Summary</h3>
  151. <table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Constructor Summary table, listing constructors, and an explanation">
  152. <caption><span>Constructors</span><span class="tabEnd">&nbsp;</span></caption>
  153. <tr>
  154. <th class="colOne" scope="col">Constructor and Description</th>
  155. </tr>
  156. <tr class="altColor">
  157. <td class="colOne"><code><span class="memberNameLink"><a href="../../../../org/jfree/chart/annotations/XYDataImageAnnotation.html#XYDataImageAnnotation-java.awt.Image-double-double-double-double-">XYDataImageAnnotation</a></span>(java.awt.Image&nbsp;image,
  158. double&nbsp;x,
  159. double&nbsp;y,
  160. double&nbsp;w,
  161. double&nbsp;h)</code>
  162. <div class="block">Creates a new annotation to be displayed within the specified rectangle.</div>
  163. </td>
  164. </tr>
  165. <tr class="rowColor">
  166. <td class="colOne"><code><span class="memberNameLink"><a href="../../../../org/jfree/chart/annotations/XYDataImageAnnotation.html#XYDataImageAnnotation-java.awt.Image-double-double-double-double-boolean-">XYDataImageAnnotation</a></span>(java.awt.Image&nbsp;image,
  167. double&nbsp;x,
  168. double&nbsp;y,
  169. double&nbsp;w,
  170. double&nbsp;h,
  171. boolean&nbsp;includeInDataBounds)</code>
  172. <div class="block">Creates a new annotation to be displayed within the specified rectangle.</div>
  173. </td>
  174. </tr>
  175. </table>
  176. </li>
  177. </ul>
  178. <!-- ========== METHOD SUMMARY =========== -->
  179. <ul class="blockList">
  180. <li class="blockList"><a name="method.summary">
  181. <!-- -->
  182. </a>
  183. <h3>Method Summary</h3>
  184. <table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation">
  185. <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>
  186. <tr>
  187. <th class="colFirst" scope="col">Modifier and Type</th>
  188. <th class="colLast" scope="col">Method and Description</th>
  189. </tr>
  190. <tr id="i0" class="altColor">
  191. <td class="colFirst"><code>java.lang.Object</code></td>
  192. <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/jfree/chart/annotations/XYDataImageAnnotation.html#clone--">clone</a></span>()</code>
  193. <div class="block">Returns a clone of the annotation.</div>
  194. </td>
  195. </tr>
  196. <tr id="i1" class="rowColor">
  197. <td class="colFirst"><code>void</code></td>
  198. <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/jfree/chart/annotations/XYDataImageAnnotation.html#draw-java.awt.Graphics2D-org.jfree.chart.plot.XYPlot-java.awt.geom.Rectangle2D-org.jfree.chart.axis.ValueAxis-org.jfree.chart.axis.ValueAxis-int-org.jfree.chart.plot.PlotRenderingInfo-">draw</a></span>(java.awt.Graphics2D&nbsp;g2,
  199. <a href="../../../../org/jfree/chart/plot/XYPlot.html" title="class in org.jfree.chart.plot">XYPlot</a>&nbsp;plot,
  200. java.awt.geom.Rectangle2D&nbsp;dataArea,
  201. <a href="../../../../org/jfree/chart/axis/ValueAxis.html" title="class in org.jfree.chart.axis">ValueAxis</a>&nbsp;domainAxis,
  202. <a href="../../../../org/jfree/chart/axis/ValueAxis.html" title="class in org.jfree.chart.axis">ValueAxis</a>&nbsp;rangeAxis,
  203. int&nbsp;rendererIndex,
  204. <a href="../../../../org/jfree/chart/plot/PlotRenderingInfo.html" title="class in org.jfree.chart.plot">PlotRenderingInfo</a>&nbsp;info)</code>
  205. <div class="block">Draws the annotation.</div>
  206. </td>
  207. </tr>
  208. <tr id="i2" class="altColor">
  209. <td class="colFirst"><code>boolean</code></td>
  210. <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/jfree/chart/annotations/XYDataImageAnnotation.html#equals-java.lang.Object-">equals</a></span>(java.lang.Object&nbsp;obj)</code>
  211. <div class="block">Tests this object for equality with an arbitrary object.</div>
  212. </td>
  213. </tr>
  214. <tr id="i3" class="rowColor">
  215. <td class="colFirst"><code>double</code></td>
  216. <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/jfree/chart/annotations/XYDataImageAnnotation.html#getHeight--">getHeight</a></span>()</code>
  217. <div class="block">Returns the height (in data space) of the data rectangle into which the
  218. image will be drawn.</div>
  219. </td>
  220. </tr>
  221. <tr id="i4" class="altColor">
  222. <td class="colFirst"><code>java.awt.Image</code></td>
  223. <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/jfree/chart/annotations/XYDataImageAnnotation.html#getImage--">getImage</a></span>()</code>
  224. <div class="block">Returns the image for the annotation.</div>
  225. </td>
  226. </tr>
  227. <tr id="i5" class="rowColor">
  228. <td class="colFirst"><code>boolean</code></td>
  229. <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/jfree/chart/annotations/XYDataImageAnnotation.html#getIncludeInDataBounds--">getIncludeInDataBounds</a></span>()</code>
  230. <div class="block">Returns the flag that controls whether or not the annotation should
  231. contribute to the autoRange for the axis it is plotted against.</div>
  232. </td>
  233. </tr>
  234. <tr id="i6" class="altColor">
  235. <td class="colFirst"><code>double</code></td>
  236. <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/jfree/chart/annotations/XYDataImageAnnotation.html#getWidth--">getWidth</a></span>()</code>
  237. <div class="block">Returns the width (in data space) of the data rectangle into which the
  238. image will be drawn.</div>
  239. </td>
  240. </tr>
  241. <tr id="i7" class="rowColor">
  242. <td class="colFirst"><code>double</code></td>
  243. <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/jfree/chart/annotations/XYDataImageAnnotation.html#getX--">getX</a></span>()</code>
  244. <div class="block">Returns the x-coordinate (in data space) for the annotation.</div>
  245. </td>
  246. </tr>
  247. <tr id="i8" class="altColor">
  248. <td class="colFirst"><code><a href="../../../../org/jfree/data/Range.html" title="class in org.jfree.data">Range</a></code></td>
  249. <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/jfree/chart/annotations/XYDataImageAnnotation.html#getXRange--">getXRange</a></span>()</code>
  250. <div class="block">Returns the x-range for the annotation.</div>
  251. </td>
  252. </tr>
  253. <tr id="i9" class="rowColor">
  254. <td class="colFirst"><code>double</code></td>
  255. <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/jfree/chart/annotations/XYDataImageAnnotation.html#getY--">getY</a></span>()</code>
  256. <div class="block">Returns the y-coordinate (in data space) for the annotation.</div>
  257. </td>
  258. </tr>
  259. <tr id="i10" class="altColor">
  260. <td class="colFirst"><code><a href="../../../../org/jfree/data/Range.html" title="class in org.jfree.data">Range</a></code></td>
  261. <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/jfree/chart/annotations/XYDataImageAnnotation.html#getYRange--">getYRange</a></span>()</code>
  262. <div class="block">Returns the y-range for the annotation.</div>
  263. </td>
  264. </tr>
  265. <tr id="i11" class="rowColor">
  266. <td class="colFirst"><code>int</code></td>
  267. <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/jfree/chart/annotations/XYDataImageAnnotation.html#hashCode--">hashCode</a></span>()</code>
  268. <div class="block">Returns a hash code for this object.</div>
  269. </td>
  270. </tr>
  271. </table>
  272. <ul class="blockList">
  273. <li class="blockList"><a name="methods.inherited.from.class.org.jfree.chart.annotations.AbstractXYAnnotation">
  274. <!-- -->
  275. </a>
  276. <h3>Methods inherited from class&nbsp;org.jfree.chart.annotations.<a href="../../../../org/jfree/chart/annotations/AbstractXYAnnotation.html" title="class in org.jfree.chart.annotations">AbstractXYAnnotation</a></h3>
  277. <code><a href="../../../../org/jfree/chart/annotations/AbstractXYAnnotation.html#addEntity-org.jfree.chart.plot.PlotRenderingInfo-java.awt.Shape-int-java.lang.String-java.lang.String-">addEntity</a>, <a href="../../../../org/jfree/chart/annotations/AbstractXYAnnotation.html#getToolTipText--">getToolTipText</a>, <a href="../../../../org/jfree/chart/annotations/AbstractXYAnnotation.html#getURL--">getURL</a>, <a href="../../../../org/jfree/chart/annotations/AbstractXYAnnotation.html#setToolTipText-java.lang.String-">setToolTipText</a>, <a href="../../../../org/jfree/chart/annotations/AbstractXYAnnotation.html#setURL-java.lang.String-">setURL</a></code></li>
  278. </ul>
  279. <ul class="blockList">
  280. <li class="blockList"><a name="methods.inherited.from.class.org.jfree.chart.annotations.AbstractAnnotation">
  281. <!-- -->
  282. </a>
  283. <h3>Methods inherited from class&nbsp;org.jfree.chart.annotations.<a href="../../../../org/jfree/chart/annotations/AbstractAnnotation.html" title="class in org.jfree.chart.annotations">AbstractAnnotation</a></h3>
  284. <code><a href="../../../../org/jfree/chart/annotations/AbstractAnnotation.html#addChangeListener-org.jfree.chart.event.AnnotationChangeListener-">addChangeListener</a>, <a href="../../../../org/jfree/chart/annotations/AbstractAnnotation.html#fireAnnotationChanged--">fireAnnotationChanged</a>, <a href="../../../../org/jfree/chart/annotations/AbstractAnnotation.html#getNotify--">getNotify</a>, <a href="../../../../org/jfree/chart/annotations/AbstractAnnotation.html#hasListener-java.util.EventListener-">hasListener</a>, <a href="../../../../org/jfree/chart/annotations/AbstractAnnotation.html#notifyListeners-org.jfree.chart.event.AnnotationChangeEvent-">notifyListeners</a>, <a href="../../../../org/jfree/chart/annotations/AbstractAnnotation.html#removeChangeListener-org.jfree.chart.event.AnnotationChangeListener-">removeChangeListener</a>, <a href="../../../../org/jfree/chart/annotations/AbstractAnnotation.html#setNotify-boolean-">setNotify</a></code></li>
  285. </ul>
  286. <ul class="blockList">
  287. <li class="blockList"><a name="methods.inherited.from.class.java.lang.Object">
  288. <!-- -->
  289. </a>
  290. <h3>Methods inherited from class&nbsp;java.lang.Object</h3>
  291. <code>finalize, getClass, notify, notifyAll, toString, wait, wait, wait</code></li>
  292. </ul>
  293. <ul class="blockList">
  294. <li class="blockList"><a name="methods.inherited.from.class.org.jfree.chart.annotations.Annotation">
  295. <!-- -->
  296. </a>
  297. <h3>Methods inherited from interface&nbsp;org.jfree.chart.annotations.<a href="../../../../org/jfree/chart/annotations/Annotation.html" title="interface in org.jfree.chart.annotations">Annotation</a></h3>
  298. <code><a href="../../../../org/jfree/chart/annotations/Annotation.html#addChangeListener-org.jfree.chart.event.AnnotationChangeListener-">addChangeListener</a>, <a href="../../../../org/jfree/chart/annotations/Annotation.html#removeChangeListener-org.jfree.chart.event.AnnotationChangeListener-">removeChangeListener</a></code></li>
  299. </ul>
  300. </li>
  301. </ul>
  302. </li>
  303. </ul>
  304. </div>
  305. <div class="details">
  306. <ul class="blockList">
  307. <li class="blockList">
  308. <!-- ========= CONSTRUCTOR DETAIL ======== -->
  309. <ul class="blockList">
  310. <li class="blockList"><a name="constructor.detail">
  311. <!-- -->
  312. </a>
  313. <h3>Constructor Detail</h3>
  314. <a name="XYDataImageAnnotation-java.awt.Image-double-double-double-double-">
  315. <!-- -->
  316. </a>
  317. <ul class="blockList">
  318. <li class="blockList">
  319. <h4>XYDataImageAnnotation</h4>
  320. <pre>public&nbsp;<a href="../../../../src-html/org/jfree/chart/annotations/XYDataImageAnnotation.html#line.114">XYDataImageAnnotation</a>(java.awt.Image&nbsp;image,
  321. double&nbsp;x,
  322. double&nbsp;y,
  323. double&nbsp;w,
  324. double&nbsp;h)</pre>
  325. <div class="block">Creates a new annotation to be displayed within the specified rectangle.</div>
  326. <dl>
  327. <dt><span class="paramLabel">Parameters:</span></dt>
  328. <dd><code>image</code> - the image (<code>null</code> not permitted).</dd>
  329. <dd><code>x</code> - the x-coordinate (in data space).</dd>
  330. <dd><code>y</code> - the y-coordinate (in data space).</dd>
  331. <dd><code>w</code> - the image display area width.</dd>
  332. <dd><code>h</code> - the image display area height.</dd>
  333. </dl>
  334. </li>
  335. </ul>
  336. <a name="XYDataImageAnnotation-java.awt.Image-double-double-double-double-boolean-">
  337. <!-- -->
  338. </a>
  339. <ul class="blockListLast">
  340. <li class="blockList">
  341. <h4>XYDataImageAnnotation</h4>
  342. <pre>public&nbsp;<a href="../../../../src-html/org/jfree/chart/annotations/XYDataImageAnnotation.html#line.132">XYDataImageAnnotation</a>(java.awt.Image&nbsp;image,
  343. double&nbsp;x,
  344. double&nbsp;y,
  345. double&nbsp;w,
  346. double&nbsp;h,
  347. boolean&nbsp;includeInDataBounds)</pre>
  348. <div class="block">Creates a new annotation to be displayed within the specified rectangle.</div>
  349. <dl>
  350. <dt><span class="paramLabel">Parameters:</span></dt>
  351. <dd><code>image</code> - the image (<code>null</code> not permitted).</dd>
  352. <dd><code>x</code> - the x-coordinate (in data space).</dd>
  353. <dd><code>y</code> - the y-coordinate (in data space).</dd>
  354. <dd><code>w</code> - the image display area width.</dd>
  355. <dd><code>h</code> - the image display area height.</dd>
  356. <dd><code>includeInDataBounds</code> - a flag that controls whether or not the
  357. annotation is included in the data bounds for the axis autoRange.</dd>
  358. <dt><span class="simpleTagLabel">Since:</span></dt>
  359. <dd>1.0.13</dd>
  360. </dl>
  361. </li>
  362. </ul>
  363. </li>
  364. </ul>
  365. <!-- ============ METHOD DETAIL ========== -->
  366. <ul class="blockList">
  367. <li class="blockList"><a name="method.detail">
  368. <!-- -->
  369. </a>
  370. <h3>Method Detail</h3>
  371. <a name="getImage--">
  372. <!-- -->
  373. </a>
  374. <ul class="blockList">
  375. <li class="blockList">
  376. <h4>getImage</h4>
  377. <pre>public&nbsp;java.awt.Image&nbsp;<a href="../../../../src-html/org/jfree/chart/annotations/XYDataImageAnnotation.html#line.150">getImage</a>()</pre>
  378. <div class="block">Returns the image for the annotation.</div>
  379. <dl>
  380. <dt><span class="returnLabel">Returns:</span></dt>
  381. <dd>The image.</dd>
  382. </dl>
  383. </li>
  384. </ul>
  385. <a name="getX--">
  386. <!-- -->
  387. </a>
  388. <ul class="blockList">
  389. <li class="blockList">
  390. <h4>getX</h4>
  391. <pre>public&nbsp;double&nbsp;<a href="../../../../src-html/org/jfree/chart/annotations/XYDataImageAnnotation.html#line.159">getX</a>()</pre>
  392. <div class="block">Returns the x-coordinate (in data space) for the annotation.</div>
  393. <dl>
  394. <dt><span class="returnLabel">Returns:</span></dt>
  395. <dd>The x-coordinate.</dd>
  396. </dl>
  397. </li>
  398. </ul>
  399. <a name="getY--">
  400. <!-- -->
  401. </a>
  402. <ul class="blockList">
  403. <li class="blockList">
  404. <h4>getY</h4>
  405. <pre>public&nbsp;double&nbsp;<a href="../../../../src-html/org/jfree/chart/annotations/XYDataImageAnnotation.html#line.168">getY</a>()</pre>
  406. <div class="block">Returns the y-coordinate (in data space) for the annotation.</div>
  407. <dl>
  408. <dt><span class="returnLabel">Returns:</span></dt>
  409. <dd>The y-coordinate.</dd>
  410. </dl>
  411. </li>
  412. </ul>
  413. <a name="getWidth--">
  414. <!-- -->
  415. </a>
  416. <ul class="blockList">
  417. <li class="blockList">
  418. <h4>getWidth</h4>
  419. <pre>public&nbsp;double&nbsp;<a href="../../../../src-html/org/jfree/chart/annotations/XYDataImageAnnotation.html#line.178">getWidth</a>()</pre>
  420. <div class="block">Returns the width (in data space) of the data rectangle into which the
  421. image will be drawn.</div>
  422. <dl>
  423. <dt><span class="returnLabel">Returns:</span></dt>
  424. <dd>The width.</dd>
  425. </dl>
  426. </li>
  427. </ul>
  428. <a name="getHeight--">
  429. <!-- -->
  430. </a>
  431. <ul class="blockList">
  432. <li class="blockList">
  433. <h4>getHeight</h4>
  434. <pre>public&nbsp;double&nbsp;<a href="../../../../src-html/org/jfree/chart/annotations/XYDataImageAnnotation.html#line.188">getHeight</a>()</pre>
  435. <div class="block">Returns the height (in data space) of the data rectangle into which the
  436. image will be drawn.</div>
  437. <dl>
  438. <dt><span class="returnLabel">Returns:</span></dt>
  439. <dd>The height.</dd>
  440. </dl>
  441. </li>
  442. </ul>
  443. <a name="getIncludeInDataBounds--">
  444. <!-- -->
  445. </a>
  446. <ul class="blockList">
  447. <li class="blockList">
  448. <h4>getIncludeInDataBounds</h4>
  449. <pre>public&nbsp;boolean&nbsp;<a href="../../../../src-html/org/jfree/chart/annotations/XYDataImageAnnotation.html#line.201">getIncludeInDataBounds</a>()</pre>
  450. <div class="block">Returns the flag that controls whether or not the annotation should
  451. contribute to the autoRange for the axis it is plotted against.</div>
  452. <dl>
  453. <dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
  454. <dd><code><a href="../../../../org/jfree/chart/annotations/XYAnnotationBoundsInfo.html#getIncludeInDataBounds--">getIncludeInDataBounds</a></code>&nbsp;in interface&nbsp;<code><a href="../../../../org/jfree/chart/annotations/XYAnnotationBoundsInfo.html" title="interface in org.jfree.chart.annotations">XYAnnotationBoundsInfo</a></code></dd>
  455. <dt><span class="returnLabel">Returns:</span></dt>
  456. <dd>A boolean.</dd>
  457. <dt><span class="simpleTagLabel">Since:</span></dt>
  458. <dd>1.0.13</dd>
  459. </dl>
  460. </li>
  461. </ul>
  462. <a name="getXRange--">
  463. <!-- -->
  464. </a>
  465. <ul class="blockList">
  466. <li class="blockList">
  467. <h4>getXRange</h4>
  468. <pre>public&nbsp;<a href="../../../../org/jfree/data/Range.html" title="class in org.jfree.data">Range</a>&nbsp;<a href="../../../../src-html/org/jfree/chart/annotations/XYDataImageAnnotation.html#line.213">getXRange</a>()</pre>
  469. <div class="block">Returns the x-range for the annotation.</div>
  470. <dl>
  471. <dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
  472. <dd><code><a href="../../../../org/jfree/chart/annotations/XYAnnotationBoundsInfo.html#getXRange--">getXRange</a></code>&nbsp;in interface&nbsp;<code><a href="../../../../org/jfree/chart/annotations/XYAnnotationBoundsInfo.html" title="interface in org.jfree.chart.annotations">XYAnnotationBoundsInfo</a></code></dd>
  473. <dt><span class="returnLabel">Returns:</span></dt>
  474. <dd>The range.</dd>
  475. <dt><span class="simpleTagLabel">Since:</span></dt>
  476. <dd>1.0.13</dd>
  477. </dl>
  478. </li>
  479. </ul>
  480. <a name="getYRange--">
  481. <!-- -->
  482. </a>
  483. <ul class="blockList">
  484. <li class="blockList">
  485. <h4>getYRange</h4>
  486. <pre>public&nbsp;<a href="../../../../org/jfree/data/Range.html" title="class in org.jfree.data">Range</a>&nbsp;<a href="../../../../src-html/org/jfree/chart/annotations/XYDataImageAnnotation.html#line.225">getYRange</a>()</pre>
  487. <div class="block">Returns the y-range for the annotation.</div>
  488. <dl>
  489. <dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
  490. <dd><code><a href="../../../../org/jfree/chart/annotations/XYAnnotationBoundsInfo.html#getYRange--">getYRange</a></code>&nbsp;in interface&nbsp;<code><a href="../../../../org/jfree/chart/annotations/XYAnnotationBoundsInfo.html" title="interface in org.jfree.chart.annotations">XYAnnotationBoundsInfo</a></code></dd>
  491. <dt><span class="returnLabel">Returns:</span></dt>
  492. <dd>The range.</dd>
  493. <dt><span class="simpleTagLabel">Since:</span></dt>
  494. <dd>1.0.13</dd>
  495. </dl>
  496. </li>
  497. </ul>
  498. <a name="draw-java.awt.Graphics2D-org.jfree.chart.plot.XYPlot-java.awt.geom.Rectangle2D-org.jfree.chart.axis.ValueAxis-org.jfree.chart.axis.ValueAxis-int-org.jfree.chart.plot.PlotRenderingInfo-">
  499. <!-- -->
  500. </a>
  501. <ul class="blockList">
  502. <li class="blockList">
  503. <h4>draw</h4>
  504. <pre>public&nbsp;void&nbsp;<a href="../../../../src-html/org/jfree/chart/annotations/XYDataImageAnnotation.html#line.244">draw</a>(java.awt.Graphics2D&nbsp;g2,
  505. <a href="../../../../org/jfree/chart/plot/XYPlot.html" title="class in org.jfree.chart.plot">XYPlot</a>&nbsp;plot,
  506. java.awt.geom.Rectangle2D&nbsp;dataArea,
  507. <a href="../../../../org/jfree/chart/axis/ValueAxis.html" title="class in org.jfree.chart.axis">ValueAxis</a>&nbsp;domainAxis,
  508. <a href="../../../../org/jfree/chart/axis/ValueAxis.html" title="class in org.jfree.chart.axis">ValueAxis</a>&nbsp;rangeAxis,
  509. int&nbsp;rendererIndex,
  510. <a href="../../../../org/jfree/chart/plot/PlotRenderingInfo.html" title="class in org.jfree.chart.plot">PlotRenderingInfo</a>&nbsp;info)</pre>
  511. <div class="block">Draws the annotation. This method is called by the drawing code in the
  512. <a href="../../../../org/jfree/chart/plot/XYPlot.html" title="class in org.jfree.chart.plot"><code>XYPlot</code></a> class, you don't normally need to call this method
  513. directly.</div>
  514. <dl>
  515. <dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
  516. <dd><code><a href="../../../../org/jfree/chart/annotations/XYAnnotation.html#draw-java.awt.Graphics2D-org.jfree.chart.plot.XYPlot-java.awt.geom.Rectangle2D-org.jfree.chart.axis.ValueAxis-org.jfree.chart.axis.ValueAxis-int-org.jfree.chart.plot.PlotRenderingInfo-">draw</a></code>&nbsp;in interface&nbsp;<code><a href="../../../../org/jfree/chart/annotations/XYAnnotation.html" title="interface in org.jfree.chart.annotations">XYAnnotation</a></code></dd>
  517. <dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
  518. <dd><code><a href="../../../../org/jfree/chart/annotations/AbstractXYAnnotation.html#draw-java.awt.Graphics2D-org.jfree.chart.plot.XYPlot-java.awt.geom.Rectangle2D-org.jfree.chart.axis.ValueAxis-org.jfree.chart.axis.ValueAxis-int-org.jfree.chart.plot.PlotRenderingInfo-">draw</a></code>&nbsp;in class&nbsp;<code><a href="../../../../org/jfree/chart/annotations/AbstractXYAnnotation.html" title="class in org.jfree.chart.annotations">AbstractXYAnnotation</a></code></dd>
  519. <dt><span class="paramLabel">Parameters:</span></dt>
  520. <dd><code>g2</code> - the graphics device.</dd>
  521. <dd><code>plot</code> - the plot.</dd>
  522. <dd><code>dataArea</code> - the data area.</dd>
  523. <dd><code>domainAxis</code> - the domain axis.</dd>
  524. <dd><code>rangeAxis</code> - the range axis.</dd>
  525. <dd><code>rendererIndex</code> - the renderer index.</dd>
  526. <dd><code>info</code> - if supplied, this info object will be populated with
  527. entity information.</dd>
  528. </dl>
  529. </li>
  530. </ul>
  531. <a name="equals-java.lang.Object-">
  532. <!-- -->
  533. </a>
  534. <ul class="blockList">
  535. <li class="blockList">
  536. <h4>equals</h4>
  537. <pre>public&nbsp;boolean&nbsp;<a href="../../../../src-html/org/jfree/chart/annotations/XYDataImageAnnotation.html#line.297">equals</a>(java.lang.Object&nbsp;obj)</pre>
  538. <div class="block">Tests this object for equality with an arbitrary object.</div>
  539. <dl>
  540. <dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
  541. <dd><code><a href="../../../../org/jfree/chart/annotations/AbstractXYAnnotation.html#equals-java.lang.Object-">equals</a></code>&nbsp;in class&nbsp;<code><a href="../../../../org/jfree/chart/annotations/AbstractXYAnnotation.html" title="class in org.jfree.chart.annotations">AbstractXYAnnotation</a></code></dd>
  542. <dt><span class="paramLabel">Parameters:</span></dt>
  543. <dd><code>obj</code> - the object (<code>null</code> permitted).</dd>
  544. <dt><span class="returnLabel">Returns:</span></dt>
  545. <dd>A boolean.</dd>
  546. </dl>
  547. </li>
  548. </ul>
  549. <a name="hashCode--">
  550. <!-- -->
  551. </a>
  552. <ul class="blockList">
  553. <li class="blockList">
  554. <h4>hashCode</h4>
  555. <pre>public&nbsp;int&nbsp;<a href="../../../../src-html/org/jfree/chart/annotations/XYDataImageAnnotation.html#line.337">hashCode</a>()</pre>
  556. <div class="block">Returns a hash code for this object.</div>
  557. <dl>
  558. <dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
  559. <dd><code><a href="../../../../org/jfree/chart/annotations/AbstractXYAnnotation.html#hashCode--">hashCode</a></code>&nbsp;in class&nbsp;<code><a href="../../../../org/jfree/chart/annotations/AbstractXYAnnotation.html" title="class in org.jfree.chart.annotations">AbstractXYAnnotation</a></code></dd>
  560. <dt><span class="returnLabel">Returns:</span></dt>
  561. <dd>A hash code.</dd>
  562. </dl>
  563. </li>
  564. </ul>
  565. <a name="clone--">
  566. <!-- -->
  567. </a>
  568. <ul class="blockListLast">
  569. <li class="blockList">
  570. <h4>clone</h4>
  571. <pre>public&nbsp;java.lang.Object&nbsp;<a href="../../../../src-html/org/jfree/chart/annotations/XYDataImageAnnotation.html#line.349">clone</a>()
  572. throws java.lang.CloneNotSupportedException</pre>
  573. <div class="block">Returns a clone of the annotation.</div>
  574. <dl>
  575. <dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
  576. <dd><code>clone</code>&nbsp;in interface&nbsp;<code>org.jfree.util.PublicCloneable</code></dd>
  577. <dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
  578. <dd><code><a href="../../../../org/jfree/chart/annotations/AbstractAnnotation.html#clone--">clone</a></code>&nbsp;in class&nbsp;<code><a href="../../../../org/jfree/chart/annotations/AbstractAnnotation.html" title="class in org.jfree.chart.annotations">AbstractAnnotation</a></code></dd>
  579. <dt><span class="returnLabel">Returns:</span></dt>
  580. <dd>A clone.</dd>
  581. <dt><span class="throwsLabel">Throws:</span></dt>
  582. <dd><code>java.lang.CloneNotSupportedException</code> - if the annotation can't be cloned.</dd>
  583. </dl>
  584. </li>
  585. </ul>
  586. </li>
  587. </ul>
  588. </li>
  589. </ul>
  590. </div>
  591. </div>
  592. <!-- ========= END OF CLASS DATA ========= -->
  593. <!-- ======= START OF BOTTOM NAVBAR ====== -->
  594. <div class="bottomNav"><a name="navbar.bottom">
  595. <!-- -->
  596. </a>
  597. <div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div>
  598. <a name="navbar.bottom.firstrow">
  599. <!-- -->
  600. </a>
  601. <ul class="navList" title="Navigation">
  602. <li><a href="../../../../overview-summary.html">Overview</a></li>
  603. <li><a href="package-summary.html">Package</a></li>
  604. <li class="navBarCell1Rev">Class</li>
  605. <li><a href="class-use/XYDataImageAnnotation.html">Use</a></li>
  606. <li><a href="package-tree.html">Tree</a></li>
  607. <li><a href="../../../../deprecated-list.html">Deprecated</a></li>
  608. <li><a href="../../../../index-files/index-1.html">Index</a></li>
  609. <li><a href="../../../../help-doc.html">Help</a></li>
  610. </ul>
  611. </div>
  612. <div class="subNav">
  613. <ul class="navList">
  614. <li><a href="../../../../org/jfree/chart/annotations/XYBoxAnnotation.html" title="class in org.jfree.chart.annotations"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
  615. <li><a href="../../../../org/jfree/chart/annotations/XYDrawableAnnotation.html" title="class in org.jfree.chart.annotations"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
  616. </ul>
  617. <ul class="navList">
  618. <li><a href="../../../../index.html?org/jfree/chart/annotations/XYDataImageAnnotation.html" target="_top">Frames</a></li>
  619. <li><a href="XYDataImageAnnotation.html" target="_top">No&nbsp;Frames</a></li>
  620. </ul>
  621. <ul class="navList" id="allclasses_navbar_bottom">
  622. <li><a href="../../../../allclasses-noframe.html">All&nbsp;Classes</a></li>
  623. </ul>
  624. <div>
  625. <script type="text/javascript"><!--
  626. allClassesLink = document.getElementById("allclasses_navbar_bottom");
  627. if(window==top) {
  628. allClassesLink.style.display = "block";
  629. }
  630. else {
  631. allClassesLink.style.display = "none";
  632. }
  633. //-->
  634. </script>
  635. </div>
  636. <div>
  637. <ul class="subNavList">
  638. <li>Summary:&nbsp;</li>
  639. <li>Nested&nbsp;|&nbsp;</li>
  640. <li>Field&nbsp;|&nbsp;</li>
  641. <li><a href="#constructor.summary">Constr</a>&nbsp;|&nbsp;</li>
  642. <li><a href="#method.summary">Method</a></li>
  643. </ul>
  644. <ul class="subNavList">
  645. <li>Detail:&nbsp;</li>
  646. <li>Field&nbsp;|&nbsp;</li>
  647. <li><a href="#constructor.detail">Constr</a>&nbsp;|&nbsp;</li>
  648. <li><a href="#method.detail">Method</a></li>
  649. </ul>
  650. </div>
  651. <a name="skip.navbar.bottom">
  652. <!-- -->
  653. </a></div>
  654. <!-- ======== END OF BOTTOM NAVBAR ======= -->
  655. </body>
  656. </html>