ItemLabelPosition.html 17 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432
  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:31 CEST 2014 -->
  6. <title>ItemLabelPosition (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="ItemLabelPosition (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};
  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/ItemLabelPosition.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/labels/ItemLabelAnchor.html" title="class in org.jfree.chart.labels"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
  53. <li><a href="../../../../org/jfree/chart/labels/MultipleXYSeriesLabelGenerator.html" title="class in org.jfree.chart.labels"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
  54. </ul>
  55. <ul class="navList">
  56. <li><a href="../../../../index.html?org/jfree/chart/labels/ItemLabelPosition.html" target="_top">Frames</a></li>
  57. <li><a href="ItemLabelPosition.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.labels</div>
  96. <h2 title="Class ItemLabelPosition" class="title">Class ItemLabelPosition</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.labels.ItemLabelPosition</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</dd>
  113. </dl>
  114. <hr>
  115. <br>
  116. <pre>public class <a href="../../../../src-html/org/jfree/chart/labels/ItemLabelPosition.html#line.56">ItemLabelPosition</a>
  117. extends java.lang.Object
  118. implements java.io.Serializable</pre>
  119. <div class="block">The attributes that control the position of the label for each data item on
  120. a chart. Instances of this class are immutable.</div>
  121. <dl>
  122. <dt><span class="seeLabel">See Also:</span></dt>
  123. <dd><a href="../../../../serialized-form.html#org.jfree.chart.labels.ItemLabelPosition">Serialized Form</a></dd>
  124. </dl>
  125. </li>
  126. </ul>
  127. </div>
  128. <div class="summary">
  129. <ul class="blockList">
  130. <li class="blockList">
  131. <!-- ======== CONSTRUCTOR SUMMARY ======== -->
  132. <ul class="blockList">
  133. <li class="blockList"><a name="constructor.summary">
  134. <!-- -->
  135. </a>
  136. <h3>Constructor Summary</h3>
  137. <table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Constructor Summary table, listing constructors, and an explanation">
  138. <caption><span>Constructors</span><span class="tabEnd">&nbsp;</span></caption>
  139. <tr>
  140. <th class="colOne" scope="col">Constructor and Description</th>
  141. </tr>
  142. <tr class="altColor">
  143. <td class="colOne"><code><span class="memberNameLink"><a href="../../../../org/jfree/chart/labels/ItemLabelPosition.html#ItemLabelPosition--">ItemLabelPosition</a></span>()</code>
  144. <div class="block">Creates a new position record with default settings.</div>
  145. </td>
  146. </tr>
  147. <tr class="rowColor">
  148. <td class="colOne"><code><span class="memberNameLink"><a href="../../../../org/jfree/chart/labels/ItemLabelPosition.html#ItemLabelPosition-org.jfree.chart.labels.ItemLabelAnchor-org.jfree.ui.TextAnchor-">ItemLabelPosition</a></span>(<a href="../../../../org/jfree/chart/labels/ItemLabelAnchor.html" title="class in org.jfree.chart.labels">ItemLabelAnchor</a>&nbsp;itemLabelAnchor,
  149. org.jfree.ui.TextAnchor&nbsp;textAnchor)</code>
  150. <div class="block">Creates a new position record (with zero rotation).</div>
  151. </td>
  152. </tr>
  153. <tr class="altColor">
  154. <td class="colOne"><code><span class="memberNameLink"><a href="../../../../org/jfree/chart/labels/ItemLabelPosition.html#ItemLabelPosition-org.jfree.chart.labels.ItemLabelAnchor-org.jfree.ui.TextAnchor-org.jfree.ui.TextAnchor-double-">ItemLabelPosition</a></span>(<a href="../../../../org/jfree/chart/labels/ItemLabelAnchor.html" title="class in org.jfree.chart.labels">ItemLabelAnchor</a>&nbsp;itemLabelAnchor,
  155. org.jfree.ui.TextAnchor&nbsp;textAnchor,
  156. org.jfree.ui.TextAnchor&nbsp;rotationAnchor,
  157. double&nbsp;angle)</code>
  158. <div class="block">Creates a new position record.</div>
  159. </td>
  160. </tr>
  161. </table>
  162. </li>
  163. </ul>
  164. <!-- ========== METHOD SUMMARY =========== -->
  165. <ul class="blockList">
  166. <li class="blockList"><a name="method.summary">
  167. <!-- -->
  168. </a>
  169. <h3>Method Summary</h3>
  170. <table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation">
  171. <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>
  172. <tr>
  173. <th class="colFirst" scope="col">Modifier and Type</th>
  174. <th class="colLast" scope="col">Method and Description</th>
  175. </tr>
  176. <tr id="i0" class="altColor">
  177. <td class="colFirst"><code>boolean</code></td>
  178. <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/jfree/chart/labels/ItemLabelPosition.html#equals-java.lang.Object-">equals</a></span>(java.lang.Object&nbsp;obj)</code>
  179. <div class="block">Tests this object for equality with an arbitrary object.</div>
  180. </td>
  181. </tr>
  182. <tr id="i1" class="rowColor">
  183. <td class="colFirst"><code>double</code></td>
  184. <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/jfree/chart/labels/ItemLabelPosition.html#getAngle--">getAngle</a></span>()</code>
  185. <div class="block">Returns the angle of rotation for the label.</div>
  186. </td>
  187. </tr>
  188. <tr id="i2" class="altColor">
  189. <td class="colFirst"><code><a href="../../../../org/jfree/chart/labels/ItemLabelAnchor.html" title="class in org.jfree.chart.labels">ItemLabelAnchor</a></code></td>
  190. <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/jfree/chart/labels/ItemLabelPosition.html#getItemLabelAnchor--">getItemLabelAnchor</a></span>()</code>
  191. <div class="block">Returns the item label anchor.</div>
  192. </td>
  193. </tr>
  194. <tr id="i3" class="rowColor">
  195. <td class="colFirst"><code>org.jfree.ui.TextAnchor</code></td>
  196. <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/jfree/chart/labels/ItemLabelPosition.html#getRotationAnchor--">getRotationAnchor</a></span>()</code>
  197. <div class="block">Returns the rotation anchor point.</div>
  198. </td>
  199. </tr>
  200. <tr id="i4" class="altColor">
  201. <td class="colFirst"><code>org.jfree.ui.TextAnchor</code></td>
  202. <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/jfree/chart/labels/ItemLabelPosition.html#getTextAnchor--">getTextAnchor</a></span>()</code>
  203. <div class="block">Returns the text anchor.</div>
  204. </td>
  205. </tr>
  206. </table>
  207. <ul class="blockList">
  208. <li class="blockList"><a name="methods.inherited.from.class.java.lang.Object">
  209. <!-- -->
  210. </a>
  211. <h3>Methods inherited from class&nbsp;java.lang.Object</h3>
  212. <code>clone, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait</code></li>
  213. </ul>
  214. </li>
  215. </ul>
  216. </li>
  217. </ul>
  218. </div>
  219. <div class="details">
  220. <ul class="blockList">
  221. <li class="blockList">
  222. <!-- ========= CONSTRUCTOR DETAIL ======== -->
  223. <ul class="blockList">
  224. <li class="blockList"><a name="constructor.detail">
  225. <!-- -->
  226. </a>
  227. <h3>Constructor Detail</h3>
  228. <a name="ItemLabelPosition--">
  229. <!-- -->
  230. </a>
  231. <ul class="blockList">
  232. <li class="blockList">
  233. <h4>ItemLabelPosition</h4>
  234. <pre>public&nbsp;<a href="../../../../src-html/org/jfree/chart/labels/ItemLabelPosition.html#line.76">ItemLabelPosition</a>()</pre>
  235. <div class="block">Creates a new position record with default settings.</div>
  236. </li>
  237. </ul>
  238. <a name="ItemLabelPosition-org.jfree.chart.labels.ItemLabelAnchor-org.jfree.ui.TextAnchor-">
  239. <!-- -->
  240. </a>
  241. <ul class="blockList">
  242. <li class="blockList">
  243. <h4>ItemLabelPosition</h4>
  244. <pre>public&nbsp;<a href="../../../../src-html/org/jfree/chart/labels/ItemLabelPosition.html#line.88">ItemLabelPosition</a>(<a href="../../../../org/jfree/chart/labels/ItemLabelAnchor.html" title="class in org.jfree.chart.labels">ItemLabelAnchor</a>&nbsp;itemLabelAnchor,
  245. org.jfree.ui.TextAnchor&nbsp;textAnchor)</pre>
  246. <div class="block">Creates a new position record (with zero rotation).</div>
  247. <dl>
  248. <dt><span class="paramLabel">Parameters:</span></dt>
  249. <dd><code>itemLabelAnchor</code> - the item label anchor (<code>null</code> not
  250. permitted).</dd>
  251. <dd><code>textAnchor</code> - the text anchor (<code>null</code> not permitted).</dd>
  252. </dl>
  253. </li>
  254. </ul>
  255. <a name="ItemLabelPosition-org.jfree.chart.labels.ItemLabelAnchor-org.jfree.ui.TextAnchor-org.jfree.ui.TextAnchor-double-">
  256. <!-- -->
  257. </a>
  258. <ul class="blockListLast">
  259. <li class="blockList">
  260. <h4>ItemLabelPosition</h4>
  261. <pre>public&nbsp;<a href="../../../../src-html/org/jfree/chart/labels/ItemLabelPosition.html#line.106">ItemLabelPosition</a>(<a href="../../../../org/jfree/chart/labels/ItemLabelAnchor.html" title="class in org.jfree.chart.labels">ItemLabelAnchor</a>&nbsp;itemLabelAnchor,
  262. org.jfree.ui.TextAnchor&nbsp;textAnchor,
  263. org.jfree.ui.TextAnchor&nbsp;rotationAnchor,
  264. double&nbsp;angle)</pre>
  265. <div class="block">Creates a new position record. The item label anchor is a point
  266. relative to the data item (dot, bar or other visual item) on a chart.
  267. The item label is aligned by aligning the text anchor with the
  268. item label anchor.</div>
  269. <dl>
  270. <dt><span class="paramLabel">Parameters:</span></dt>
  271. <dd><code>itemLabelAnchor</code> - the item label anchor (<code>null</code> not
  272. permitted).</dd>
  273. <dd><code>textAnchor</code> - the text anchor (<code>null</code> not permitted).</dd>
  274. <dd><code>rotationAnchor</code> - the rotation anchor (<code>null</code> not
  275. permitted).</dd>
  276. <dd><code>angle</code> - the rotation angle (in radians).</dd>
  277. </dl>
  278. </li>
  279. </ul>
  280. </li>
  281. </ul>
  282. <!-- ============ METHOD DETAIL ========== -->
  283. <ul class="blockList">
  284. <li class="blockList"><a name="method.detail">
  285. <!-- -->
  286. </a>
  287. <h3>Method Detail</h3>
  288. <a name="getItemLabelAnchor--">
  289. <!-- -->
  290. </a>
  291. <ul class="blockList">
  292. <li class="blockList">
  293. <h4>getItemLabelAnchor</h4>
  294. <pre>public&nbsp;<a href="../../../../org/jfree/chart/labels/ItemLabelAnchor.html" title="class in org.jfree.chart.labels">ItemLabelAnchor</a>&nbsp;<a href="../../../../src-html/org/jfree/chart/labels/ItemLabelPosition.html#line.123">getItemLabelAnchor</a>()</pre>
  295. <div class="block">Returns the item label anchor.</div>
  296. <dl>
  297. <dt><span class="returnLabel">Returns:</span></dt>
  298. <dd>The item label anchor (never <code>null</code>).</dd>
  299. </dl>
  300. </li>
  301. </ul>
  302. <a name="getTextAnchor--">
  303. <!-- -->
  304. </a>
  305. <ul class="blockList">
  306. <li class="blockList">
  307. <h4>getTextAnchor</h4>
  308. <pre>public&nbsp;org.jfree.ui.TextAnchor&nbsp;<a href="../../../../src-html/org/jfree/chart/labels/ItemLabelPosition.html#line.132">getTextAnchor</a>()</pre>
  309. <div class="block">Returns the text anchor.</div>
  310. <dl>
  311. <dt><span class="returnLabel">Returns:</span></dt>
  312. <dd>The text anchor (never <code>null</code>).</dd>
  313. </dl>
  314. </li>
  315. </ul>
  316. <a name="getRotationAnchor--">
  317. <!-- -->
  318. </a>
  319. <ul class="blockList">
  320. <li class="blockList">
  321. <h4>getRotationAnchor</h4>
  322. <pre>public&nbsp;org.jfree.ui.TextAnchor&nbsp;<a href="../../../../src-html/org/jfree/chart/labels/ItemLabelPosition.html#line.141">getRotationAnchor</a>()</pre>
  323. <div class="block">Returns the rotation anchor point.</div>
  324. <dl>
  325. <dt><span class="returnLabel">Returns:</span></dt>
  326. <dd>The rotation anchor point (never <code>null</code>).</dd>
  327. </dl>
  328. </li>
  329. </ul>
  330. <a name="getAngle--">
  331. <!-- -->
  332. </a>
  333. <ul class="blockList">
  334. <li class="blockList">
  335. <h4>getAngle</h4>
  336. <pre>public&nbsp;double&nbsp;<a href="../../../../src-html/org/jfree/chart/labels/ItemLabelPosition.html#line.150">getAngle</a>()</pre>
  337. <div class="block">Returns the angle of rotation for the label.</div>
  338. <dl>
  339. <dt><span class="returnLabel">Returns:</span></dt>
  340. <dd>The angle (in radians).</dd>
  341. </dl>
  342. </li>
  343. </ul>
  344. <a name="equals-java.lang.Object-">
  345. <!-- -->
  346. </a>
  347. <ul class="blockListLast">
  348. <li class="blockList">
  349. <h4>equals</h4>
  350. <pre>public&nbsp;boolean&nbsp;<a href="../../../../src-html/org/jfree/chart/labels/ItemLabelPosition.html#line.162">equals</a>(java.lang.Object&nbsp;obj)</pre>
  351. <div class="block">Tests this object for equality with an arbitrary object.</div>
  352. <dl>
  353. <dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
  354. <dd><code>equals</code>&nbsp;in class&nbsp;<code>java.lang.Object</code></dd>
  355. <dt><span class="paramLabel">Parameters:</span></dt>
  356. <dd><code>obj</code> - the object (<code>null</code> permitted).</dd>
  357. <dt><span class="returnLabel">Returns:</span></dt>
  358. <dd>A boolean.</dd>
  359. </dl>
  360. </li>
  361. </ul>
  362. </li>
  363. </ul>
  364. </li>
  365. </ul>
  366. </div>
  367. </div>
  368. <!-- ========= END OF CLASS DATA ========= -->
  369. <!-- ======= START OF BOTTOM NAVBAR ====== -->
  370. <div class="bottomNav"><a name="navbar.bottom">
  371. <!-- -->
  372. </a>
  373. <div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div>
  374. <a name="navbar.bottom.firstrow">
  375. <!-- -->
  376. </a>
  377. <ul class="navList" title="Navigation">
  378. <li><a href="../../../../overview-summary.html">Overview</a></li>
  379. <li><a href="package-summary.html">Package</a></li>
  380. <li class="navBarCell1Rev">Class</li>
  381. <li><a href="class-use/ItemLabelPosition.html">Use</a></li>
  382. <li><a href="package-tree.html">Tree</a></li>
  383. <li><a href="../../../../deprecated-list.html">Deprecated</a></li>
  384. <li><a href="../../../../index-files/index-1.html">Index</a></li>
  385. <li><a href="../../../../help-doc.html">Help</a></li>
  386. </ul>
  387. </div>
  388. <div class="subNav">
  389. <ul class="navList">
  390. <li><a href="../../../../org/jfree/chart/labels/ItemLabelAnchor.html" title="class in org.jfree.chart.labels"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
  391. <li><a href="../../../../org/jfree/chart/labels/MultipleXYSeriesLabelGenerator.html" title="class in org.jfree.chart.labels"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
  392. </ul>
  393. <ul class="navList">
  394. <li><a href="../../../../index.html?org/jfree/chart/labels/ItemLabelPosition.html" target="_top">Frames</a></li>
  395. <li><a href="ItemLabelPosition.html" target="_top">No&nbsp;Frames</a></li>
  396. </ul>
  397. <ul class="navList" id="allclasses_navbar_bottom">
  398. <li><a href="../../../../allclasses-noframe.html">All&nbsp;Classes</a></li>
  399. </ul>
  400. <div>
  401. <script type="text/javascript"><!--
  402. allClassesLink = document.getElementById("allclasses_navbar_bottom");
  403. if(window==top) {
  404. allClassesLink.style.display = "block";
  405. }
  406. else {
  407. allClassesLink.style.display = "none";
  408. }
  409. //-->
  410. </script>
  411. </div>
  412. <div>
  413. <ul class="subNavList">
  414. <li>Summary:&nbsp;</li>
  415. <li>Nested&nbsp;|&nbsp;</li>
  416. <li>Field&nbsp;|&nbsp;</li>
  417. <li><a href="#constructor.summary">Constr</a>&nbsp;|&nbsp;</li>
  418. <li><a href="#method.summary">Method</a></li>
  419. </ul>
  420. <ul class="subNavList">
  421. <li>Detail:&nbsp;</li>
  422. <li>Field&nbsp;|&nbsp;</li>
  423. <li><a href="#constructor.detail">Constr</a>&nbsp;|&nbsp;</li>
  424. <li><a href="#method.detail">Method</a></li>
  425. </ul>
  426. </div>
  427. <a name="skip.navbar.bottom">
  428. <!-- -->
  429. </a></div>
  430. <!-- ======== END OF BOTTOM NAVBAR ======= -->
  431. </body>
  432. </html>