ChartEntity.html 26 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626
  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>ChartEntity (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="ChartEntity (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,"i12":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/ChartEntity.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/CategoryLabelEntity.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/ContourEntity.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/ChartEntity.html" target="_top">Frames</a></li>
  57. <li><a href="ChartEntity.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 ChartEntity" class="title">Class ChartEntity</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>org.jfree.chart.entity.ChartEntity</li>
  104. </ul>
  105. </li>
  106. </ul>
  107. <div class="description">
  108. <ul class="blockList">
  109. <li class="blockList">
  110. <dl>
  111. <dt>All Implemented Interfaces:</dt>
  112. <dd>java.io.Serializable, java.lang.Cloneable, org.jfree.util.PublicCloneable</dd>
  113. </dl>
  114. <dl>
  115. <dt>Direct Known Subclasses:</dt>
  116. <dd><a href="../../../../org/jfree/chart/entity/AxisEntity.html" title="class in org.jfree.chart.entity">AxisEntity</a>, <a href="../../../../org/jfree/chart/entity/CategoryItemEntity.html" title="class in org.jfree.chart.entity">CategoryItemEntity</a>, <a href="../../../../org/jfree/chart/entity/ContourEntity.html" title="class in org.jfree.chart.entity">ContourEntity</a>, <a href="../../../../org/jfree/chart/entity/JFreeChartEntity.html" title="class in org.jfree.chart.entity">JFreeChartEntity</a>, <a href="../../../../org/jfree/chart/entity/LegendItemEntity.html" title="class in org.jfree.chart.entity">LegendItemEntity</a>, <a href="../../../../org/jfree/chart/entity/PieSectionEntity.html" title="class in org.jfree.chart.entity">PieSectionEntity</a>, <a href="../../../../org/jfree/chart/entity/PlotEntity.html" title="class in org.jfree.chart.entity">PlotEntity</a>, <a href="../../../../org/jfree/chart/entity/TickLabelEntity.html" title="class in org.jfree.chart.entity">TickLabelEntity</a>, <a href="../../../../org/jfree/chart/entity/TitleEntity.html" title="class in org.jfree.chart.entity">TitleEntity</a>, <a href="../../../../org/jfree/chart/entity/XYAnnotationEntity.html" title="class in org.jfree.chart.entity">XYAnnotationEntity</a>, <a href="../../../../org/jfree/chart/entity/XYItemEntity.html" title="class in org.jfree.chart.entity">XYItemEntity</a></dd>
  117. </dl>
  118. <hr>
  119. <br>
  120. <pre>public class <a href="../../../../src-html/org/jfree/chart/entity/ChartEntity.html#line.96">ChartEntity</a>
  121. extends java.lang.Object
  122. implements java.lang.Cloneable, org.jfree.util.PublicCloneable, java.io.Serializable</pre>
  123. <div class="block">A class that captures information about some component of a chart (a bar,
  124. line etc).</div>
  125. <dl>
  126. <dt><span class="seeLabel">See Also:</span></dt>
  127. <dd><a href="../../../../serialized-form.html#org.jfree.chart.entity.ChartEntity">Serialized Form</a></dd>
  128. </dl>
  129. </li>
  130. </ul>
  131. </div>
  132. <div class="summary">
  133. <ul class="blockList">
  134. <li class="blockList">
  135. <!-- ======== CONSTRUCTOR SUMMARY ======== -->
  136. <ul class="blockList">
  137. <li class="blockList"><a name="constructor.summary">
  138. <!-- -->
  139. </a>
  140. <h3>Constructor Summary</h3>
  141. <table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Constructor Summary table, listing constructors, and an explanation">
  142. <caption><span>Constructors</span><span class="tabEnd">&nbsp;</span></caption>
  143. <tr>
  144. <th class="colOne" scope="col">Constructor and Description</th>
  145. </tr>
  146. <tr class="altColor">
  147. <td class="colOne"><code><span class="memberNameLink"><a href="../../../../org/jfree/chart/entity/ChartEntity.html#ChartEntity-java.awt.Shape-">ChartEntity</a></span>(java.awt.Shape&nbsp;area)</code>
  148. <div class="block">Creates a new chart entity.</div>
  149. </td>
  150. </tr>
  151. <tr class="rowColor">
  152. <td class="colOne"><code><span class="memberNameLink"><a href="../../../../org/jfree/chart/entity/ChartEntity.html#ChartEntity-java.awt.Shape-java.lang.String-">ChartEntity</a></span>(java.awt.Shape&nbsp;area,
  153. java.lang.String&nbsp;toolTipText)</code>
  154. <div class="block">Creates a new chart entity.</div>
  155. </td>
  156. </tr>
  157. <tr class="altColor">
  158. <td class="colOne"><code><span class="memberNameLink"><a href="../../../../org/jfree/chart/entity/ChartEntity.html#ChartEntity-java.awt.Shape-java.lang.String-java.lang.String-">ChartEntity</a></span>(java.awt.Shape&nbsp;area,
  159. java.lang.String&nbsp;toolTipText,
  160. java.lang.String&nbsp;urlText)</code>
  161. <div class="block">Creates a new entity.</div>
  162. </td>
  163. </tr>
  164. </table>
  165. </li>
  166. </ul>
  167. <!-- ========== METHOD SUMMARY =========== -->
  168. <ul class="blockList">
  169. <li class="blockList"><a name="method.summary">
  170. <!-- -->
  171. </a>
  172. <h3>Method Summary</h3>
  173. <table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation">
  174. <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>
  175. <tr>
  176. <th class="colFirst" scope="col">Modifier and Type</th>
  177. <th class="colLast" scope="col">Method and Description</th>
  178. </tr>
  179. <tr id="i0" class="altColor">
  180. <td class="colFirst"><code>java.lang.Object</code></td>
  181. <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/jfree/chart/entity/ChartEntity.html#clone--">clone</a></span>()</code>
  182. <div class="block">Returns a clone of the entity.</div>
  183. </td>
  184. </tr>
  185. <tr id="i1" class="rowColor">
  186. <td class="colFirst"><code>boolean</code></td>
  187. <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/jfree/chart/entity/ChartEntity.html#equals-java.lang.Object-">equals</a></span>(java.lang.Object&nbsp;obj)</code>
  188. <div class="block">Tests the entity for equality with an arbitrary object.</div>
  189. </td>
  190. </tr>
  191. <tr id="i2" class="altColor">
  192. <td class="colFirst"><code>java.awt.Shape</code></td>
  193. <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/jfree/chart/entity/ChartEntity.html#getArea--">getArea</a></span>()</code>
  194. <div class="block">Returns the area occupied by the entity (in Java 2D space).</div>
  195. </td>
  196. </tr>
  197. <tr id="i3" class="rowColor">
  198. <td class="colFirst"><code>java.lang.String</code></td>
  199. <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/jfree/chart/entity/ChartEntity.html#getImageMapAreaTag-org.jfree.chart.imagemap.ToolTipTagFragmentGenerator-org.jfree.chart.imagemap.URLTagFragmentGenerator-">getImageMapAreaTag</a></span>(<a href="../../../../org/jfree/chart/imagemap/ToolTipTagFragmentGenerator.html" title="interface in org.jfree.chart.imagemap">ToolTipTagFragmentGenerator</a>&nbsp;toolTipTagFragmentGenerator,
  200. <a href="../../../../org/jfree/chart/imagemap/URLTagFragmentGenerator.html" title="interface in org.jfree.chart.imagemap">URLTagFragmentGenerator</a>&nbsp;urlTagFragmentGenerator)</code>
  201. <div class="block">Returns an HTML image map tag for this entity.</div>
  202. </td>
  203. </tr>
  204. <tr id="i4" class="altColor">
  205. <td class="colFirst"><code>java.lang.String</code></td>
  206. <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/jfree/chart/entity/ChartEntity.html#getShapeCoords--">getShapeCoords</a></span>()</code>
  207. <div class="block">Returns the shape coordinates as a string.</div>
  208. </td>
  209. </tr>
  210. <tr id="i5" class="rowColor">
  211. <td class="colFirst"><code>java.lang.String</code></td>
  212. <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/jfree/chart/entity/ChartEntity.html#getShapeType--">getShapeType</a></span>()</code>
  213. <div class="block">Returns a string describing the entity area.</div>
  214. </td>
  215. </tr>
  216. <tr id="i6" class="altColor">
  217. <td class="colFirst"><code>java.lang.String</code></td>
  218. <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/jfree/chart/entity/ChartEntity.html#getToolTipText--">getToolTipText</a></span>()</code>
  219. <div class="block">Returns the tool tip text for the entity.</div>
  220. </td>
  221. </tr>
  222. <tr id="i7" class="rowColor">
  223. <td class="colFirst"><code>java.lang.String</code></td>
  224. <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/jfree/chart/entity/ChartEntity.html#getURLText--">getURLText</a></span>()</code>
  225. <div class="block">Returns the URL text for the entity.</div>
  226. </td>
  227. </tr>
  228. <tr id="i8" class="altColor">
  229. <td class="colFirst"><code>int</code></td>
  230. <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/jfree/chart/entity/ChartEntity.html#hashCode--">hashCode</a></span>()</code>
  231. <div class="block">Returns a hash code for this instance.</div>
  232. </td>
  233. </tr>
  234. <tr id="i9" class="rowColor">
  235. <td class="colFirst"><code>void</code></td>
  236. <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/jfree/chart/entity/ChartEntity.html#setArea-java.awt.Shape-">setArea</a></span>(java.awt.Shape&nbsp;area)</code>
  237. <div class="block">Sets the area for the entity.</div>
  238. </td>
  239. </tr>
  240. <tr id="i10" class="altColor">
  241. <td class="colFirst"><code>void</code></td>
  242. <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/jfree/chart/entity/ChartEntity.html#setToolTipText-java.lang.String-">setToolTipText</a></span>(java.lang.String&nbsp;text)</code>
  243. <div class="block">Sets the tool tip text.</div>
  244. </td>
  245. </tr>
  246. <tr id="i11" class="rowColor">
  247. <td class="colFirst"><code>void</code></td>
  248. <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/jfree/chart/entity/ChartEntity.html#setURLText-java.lang.String-">setURLText</a></span>(java.lang.String&nbsp;text)</code>
  249. <div class="block">Sets the URL text.</div>
  250. </td>
  251. </tr>
  252. <tr id="i12" class="altColor">
  253. <td class="colFirst"><code>java.lang.String</code></td>
  254. <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/jfree/chart/entity/ChartEntity.html#toString--">toString</a></span>()</code>
  255. <div class="block">Returns a string representation of the chart entity, useful for
  256. debugging.</div>
  257. </td>
  258. </tr>
  259. </table>
  260. <ul class="blockList">
  261. <li class="blockList"><a name="methods.inherited.from.class.java.lang.Object">
  262. <!-- -->
  263. </a>
  264. <h3>Methods inherited from class&nbsp;java.lang.Object</h3>
  265. <code>finalize, getClass, notify, notifyAll, wait, wait, wait</code></li>
  266. </ul>
  267. </li>
  268. </ul>
  269. </li>
  270. </ul>
  271. </div>
  272. <div class="details">
  273. <ul class="blockList">
  274. <li class="blockList">
  275. <!-- ========= CONSTRUCTOR DETAIL ======== -->
  276. <ul class="blockList">
  277. <li class="blockList"><a name="constructor.detail">
  278. <!-- -->
  279. </a>
  280. <h3>Constructor Detail</h3>
  281. <a name="ChartEntity-java.awt.Shape-">
  282. <!-- -->
  283. </a>
  284. <ul class="blockList">
  285. <li class="blockList">
  286. <h4>ChartEntity</h4>
  287. <pre>public&nbsp;<a href="../../../../src-html/org/jfree/chart/entity/ChartEntity.html#line.115">ChartEntity</a>(java.awt.Shape&nbsp;area)</pre>
  288. <div class="block">Creates a new chart entity.</div>
  289. <dl>
  290. <dt><span class="paramLabel">Parameters:</span></dt>
  291. <dd><code>area</code> - the area (<code>null</code> not permitted).</dd>
  292. </dl>
  293. </li>
  294. </ul>
  295. <a name="ChartEntity-java.awt.Shape-java.lang.String-">
  296. <!-- -->
  297. </a>
  298. <ul class="blockList">
  299. <li class="blockList">
  300. <h4>ChartEntity</h4>
  301. <pre>public&nbsp;<a href="../../../../src-html/org/jfree/chart/entity/ChartEntity.html#line.126">ChartEntity</a>(java.awt.Shape&nbsp;area,
  302. java.lang.String&nbsp;toolTipText)</pre>
  303. <div class="block">Creates a new chart entity.</div>
  304. <dl>
  305. <dt><span class="paramLabel">Parameters:</span></dt>
  306. <dd><code>area</code> - the area (<code>null</code> not permitted).</dd>
  307. <dd><code>toolTipText</code> - the tool tip text (<code>null</code> permitted).</dd>
  308. </dl>
  309. </li>
  310. </ul>
  311. <a name="ChartEntity-java.awt.Shape-java.lang.String-java.lang.String-">
  312. <!-- -->
  313. </a>
  314. <ul class="blockListLast">
  315. <li class="blockList">
  316. <h4>ChartEntity</h4>
  317. <pre>public&nbsp;<a href="../../../../src-html/org/jfree/chart/entity/ChartEntity.html#line.139">ChartEntity</a>(java.awt.Shape&nbsp;area,
  318. java.lang.String&nbsp;toolTipText,
  319. java.lang.String&nbsp;urlText)</pre>
  320. <div class="block">Creates a new entity.</div>
  321. <dl>
  322. <dt><span class="paramLabel">Parameters:</span></dt>
  323. <dd><code>area</code> - the area (<code>null</code> not permitted).</dd>
  324. <dd><code>toolTipText</code> - the tool tip text (<code>null</code> permitted).</dd>
  325. <dd><code>urlText</code> - the URL text for HTML image maps (<code>null</code>
  326. permitted).</dd>
  327. </dl>
  328. </li>
  329. </ul>
  330. </li>
  331. </ul>
  332. <!-- ============ METHOD DETAIL ========== -->
  333. <ul class="blockList">
  334. <li class="blockList"><a name="method.detail">
  335. <!-- -->
  336. </a>
  337. <h3>Method Detail</h3>
  338. <a name="getArea--">
  339. <!-- -->
  340. </a>
  341. <ul class="blockList">
  342. <li class="blockList">
  343. <h4>getArea</h4>
  344. <pre>public&nbsp;java.awt.Shape&nbsp;<a href="../../../../src-html/org/jfree/chart/entity/ChartEntity.html#line.151">getArea</a>()</pre>
  345. <div class="block">Returns the area occupied by the entity (in Java 2D space).</div>
  346. <dl>
  347. <dt><span class="returnLabel">Returns:</span></dt>
  348. <dd>The area (never <code>null</code>).</dd>
  349. </dl>
  350. </li>
  351. </ul>
  352. <a name="setArea-java.awt.Shape-">
  353. <!-- -->
  354. </a>
  355. <ul class="blockList">
  356. <li class="blockList">
  357. <h4>setArea</h4>
  358. <pre>public&nbsp;void&nbsp;<a href="../../../../src-html/org/jfree/chart/entity/ChartEntity.html#line.164">setArea</a>(java.awt.Shape&nbsp;area)</pre>
  359. <div class="block">Sets the area for the entity.
  360. <P>
  361. This class conveys information about chart entities back to a client.
  362. Setting this area doesn't change the entity (which has already been
  363. drawn).</div>
  364. <dl>
  365. <dt><span class="paramLabel">Parameters:</span></dt>
  366. <dd><code>area</code> - the area (<code>null</code> not permitted).</dd>
  367. </dl>
  368. </li>
  369. </ul>
  370. <a name="getToolTipText--">
  371. <!-- -->
  372. </a>
  373. <ul class="blockList">
  374. <li class="blockList">
  375. <h4>getToolTipText</h4>
  376. <pre>public&nbsp;java.lang.String&nbsp;<a href="../../../../src-html/org/jfree/chart/entity/ChartEntity.html#line.177">getToolTipText</a>()</pre>
  377. <div class="block">Returns the tool tip text for the entity. Be aware that this text
  378. may have been generated from user supplied data, so for security
  379. reasons some form of filtering should be applied before incorporating
  380. this text into any HTML output.</div>
  381. <dl>
  382. <dt><span class="returnLabel">Returns:</span></dt>
  383. <dd>The tool tip text (possibly <code>null</code>).</dd>
  384. </dl>
  385. </li>
  386. </ul>
  387. <a name="setToolTipText-java.lang.String-">
  388. <!-- -->
  389. </a>
  390. <ul class="blockList">
  391. <li class="blockList">
  392. <h4>setToolTipText</h4>
  393. <pre>public&nbsp;void&nbsp;<a href="../../../../src-html/org/jfree/chart/entity/ChartEntity.html#line.186">setToolTipText</a>(java.lang.String&nbsp;text)</pre>
  394. <div class="block">Sets the tool tip text.</div>
  395. <dl>
  396. <dt><span class="paramLabel">Parameters:</span></dt>
  397. <dd><code>text</code> - the text (<code>null</code> permitted).</dd>
  398. </dl>
  399. </li>
  400. </ul>
  401. <a name="getURLText--">
  402. <!-- -->
  403. </a>
  404. <ul class="blockList">
  405. <li class="blockList">
  406. <h4>getURLText</h4>
  407. <pre>public&nbsp;java.lang.String&nbsp;<a href="../../../../src-html/org/jfree/chart/entity/ChartEntity.html#line.197">getURLText</a>()</pre>
  408. <div class="block">Returns the URL text for the entity. Be aware that this text
  409. may have been generated from user supplied data, so some form of
  410. filtering should be applied before this "URL" is used in any output.</div>
  411. <dl>
  412. <dt><span class="returnLabel">Returns:</span></dt>
  413. <dd>The URL text (possibly <code>null</code>).</dd>
  414. </dl>
  415. </li>
  416. </ul>
  417. <a name="setURLText-java.lang.String-">
  418. <!-- -->
  419. </a>
  420. <ul class="blockList">
  421. <li class="blockList">
  422. <h4>setURLText</h4>
  423. <pre>public&nbsp;void&nbsp;<a href="../../../../src-html/org/jfree/chart/entity/ChartEntity.html#line.206">setURLText</a>(java.lang.String&nbsp;text)</pre>
  424. <div class="block">Sets the URL text.</div>
  425. <dl>
  426. <dt><span class="paramLabel">Parameters:</span></dt>
  427. <dd><code>text</code> - the text (<code>null</code> permitted).</dd>
  428. </dl>
  429. </li>
  430. </ul>
  431. <a name="getShapeType--">
  432. <!-- -->
  433. </a>
  434. <ul class="blockList">
  435. <li class="blockList">
  436. <h4>getShapeType</h4>
  437. <pre>public&nbsp;java.lang.String&nbsp;<a href="../../../../src-html/org/jfree/chart/entity/ChartEntity.html#line.216">getShapeType</a>()</pre>
  438. <div class="block">Returns a string describing the entity area. This string is intended
  439. for use in an AREA tag when generating an image map.</div>
  440. <dl>
  441. <dt><span class="returnLabel">Returns:</span></dt>
  442. <dd>The shape type (never <code>null</code>).</dd>
  443. </dl>
  444. </li>
  445. </ul>
  446. <a name="getShapeCoords--">
  447. <!-- -->
  448. </a>
  449. <ul class="blockList">
  450. <li class="blockList">
  451. <h4>getShapeCoords</h4>
  452. <pre>public&nbsp;java.lang.String&nbsp;<a href="../../../../src-html/org/jfree/chart/entity/ChartEntity.html#line.230">getShapeCoords</a>()</pre>
  453. <div class="block">Returns the shape coordinates as a string.</div>
  454. <dl>
  455. <dt><span class="returnLabel">Returns:</span></dt>
  456. <dd>The shape coordinates (never <code>null</code>).</dd>
  457. </dl>
  458. </li>
  459. </ul>
  460. <a name="getImageMapAreaTag-org.jfree.chart.imagemap.ToolTipTagFragmentGenerator-org.jfree.chart.imagemap.URLTagFragmentGenerator-">
  461. <!-- -->
  462. </a>
  463. <ul class="blockList">
  464. <li class="blockList">
  465. <h4>getImageMapAreaTag</h4>
  466. <pre>public&nbsp;java.lang.String&nbsp;<a href="../../../../src-html/org/jfree/chart/entity/ChartEntity.html#line.309">getImageMapAreaTag</a>(<a href="../../../../org/jfree/chart/imagemap/ToolTipTagFragmentGenerator.html" title="interface in org.jfree.chart.imagemap">ToolTipTagFragmentGenerator</a>&nbsp;toolTipTagFragmentGenerator,
  467. <a href="../../../../org/jfree/chart/imagemap/URLTagFragmentGenerator.html" title="interface in org.jfree.chart.imagemap">URLTagFragmentGenerator</a>&nbsp;urlTagFragmentGenerator)</pre>
  468. <div class="block">Returns an HTML image map tag for this entity. The returned fragment
  469. should be <code>XHTML 1.0</code> compliant.</div>
  470. <dl>
  471. <dt><span class="paramLabel">Parameters:</span></dt>
  472. <dd><code>toolTipTagFragmentGenerator</code> - a generator for the HTML fragment
  473. that will contain the tooltip text (<code>null</code> not permitted
  474. if this entity contains tooltip information).</dd>
  475. <dd><code>urlTagFragmentGenerator</code> - a generator for the HTML fragment that
  476. will contain the URL reference (<code>null</code> not permitted if
  477. this entity has a URL).</dd>
  478. <dt><span class="returnLabel">Returns:</span></dt>
  479. <dd>The HTML tag.</dd>
  480. </dl>
  481. </li>
  482. </ul>
  483. <a name="toString--">
  484. <!-- -->
  485. </a>
  486. <ul class="blockList">
  487. <li class="blockList">
  488. <h4>toString</h4>
  489. <pre>public&nbsp;java.lang.String&nbsp;<a href="../../../../src-html/org/jfree/chart/entity/ChartEntity.html#line.349">toString</a>()</pre>
  490. <div class="block">Returns a string representation of the chart entity, useful for
  491. debugging.</div>
  492. <dl>
  493. <dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
  494. <dd><code>toString</code>&nbsp;in class&nbsp;<code>java.lang.Object</code></dd>
  495. <dt><span class="returnLabel">Returns:</span></dt>
  496. <dd>A string.</dd>
  497. </dl>
  498. </li>
  499. </ul>
  500. <a name="equals-java.lang.Object-">
  501. <!-- -->
  502. </a>
  503. <ul class="blockList">
  504. <li class="blockList">
  505. <h4>equals</h4>
  506. <pre>public&nbsp;boolean&nbsp;<a href="../../../../src-html/org/jfree/chart/entity/ChartEntity.html#line.364">equals</a>(java.lang.Object&nbsp;obj)</pre>
  507. <div class="block">Tests the entity for equality with an arbitrary object.</div>
  508. <dl>
  509. <dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
  510. <dd><code>equals</code>&nbsp;in class&nbsp;<code>java.lang.Object</code></dd>
  511. <dt><span class="paramLabel">Parameters:</span></dt>
  512. <dd><code>obj</code> - the object to test against (<code>null</code> permitted).</dd>
  513. <dt><span class="returnLabel">Returns:</span></dt>
  514. <dd>A boolean.</dd>
  515. </dl>
  516. </li>
  517. </ul>
  518. <a name="hashCode--">
  519. <!-- -->
  520. </a>
  521. <ul class="blockList">
  522. <li class="blockList">
  523. <h4>hashCode</h4>
  524. <pre>public&nbsp;int&nbsp;<a href="../../../../src-html/org/jfree/chart/entity/ChartEntity.html#line.390">hashCode</a>()</pre>
  525. <div class="block">Returns a hash code for this instance.</div>
  526. <dl>
  527. <dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
  528. <dd><code>hashCode</code>&nbsp;in class&nbsp;<code>java.lang.Object</code></dd>
  529. <dt><span class="returnLabel">Returns:</span></dt>
  530. <dd>A hash code.</dd>
  531. </dl>
  532. </li>
  533. </ul>
  534. <a name="clone--">
  535. <!-- -->
  536. </a>
  537. <ul class="blockListLast">
  538. <li class="blockList">
  539. <h4>clone</h4>
  540. <pre>public&nbsp;java.lang.Object&nbsp;<a href="../../../../src-html/org/jfree/chart/entity/ChartEntity.html#line.406">clone</a>()
  541. throws java.lang.CloneNotSupportedException</pre>
  542. <div class="block">Returns a clone of the entity.</div>
  543. <dl>
  544. <dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
  545. <dd><code>clone</code>&nbsp;in interface&nbsp;<code>org.jfree.util.PublicCloneable</code></dd>
  546. <dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
  547. <dd><code>clone</code>&nbsp;in class&nbsp;<code>java.lang.Object</code></dd>
  548. <dt><span class="returnLabel">Returns:</span></dt>
  549. <dd>A clone.</dd>
  550. <dt><span class="throwsLabel">Throws:</span></dt>
  551. <dd><code>java.lang.CloneNotSupportedException</code> - if there is a problem cloning the
  552. entity.</dd>
  553. </dl>
  554. </li>
  555. </ul>
  556. </li>
  557. </ul>
  558. </li>
  559. </ul>
  560. </div>
  561. </div>
  562. <!-- ========= END OF CLASS DATA ========= -->
  563. <!-- ======= START OF BOTTOM NAVBAR ====== -->
  564. <div class="bottomNav"><a name="navbar.bottom">
  565. <!-- -->
  566. </a>
  567. <div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div>
  568. <a name="navbar.bottom.firstrow">
  569. <!-- -->
  570. </a>
  571. <ul class="navList" title="Navigation">
  572. <li><a href="../../../../overview-summary.html">Overview</a></li>
  573. <li><a href="package-summary.html">Package</a></li>
  574. <li class="navBarCell1Rev">Class</li>
  575. <li><a href="class-use/ChartEntity.html">Use</a></li>
  576. <li><a href="package-tree.html">Tree</a></li>
  577. <li><a href="../../../../deprecated-list.html">Deprecated</a></li>
  578. <li><a href="../../../../index-files/index-1.html">Index</a></li>
  579. <li><a href="../../../../help-doc.html">Help</a></li>
  580. </ul>
  581. </div>
  582. <div class="subNav">
  583. <ul class="navList">
  584. <li><a href="../../../../org/jfree/chart/entity/CategoryLabelEntity.html" title="class in org.jfree.chart.entity"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
  585. <li><a href="../../../../org/jfree/chart/entity/ContourEntity.html" title="class in org.jfree.chart.entity"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
  586. </ul>
  587. <ul class="navList">
  588. <li><a href="../../../../index.html?org/jfree/chart/entity/ChartEntity.html" target="_top">Frames</a></li>
  589. <li><a href="ChartEntity.html" target="_top">No&nbsp;Frames</a></li>
  590. </ul>
  591. <ul class="navList" id="allclasses_navbar_bottom">
  592. <li><a href="../../../../allclasses-noframe.html">All&nbsp;Classes</a></li>
  593. </ul>
  594. <div>
  595. <script type="text/javascript"><!--
  596. allClassesLink = document.getElementById("allclasses_navbar_bottom");
  597. if(window==top) {
  598. allClassesLink.style.display = "block";
  599. }
  600. else {
  601. allClassesLink.style.display = "none";
  602. }
  603. //-->
  604. </script>
  605. </div>
  606. <div>
  607. <ul class="subNavList">
  608. <li>Summary:&nbsp;</li>
  609. <li>Nested&nbsp;|&nbsp;</li>
  610. <li>Field&nbsp;|&nbsp;</li>
  611. <li><a href="#constructor.summary">Constr</a>&nbsp;|&nbsp;</li>
  612. <li><a href="#method.summary">Method</a></li>
  613. </ul>
  614. <ul class="subNavList">
  615. <li>Detail:&nbsp;</li>
  616. <li>Field&nbsp;|&nbsp;</li>
  617. <li><a href="#constructor.detail">Constr</a>&nbsp;|&nbsp;</li>
  618. <li><a href="#method.detail">Method</a></li>
  619. </ul>
  620. </div>
  621. <a name="skip.navbar.bottom">
  622. <!-- -->
  623. </a></div>
  624. <!-- ======== END OF BOTTOM NAVBAR ======= -->
  625. </body>
  626. </html>