HMSNumberFormat.html 16 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419
  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:41 CEST 2014 -->
  6. <title>HMSNumberFormat (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="HMSNumberFormat (JFreeChart Class Library (version 1.0.19-fx))";
  16. }
  17. }
  18. catch(err) {
  19. }
  20. //-->
  21. var methods = {"i0":10,"i1":10,"i2":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/HMSNumberFormat.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/util/HexNumberFormat.html" title="class in org.jfree.chart.util"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
  53. <li><a href="../../../../org/jfree/chart/util/LineUtilities.html" title="class in org.jfree.chart.util"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
  54. </ul>
  55. <ul class="navList">
  56. <li><a href="../../../../index.html?org/jfree/chart/util/HMSNumberFormat.html" target="_top">Frames</a></li>
  57. <li><a href="HMSNumberFormat.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><a href="#nested.classes.inherited.from.class.java.text.NumberFormat">Nested</a>&nbsp;|&nbsp;</li>
  78. <li><a href="#fields.inherited.from.class.java.text.NumberFormat">Field</a>&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.util</div>
  96. <h2 title="Class HMSNumberFormat" class="title">Class HMSNumberFormat</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>java.text.Format</li>
  104. <li>
  105. <ul class="inheritance">
  106. <li>java.text.NumberFormat</li>
  107. <li>
  108. <ul class="inheritance">
  109. <li>org.jfree.chart.util.HMSNumberFormat</li>
  110. </ul>
  111. </li>
  112. </ul>
  113. </li>
  114. </ul>
  115. </li>
  116. </ul>
  117. <div class="description">
  118. <ul class="blockList">
  119. <li class="blockList">
  120. <dl>
  121. <dt>All Implemented Interfaces:</dt>
  122. <dd>java.io.Serializable, java.lang.Cloneable</dd>
  123. </dl>
  124. <hr>
  125. <br>
  126. <pre>public class <a href="../../../../src-html/org/jfree/chart/util/HMSNumberFormat.html#line.56">HMSNumberFormat</a>
  127. extends java.text.NumberFormat</pre>
  128. <div class="block">A custom number formatter that formats numbers (in seconds) as HH:MM:SS.
  129. Created in response to:
  130. http://stackoverflow.com/questions/19028908/jfreechart-need-to-customize-y-axis-just-for-printing</div>
  131. <dl>
  132. <dt><span class="simpleTagLabel">Since:</span></dt>
  133. <dd>1.0.17</dd>
  134. <dt><span class="seeLabel">See Also:</span></dt>
  135. <dd><a href="../../../../serialized-form.html#org.jfree.chart.util.HMSNumberFormat">Serialized Form</a></dd>
  136. </dl>
  137. </li>
  138. </ul>
  139. </div>
  140. <div class="summary">
  141. <ul class="blockList">
  142. <li class="blockList">
  143. <!-- ======== NESTED CLASS SUMMARY ======== -->
  144. <ul class="blockList">
  145. <li class="blockList"><a name="nested.class.summary">
  146. <!-- -->
  147. </a>
  148. <h3>Nested Class Summary</h3>
  149. <ul class="blockList">
  150. <li class="blockList"><a name="nested.classes.inherited.from.class.java.text.NumberFormat">
  151. <!-- -->
  152. </a>
  153. <h3>Nested classes/interfaces inherited from class&nbsp;java.text.NumberFormat</h3>
  154. <code>java.text.NumberFormat.Field</code></li>
  155. </ul>
  156. </li>
  157. </ul>
  158. <!-- =========== FIELD SUMMARY =========== -->
  159. <ul class="blockList">
  160. <li class="blockList"><a name="field.summary">
  161. <!-- -->
  162. </a>
  163. <h3>Field Summary</h3>
  164. <ul class="blockList">
  165. <li class="blockList"><a name="fields.inherited.from.class.java.text.NumberFormat">
  166. <!-- -->
  167. </a>
  168. <h3>Fields inherited from class&nbsp;java.text.NumberFormat</h3>
  169. <code>FRACTION_FIELD, INTEGER_FIELD</code></li>
  170. </ul>
  171. </li>
  172. </ul>
  173. <!-- ======== CONSTRUCTOR SUMMARY ======== -->
  174. <ul class="blockList">
  175. <li class="blockList"><a name="constructor.summary">
  176. <!-- -->
  177. </a>
  178. <h3>Constructor Summary</h3>
  179. <table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Constructor Summary table, listing constructors, and an explanation">
  180. <caption><span>Constructors</span><span class="tabEnd">&nbsp;</span></caption>
  181. <tr>
  182. <th class="colOne" scope="col">Constructor and Description</th>
  183. </tr>
  184. <tr class="altColor">
  185. <td class="colOne"><code><span class="memberNameLink"><a href="../../../../org/jfree/chart/util/HMSNumberFormat.html#HMSNumberFormat--">HMSNumberFormat</a></span>()</code>
  186. <div class="block">Creates a new instance.</div>
  187. </td>
  188. </tr>
  189. </table>
  190. </li>
  191. </ul>
  192. <!-- ========== METHOD SUMMARY =========== -->
  193. <ul class="blockList">
  194. <li class="blockList"><a name="method.summary">
  195. <!-- -->
  196. </a>
  197. <h3>Method Summary</h3>
  198. <table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation">
  199. <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>
  200. <tr>
  201. <th class="colFirst" scope="col">Modifier and Type</th>
  202. <th class="colLast" scope="col">Method and Description</th>
  203. </tr>
  204. <tr id="i0" class="altColor">
  205. <td class="colFirst"><code>java.lang.StringBuffer</code></td>
  206. <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/jfree/chart/util/HMSNumberFormat.html#format-double-java.lang.StringBuffer-java.text.FieldPosition-">format</a></span>(double&nbsp;number,
  207. java.lang.StringBuffer&nbsp;toAppendTo,
  208. java.text.FieldPosition&nbsp;pos)</code>
  209. <div class="block">Formats the specified number as a string of the form HH:MM:SS.</div>
  210. </td>
  211. </tr>
  212. <tr id="i1" class="rowColor">
  213. <td class="colFirst"><code>java.lang.StringBuffer</code></td>
  214. <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/jfree/chart/util/HMSNumberFormat.html#format-long-java.lang.StringBuffer-java.text.FieldPosition-">format</a></span>(long&nbsp;number,
  215. java.lang.StringBuffer&nbsp;toAppendTo,
  216. java.text.FieldPosition&nbsp;pos)</code>
  217. <div class="block">Formats the specified number as a string of the form HH:MM:SS.</div>
  218. </td>
  219. </tr>
  220. <tr id="i2" class="altColor">
  221. <td class="colFirst"><code>java.lang.Number</code></td>
  222. <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/jfree/chart/util/HMSNumberFormat.html#parse-java.lang.String-java.text.ParsePosition-">parse</a></span>(java.lang.String&nbsp;source,
  223. java.text.ParsePosition&nbsp;parsePosition)</code>
  224. <div class="block">Parsing is not implemented, so this method always returns
  225. <code>null</code>.</div>
  226. </td>
  227. </tr>
  228. </table>
  229. <ul class="blockList">
  230. <li class="blockList"><a name="methods.inherited.from.class.java.text.NumberFormat">
  231. <!-- -->
  232. </a>
  233. <h3>Methods inherited from class&nbsp;java.text.NumberFormat</h3>
  234. <code>clone, equals, format, format, format, getAvailableLocales, getCurrency, getCurrencyInstance, getCurrencyInstance, getInstance, getInstance, getIntegerInstance, getIntegerInstance, getMaximumFractionDigits, getMaximumIntegerDigits, getMinimumFractionDigits, getMinimumIntegerDigits, getNumberInstance, getNumberInstance, getPercentInstance, getPercentInstance, getRoundingMode, hashCode, isGroupingUsed, isParseIntegerOnly, parse, parseObject, setCurrency, setGroupingUsed, setMaximumFractionDigits, setMaximumIntegerDigits, setMinimumFractionDigits, setMinimumIntegerDigits, setParseIntegerOnly, setRoundingMode</code></li>
  235. </ul>
  236. <ul class="blockList">
  237. <li class="blockList"><a name="methods.inherited.from.class.java.text.Format">
  238. <!-- -->
  239. </a>
  240. <h3>Methods inherited from class&nbsp;java.text.Format</h3>
  241. <code>format, formatToCharacterIterator, parseObject</code></li>
  242. </ul>
  243. <ul class="blockList">
  244. <li class="blockList"><a name="methods.inherited.from.class.java.lang.Object">
  245. <!-- -->
  246. </a>
  247. <h3>Methods inherited from class&nbsp;java.lang.Object</h3>
  248. <code>finalize, getClass, notify, notifyAll, toString, wait, wait, wait</code></li>
  249. </ul>
  250. </li>
  251. </ul>
  252. </li>
  253. </ul>
  254. </div>
  255. <div class="details">
  256. <ul class="blockList">
  257. <li class="blockList">
  258. <!-- ========= CONSTRUCTOR DETAIL ======== -->
  259. <ul class="blockList">
  260. <li class="blockList"><a name="constructor.detail">
  261. <!-- -->
  262. </a>
  263. <h3>Constructor Detail</h3>
  264. <a name="HMSNumberFormat--">
  265. <!-- -->
  266. </a>
  267. <ul class="blockListLast">
  268. <li class="blockList">
  269. <h4>HMSNumberFormat</h4>
  270. <pre>public&nbsp;<a href="../../../../src-html/org/jfree/chart/util/HMSNumberFormat.html#line.63">HMSNumberFormat</a>()</pre>
  271. <div class="block">Creates a new instance.</div>
  272. </li>
  273. </ul>
  274. </li>
  275. </ul>
  276. <!-- ============ METHOD DETAIL ========== -->
  277. <ul class="blockList">
  278. <li class="blockList"><a name="method.detail">
  279. <!-- -->
  280. </a>
  281. <h3>Method Detail</h3>
  282. <a name="format-double-java.lang.StringBuffer-java.text.FieldPosition-">
  283. <!-- -->
  284. </a>
  285. <ul class="blockList">
  286. <li class="blockList">
  287. <h4>format</h4>
  288. <pre>public&nbsp;java.lang.StringBuffer&nbsp;<a href="../../../../src-html/org/jfree/chart/util/HMSNumberFormat.html#line.78">format</a>(double&nbsp;number,
  289. java.lang.StringBuffer&nbsp;toAppendTo,
  290. java.text.FieldPosition&nbsp;pos)</pre>
  291. <div class="block">Formats the specified number as a string of the form HH:MM:SS. The
  292. decimal fraction is ignored.</div>
  293. <dl>
  294. <dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
  295. <dd><code>format</code>&nbsp;in class&nbsp;<code>java.text.NumberFormat</code></dd>
  296. <dt><span class="paramLabel">Parameters:</span></dt>
  297. <dd><code>number</code> - the number to format.</dd>
  298. <dd><code>toAppendTo</code> - the buffer to append to (ignored here).</dd>
  299. <dd><code>pos</code> - the field position (ignored here).</dd>
  300. <dt><span class="returnLabel">Returns:</span></dt>
  301. <dd>The string buffer.</dd>
  302. </dl>
  303. </li>
  304. </ul>
  305. <a name="format-long-java.lang.StringBuffer-java.text.FieldPosition-">
  306. <!-- -->
  307. </a>
  308. <ul class="blockList">
  309. <li class="blockList">
  310. <h4>format</h4>
  311. <pre>public&nbsp;java.lang.StringBuffer&nbsp;<a href="../../../../src-html/org/jfree/chart/util/HMSNumberFormat.html#line.93">format</a>(long&nbsp;number,
  312. java.lang.StringBuffer&nbsp;toAppendTo,
  313. java.text.FieldPosition&nbsp;pos)</pre>
  314. <div class="block">Formats the specified number as a string of the form HH:MM:SS.</div>
  315. <dl>
  316. <dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
  317. <dd><code>format</code>&nbsp;in class&nbsp;<code>java.text.NumberFormat</code></dd>
  318. <dt><span class="paramLabel">Parameters:</span></dt>
  319. <dd><code>number</code> - the number to format.</dd>
  320. <dd><code>toAppendTo</code> - the buffer to append to (ignored here).</dd>
  321. <dd><code>pos</code> - the field position (ignored here).</dd>
  322. <dt><span class="returnLabel">Returns:</span></dt>
  323. <dd>The string buffer.</dd>
  324. </dl>
  325. </li>
  326. </ul>
  327. <a name="parse-java.lang.String-java.text.ParsePosition-">
  328. <!-- -->
  329. </a>
  330. <ul class="blockListLast">
  331. <li class="blockList">
  332. <h4>parse</h4>
  333. <pre>public&nbsp;java.lang.Number&nbsp;<a href="../../../../src-html/org/jfree/chart/util/HMSNumberFormat.html#line.116">parse</a>(java.lang.String&nbsp;source,
  334. java.text.ParsePosition&nbsp;parsePosition)</pre>
  335. <div class="block">Parsing is not implemented, so this method always returns
  336. <code>null</code>.</div>
  337. <dl>
  338. <dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
  339. <dd><code>parse</code>&nbsp;in class&nbsp;<code>java.text.NumberFormat</code></dd>
  340. <dt><span class="paramLabel">Parameters:</span></dt>
  341. <dd><code>source</code> - ignored.</dd>
  342. <dd><code>parsePosition</code> - ignored.</dd>
  343. <dt><span class="returnLabel">Returns:</span></dt>
  344. <dd>Always <code>null</code>.</dd>
  345. </dl>
  346. </li>
  347. </ul>
  348. </li>
  349. </ul>
  350. </li>
  351. </ul>
  352. </div>
  353. </div>
  354. <!-- ========= END OF CLASS DATA ========= -->
  355. <!-- ======= START OF BOTTOM NAVBAR ====== -->
  356. <div class="bottomNav"><a name="navbar.bottom">
  357. <!-- -->
  358. </a>
  359. <div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div>
  360. <a name="navbar.bottom.firstrow">
  361. <!-- -->
  362. </a>
  363. <ul class="navList" title="Navigation">
  364. <li><a href="../../../../overview-summary.html">Overview</a></li>
  365. <li><a href="package-summary.html">Package</a></li>
  366. <li class="navBarCell1Rev">Class</li>
  367. <li><a href="class-use/HMSNumberFormat.html">Use</a></li>
  368. <li><a href="package-tree.html">Tree</a></li>
  369. <li><a href="../../../../deprecated-list.html">Deprecated</a></li>
  370. <li><a href="../../../../index-files/index-1.html">Index</a></li>
  371. <li><a href="../../../../help-doc.html">Help</a></li>
  372. </ul>
  373. </div>
  374. <div class="subNav">
  375. <ul class="navList">
  376. <li><a href="../../../../org/jfree/chart/util/HexNumberFormat.html" title="class in org.jfree.chart.util"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
  377. <li><a href="../../../../org/jfree/chart/util/LineUtilities.html" title="class in org.jfree.chart.util"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
  378. </ul>
  379. <ul class="navList">
  380. <li><a href="../../../../index.html?org/jfree/chart/util/HMSNumberFormat.html" target="_top">Frames</a></li>
  381. <li><a href="HMSNumberFormat.html" target="_top">No&nbsp;Frames</a></li>
  382. </ul>
  383. <ul class="navList" id="allclasses_navbar_bottom">
  384. <li><a href="../../../../allclasses-noframe.html">All&nbsp;Classes</a></li>
  385. </ul>
  386. <div>
  387. <script type="text/javascript"><!--
  388. allClassesLink = document.getElementById("allclasses_navbar_bottom");
  389. if(window==top) {
  390. allClassesLink.style.display = "block";
  391. }
  392. else {
  393. allClassesLink.style.display = "none";
  394. }
  395. //-->
  396. </script>
  397. </div>
  398. <div>
  399. <ul class="subNavList">
  400. <li>Summary:&nbsp;</li>
  401. <li><a href="#nested.classes.inherited.from.class.java.text.NumberFormat">Nested</a>&nbsp;|&nbsp;</li>
  402. <li><a href="#fields.inherited.from.class.java.text.NumberFormat">Field</a>&nbsp;|&nbsp;</li>
  403. <li><a href="#constructor.summary">Constr</a>&nbsp;|&nbsp;</li>
  404. <li><a href="#method.summary">Method</a></li>
  405. </ul>
  406. <ul class="subNavList">
  407. <li>Detail:&nbsp;</li>
  408. <li>Field&nbsp;|&nbsp;</li>
  409. <li><a href="#constructor.detail">Constr</a>&nbsp;|&nbsp;</li>
  410. <li><a href="#method.detail">Method</a></li>
  411. </ul>
  412. </div>
  413. <a name="skip.navbar.bottom">
  414. <!-- -->
  415. </a></div>
  416. <!-- ======== END OF BOTTOM NAVBAR ======= -->
  417. </body>
  418. </html>