Tick.html 16 KB

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