XYAnnotationEntity.html 15 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361
  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:30 CEST 2014 -->
  6. <title>XYAnnotationEntity (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="XYAnnotationEntity (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/XYAnnotationEntity.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/entity/TitleEntity.html" title="class in org.jfree.chart.entity"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
  53. <li><a href="../../../../org/jfree/chart/entity/XYItemEntity.html" title="class in org.jfree.chart.entity"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
  54. </ul>
  55. <ul class="navList">
  56. <li><a href="../../../../index.html?org/jfree/chart/entity/XYAnnotationEntity.html" target="_top">Frames</a></li>
  57. <li><a href="XYAnnotationEntity.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.entity</div>
  96. <h2 title="Class XYAnnotationEntity" class="title">Class XYAnnotationEntity</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/entity/ChartEntity.html" title="class in org.jfree.chart.entity">org.jfree.chart.entity.ChartEntity</a></li>
  104. <li>
  105. <ul class="inheritance">
  106. <li>org.jfree.chart.entity.XYAnnotationEntity</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, java.lang.Cloneable, org.jfree.util.PublicCloneable</dd>
  118. </dl>
  119. <hr>
  120. <br>
  121. <pre>public class <a href="../../../../src-html/org/jfree/chart/entity/XYAnnotationEntity.html#line.50">XYAnnotationEntity</a>
  122. extends <a href="../../../../org/jfree/chart/entity/ChartEntity.html" title="class in org.jfree.chart.entity">ChartEntity</a>
  123. implements java.io.Serializable</pre>
  124. <div class="block">A chart entity that represents an annotation on an
  125. <a href="../../../../org/jfree/chart/plot/XYPlot.html" title="class in org.jfree.chart.plot"><code>XYPlot</code></a>.</div>
  126. <dl>
  127. <dt><span class="seeLabel">See Also:</span></dt>
  128. <dd><a href="../../../../serialized-form.html#org.jfree.chart.entity.XYAnnotationEntity">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. <!-- ======== CONSTRUCTOR SUMMARY ======== -->
  137. <ul class="blockList">
  138. <li class="blockList"><a name="constructor.summary">
  139. <!-- -->
  140. </a>
  141. <h3>Constructor Summary</h3>
  142. <table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Constructor Summary table, listing constructors, and an explanation">
  143. <caption><span>Constructors</span><span class="tabEnd">&nbsp;</span></caption>
  144. <tr>
  145. <th class="colOne" scope="col">Constructor and Description</th>
  146. </tr>
  147. <tr class="altColor">
  148. <td class="colOne"><code><span class="memberNameLink"><a href="../../../../org/jfree/chart/entity/XYAnnotationEntity.html#XYAnnotationEntity-java.awt.Shape-int-java.lang.String-java.lang.String-">XYAnnotationEntity</a></span>(java.awt.Shape&nbsp;hotspot,
  149. int&nbsp;rendererIndex,
  150. java.lang.String&nbsp;toolTipText,
  151. java.lang.String&nbsp;urlText)</code>
  152. <div class="block">Creates a new entity.</div>
  153. </td>
  154. </tr>
  155. </table>
  156. </li>
  157. </ul>
  158. <!-- ========== METHOD SUMMARY =========== -->
  159. <ul class="blockList">
  160. <li class="blockList"><a name="method.summary">
  161. <!-- -->
  162. </a>
  163. <h3>Method Summary</h3>
  164. <table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation">
  165. <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>
  166. <tr>
  167. <th class="colFirst" scope="col">Modifier and Type</th>
  168. <th class="colLast" scope="col">Method and Description</th>
  169. </tr>
  170. <tr id="i0" class="altColor">
  171. <td class="colFirst"><code>boolean</code></td>
  172. <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/jfree/chart/entity/XYAnnotationEntity.html#equals-java.lang.Object-">equals</a></span>(java.lang.Object&nbsp;obj)</code>
  173. <div class="block">Tests the entity for equality with an arbitrary object.</div>
  174. </td>
  175. </tr>
  176. <tr id="i1" class="rowColor">
  177. <td class="colFirst"><code>int</code></td>
  178. <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/jfree/chart/entity/XYAnnotationEntity.html#getRendererIndex--">getRendererIndex</a></span>()</code>
  179. <div class="block">Returns the renderer index.</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/entity/XYAnnotationEntity.html#setRendererIndex-int-">setRendererIndex</a></span>(int&nbsp;index)</code>
  185. <div class="block">Sets the renderer index.</div>
  186. </td>
  187. </tr>
  188. </table>
  189. <ul class="blockList">
  190. <li class="blockList"><a name="methods.inherited.from.class.org.jfree.chart.entity.ChartEntity">
  191. <!-- -->
  192. </a>
  193. <h3>Methods inherited from class&nbsp;org.jfree.chart.entity.<a href="../../../../org/jfree/chart/entity/ChartEntity.html" title="class in org.jfree.chart.entity">ChartEntity</a></h3>
  194. <code><a href="../../../../org/jfree/chart/entity/ChartEntity.html#clone--">clone</a>, <a href="../../../../org/jfree/chart/entity/ChartEntity.html#getArea--">getArea</a>, <a href="../../../../org/jfree/chart/entity/ChartEntity.html#getImageMapAreaTag-org.jfree.chart.imagemap.ToolTipTagFragmentGenerator-org.jfree.chart.imagemap.URLTagFragmentGenerator-">getImageMapAreaTag</a>, <a href="../../../../org/jfree/chart/entity/ChartEntity.html#getShapeCoords--">getShapeCoords</a>, <a href="../../../../org/jfree/chart/entity/ChartEntity.html#getShapeType--">getShapeType</a>, <a href="../../../../org/jfree/chart/entity/ChartEntity.html#getToolTipText--">getToolTipText</a>, <a href="../../../../org/jfree/chart/entity/ChartEntity.html#getURLText--">getURLText</a>, <a href="../../../../org/jfree/chart/entity/ChartEntity.html#hashCode--">hashCode</a>, <a href="../../../../org/jfree/chart/entity/ChartEntity.html#setArea-java.awt.Shape-">setArea</a>, <a href="../../../../org/jfree/chart/entity/ChartEntity.html#setToolTipText-java.lang.String-">setToolTipText</a>, <a href="../../../../org/jfree/chart/entity/ChartEntity.html#setURLText-java.lang.String-">setURLText</a>, <a href="../../../../org/jfree/chart/entity/ChartEntity.html#toString--">toString</a></code></li>
  195. </ul>
  196. <ul class="blockList">
  197. <li class="blockList"><a name="methods.inherited.from.class.java.lang.Object">
  198. <!-- -->
  199. </a>
  200. <h3>Methods inherited from class&nbsp;java.lang.Object</h3>
  201. <code>finalize, getClass, notify, notifyAll, wait, wait, wait</code></li>
  202. </ul>
  203. </li>
  204. </ul>
  205. </li>
  206. </ul>
  207. </div>
  208. <div class="details">
  209. <ul class="blockList">
  210. <li class="blockList">
  211. <!-- ========= CONSTRUCTOR DETAIL ======== -->
  212. <ul class="blockList">
  213. <li class="blockList"><a name="constructor.detail">
  214. <!-- -->
  215. </a>
  216. <h3>Constructor Detail</h3>
  217. <a name="XYAnnotationEntity-java.awt.Shape-int-java.lang.String-java.lang.String-">
  218. <!-- -->
  219. </a>
  220. <ul class="blockListLast">
  221. <li class="blockList">
  222. <h4>XYAnnotationEntity</h4>
  223. <pre>public&nbsp;<a href="../../../../src-html/org/jfree/chart/entity/XYAnnotationEntity.html#line.67">XYAnnotationEntity</a>(java.awt.Shape&nbsp;hotspot,
  224. int&nbsp;rendererIndex,
  225. java.lang.String&nbsp;toolTipText,
  226. java.lang.String&nbsp;urlText)</pre>
  227. <div class="block">Creates a new entity.</div>
  228. <dl>
  229. <dt><span class="paramLabel">Parameters:</span></dt>
  230. <dd><code>hotspot</code> - the area.</dd>
  231. <dd><code>rendererIndex</code> - the rendererIndex (zero-based index).</dd>
  232. <dd><code>toolTipText</code> - the tool tip text.</dd>
  233. <dd><code>urlText</code> - the URL text for HTML image maps.</dd>
  234. </dl>
  235. </li>
  236. </ul>
  237. </li>
  238. </ul>
  239. <!-- ============ METHOD DETAIL ========== -->
  240. <ul class="blockList">
  241. <li class="blockList"><a name="method.detail">
  242. <!-- -->
  243. </a>
  244. <h3>Method Detail</h3>
  245. <a name="getRendererIndex--">
  246. <!-- -->
  247. </a>
  248. <ul class="blockList">
  249. <li class="blockList">
  250. <h4>getRendererIndex</h4>
  251. <pre>public&nbsp;int&nbsp;<a href="../../../../src-html/org/jfree/chart/entity/XYAnnotationEntity.html#line.78">getRendererIndex</a>()</pre>
  252. <div class="block">Returns the renderer index.</div>
  253. <dl>
  254. <dt><span class="returnLabel">Returns:</span></dt>
  255. <dd>The renderer index.</dd>
  256. </dl>
  257. </li>
  258. </ul>
  259. <a name="setRendererIndex-int-">
  260. <!-- -->
  261. </a>
  262. <ul class="blockList">
  263. <li class="blockList">
  264. <h4>setRendererIndex</h4>
  265. <pre>public&nbsp;void&nbsp;<a href="../../../../src-html/org/jfree/chart/entity/XYAnnotationEntity.html#line.87">setRendererIndex</a>(int&nbsp;index)</pre>
  266. <div class="block">Sets the renderer index.</div>
  267. <dl>
  268. <dt><span class="paramLabel">Parameters:</span></dt>
  269. <dd><code>index</code> - the item index (zero-based).</dd>
  270. </dl>
  271. </li>
  272. </ul>
  273. <a name="equals-java.lang.Object-">
  274. <!-- -->
  275. </a>
  276. <ul class="blockListLast">
  277. <li class="blockList">
  278. <h4>equals</h4>
  279. <pre>public&nbsp;boolean&nbsp;<a href="../../../../src-html/org/jfree/chart/entity/XYAnnotationEntity.html#line.99">equals</a>(java.lang.Object&nbsp;obj)</pre>
  280. <div class="block">Tests the entity for equality with an arbitrary object.</div>
  281. <dl>
  282. <dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
  283. <dd><code><a href="../../../../org/jfree/chart/entity/ChartEntity.html#equals-java.lang.Object-">equals</a></code>&nbsp;in class&nbsp;<code><a href="../../../../org/jfree/chart/entity/ChartEntity.html" title="class in org.jfree.chart.entity">ChartEntity</a></code></dd>
  284. <dt><span class="paramLabel">Parameters:</span></dt>
  285. <dd><code>obj</code> - the object (<code>null</code> permitted).</dd>
  286. <dt><span class="returnLabel">Returns:</span></dt>
  287. <dd>A boolean.</dd>
  288. </dl>
  289. </li>
  290. </ul>
  291. </li>
  292. </ul>
  293. </li>
  294. </ul>
  295. </div>
  296. </div>
  297. <!-- ========= END OF CLASS DATA ========= -->
  298. <!-- ======= START OF BOTTOM NAVBAR ====== -->
  299. <div class="bottomNav"><a name="navbar.bottom">
  300. <!-- -->
  301. </a>
  302. <div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div>
  303. <a name="navbar.bottom.firstrow">
  304. <!-- -->
  305. </a>
  306. <ul class="navList" title="Navigation">
  307. <li><a href="../../../../overview-summary.html">Overview</a></li>
  308. <li><a href="package-summary.html">Package</a></li>
  309. <li class="navBarCell1Rev">Class</li>
  310. <li><a href="class-use/XYAnnotationEntity.html">Use</a></li>
  311. <li><a href="package-tree.html">Tree</a></li>
  312. <li><a href="../../../../deprecated-list.html">Deprecated</a></li>
  313. <li><a href="../../../../index-files/index-1.html">Index</a></li>
  314. <li><a href="../../../../help-doc.html">Help</a></li>
  315. </ul>
  316. </div>
  317. <div class="subNav">
  318. <ul class="navList">
  319. <li><a href="../../../../org/jfree/chart/entity/TitleEntity.html" title="class in org.jfree.chart.entity"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
  320. <li><a href="../../../../org/jfree/chart/entity/XYItemEntity.html" title="class in org.jfree.chart.entity"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
  321. </ul>
  322. <ul class="navList">
  323. <li><a href="../../../../index.html?org/jfree/chart/entity/XYAnnotationEntity.html" target="_top">Frames</a></li>
  324. <li><a href="XYAnnotationEntity.html" target="_top">No&nbsp;Frames</a></li>
  325. </ul>
  326. <ul class="navList" id="allclasses_navbar_bottom">
  327. <li><a href="../../../../allclasses-noframe.html">All&nbsp;Classes</a></li>
  328. </ul>
  329. <div>
  330. <script type="text/javascript"><!--
  331. allClassesLink = document.getElementById("allclasses_navbar_bottom");
  332. if(window==top) {
  333. allClassesLink.style.display = "block";
  334. }
  335. else {
  336. allClassesLink.style.display = "none";
  337. }
  338. //-->
  339. </script>
  340. </div>
  341. <div>
  342. <ul class="subNavList">
  343. <li>Summary:&nbsp;</li>
  344. <li>Nested&nbsp;|&nbsp;</li>
  345. <li>Field&nbsp;|&nbsp;</li>
  346. <li><a href="#constructor.summary">Constr</a>&nbsp;|&nbsp;</li>
  347. <li><a href="#method.summary">Method</a></li>
  348. </ul>
  349. <ul class="subNavList">
  350. <li>Detail:&nbsp;</li>
  351. <li>Field&nbsp;|&nbsp;</li>
  352. <li><a href="#constructor.detail">Constr</a>&nbsp;|&nbsp;</li>
  353. <li><a href="#method.detail">Method</a></li>
  354. </ul>
  355. </div>
  356. <a name="skip.navbar.bottom">
  357. <!-- -->
  358. </a></div>
  359. <!-- ======== END OF BOTTOM NAVBAR ======= -->
  360. </body>
  361. </html>