TickUnit.html 16 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449
  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>TickUnit (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="TickUnit (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};
  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/TickUnit.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/TickType.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/TickUnits.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/TickUnit.html" target="_top">Frames</a></li>
  57. <li><a href="TickUnit.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 TickUnit" class="title">Class TickUnit</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.TickUnit</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.Comparable</dd>
  113. </dl>
  114. <dl>
  115. <dt>Direct Known Subclasses:</dt>
  116. <dd><a href="../../../../org/jfree/chart/axis/DateTickUnit.html" title="class in org.jfree.chart.axis">DateTickUnit</a>, <a href="../../../../org/jfree/chart/axis/NumberTickUnit.html" title="class in org.jfree.chart.axis">NumberTickUnit</a></dd>
  117. </dl>
  118. <hr>
  119. <br>
  120. <pre>public abstract class <a href="../../../../src-html/org/jfree/chart/axis/TickUnit.html#line.63">TickUnit</a>
  121. extends java.lang.Object
  122. implements java.lang.Comparable, java.io.Serializable</pre>
  123. <div class="block">Base class representing a tick unit. This determines the spacing of the
  124. tick marks on an axis.
  125. <P>
  126. This class (and any subclasses) should be immutable, the reason being that
  127. ORDERED collections of tick units are maintained and if one instance can be
  128. changed, it may destroy the order of the collection that it belongs to.
  129. In addition, if the implementations are immutable, they can belong to
  130. multiple collections.</div>
  131. <dl>
  132. <dt><span class="seeLabel">See Also:</span></dt>
  133. <dd><a href="../../../../org/jfree/chart/axis/ValueAxis.html" title="class in org.jfree.chart.axis"><code>ValueAxis</code></a>,
  134. <a href="../../../../serialized-form.html#org.jfree.chart.axis.TickUnit">Serialized Form</a></dd>
  135. </dl>
  136. </li>
  137. </ul>
  138. </div>
  139. <div class="summary">
  140. <ul class="blockList">
  141. <li class="blockList">
  142. <!-- ======== CONSTRUCTOR SUMMARY ======== -->
  143. <ul class="blockList">
  144. <li class="blockList"><a name="constructor.summary">
  145. <!-- -->
  146. </a>
  147. <h3>Constructor Summary</h3>
  148. <table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Constructor Summary table, listing constructors, and an explanation">
  149. <caption><span>Constructors</span><span class="tabEnd">&nbsp;</span></caption>
  150. <tr>
  151. <th class="colOne" scope="col">Constructor and Description</th>
  152. </tr>
  153. <tr class="altColor">
  154. <td class="colOne"><code><span class="memberNameLink"><a href="../../../../org/jfree/chart/axis/TickUnit.html#TickUnit-double-">TickUnit</a></span>(double&nbsp;size)</code>
  155. <div class="block">Constructs a new tick unit.</div>
  156. </td>
  157. </tr>
  158. <tr class="rowColor">
  159. <td class="colOne"><code><span class="memberNameLink"><a href="../../../../org/jfree/chart/axis/TickUnit.html#TickUnit-double-int-">TickUnit</a></span>(double&nbsp;size,
  160. int&nbsp;minorTickCount)</code>
  161. <div class="block">Constructs a new tick unit.</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>int</code></td>
  181. <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/jfree/chart/axis/TickUnit.html#compareTo-java.lang.Object-">compareTo</a></span>(java.lang.Object&nbsp;object)</code>
  182. <div class="block">Compares this tick unit to an arbitrary object.</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/axis/TickUnit.html#equals-java.lang.Object-">equals</a></span>(java.lang.Object&nbsp;obj)</code>
  188. <div class="block">Tests this unit for equality with another object.</div>
  189. </td>
  190. </tr>
  191. <tr id="i2" class="altColor">
  192. <td class="colFirst"><code>int</code></td>
  193. <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/jfree/chart/axis/TickUnit.html#getMinorTickCount--">getMinorTickCount</a></span>()</code>
  194. <div class="block">Returns the minor tick count.</div>
  195. </td>
  196. </tr>
  197. <tr id="i3" class="rowColor">
  198. <td class="colFirst"><code>double</code></td>
  199. <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/jfree/chart/axis/TickUnit.html#getSize--">getSize</a></span>()</code>
  200. <div class="block">Returns the size of the tick unit.</div>
  201. </td>
  202. </tr>
  203. <tr id="i4" class="altColor">
  204. <td class="colFirst"><code>int</code></td>
  205. <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/jfree/chart/axis/TickUnit.html#hashCode--">hashCode</a></span>()</code>
  206. <div class="block">Returns a hash code for this instance.</div>
  207. </td>
  208. </tr>
  209. <tr id="i5" class="rowColor">
  210. <td class="colFirst"><code>java.lang.String</code></td>
  211. <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/jfree/chart/axis/TickUnit.html#valueToString-double-">valueToString</a></span>(double&nbsp;value)</code>
  212. <div class="block">Converts the supplied value to a string.</div>
  213. </td>
  214. </tr>
  215. </table>
  216. <ul class="blockList">
  217. <li class="blockList"><a name="methods.inherited.from.class.java.lang.Object">
  218. <!-- -->
  219. </a>
  220. <h3>Methods inherited from class&nbsp;java.lang.Object</h3>
  221. <code>clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait</code></li>
  222. </ul>
  223. </li>
  224. </ul>
  225. </li>
  226. </ul>
  227. </div>
  228. <div class="details">
  229. <ul class="blockList">
  230. <li class="blockList">
  231. <!-- ========= CONSTRUCTOR DETAIL ======== -->
  232. <ul class="blockList">
  233. <li class="blockList"><a name="constructor.detail">
  234. <!-- -->
  235. </a>
  236. <h3>Constructor Detail</h3>
  237. <a name="TickUnit-double-">
  238. <!-- -->
  239. </a>
  240. <ul class="blockList">
  241. <li class="blockList">
  242. <h4>TickUnit</h4>
  243. <pre>public&nbsp;<a href="../../../../src-html/org/jfree/chart/axis/TickUnit.html#line.83">TickUnit</a>(double&nbsp;size)</pre>
  244. <div class="block">Constructs a new tick unit.</div>
  245. <dl>
  246. <dt><span class="paramLabel">Parameters:</span></dt>
  247. <dd><code>size</code> - the tick unit size.</dd>
  248. </dl>
  249. </li>
  250. </ul>
  251. <a name="TickUnit-double-int-">
  252. <!-- -->
  253. </a>
  254. <ul class="blockListLast">
  255. <li class="blockList">
  256. <h4>TickUnit</h4>
  257. <pre>public&nbsp;<a href="../../../../src-html/org/jfree/chart/axis/TickUnit.html#line.95">TickUnit</a>(double&nbsp;size,
  258. int&nbsp;minorTickCount)</pre>
  259. <div class="block">Constructs a new tick unit.</div>
  260. <dl>
  261. <dt><span class="paramLabel">Parameters:</span></dt>
  262. <dd><code>size</code> - the tick unit size.</dd>
  263. <dd><code>minorTickCount</code> - the minor tick count.</dd>
  264. <dt><span class="simpleTagLabel">Since:</span></dt>
  265. <dd>1.0.7</dd>
  266. </dl>
  267. </li>
  268. </ul>
  269. </li>
  270. </ul>
  271. <!-- ============ METHOD DETAIL ========== -->
  272. <ul class="blockList">
  273. <li class="blockList"><a name="method.detail">
  274. <!-- -->
  275. </a>
  276. <h3>Method Detail</h3>
  277. <a name="getSize--">
  278. <!-- -->
  279. </a>
  280. <ul class="blockList">
  281. <li class="blockList">
  282. <h4>getSize</h4>
  283. <pre>public&nbsp;double&nbsp;<a href="../../../../src-html/org/jfree/chart/axis/TickUnit.html#line.105">getSize</a>()</pre>
  284. <div class="block">Returns the size of the tick unit.</div>
  285. <dl>
  286. <dt><span class="returnLabel">Returns:</span></dt>
  287. <dd>The size of the tick unit.</dd>
  288. </dl>
  289. </li>
  290. </ul>
  291. <a name="getMinorTickCount--">
  292. <!-- -->
  293. </a>
  294. <ul class="blockList">
  295. <li class="blockList">
  296. <h4>getMinorTickCount</h4>
  297. <pre>public&nbsp;int&nbsp;<a href="../../../../src-html/org/jfree/chart/axis/TickUnit.html#line.116">getMinorTickCount</a>()</pre>
  298. <div class="block">Returns the minor tick count.</div>
  299. <dl>
  300. <dt><span class="returnLabel">Returns:</span></dt>
  301. <dd>The minor tick count.</dd>
  302. <dt><span class="simpleTagLabel">Since:</span></dt>
  303. <dd>1.0.7</dd>
  304. </dl>
  305. </li>
  306. </ul>
  307. <a name="valueToString-double-">
  308. <!-- -->
  309. </a>
  310. <ul class="blockList">
  311. <li class="blockList">
  312. <h4>valueToString</h4>
  313. <pre>public&nbsp;java.lang.String&nbsp;<a href="../../../../src-html/org/jfree/chart/axis/TickUnit.html#line.129">valueToString</a>(double&nbsp;value)</pre>
  314. <div class="block">Converts the supplied value to a string.
  315. <P>
  316. Subclasses may implement special formatting by overriding this method.</div>
  317. <dl>
  318. <dt><span class="paramLabel">Parameters:</span></dt>
  319. <dd><code>value</code> - the data value.</dd>
  320. <dt><span class="returnLabel">Returns:</span></dt>
  321. <dd>Value as string.</dd>
  322. </dl>
  323. </li>
  324. </ul>
  325. <a name="compareTo-java.lang.Object-">
  326. <!-- -->
  327. </a>
  328. <ul class="blockList">
  329. <li class="blockList">
  330. <h4>compareTo</h4>
  331. <pre>public&nbsp;int&nbsp;<a href="../../../../src-html/org/jfree/chart/axis/TickUnit.html#line.143">compareTo</a>(java.lang.Object&nbsp;object)</pre>
  332. <div class="block">Compares this tick unit to an arbitrary object.</div>
  333. <dl>
  334. <dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
  335. <dd><code>compareTo</code>&nbsp;in interface&nbsp;<code>java.lang.Comparable</code></dd>
  336. <dt><span class="paramLabel">Parameters:</span></dt>
  337. <dd><code>object</code> - the object to compare against.</dd>
  338. <dt><span class="returnLabel">Returns:</span></dt>
  339. <dd><code>1</code> if the size of the other object is less than this,
  340. <code>0</code> if both have the same size and <code>-1</code> this
  341. size is less than the others.</dd>
  342. </dl>
  343. </li>
  344. </ul>
  345. <a name="equals-java.lang.Object-">
  346. <!-- -->
  347. </a>
  348. <ul class="blockList">
  349. <li class="blockList">
  350. <h4>equals</h4>
  351. <pre>public&nbsp;boolean&nbsp;<a href="../../../../src-html/org/jfree/chart/axis/TickUnit.html#line.171">equals</a>(java.lang.Object&nbsp;obj)</pre>
  352. <div class="block">Tests this unit for equality with another object.</div>
  353. <dl>
  354. <dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
  355. <dd><code>equals</code>&nbsp;in class&nbsp;<code>java.lang.Object</code></dd>
  356. <dt><span class="paramLabel">Parameters:</span></dt>
  357. <dd><code>obj</code> - the object.</dd>
  358. <dt><span class="returnLabel">Returns:</span></dt>
  359. <dd><code>true</code> or <code>false</code>.</dd>
  360. </dl>
  361. </li>
  362. </ul>
  363. <a name="hashCode--">
  364. <!-- -->
  365. </a>
  366. <ul class="blockListLast">
  367. <li class="blockList">
  368. <h4>hashCode</h4>
  369. <pre>public&nbsp;int&nbsp;<a href="../../../../src-html/org/jfree/chart/axis/TickUnit.html#line.194">hashCode</a>()</pre>
  370. <div class="block">Returns a hash code for this instance.</div>
  371. <dl>
  372. <dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
  373. <dd><code>hashCode</code>&nbsp;in class&nbsp;<code>java.lang.Object</code></dd>
  374. <dt><span class="returnLabel">Returns:</span></dt>
  375. <dd>A hash code.</dd>
  376. </dl>
  377. </li>
  378. </ul>
  379. </li>
  380. </ul>
  381. </li>
  382. </ul>
  383. </div>
  384. </div>
  385. <!-- ========= END OF CLASS DATA ========= -->
  386. <!-- ======= START OF BOTTOM NAVBAR ====== -->
  387. <div class="bottomNav"><a name="navbar.bottom">
  388. <!-- -->
  389. </a>
  390. <div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div>
  391. <a name="navbar.bottom.firstrow">
  392. <!-- -->
  393. </a>
  394. <ul class="navList" title="Navigation">
  395. <li><a href="../../../../overview-summary.html">Overview</a></li>
  396. <li><a href="package-summary.html">Package</a></li>
  397. <li class="navBarCell1Rev">Class</li>
  398. <li><a href="class-use/TickUnit.html">Use</a></li>
  399. <li><a href="package-tree.html">Tree</a></li>
  400. <li><a href="../../../../deprecated-list.html">Deprecated</a></li>
  401. <li><a href="../../../../index-files/index-1.html">Index</a></li>
  402. <li><a href="../../../../help-doc.html">Help</a></li>
  403. </ul>
  404. </div>
  405. <div class="subNav">
  406. <ul class="navList">
  407. <li><a href="../../../../org/jfree/chart/axis/TickType.html" title="class in org.jfree.chart.axis"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
  408. <li><a href="../../../../org/jfree/chart/axis/TickUnits.html" title="class in org.jfree.chart.axis"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
  409. </ul>
  410. <ul class="navList">
  411. <li><a href="../../../../index.html?org/jfree/chart/axis/TickUnit.html" target="_top">Frames</a></li>
  412. <li><a href="TickUnit.html" target="_top">No&nbsp;Frames</a></li>
  413. </ul>
  414. <ul class="navList" id="allclasses_navbar_bottom">
  415. <li><a href="../../../../allclasses-noframe.html">All&nbsp;Classes</a></li>
  416. </ul>
  417. <div>
  418. <script type="text/javascript"><!--
  419. allClassesLink = document.getElementById("allclasses_navbar_bottom");
  420. if(window==top) {
  421. allClassesLink.style.display = "block";
  422. }
  423. else {
  424. allClassesLink.style.display = "none";
  425. }
  426. //-->
  427. </script>
  428. </div>
  429. <div>
  430. <ul class="subNavList">
  431. <li>Summary:&nbsp;</li>
  432. <li>Nested&nbsp;|&nbsp;</li>
  433. <li>Field&nbsp;|&nbsp;</li>
  434. <li><a href="#constructor.summary">Constr</a>&nbsp;|&nbsp;</li>
  435. <li><a href="#method.summary">Method</a></li>
  436. </ul>
  437. <ul class="subNavList">
  438. <li>Detail:&nbsp;</li>
  439. <li>Field&nbsp;|&nbsp;</li>
  440. <li><a href="#constructor.detail">Constr</a>&nbsp;|&nbsp;</li>
  441. <li><a href="#method.detail">Method</a></li>
  442. </ul>
  443. </div>
  444. <a name="skip.navbar.bottom">
  445. <!-- -->
  446. </a></div>
  447. <!-- ======== END OF BOTTOM NAVBAR ======= -->
  448. </body>
  449. </html>