TickUnitSource.html 12 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289
  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>TickUnitSource (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="TickUnitSource (JFreeChart Class Library (version 1.0.19-fx))";
  16. }
  17. }
  18. catch(err) {
  19. }
  20. //-->
  21. var methods = {"i0":6,"i1":6,"i2":6};
  22. var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],4:["t3","Abstract 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/TickUnitSource.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/TickUnits.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/Timeline.html" title="interface 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/TickUnitSource.html" target="_top">Frames</a></li>
  57. <li><a href="TickUnitSource.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>Constr&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>Constr&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="Interface TickUnitSource" class="title">Interface TickUnitSource</h2>
  97. </div>
  98. <div class="contentContainer">
  99. <div class="description">
  100. <ul class="blockList">
  101. <li class="blockList">
  102. <dl>
  103. <dt>All Known Implementing Classes:</dt>
  104. <dd><a href="../../../../org/jfree/chart/axis/NumberTickUnitSource.html" title="class in org.jfree.chart.axis">NumberTickUnitSource</a>, <a href="../../../../org/jfree/chart/axis/StandardTickUnitSource.html" title="class in org.jfree.chart.axis">StandardTickUnitSource</a>, <a href="../../../../org/jfree/chart/axis/TickUnits.html" title="class in org.jfree.chart.axis">TickUnits</a></dd>
  105. </dl>
  106. <hr>
  107. <br>
  108. <pre>public interface <a href="../../../../src-html/org/jfree/chart/axis/TickUnitSource.html#line.47">TickUnitSource</a></pre>
  109. <div class="block">An interface used by the <a href="../../../../org/jfree/chart/axis/DateAxis.html" title="class in org.jfree.chart.axis"><code>DateAxis</code></a> and <a href="../../../../org/jfree/chart/axis/NumberAxis.html" title="class in org.jfree.chart.axis"><code>NumberAxis</code></a> classes to
  110. obtain a suitable <a href="../../../../org/jfree/chart/axis/TickUnit.html" title="class in org.jfree.chart.axis"><code>TickUnit</code></a>.</div>
  111. </li>
  112. </ul>
  113. </div>
  114. <div class="summary">
  115. <ul class="blockList">
  116. <li class="blockList">
  117. <!-- ========== METHOD SUMMARY =========== -->
  118. <ul class="blockList">
  119. <li class="blockList"><a name="method.summary">
  120. <!-- -->
  121. </a>
  122. <h3>Method Summary</h3>
  123. <table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation">
  124. <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="t3" class="tableTab"><span><a href="javascript:show(4);">Abstract Methods</a></span><span class="tabEnd">&nbsp;</span></span></caption>
  125. <tr>
  126. <th class="colFirst" scope="col">Modifier and Type</th>
  127. <th class="colLast" scope="col">Method and Description</th>
  128. </tr>
  129. <tr id="i0" class="altColor">
  130. <td class="colFirst"><code><a href="../../../../org/jfree/chart/axis/TickUnit.html" title="class in org.jfree.chart.axis">TickUnit</a></code></td>
  131. <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/jfree/chart/axis/TickUnitSource.html#getCeilingTickUnit-double-">getCeilingTickUnit</a></span>(double&nbsp;size)</code>
  132. <div class="block">Returns the smallest tick unit available in the source that is greater
  133. than or equal to the specified size.</div>
  134. </td>
  135. </tr>
  136. <tr id="i1" class="rowColor">
  137. <td class="colFirst"><code><a href="../../../../org/jfree/chart/axis/TickUnit.html" title="class in org.jfree.chart.axis">TickUnit</a></code></td>
  138. <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/jfree/chart/axis/TickUnitSource.html#getCeilingTickUnit-org.jfree.chart.axis.TickUnit-">getCeilingTickUnit</a></span>(<a href="../../../../org/jfree/chart/axis/TickUnit.html" title="class in org.jfree.chart.axis">TickUnit</a>&nbsp;unit)</code>
  139. <div class="block">Returns the tick unit in the collection that is greater than or equal
  140. to (in size) the specified unit.</div>
  141. </td>
  142. </tr>
  143. <tr id="i2" class="altColor">
  144. <td class="colFirst"><code><a href="../../../../org/jfree/chart/axis/TickUnit.html" title="class in org.jfree.chart.axis">TickUnit</a></code></td>
  145. <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/jfree/chart/axis/TickUnitSource.html#getLargerTickUnit-org.jfree.chart.axis.TickUnit-">getLargerTickUnit</a></span>(<a href="../../../../org/jfree/chart/axis/TickUnit.html" title="class in org.jfree.chart.axis">TickUnit</a>&nbsp;unit)</code>
  146. <div class="block">Returns the smallest tick unit available in the source that is larger
  147. than <code>unit</code> or, if there is no larger unit, returns
  148. <code>unit</code>.</div>
  149. </td>
  150. </tr>
  151. </table>
  152. </li>
  153. </ul>
  154. </li>
  155. </ul>
  156. </div>
  157. <div class="details">
  158. <ul class="blockList">
  159. <li class="blockList">
  160. <!-- ============ METHOD DETAIL ========== -->
  161. <ul class="blockList">
  162. <li class="blockList"><a name="method.detail">
  163. <!-- -->
  164. </a>
  165. <h3>Method Detail</h3>
  166. <a name="getLargerTickUnit-org.jfree.chart.axis.TickUnit-">
  167. <!-- -->
  168. </a>
  169. <ul class="blockList">
  170. <li class="blockList">
  171. <h4>getLargerTickUnit</h4>
  172. <pre><a href="../../../../org/jfree/chart/axis/TickUnit.html" title="class in org.jfree.chart.axis">TickUnit</a>&nbsp;<a href="../../../../src-html/org/jfree/chart/axis/TickUnitSource.html#line.58">getLargerTickUnit</a>(<a href="../../../../org/jfree/chart/axis/TickUnit.html" title="class in org.jfree.chart.axis">TickUnit</a>&nbsp;unit)</pre>
  173. <div class="block">Returns the smallest tick unit available in the source that is larger
  174. than <code>unit</code> or, if there is no larger unit, returns
  175. <code>unit</code>.</div>
  176. <dl>
  177. <dt><span class="paramLabel">Parameters:</span></dt>
  178. <dd><code>unit</code> - the unit (<code>null</code> not permitted).</dd>
  179. <dt><span class="returnLabel">Returns:</span></dt>
  180. <dd>A tick unit that is larger than the supplied unit.</dd>
  181. </dl>
  182. </li>
  183. </ul>
  184. <a name="getCeilingTickUnit-org.jfree.chart.axis.TickUnit-">
  185. <!-- -->
  186. </a>
  187. <ul class="blockList">
  188. <li class="blockList">
  189. <h4>getCeilingTickUnit</h4>
  190. <pre><a href="../../../../org/jfree/chart/axis/TickUnit.html" title="class in org.jfree.chart.axis">TickUnit</a>&nbsp;<a href="../../../../src-html/org/jfree/chart/axis/TickUnitSource.html#line.68">getCeilingTickUnit</a>(<a href="../../../../org/jfree/chart/axis/TickUnit.html" title="class in org.jfree.chart.axis">TickUnit</a>&nbsp;unit)</pre>
  191. <div class="block">Returns the tick unit in the collection that is greater than or equal
  192. to (in size) the specified unit.</div>
  193. <dl>
  194. <dt><span class="paramLabel">Parameters:</span></dt>
  195. <dd><code>unit</code> - the unit.</dd>
  196. <dt><span class="returnLabel">Returns:</span></dt>
  197. <dd>A unit from the collection.</dd>
  198. </dl>
  199. </li>
  200. </ul>
  201. <a name="getCeilingTickUnit-double-">
  202. <!-- -->
  203. </a>
  204. <ul class="blockListLast">
  205. <li class="blockList">
  206. <h4>getCeilingTickUnit</h4>
  207. <pre><a href="../../../../org/jfree/chart/axis/TickUnit.html" title="class in org.jfree.chart.axis">TickUnit</a>&nbsp;<a href="../../../../src-html/org/jfree/chart/axis/TickUnitSource.html#line.79">getCeilingTickUnit</a>(double&nbsp;size)</pre>
  208. <div class="block">Returns the smallest tick unit available in the source that is greater
  209. than or equal to the specified size. If there is no such tick unit,
  210. the method should return the largest available tick in the source.</div>
  211. <dl>
  212. <dt><span class="paramLabel">Parameters:</span></dt>
  213. <dd><code>size</code> - the size.</dd>
  214. <dt><span class="returnLabel">Returns:</span></dt>
  215. <dd>A unit from the collection (never <code>null</code>).</dd>
  216. </dl>
  217. </li>
  218. </ul>
  219. </li>
  220. </ul>
  221. </li>
  222. </ul>
  223. </div>
  224. </div>
  225. <!-- ========= END OF CLASS DATA ========= -->
  226. <!-- ======= START OF BOTTOM NAVBAR ====== -->
  227. <div class="bottomNav"><a name="navbar.bottom">
  228. <!-- -->
  229. </a>
  230. <div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div>
  231. <a name="navbar.bottom.firstrow">
  232. <!-- -->
  233. </a>
  234. <ul class="navList" title="Navigation">
  235. <li><a href="../../../../overview-summary.html">Overview</a></li>
  236. <li><a href="package-summary.html">Package</a></li>
  237. <li class="navBarCell1Rev">Class</li>
  238. <li><a href="class-use/TickUnitSource.html">Use</a></li>
  239. <li><a href="package-tree.html">Tree</a></li>
  240. <li><a href="../../../../deprecated-list.html">Deprecated</a></li>
  241. <li><a href="../../../../index-files/index-1.html">Index</a></li>
  242. <li><a href="../../../../help-doc.html">Help</a></li>
  243. </ul>
  244. </div>
  245. <div class="subNav">
  246. <ul class="navList">
  247. <li><a href="../../../../org/jfree/chart/axis/TickUnits.html" title="class in org.jfree.chart.axis"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
  248. <li><a href="../../../../org/jfree/chart/axis/Timeline.html" title="interface in org.jfree.chart.axis"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
  249. </ul>
  250. <ul class="navList">
  251. <li><a href="../../../../index.html?org/jfree/chart/axis/TickUnitSource.html" target="_top">Frames</a></li>
  252. <li><a href="TickUnitSource.html" target="_top">No&nbsp;Frames</a></li>
  253. </ul>
  254. <ul class="navList" id="allclasses_navbar_bottom">
  255. <li><a href="../../../../allclasses-noframe.html">All&nbsp;Classes</a></li>
  256. </ul>
  257. <div>
  258. <script type="text/javascript"><!--
  259. allClassesLink = document.getElementById("allclasses_navbar_bottom");
  260. if(window==top) {
  261. allClassesLink.style.display = "block";
  262. }
  263. else {
  264. allClassesLink.style.display = "none";
  265. }
  266. //-->
  267. </script>
  268. </div>
  269. <div>
  270. <ul class="subNavList">
  271. <li>Summary:&nbsp;</li>
  272. <li>Nested&nbsp;|&nbsp;</li>
  273. <li>Field&nbsp;|&nbsp;</li>
  274. <li>Constr&nbsp;|&nbsp;</li>
  275. <li><a href="#method.summary">Method</a></li>
  276. </ul>
  277. <ul class="subNavList">
  278. <li>Detail:&nbsp;</li>
  279. <li>Field&nbsp;|&nbsp;</li>
  280. <li>Constr&nbsp;|&nbsp;</li>
  281. <li><a href="#method.detail">Method</a></li>
  282. </ul>
  283. </div>
  284. <a name="skip.navbar.bottom">
  285. <!-- -->
  286. </a></div>
  287. <!-- ======== END OF BOTTOM NAVBAR ======= -->
  288. </body>
  289. </html>