NumberTickUnit.html 17 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430
  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>NumberTickUnit (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="NumberTickUnit (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};
  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/NumberTickUnit.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/NumberTick.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/NumberTickUnitSource.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/NumberTickUnit.html" target="_top">Frames</a></li>
  57. <li><a href="NumberTickUnit.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 NumberTickUnit" class="title">Class NumberTickUnit</h2>
  97. </div>
  98. <div class="contentContainer">
  99. <ul class="inheritance">
  100. <li>java.lang.Object</li>
  101. <li>
  102. <ul class="inheritance">
  103. <li><a href="../../../../org/jfree/chart/axis/TickUnit.html" title="class in org.jfree.chart.axis">org.jfree.chart.axis.TickUnit</a></li>
  104. <li>
  105. <ul class="inheritance">
  106. <li>org.jfree.chart.axis.NumberTickUnit</li>
  107. </ul>
  108. </li>
  109. </ul>
  110. </li>
  111. </ul>
  112. <div class="description">
  113. <ul class="blockList">
  114. <li class="blockList">
  115. <dl>
  116. <dt>All Implemented Interfaces:</dt>
  117. <dd>java.io.Serializable, java.lang.Comparable</dd>
  118. </dl>
  119. <hr>
  120. <br>
  121. <pre>public class <a href="../../../../src-html/org/jfree/chart/axis/NumberTickUnit.html#line.59">NumberTickUnit</a>
  122. extends <a href="../../../../org/jfree/chart/axis/TickUnit.html" title="class in org.jfree.chart.axis">TickUnit</a>
  123. implements java.io.Serializable</pre>
  124. <div class="block">A numerical tick unit.</div>
  125. <dl>
  126. <dt><span class="seeLabel">See Also:</span></dt>
  127. <dd><a href="../../../../serialized-form.html#org.jfree.chart.axis.NumberTickUnit">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/axis/NumberTickUnit.html#NumberTickUnit-double-">NumberTickUnit</a></span>(double&nbsp;size)</code>
  148. <div class="block">Creates a new number tick unit.</div>
  149. </td>
  150. </tr>
  151. <tr class="rowColor">
  152. <td class="colOne"><code><span class="memberNameLink"><a href="../../../../org/jfree/chart/axis/NumberTickUnit.html#NumberTickUnit-double-java.text.NumberFormat-">NumberTickUnit</a></span>(double&nbsp;size,
  153. java.text.NumberFormat&nbsp;formatter)</code>
  154. <div class="block">Creates a new number tick unit.</div>
  155. </td>
  156. </tr>
  157. <tr class="altColor">
  158. <td class="colOne"><code><span class="memberNameLink"><a href="../../../../org/jfree/chart/axis/NumberTickUnit.html#NumberTickUnit-double-java.text.NumberFormat-int-">NumberTickUnit</a></span>(double&nbsp;size,
  159. java.text.NumberFormat&nbsp;formatter,
  160. int&nbsp;minorTickCount)</code>
  161. <div class="block">Creates a new number 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>boolean</code></td>
  181. <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/jfree/chart/axis/NumberTickUnit.html#equals-java.lang.Object-">equals</a></span>(java.lang.Object&nbsp;obj)</code>
  182. <div class="block">Tests this formatter for equality with an arbitrary object.</div>
  183. </td>
  184. </tr>
  185. <tr id="i1" class="rowColor">
  186. <td class="colFirst"><code>int</code></td>
  187. <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/jfree/chart/axis/NumberTickUnit.html#hashCode--">hashCode</a></span>()</code>
  188. <div class="block">Returns a hash code for this instance.</div>
  189. </td>
  190. </tr>
  191. <tr id="i2" class="altColor">
  192. <td class="colFirst"><code>java.lang.String</code></td>
  193. <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/jfree/chart/axis/NumberTickUnit.html#toString--">toString</a></span>()</code>
  194. <div class="block">Returns a string representing this unit.</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/axis/NumberTickUnit.html#valueToString-double-">valueToString</a></span>(double&nbsp;value)</code>
  200. <div class="block">Converts a value to a string.</div>
  201. </td>
  202. </tr>
  203. </table>
  204. <ul class="blockList">
  205. <li class="blockList"><a name="methods.inherited.from.class.org.jfree.chart.axis.TickUnit">
  206. <!-- -->
  207. </a>
  208. <h3>Methods inherited from class&nbsp;org.jfree.chart.axis.<a href="../../../../org/jfree/chart/axis/TickUnit.html" title="class in org.jfree.chart.axis">TickUnit</a></h3>
  209. <code><a href="../../../../org/jfree/chart/axis/TickUnit.html#compareTo-java.lang.Object-">compareTo</a>, <a href="../../../../org/jfree/chart/axis/TickUnit.html#getMinorTickCount--">getMinorTickCount</a>, <a href="../../../../org/jfree/chart/axis/TickUnit.html#getSize--">getSize</a></code></li>
  210. </ul>
  211. <ul class="blockList">
  212. <li class="blockList"><a name="methods.inherited.from.class.java.lang.Object">
  213. <!-- -->
  214. </a>
  215. <h3>Methods inherited from class&nbsp;java.lang.Object</h3>
  216. <code>clone, finalize, getClass, notify, notifyAll, wait, wait, wait</code></li>
  217. </ul>
  218. </li>
  219. </ul>
  220. </li>
  221. </ul>
  222. </div>
  223. <div class="details">
  224. <ul class="blockList">
  225. <li class="blockList">
  226. <!-- ========= CONSTRUCTOR DETAIL ======== -->
  227. <ul class="blockList">
  228. <li class="blockList"><a name="constructor.detail">
  229. <!-- -->
  230. </a>
  231. <h3>Constructor Detail</h3>
  232. <a name="NumberTickUnit-double-">
  233. <!-- -->
  234. </a>
  235. <ul class="blockList">
  236. <li class="blockList">
  237. <h4>NumberTickUnit</h4>
  238. <pre>public&nbsp;<a href="../../../../src-html/org/jfree/chart/axis/NumberTickUnit.html#line.72">NumberTickUnit</a>(double&nbsp;size)</pre>
  239. <div class="block">Creates a new number tick unit.</div>
  240. <dl>
  241. <dt><span class="paramLabel">Parameters:</span></dt>
  242. <dd><code>size</code> - the size of the tick unit.</dd>
  243. </dl>
  244. </li>
  245. </ul>
  246. <a name="NumberTickUnit-double-java.text.NumberFormat-">
  247. <!-- -->
  248. </a>
  249. <ul class="blockList">
  250. <li class="blockList">
  251. <h4>NumberTickUnit</h4>
  252. <pre>public&nbsp;<a href="../../../../src-html/org/jfree/chart/axis/NumberTickUnit.html#line.83">NumberTickUnit</a>(double&nbsp;size,
  253. java.text.NumberFormat&nbsp;formatter)</pre>
  254. <div class="block">Creates a new number tick unit.</div>
  255. <dl>
  256. <dt><span class="paramLabel">Parameters:</span></dt>
  257. <dd><code>size</code> - the size of the tick unit.</dd>
  258. <dd><code>formatter</code> - a number formatter for the tick unit (<code>null</code>
  259. not permitted).</dd>
  260. </dl>
  261. </li>
  262. </ul>
  263. <a name="NumberTickUnit-double-java.text.NumberFormat-int-">
  264. <!-- -->
  265. </a>
  266. <ul class="blockListLast">
  267. <li class="blockList">
  268. <h4>NumberTickUnit</h4>
  269. <pre>public&nbsp;<a href="../../../../src-html/org/jfree/chart/axis/NumberTickUnit.html#line.99">NumberTickUnit</a>(double&nbsp;size,
  270. java.text.NumberFormat&nbsp;formatter,
  271. int&nbsp;minorTickCount)</pre>
  272. <div class="block">Creates a new number tick unit.</div>
  273. <dl>
  274. <dt><span class="paramLabel">Parameters:</span></dt>
  275. <dd><code>size</code> - the size of the tick unit.</dd>
  276. <dd><code>formatter</code> - a number formatter for the tick unit (<code>null</code>
  277. not permitted).</dd>
  278. <dd><code>minorTickCount</code> - the number of minor ticks.</dd>
  279. <dt><span class="simpleTagLabel">Since:</span></dt>
  280. <dd>1.0.7</dd>
  281. </dl>
  282. </li>
  283. </ul>
  284. </li>
  285. </ul>
  286. <!-- ============ METHOD DETAIL ========== -->
  287. <ul class="blockList">
  288. <li class="blockList"><a name="method.detail">
  289. <!-- -->
  290. </a>
  291. <h3>Method Detail</h3>
  292. <a name="valueToString-double-">
  293. <!-- -->
  294. </a>
  295. <ul class="blockList">
  296. <li class="blockList">
  297. <h4>valueToString</h4>
  298. <pre>public&nbsp;java.lang.String&nbsp;<a href="../../../../src-html/org/jfree/chart/axis/NumberTickUnit.html#line.114">valueToString</a>(double&nbsp;value)</pre>
  299. <div class="block">Converts a value to a string.</div>
  300. <dl>
  301. <dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
  302. <dd><code><a href="../../../../org/jfree/chart/axis/TickUnit.html#valueToString-double-">valueToString</a></code>&nbsp;in class&nbsp;<code><a href="../../../../org/jfree/chart/axis/TickUnit.html" title="class in org.jfree.chart.axis">TickUnit</a></code></dd>
  303. <dt><span class="paramLabel">Parameters:</span></dt>
  304. <dd><code>value</code> - the value.</dd>
  305. <dt><span class="returnLabel">Returns:</span></dt>
  306. <dd>The formatted string.</dd>
  307. </dl>
  308. </li>
  309. </ul>
  310. <a name="equals-java.lang.Object-">
  311. <!-- -->
  312. </a>
  313. <ul class="blockList">
  314. <li class="blockList">
  315. <h4>equals</h4>
  316. <pre>public&nbsp;boolean&nbsp;<a href="../../../../src-html/org/jfree/chart/axis/NumberTickUnit.html#line.126">equals</a>(java.lang.Object&nbsp;obj)</pre>
  317. <div class="block">Tests this formatter for equality with an arbitrary object.</div>
  318. <dl>
  319. <dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
  320. <dd><code><a href="../../../../org/jfree/chart/axis/TickUnit.html#equals-java.lang.Object-">equals</a></code>&nbsp;in class&nbsp;<code><a href="../../../../org/jfree/chart/axis/TickUnit.html" title="class in org.jfree.chart.axis">TickUnit</a></code></dd>
  321. <dt><span class="paramLabel">Parameters:</span></dt>
  322. <dd><code>obj</code> - the object (<code>null</code> permitted).</dd>
  323. <dt><span class="returnLabel">Returns:</span></dt>
  324. <dd>A boolean.</dd>
  325. </dl>
  326. </li>
  327. </ul>
  328. <a name="toString--">
  329. <!-- -->
  330. </a>
  331. <ul class="blockList">
  332. <li class="blockList">
  333. <h4>toString</h4>
  334. <pre>public&nbsp;java.lang.String&nbsp;<a href="../../../../src-html/org/jfree/chart/axis/NumberTickUnit.html#line.149">toString</a>()</pre>
  335. <div class="block">Returns a string representing this unit.</div>
  336. <dl>
  337. <dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
  338. <dd><code>toString</code>&nbsp;in class&nbsp;<code>java.lang.Object</code></dd>
  339. <dt><span class="returnLabel">Returns:</span></dt>
  340. <dd>A string.</dd>
  341. </dl>
  342. </li>
  343. </ul>
  344. <a name="hashCode--">
  345. <!-- -->
  346. </a>
  347. <ul class="blockListLast">
  348. <li class="blockList">
  349. <h4>hashCode</h4>
  350. <pre>public&nbsp;int&nbsp;<a href="../../../../src-html/org/jfree/chart/axis/NumberTickUnit.html#line.159">hashCode</a>()</pre>
  351. <div class="block">Returns a hash code for this instance.</div>
  352. <dl>
  353. <dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
  354. <dd><code><a href="../../../../org/jfree/chart/axis/TickUnit.html#hashCode--">hashCode</a></code>&nbsp;in class&nbsp;<code><a href="../../../../org/jfree/chart/axis/TickUnit.html" title="class in org.jfree.chart.axis">TickUnit</a></code></dd>
  355. <dt><span class="returnLabel">Returns:</span></dt>
  356. <dd>A hash code.</dd>
  357. </dl>
  358. </li>
  359. </ul>
  360. </li>
  361. </ul>
  362. </li>
  363. </ul>
  364. </div>
  365. </div>
  366. <!-- ========= END OF CLASS DATA ========= -->
  367. <!-- ======= START OF BOTTOM NAVBAR ====== -->
  368. <div class="bottomNav"><a name="navbar.bottom">
  369. <!-- -->
  370. </a>
  371. <div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div>
  372. <a name="navbar.bottom.firstrow">
  373. <!-- -->
  374. </a>
  375. <ul class="navList" title="Navigation">
  376. <li><a href="../../../../overview-summary.html">Overview</a></li>
  377. <li><a href="package-summary.html">Package</a></li>
  378. <li class="navBarCell1Rev">Class</li>
  379. <li><a href="class-use/NumberTickUnit.html">Use</a></li>
  380. <li><a href="package-tree.html">Tree</a></li>
  381. <li><a href="../../../../deprecated-list.html">Deprecated</a></li>
  382. <li><a href="../../../../index-files/index-1.html">Index</a></li>
  383. <li><a href="../../../../help-doc.html">Help</a></li>
  384. </ul>
  385. </div>
  386. <div class="subNav">
  387. <ul class="navList">
  388. <li><a href="../../../../org/jfree/chart/axis/NumberTick.html" title="class in org.jfree.chart.axis"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
  389. <li><a href="../../../../org/jfree/chart/axis/NumberTickUnitSource.html" title="class in org.jfree.chart.axis"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
  390. </ul>
  391. <ul class="navList">
  392. <li><a href="../../../../index.html?org/jfree/chart/axis/NumberTickUnit.html" target="_top">Frames</a></li>
  393. <li><a href="NumberTickUnit.html" target="_top">No&nbsp;Frames</a></li>
  394. </ul>
  395. <ul class="navList" id="allclasses_navbar_bottom">
  396. <li><a href="../../../../allclasses-noframe.html">All&nbsp;Classes</a></li>
  397. </ul>
  398. <div>
  399. <script type="text/javascript"><!--
  400. allClassesLink = document.getElementById("allclasses_navbar_bottom");
  401. if(window==top) {
  402. allClassesLink.style.display = "block";
  403. }
  404. else {
  405. allClassesLink.style.display = "none";
  406. }
  407. //-->
  408. </script>
  409. </div>
  410. <div>
  411. <ul class="subNavList">
  412. <li>Summary:&nbsp;</li>
  413. <li>Nested&nbsp;|&nbsp;</li>
  414. <li>Field&nbsp;|&nbsp;</li>
  415. <li><a href="#constructor.summary">Constr</a>&nbsp;|&nbsp;</li>
  416. <li><a href="#method.summary">Method</a></li>
  417. </ul>
  418. <ul class="subNavList">
  419. <li>Detail:&nbsp;</li>
  420. <li>Field&nbsp;|&nbsp;</li>
  421. <li><a href="#constructor.detail">Constr</a>&nbsp;|&nbsp;</li>
  422. <li><a href="#method.detail">Method</a></li>
  423. </ul>
  424. </div>
  425. <a name="skip.navbar.bottom">
  426. <!-- -->
  427. </a></div>
  428. <!-- ======== END OF BOTTOM NAVBAR ======= -->
  429. </body>
  430. </html>