Timeline.html 17 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416
  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>Timeline (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="Timeline (JFreeChart Class Library (version 1.0.19-fx))";
  16. }
  17. }
  18. catch(err) {
  19. }
  20. //-->
  21. var methods = {"i0":6,"i1":6,"i2":6,"i3":6,"i4":6,"i5":6,"i6":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/Timeline.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/TickUnitSource.html" title="interface in org.jfree.chart.axis"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
  53. <li><a href="../../../../org/jfree/chart/axis/ValueAxis.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/Timeline.html" target="_top">Frames</a></li>
  57. <li><a href="Timeline.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 Timeline" class="title">Interface Timeline</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/SegmentedTimeline.html" title="class in org.jfree.chart.axis">SegmentedTimeline</a></dd>
  105. </dl>
  106. <hr>
  107. <br>
  108. <pre>public interface <a href="../../../../src-html/org/jfree/chart/axis/Timeline.html#line.74">Timeline</a></pre>
  109. <div class="block">An interface that defines the contract for a Timeline.
  110. <P>
  111. A Timeline will present a series of values to be used for an axis. Each
  112. Timeline must provide transformation methods between domain values and
  113. timeline values. In theory many transformations are possible. This interface
  114. has been implemented completely in
  115. <a href="../../../../org/jfree/chart/axis/SegmentedTimeline.html" title="class in org.jfree.chart.axis"><code>SegmentedTimeline</code></a>.
  116. <P>
  117. A timeline can be used as parameter to a
  118. <a href="../../../../org/jfree/chart/axis/DateAxis.html" title="class in org.jfree.chart.axis"><code>DateAxis</code></a> to define the values that this axis
  119. supports. As an example, the <a href="../../../../org/jfree/chart/axis/SegmentedTimeline.html" title="class in org.jfree.chart.axis"><code>SegmentedTimeline</code></a>
  120. implements a timeline formed by segments of equal length (ex. days, hours,
  121. minutes) where some segments can be included in the timeline and others
  122. excluded. Therefore timelines like "working days" or "working hours" can be
  123. created where non-working days or non-working hours respectively can be
  124. removed from the timeline, and therefore from the axis. This creates a smooth
  125. plot with equal separation between all included segments.
  126. <P>
  127. Because Timelines were created mainly for Date related axis, values are
  128. represented as longs instead of doubles. In this case, the domain value is
  129. just the number of milliseconds since January 1, 1970, 00:00:00 GMT as
  130. defined by the getTime() method of <code>Date</code>.</div>
  131. <dl>
  132. <dt><span class="seeLabel">See Also:</span></dt>
  133. <dd><a href="../../../../org/jfree/chart/axis/SegmentedTimeline.html" title="class in org.jfree.chart.axis"><code>SegmentedTimeline</code></a>,
  134. <a href="../../../../org/jfree/chart/axis/DateAxis.html" title="class in org.jfree.chart.axis"><code>DateAxis</code></a></dd>
  135. </dl>
  136. </li>
  137. </ul>
  138. </div>
  139. <div class="summary">
  140. <ul class="blockList">
  141. <li class="blockList">
  142. <!-- ========== METHOD SUMMARY =========== -->
  143. <ul class="blockList">
  144. <li class="blockList"><a name="method.summary">
  145. <!-- -->
  146. </a>
  147. <h3>Method Summary</h3>
  148. <table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation">
  149. <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>
  150. <tr>
  151. <th class="colFirst" scope="col">Modifier and Type</th>
  152. <th class="colLast" scope="col">Method and Description</th>
  153. </tr>
  154. <tr id="i0" class="altColor">
  155. <td class="colFirst"><code>boolean</code></td>
  156. <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/jfree/chart/axis/Timeline.html#containsDomainRange-java.util.Date-java.util.Date-">containsDomainRange</a></span>(java.util.Date&nbsp;fromDate,
  157. java.util.Date&nbsp;toDate)</code>
  158. <div class="block">Returns <code>true</code> if a range of dates are contained in the
  159. timeline.</div>
  160. </td>
  161. </tr>
  162. <tr id="i1" class="rowColor">
  163. <td class="colFirst"><code>boolean</code></td>
  164. <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/jfree/chart/axis/Timeline.html#containsDomainRange-long-long-">containsDomainRange</a></span>(long&nbsp;fromMillisecond,
  165. long&nbsp;toMillisecond)</code>
  166. <div class="block">Returns <code>true</code> if a range of values are contained in the
  167. timeline.</div>
  168. </td>
  169. </tr>
  170. <tr id="i2" class="altColor">
  171. <td class="colFirst"><code>boolean</code></td>
  172. <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/jfree/chart/axis/Timeline.html#containsDomainValue-java.util.Date-">containsDomainValue</a></span>(java.util.Date&nbsp;date)</code>
  173. <div class="block">Returns <code>true</code> if a date is contained in the timeline values.</div>
  174. </td>
  175. </tr>
  176. <tr id="i3" class="rowColor">
  177. <td class="colFirst"><code>boolean</code></td>
  178. <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/jfree/chart/axis/Timeline.html#containsDomainValue-long-">containsDomainValue</a></span>(long&nbsp;millisecond)</code>
  179. <div class="block">Returns <code>true</code> if a value is contained in the timeline values.</div>
  180. </td>
  181. </tr>
  182. <tr id="i4" class="altColor">
  183. <td class="colFirst"><code>long</code></td>
  184. <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/jfree/chart/axis/Timeline.html#toMillisecond-long-">toMillisecond</a></span>(long&nbsp;timelineValue)</code>
  185. <div class="block">Translates a value relative to this timeline into a domain value.</div>
  186. </td>
  187. </tr>
  188. <tr id="i5" class="rowColor">
  189. <td class="colFirst"><code>long</code></td>
  190. <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/jfree/chart/axis/Timeline.html#toTimelineValue-java.util.Date-">toTimelineValue</a></span>(java.util.Date&nbsp;date)</code>
  191. <div class="block">Translates a date into a value on this timeline.</div>
  192. </td>
  193. </tr>
  194. <tr id="i6" class="altColor">
  195. <td class="colFirst"><code>long</code></td>
  196. <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/jfree/chart/axis/Timeline.html#toTimelineValue-long-">toTimelineValue</a></span>(long&nbsp;millisecond)</code>
  197. <div class="block">Translates a millisecond (as defined by java.util.Date) into an index
  198. along this timeline.</div>
  199. </td>
  200. </tr>
  201. </table>
  202. </li>
  203. </ul>
  204. </li>
  205. </ul>
  206. </div>
  207. <div class="details">
  208. <ul class="blockList">
  209. <li class="blockList">
  210. <!-- ============ METHOD DETAIL ========== -->
  211. <ul class="blockList">
  212. <li class="blockList"><a name="method.detail">
  213. <!-- -->
  214. </a>
  215. <h3>Method Detail</h3>
  216. <a name="toTimelineValue-long-">
  217. <!-- -->
  218. </a>
  219. <ul class="blockList">
  220. <li class="blockList">
  221. <h4>toTimelineValue</h4>
  222. <pre>long&nbsp;<a href="../../../../src-html/org/jfree/chart/axis/Timeline.html#line.84">toTimelineValue</a>(long&nbsp;millisecond)</pre>
  223. <div class="block">Translates a millisecond (as defined by java.util.Date) into an index
  224. along this timeline.</div>
  225. <dl>
  226. <dt><span class="paramLabel">Parameters:</span></dt>
  227. <dd><code>millisecond</code> - the millisecond.</dd>
  228. <dt><span class="returnLabel">Returns:</span></dt>
  229. <dd>A timeline value.</dd>
  230. </dl>
  231. </li>
  232. </ul>
  233. <a name="toTimelineValue-java.util.Date-">
  234. <!-- -->
  235. </a>
  236. <ul class="blockList">
  237. <li class="blockList">
  238. <h4>toTimelineValue</h4>
  239. <pre>long&nbsp;<a href="../../../../src-html/org/jfree/chart/axis/Timeline.html#line.93">toTimelineValue</a>(java.util.Date&nbsp;date)</pre>
  240. <div class="block">Translates a date into a value on this timeline.</div>
  241. <dl>
  242. <dt><span class="paramLabel">Parameters:</span></dt>
  243. <dd><code>date</code> - the date.</dd>
  244. <dt><span class="returnLabel">Returns:</span></dt>
  245. <dd>A timeline value</dd>
  246. </dl>
  247. </li>
  248. </ul>
  249. <a name="toMillisecond-long-">
  250. <!-- -->
  251. </a>
  252. <ul class="blockList">
  253. <li class="blockList">
  254. <h4>toMillisecond</h4>
  255. <pre>long&nbsp;<a href="../../../../src-html/org/jfree/chart/axis/Timeline.html#line.109">toMillisecond</a>(long&nbsp;timelineValue)</pre>
  256. <div class="block">Translates a value relative to this timeline into a domain value. The
  257. domain value obtained by this method is not always the same domain value
  258. that could have been supplied to
  259. translateDomainValueToTimelineValue(domainValue).
  260. This is because the original transformation may not be complete
  261. reversable.</div>
  262. <dl>
  263. <dt><span class="paramLabel">Parameters:</span></dt>
  264. <dd><code>timelineValue</code> - a timeline value.</dd>
  265. <dt><span class="returnLabel">Returns:</span></dt>
  266. <dd>A domain value.</dd>
  267. <dt><span class="seeLabel">See Also:</span></dt>
  268. <dd><a href="../../../../org/jfree/chart/axis/SegmentedTimeline.html" title="class in org.jfree.chart.axis"><code>SegmentedTimeline</code></a></dd>
  269. </dl>
  270. </li>
  271. </ul>
  272. <a name="containsDomainValue-long-">
  273. <!-- -->
  274. </a>
  275. <ul class="blockList">
  276. <li class="blockList">
  277. <h4>containsDomainValue</h4>
  278. <pre>boolean&nbsp;<a href="../../../../src-html/org/jfree/chart/axis/Timeline.html#line.119">containsDomainValue</a>(long&nbsp;millisecond)</pre>
  279. <div class="block">Returns <code>true</code> if a value is contained in the timeline values.</div>
  280. <dl>
  281. <dt><span class="paramLabel">Parameters:</span></dt>
  282. <dd><code>millisecond</code> - the millisecond.</dd>
  283. <dt><span class="returnLabel">Returns:</span></dt>
  284. <dd><code>true</code> if value is contained in the timeline and
  285. <code>false</code> otherwise.</dd>
  286. </dl>
  287. </li>
  288. </ul>
  289. <a name="containsDomainValue-java.util.Date-">
  290. <!-- -->
  291. </a>
  292. <ul class="blockList">
  293. <li class="blockList">
  294. <h4>containsDomainValue</h4>
  295. <pre>boolean&nbsp;<a href="../../../../src-html/org/jfree/chart/axis/Timeline.html#line.129">containsDomainValue</a>(java.util.Date&nbsp;date)</pre>
  296. <div class="block">Returns <code>true</code> if a date is contained in the timeline values.</div>
  297. <dl>
  298. <dt><span class="paramLabel">Parameters:</span></dt>
  299. <dd><code>date</code> - the date to verify.</dd>
  300. <dt><span class="returnLabel">Returns:</span></dt>
  301. <dd><code>true</code> if value is contained in the timeline and
  302. <code>false</code> otherwise.</dd>
  303. </dl>
  304. </li>
  305. </ul>
  306. <a name="containsDomainRange-long-long-">
  307. <!-- -->
  308. </a>
  309. <ul class="blockList">
  310. <li class="blockList">
  311. <h4>containsDomainRange</h4>
  312. <pre>boolean&nbsp;<a href="../../../../src-html/org/jfree/chart/axis/Timeline.html#line.141">containsDomainRange</a>(long&nbsp;fromMillisecond,
  313. long&nbsp;toMillisecond)</pre>
  314. <div class="block">Returns <code>true</code> if a range of values are contained in the
  315. timeline.</div>
  316. <dl>
  317. <dt><span class="paramLabel">Parameters:</span></dt>
  318. <dd><code>fromMillisecond</code> - the start of the range to verify.</dd>
  319. <dd><code>toMillisecond</code> - the end of the range to verify.</dd>
  320. <dt><span class="returnLabel">Returns:</span></dt>
  321. <dd><code>true</code> if the range is contained in the timeline or
  322. <code>false</code> otherwise</dd>
  323. </dl>
  324. </li>
  325. </ul>
  326. <a name="containsDomainRange-java.util.Date-java.util.Date-">
  327. <!-- -->
  328. </a>
  329. <ul class="blockListLast">
  330. <li class="blockList">
  331. <h4>containsDomainRange</h4>
  332. <pre>boolean&nbsp;<a href="../../../../src-html/org/jfree/chart/axis/Timeline.html#line.153">containsDomainRange</a>(java.util.Date&nbsp;fromDate,
  333. java.util.Date&nbsp;toDate)</pre>
  334. <div class="block">Returns <code>true</code> if a range of dates are contained in the
  335. timeline.</div>
  336. <dl>
  337. <dt><span class="paramLabel">Parameters:</span></dt>
  338. <dd><code>fromDate</code> - the start of the range to verify.</dd>
  339. <dd><code>toDate</code> - the end of the range to verify.</dd>
  340. <dt><span class="returnLabel">Returns:</span></dt>
  341. <dd><code>true</code> if the range is contained in the timeline or
  342. <code>false</code> otherwise</dd>
  343. </dl>
  344. </li>
  345. </ul>
  346. </li>
  347. </ul>
  348. </li>
  349. </ul>
  350. </div>
  351. </div>
  352. <!-- ========= END OF CLASS DATA ========= -->
  353. <!-- ======= START OF BOTTOM NAVBAR ====== -->
  354. <div class="bottomNav"><a name="navbar.bottom">
  355. <!-- -->
  356. </a>
  357. <div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div>
  358. <a name="navbar.bottom.firstrow">
  359. <!-- -->
  360. </a>
  361. <ul class="navList" title="Navigation">
  362. <li><a href="../../../../overview-summary.html">Overview</a></li>
  363. <li><a href="package-summary.html">Package</a></li>
  364. <li class="navBarCell1Rev">Class</li>
  365. <li><a href="class-use/Timeline.html">Use</a></li>
  366. <li><a href="package-tree.html">Tree</a></li>
  367. <li><a href="../../../../deprecated-list.html">Deprecated</a></li>
  368. <li><a href="../../../../index-files/index-1.html">Index</a></li>
  369. <li><a href="../../../../help-doc.html">Help</a></li>
  370. </ul>
  371. </div>
  372. <div class="subNav">
  373. <ul class="navList">
  374. <li><a href="../../../../org/jfree/chart/axis/TickUnitSource.html" title="interface in org.jfree.chart.axis"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
  375. <li><a href="../../../../org/jfree/chart/axis/ValueAxis.html" title="class in org.jfree.chart.axis"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
  376. </ul>
  377. <ul class="navList">
  378. <li><a href="../../../../index.html?org/jfree/chart/axis/Timeline.html" target="_top">Frames</a></li>
  379. <li><a href="Timeline.html" target="_top">No&nbsp;Frames</a></li>
  380. </ul>
  381. <ul class="navList" id="allclasses_navbar_bottom">
  382. <li><a href="../../../../allclasses-noframe.html">All&nbsp;Classes</a></li>
  383. </ul>
  384. <div>
  385. <script type="text/javascript"><!--
  386. allClassesLink = document.getElementById("allclasses_navbar_bottom");
  387. if(window==top) {
  388. allClassesLink.style.display = "block";
  389. }
  390. else {
  391. allClassesLink.style.display = "none";
  392. }
  393. //-->
  394. </script>
  395. </div>
  396. <div>
  397. <ul class="subNavList">
  398. <li>Summary:&nbsp;</li>
  399. <li>Nested&nbsp;|&nbsp;</li>
  400. <li>Field&nbsp;|&nbsp;</li>
  401. <li>Constr&nbsp;|&nbsp;</li>
  402. <li><a href="#method.summary">Method</a></li>
  403. </ul>
  404. <ul class="subNavList">
  405. <li>Detail:&nbsp;</li>
  406. <li>Field&nbsp;|&nbsp;</li>
  407. <li>Constr&nbsp;|&nbsp;</li>
  408. <li><a href="#method.detail">Method</a></li>
  409. </ul>
  410. </div>
  411. <a name="skip.navbar.bottom">
  412. <!-- -->
  413. </a></div>
  414. <!-- ======== END OF BOTTOM NAVBAR ======= -->
  415. </body>
  416. </html>