123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914915916917918919920921922923924925926927928929930931932933934935936937938939940941942943944945946947948949950951952953954955956957958959960961962963964965966967968969970 |
- <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
- <!-- NewPage -->
- <html lang="en">
- <head>
- <!-- Generated by javadoc (1.8.0_05) on Thu Jul 31 14:50:28 CEST 2014 -->
- <title>SegmentedTimeline.Segment (JFreeChart Class Library (version 1.0.19-fx))</title>
- <meta name="date" content="2014-07-31">
- <link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style">
- <script type="text/javascript" src="../../../../script.js"></script>
- </head>
- <body>
- <script type="text/javascript"><!--
- try {
- if (location.href.indexOf('is-external=true') == -1) {
- parent.document.title="SegmentedTimeline.Segment (JFreeChart Class Library (version 1.0.19-fx))";
- }
- }
- catch(err) {
- }
- //-->
- var methods = {"i0":10,"i1":10,"i2":10,"i3":10,"i4":10,"i5":10,"i6":10,"i7":10,"i8":10,"i9":10,"i10":10,"i11":10,"i12":10,"i13":10,"i14":10,"i15":10,"i16":10,"i17":10,"i18":10,"i19":10,"i20":10,"i21":10,"i22":10,"i23":10,"i24":10,"i25":10};
- var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],8:["t4","Concrete Methods"]};
- var altColor = "altColor";
- var rowColor = "rowColor";
- var tableTab = "tableTab";
- var activeTableTab = "activeTableTab";
- </script>
- <noscript>
- <div>JavaScript is disabled on your browser.</div>
- </noscript>
- <!-- ========= START OF TOP NAVBAR ======= -->
- <div class="topNav"><a name="navbar.top">
- <!-- -->
- </a>
- <div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div>
- <a name="navbar.top.firstrow">
- <!-- -->
- </a>
- <ul class="navList" title="Navigation">
- <li><a href="../../../../overview-summary.html">Overview</a></li>
- <li><a href="package-summary.html">Package</a></li>
- <li class="navBarCell1Rev">Class</li>
- <li><a href="class-use/SegmentedTimeline.Segment.html">Use</a></li>
- <li><a href="package-tree.html">Tree</a></li>
- <li><a href="../../../../deprecated-list.html">Deprecated</a></li>
- <li><a href="../../../../index-files/index-1.html">Index</a></li>
- <li><a href="../../../../help-doc.html">Help</a></li>
- </ul>
- </div>
- <div class="subNav">
- <ul class="navList">
- <li><a href="../../../../org/jfree/chart/axis/SegmentedTimeline.BaseTimelineSegmentRange.html" title="class in org.jfree.chart.axis"><span class="typeNameLink">Prev Class</span></a></li>
- <li><a href="../../../../org/jfree/chart/axis/SegmentedTimeline.SegmentRange.html" title="class in org.jfree.chart.axis"><span class="typeNameLink">Next Class</span></a></li>
- </ul>
- <ul class="navList">
- <li><a href="../../../../index.html?org/jfree/chart/axis/SegmentedTimeline.Segment.html" target="_top">Frames</a></li>
- <li><a href="SegmentedTimeline.Segment.html" target="_top">No Frames</a></li>
- </ul>
- <ul class="navList" id="allclasses_navbar_top">
- <li><a href="../../../../allclasses-noframe.html">All Classes</a></li>
- </ul>
- <div>
- <script type="text/javascript"><!--
- allClassesLink = document.getElementById("allclasses_navbar_top");
- if(window==top) {
- allClassesLink.style.display = "block";
- }
- else {
- allClassesLink.style.display = "none";
- }
- //-->
- </script>
- </div>
- <div>
- <ul class="subNavList">
- <li>Summary: </li>
- <li>Nested | </li>
- <li><a href="#field.summary">Field</a> | </li>
- <li><a href="#constructor.summary">Constr</a> | </li>
- <li><a href="#method.summary">Method</a></li>
- </ul>
- <ul class="subNavList">
- <li>Detail: </li>
- <li><a href="#field.detail">Field</a> | </li>
- <li><a href="#constructor.detail">Constr</a> | </li>
- <li><a href="#method.detail">Method</a></li>
- </ul>
- </div>
- <a name="skip.navbar.top">
- <!-- -->
- </a></div>
- <!-- ========= END OF TOP NAVBAR ========= -->
- <!-- ======== START OF CLASS DATA ======== -->
- <div class="header">
- <div class="subTitle">org.jfree.chart.axis</div>
- <h2 title="Class SegmentedTimeline.Segment" class="title">Class SegmentedTimeline.Segment</h2>
- </div>
- <div class="contentContainer">
- <ul class="inheritance">
- <li>java.lang.Object</li>
- <li>
- <ul class="inheritance">
- <li>org.jfree.chart.axis.SegmentedTimeline.Segment</li>
- </ul>
- </li>
- </ul>
- <div class="description">
- <ul class="blockList">
- <li class="blockList">
- <dl>
- <dt>All Implemented Interfaces:</dt>
- <dd>java.io.Serializable, java.lang.Cloneable, java.lang.Comparable</dd>
- </dl>
- <dl>
- <dt>Direct Known Subclasses:</dt>
- <dd><a href="../../../../org/jfree/chart/axis/SegmentedTimeline.SegmentRange.html" title="class in org.jfree.chart.axis">SegmentedTimeline.SegmentRange</a></dd>
- </dl>
- <dl>
- <dt>Enclosing class:</dt>
- <dd><a href="../../../../org/jfree/chart/axis/SegmentedTimeline.html" title="class in org.jfree.chart.axis">SegmentedTimeline</a></dd>
- </dl>
- <hr>
- <br>
- <pre>public class <a href="../../../../src-html/org/jfree/chart/axis/SegmentedTimeline.html#line.1229">SegmentedTimeline.Segment</a>
- extends java.lang.Object
- implements java.lang.Comparable, java.lang.Cloneable, java.io.Serializable</pre>
- <div class="block">Internal class to represent a valid segment for this timeline. A segment
- is valid on a timeline if it is part of its included, excluded or
- exception segments.
- <p>
- Each segment will know its segment number, segmentStart, segmentEnd and
- index inside the segment.</div>
- <dl>
- <dt><span class="seeLabel">See Also:</span></dt>
- <dd><a href="../../../../serialized-form.html#org.jfree.chart.axis.SegmentedTimeline.Segment">Serialized Form</a></dd>
- </dl>
- </li>
- </ul>
- </div>
- <div class="summary">
- <ul class="blockList">
- <li class="blockList">
- <!-- =========== FIELD SUMMARY =========== -->
- <ul class="blockList">
- <li class="blockList"><a name="field.summary">
- <!-- -->
- </a>
- <h3>Field Summary</h3>
- <table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Field Summary table, listing fields, and an explanation">
- <caption><span>Fields</span><span class="tabEnd"> </span></caption>
- <tr>
- <th class="colFirst" scope="col">Modifier and Type</th>
- <th class="colLast" scope="col">Field and Description</th>
- </tr>
- <tr class="altColor">
- <td class="colFirst"><code>protected long</code></td>
- <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/jfree/chart/axis/SegmentedTimeline.Segment.html#millisecond">millisecond</a></span></code>
- <div class="block">A reference point within the segment.</div>
- </td>
- </tr>
- <tr class="rowColor">
- <td class="colFirst"><code>protected long</code></td>
- <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/jfree/chart/axis/SegmentedTimeline.Segment.html#segmentEnd">segmentEnd</a></span></code>
- <div class="block">The segment end.</div>
- </td>
- </tr>
- <tr class="altColor">
- <td class="colFirst"><code>protected long</code></td>
- <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/jfree/chart/axis/SegmentedTimeline.Segment.html#segmentNumber">segmentNumber</a></span></code>
- <div class="block">The segment number.</div>
- </td>
- </tr>
- <tr class="rowColor">
- <td class="colFirst"><code>protected long</code></td>
- <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/jfree/chart/axis/SegmentedTimeline.Segment.html#segmentStart">segmentStart</a></span></code>
- <div class="block">The segment start.</div>
- </td>
- </tr>
- </table>
- </li>
- </ul>
- <!-- ======== CONSTRUCTOR SUMMARY ======== -->
- <ul class="blockList">
- <li class="blockList"><a name="constructor.summary">
- <!-- -->
- </a>
- <h3>Constructor Summary</h3>
- <table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Constructor Summary table, listing constructors, and an explanation">
- <caption><span>Constructors</span><span class="tabEnd"> </span></caption>
- <tr>
- <th class="colFirst" scope="col">Modifier</th>
- <th class="colLast" scope="col">Constructor and Description</th>
- </tr>
- <tr class="altColor">
- <td class="colFirst"><code>protected </code></td>
- <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/jfree/chart/axis/SegmentedTimeline.Segment.html#Segment--">Segment</a></span>()</code>
- <div class="block">Protected constructor only used by sub-classes.</div>
- </td>
- </tr>
- <tr class="rowColor">
- <td class="colFirst"><code>protected </code></td>
- <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/jfree/chart/axis/SegmentedTimeline.Segment.html#Segment-long-">Segment</a></span>(long millisecond)</code>
- <div class="block">Creates a segment for a given point in time.</div>
- </td>
- </tr>
- </table>
- </li>
- </ul>
- <!-- ========== METHOD SUMMARY =========== -->
- <ul class="blockList">
- <li class="blockList"><a name="method.summary">
- <!-- -->
- </a>
- <h3>Method Summary</h3>
- <table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation">
- <caption><span id="t0" class="activeTableTab"><span>All Methods</span><span class="tabEnd"> </span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd"> </span></span><span id="t4" class="tableTab"><span><a href="javascript:show(8);">Concrete Methods</a></span><span class="tabEnd"> </span></span></caption>
- <tr>
- <th class="colFirst" scope="col">Modifier and Type</th>
- <th class="colLast" scope="col">Method and Description</th>
- </tr>
- <tr id="i0" class="altColor">
- <td class="colFirst"><code>boolean</code></td>
- <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/jfree/chart/axis/SegmentedTimeline.Segment.html#after-org.jfree.chart.axis.SegmentedTimeline.Segment-">after</a></span>(<a href="../../../../org/jfree/chart/axis/SegmentedTimeline.Segment.html" title="class in org.jfree.chart.axis">SegmentedTimeline.Segment</a> other)</code>
- <div class="block">Returns <code>true</code> if this segment is wholly after another
- segment.</div>
- </td>
- </tr>
- <tr id="i1" class="rowColor">
- <td class="colFirst"><code>boolean</code></td>
- <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/jfree/chart/axis/SegmentedTimeline.Segment.html#before-org.jfree.chart.axis.SegmentedTimeline.Segment-">before</a></span>(<a href="../../../../org/jfree/chart/axis/SegmentedTimeline.Segment.html" title="class in org.jfree.chart.axis">SegmentedTimeline.Segment</a> other)</code>
- <div class="block">Returns <code>true</code> if this segment is wholly before another
- segment.</div>
- </td>
- </tr>
- <tr id="i2" class="altColor">
- <td class="colFirst"><code>long</code></td>
- <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/jfree/chart/axis/SegmentedTimeline.Segment.html#calculateSegmentNumber-long-">calculateSegmentNumber</a></span>(long millis)</code>
- <div class="block">Calculates the segment number for a given millisecond.</div>
- </td>
- </tr>
- <tr id="i3" class="rowColor">
- <td class="colFirst"><code>int</code></td>
- <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/jfree/chart/axis/SegmentedTimeline.Segment.html#compareTo-java.lang.Object-">compareTo</a></span>(java.lang.Object object)</code>
- <div class="block">Will compare this Segment with another Segment (from Comparable
- interface).</div>
- </td>
- </tr>
- <tr id="i4" class="altColor">
- <td class="colFirst"><code>boolean</code></td>
- <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/jfree/chart/axis/SegmentedTimeline.Segment.html#contained-long-long-">contained</a></span>(long from,
- long to)</code>
- <div class="block">Returns <code>true</code> if this segment is contained in an interval.</div>
- </td>
- </tr>
- <tr id="i5" class="rowColor">
- <td class="colFirst"><code>boolean</code></td>
- <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/jfree/chart/axis/SegmentedTimeline.Segment.html#contains-long-">contains</a></span>(long millis)</code>
- <div class="block">Returns true if a particular millisecond is contained in this
- segment.</div>
- </td>
- </tr>
- <tr id="i6" class="altColor">
- <td class="colFirst"><code>boolean</code></td>
- <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/jfree/chart/axis/SegmentedTimeline.Segment.html#contains-long-long-">contains</a></span>(long from,
- long to)</code>
- <div class="block">Returns <code>true</code> if an interval is contained in this
- segment.</div>
- </td>
- </tr>
- <tr id="i7" class="rowColor">
- <td class="colFirst"><code>boolean</code></td>
- <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/jfree/chart/axis/SegmentedTimeline.Segment.html#contains-org.jfree.chart.axis.SegmentedTimeline.Segment-">contains</a></span>(<a href="../../../../org/jfree/chart/axis/SegmentedTimeline.Segment.html" title="class in org.jfree.chart.axis">SegmentedTimeline.Segment</a> segment)</code>
- <div class="block">Returns <code>true</code> if a segment is contained in this segment.</div>
- </td>
- </tr>
- <tr id="i8" class="altColor">
- <td class="colFirst"><code><a href="../../../../org/jfree/chart/axis/SegmentedTimeline.Segment.html" title="class in org.jfree.chart.axis">SegmentedTimeline.Segment</a></code></td>
- <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/jfree/chart/axis/SegmentedTimeline.Segment.html#copy--">copy</a></span>()</code>
- <div class="block">Returns a copy of ourselves or <code>null</code> if there was an
- exception during cloning.</div>
- </td>
- </tr>
- <tr id="i9" class="rowColor">
- <td class="colFirst"><code>void</code></td>
- <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/jfree/chart/axis/SegmentedTimeline.Segment.html#dec--">dec</a></span>()</code>
- <div class="block">Decrements the internal attributes of this segment by one segment.</div>
- </td>
- </tr>
- <tr id="i10" class="altColor">
- <td class="colFirst"><code>void</code></td>
- <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/jfree/chart/axis/SegmentedTimeline.Segment.html#dec-long-">dec</a></span>(long n)</code>
- <div class="block">Decrements the internal attributes of this segment by a number of
- segments.</div>
- </td>
- </tr>
- <tr id="i11" class="rowColor">
- <td class="colFirst"><code>boolean</code></td>
- <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/jfree/chart/axis/SegmentedTimeline.Segment.html#equals-java.lang.Object-">equals</a></span>(java.lang.Object object)</code>
- <div class="block">Tests an object (usually another <code>Segment</code>) for equality
- with this segment.</div>
- </td>
- </tr>
- <tr id="i12" class="altColor">
- <td class="colFirst"><code>java.util.Date</code></td>
- <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/jfree/chart/axis/SegmentedTimeline.Segment.html#getDate--">getDate</a></span>()</code>
- <div class="block">Returns a <code>Date</code> that represents the reference point
- for this segment.</div>
- </td>
- </tr>
- <tr id="i13" class="rowColor">
- <td class="colFirst"><code>long</code></td>
- <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/jfree/chart/axis/SegmentedTimeline.Segment.html#getMillisecond--">getMillisecond</a></span>()</code>
- <div class="block">Returns the millisecond used to reference this segment (always
- between the segmentStart and segmentEnd).</div>
- </td>
- </tr>
- <tr id="i14" class="altColor">
- <td class="colFirst"><code>long</code></td>
- <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/jfree/chart/axis/SegmentedTimeline.Segment.html#getSegmentCount--">getSegmentCount</a></span>()</code>
- <div class="block">Returns always one (the number of segments contained in this
- segment).</div>
- </td>
- </tr>
- <tr id="i15" class="rowColor">
- <td class="colFirst"><code>long</code></td>
- <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/jfree/chart/axis/SegmentedTimeline.Segment.html#getSegmentEnd--">getSegmentEnd</a></span>()</code>
- <div class="block">Gets the end of this segment in ms.</div>
- </td>
- </tr>
- <tr id="i16" class="altColor">
- <td class="colFirst"><code>long</code></td>
- <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/jfree/chart/axis/SegmentedTimeline.Segment.html#getSegmentNumber--">getSegmentNumber</a></span>()</code>
- <div class="block">Returns the segment number of this segment.</div>
- </td>
- </tr>
- <tr id="i17" class="rowColor">
- <td class="colFirst"><code>long</code></td>
- <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/jfree/chart/axis/SegmentedTimeline.Segment.html#getSegmentStart--">getSegmentStart</a></span>()</code>
- <div class="block">Gets the start of this segment in ms.</div>
- </td>
- </tr>
- <tr id="i18" class="altColor">
- <td class="colFirst"><code>void</code></td>
- <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/jfree/chart/axis/SegmentedTimeline.Segment.html#inc--">inc</a></span>()</code>
- <div class="block">Increments the internal attributes of this segment by one segment.</div>
- </td>
- </tr>
- <tr id="i19" class="rowColor">
- <td class="colFirst"><code>void</code></td>
- <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/jfree/chart/axis/SegmentedTimeline.Segment.html#inc-long-">inc</a></span>(long n)</code>
- <div class="block">Increments the internal attributes of this segment by a number of
- segments.</div>
- </td>
- </tr>
- <tr id="i20" class="altColor">
- <td class="colFirst"><code>boolean</code></td>
- <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/jfree/chart/axis/SegmentedTimeline.Segment.html#inExceptionSegments--">inExceptionSegments</a></span>()</code>
- <div class="block">Returns true if we are an exception segment.</div>
- </td>
- </tr>
- <tr id="i21" class="rowColor">
- <td class="colFirst"><code>boolean</code></td>
- <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/jfree/chart/axis/SegmentedTimeline.Segment.html#inExcludeSegments--">inExcludeSegments</a></span>()</code>
- <div class="block">Returns true if we are an excluded segment.</div>
- </td>
- </tr>
- <tr id="i22" class="altColor">
- <td class="colFirst"><code>boolean</code></td>
- <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/jfree/chart/axis/SegmentedTimeline.Segment.html#inIncludeSegments--">inIncludeSegments</a></span>()</code>
- <div class="block">Returns true if we are an included segment and we are not an
- exception.</div>
- </td>
- </tr>
- <tr id="i23" class="rowColor">
- <td class="colFirst"><code><a href="../../../../org/jfree/chart/axis/SegmentedTimeline.Segment.html" title="class in org.jfree.chart.axis">SegmentedTimeline.Segment</a></code></td>
- <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/jfree/chart/axis/SegmentedTimeline.Segment.html#intersect-long-long-">intersect</a></span>(long from,
- long to)</code>
- <div class="block">Returns a segment that is the intersection of this segment and the
- interval.</div>
- </td>
- </tr>
- <tr id="i24" class="altColor">
- <td class="colFirst"><code>void</code></td>
- <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/jfree/chart/axis/SegmentedTimeline.Segment.html#moveIndexToEnd--">moveIndexToEnd</a></span>()</code>
- <div class="block">Moves the index of this segment to the end of the segment.</div>
- </td>
- </tr>
- <tr id="i25" class="rowColor">
- <td class="colFirst"><code>void</code></td>
- <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/jfree/chart/axis/SegmentedTimeline.Segment.html#moveIndexToStart--">moveIndexToStart</a></span>()</code>
- <div class="block">Moves the index of this segment to the beginning if the segment.</div>
- </td>
- </tr>
- </table>
- <ul class="blockList">
- <li class="blockList"><a name="methods.inherited.from.class.java.lang.Object">
- <!-- -->
- </a>
- <h3>Methods inherited from class java.lang.Object</h3>
- <code>clone, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait</code></li>
- </ul>
- </li>
- </ul>
- </li>
- </ul>
- </div>
- <div class="details">
- <ul class="blockList">
- <li class="blockList">
- <!-- ============ FIELD DETAIL =========== -->
- <ul class="blockList">
- <li class="blockList"><a name="field.detail">
- <!-- -->
- </a>
- <h3>Field Detail</h3>
- <a name="segmentNumber">
- <!-- -->
- </a>
- <ul class="blockList">
- <li class="blockList">
- <h4>segmentNumber</h4>
- <pre>protected long <a href="../../../../src-html/org/jfree/chart/axis/SegmentedTimeline.Segment.html#line.1232">segmentNumber</a></pre>
- <div class="block">The segment number.</div>
- </li>
- </ul>
- <a name="segmentStart">
- <!-- -->
- </a>
- <ul class="blockList">
- <li class="blockList">
- <h4>segmentStart</h4>
- <pre>protected long <a href="../../../../src-html/org/jfree/chart/axis/SegmentedTimeline.Segment.html#line.1235">segmentStart</a></pre>
- <div class="block">The segment start.</div>
- </li>
- </ul>
- <a name="segmentEnd">
- <!-- -->
- </a>
- <ul class="blockList">
- <li class="blockList">
- <h4>segmentEnd</h4>
- <pre>protected long <a href="../../../../src-html/org/jfree/chart/axis/SegmentedTimeline.Segment.html#line.1238">segmentEnd</a></pre>
- <div class="block">The segment end.</div>
- </li>
- </ul>
- <a name="millisecond">
- <!-- -->
- </a>
- <ul class="blockListLast">
- <li class="blockList">
- <h4>millisecond</h4>
- <pre>protected long <a href="../../../../src-html/org/jfree/chart/axis/SegmentedTimeline.Segment.html#line.1241">millisecond</a></pre>
- <div class="block">A reference point within the segment.</div>
- </li>
- </ul>
- </li>
- </ul>
- <!-- ========= CONSTRUCTOR DETAIL ======== -->
- <ul class="blockList">
- <li class="blockList"><a name="constructor.detail">
- <!-- -->
- </a>
- <h3>Constructor Detail</h3>
- <a name="Segment--">
- <!-- -->
- </a>
- <ul class="blockList">
- <li class="blockList">
- <h4>Segment</h4>
- <pre>protected <a href="../../../../src-html/org/jfree/chart/axis/SegmentedTimeline.Segment.html#line.1246">Segment</a>()</pre>
- <div class="block">Protected constructor only used by sub-classes.</div>
- </li>
- </ul>
- <a name="Segment-long-">
- <!-- -->
- </a>
- <ul class="blockListLast">
- <li class="blockList">
- <h4>Segment</h4>
- <pre>protected <a href="../../../../src-html/org/jfree/chart/axis/SegmentedTimeline.Segment.html#line.1255">Segment</a>(long millisecond)</pre>
- <div class="block">Creates a segment for a given point in time.</div>
- <dl>
- <dt><span class="paramLabel">Parameters:</span></dt>
- <dd><code>millisecond</code> - the millisecond (as encoded by java.util.Date).</dd>
- </dl>
- </li>
- </ul>
- </li>
- </ul>
- <!-- ============ METHOD DETAIL ========== -->
- <ul class="blockList">
- <li class="blockList"><a name="method.detail">
- <!-- -->
- </a>
- <h3>Method Detail</h3>
- <a name="calculateSegmentNumber-long-">
- <!-- -->
- </a>
- <ul class="blockList">
- <li class="blockList">
- <h4>calculateSegmentNumber</h4>
- <pre>public long <a href="../../../../src-html/org/jfree/chart/axis/SegmentedTimeline.Segment.html#line.1271">calculateSegmentNumber</a>(long millis)</pre>
- <div class="block">Calculates the segment number for a given millisecond.</div>
- <dl>
- <dt><span class="paramLabel">Parameters:</span></dt>
- <dd><code>millis</code> - the millisecond (as encoded by java.util.Date).</dd>
- <dt><span class="returnLabel">Returns:</span></dt>
- <dd>The segment number.</dd>
- </dl>
- </li>
- </ul>
- <a name="getSegmentNumber--">
- <!-- -->
- </a>
- <ul class="blockList">
- <li class="blockList">
- <h4>getSegmentNumber</h4>
- <pre>public long <a href="../../../../src-html/org/jfree/chart/axis/SegmentedTimeline.Segment.html#line.1287">getSegmentNumber</a>()</pre>
- <div class="block">Returns the segment number of this segment. Segments start at 0.</div>
- <dl>
- <dt><span class="returnLabel">Returns:</span></dt>
- <dd>The segment number.</dd>
- </dl>
- </li>
- </ul>
- <a name="getSegmentCount--">
- <!-- -->
- </a>
- <ul class="blockList">
- <li class="blockList">
- <h4>getSegmentCount</h4>
- <pre>public long <a href="../../../../src-html/org/jfree/chart/axis/SegmentedTimeline.Segment.html#line.1297">getSegmentCount</a>()</pre>
- <div class="block">Returns always one (the number of segments contained in this
- segment).</div>
- <dl>
- <dt><span class="returnLabel">Returns:</span></dt>
- <dd>The segment count (always 1 for this class).</dd>
- </dl>
- </li>
- </ul>
- <a name="getSegmentStart--">
- <!-- -->
- </a>
- <ul class="blockList">
- <li class="blockList">
- <h4>getSegmentStart</h4>
- <pre>public long <a href="../../../../src-html/org/jfree/chart/axis/SegmentedTimeline.Segment.html#line.1306">getSegmentStart</a>()</pre>
- <div class="block">Gets the start of this segment in ms.</div>
- <dl>
- <dt><span class="returnLabel">Returns:</span></dt>
- <dd>The segment start.</dd>
- </dl>
- </li>
- </ul>
- <a name="getSegmentEnd--">
- <!-- -->
- </a>
- <ul class="blockList">
- <li class="blockList">
- <h4>getSegmentEnd</h4>
- <pre>public long <a href="../../../../src-html/org/jfree/chart/axis/SegmentedTimeline.Segment.html#line.1315">getSegmentEnd</a>()</pre>
- <div class="block">Gets the end of this segment in ms.</div>
- <dl>
- <dt><span class="returnLabel">Returns:</span></dt>
- <dd>The segment end.</dd>
- </dl>
- </li>
- </ul>
- <a name="getMillisecond--">
- <!-- -->
- </a>
- <ul class="blockList">
- <li class="blockList">
- <h4>getMillisecond</h4>
- <pre>public long <a href="../../../../src-html/org/jfree/chart/axis/SegmentedTimeline.Segment.html#line.1325">getMillisecond</a>()</pre>
- <div class="block">Returns the millisecond used to reference this segment (always
- between the segmentStart and segmentEnd).</div>
- <dl>
- <dt><span class="returnLabel">Returns:</span></dt>
- <dd>The millisecond.</dd>
- </dl>
- </li>
- </ul>
- <a name="getDate--">
- <!-- -->
- </a>
- <ul class="blockList">
- <li class="blockList">
- <h4>getDate</h4>
- <pre>public java.util.Date <a href="../../../../src-html/org/jfree/chart/axis/SegmentedTimeline.Segment.html#line.1335">getDate</a>()</pre>
- <div class="block">Returns a <code>Date</code> that represents the reference point
- for this segment.</div>
- <dl>
- <dt><span class="returnLabel">Returns:</span></dt>
- <dd>The date.</dd>
- </dl>
- </li>
- </ul>
- <a name="contains-long-">
- <!-- -->
- </a>
- <ul class="blockList">
- <li class="blockList">
- <h4>contains</h4>
- <pre>public boolean <a href="../../../../src-html/org/jfree/chart/axis/SegmentedTimeline.Segment.html#line.1348">contains</a>(long millis)</pre>
- <div class="block">Returns true if a particular millisecond is contained in this
- segment.</div>
- <dl>
- <dt><span class="paramLabel">Parameters:</span></dt>
- <dd><code>millis</code> - the millisecond to verify.</dd>
- <dt><span class="returnLabel">Returns:</span></dt>
- <dd><code>true</code> if the millisecond is contained in the
- segment.</dd>
- </dl>
- </li>
- </ul>
- <a name="contains-long-long-">
- <!-- -->
- </a>
- <ul class="blockList">
- <li class="blockList">
- <h4>contains</h4>
- <pre>public boolean <a href="../../../../src-html/org/jfree/chart/axis/SegmentedTimeline.Segment.html#line.1362">contains</a>(long from,
- long to)</pre>
- <div class="block">Returns <code>true</code> if an interval is contained in this
- segment.</div>
- <dl>
- <dt><span class="paramLabel">Parameters:</span></dt>
- <dd><code>from</code> - the start of the interval.</dd>
- <dd><code>to</code> - the end of the interval.</dd>
- <dt><span class="returnLabel">Returns:</span></dt>
- <dd><code>true</code> if the interval is contained in the
- segment.</dd>
- </dl>
- </li>
- </ul>
- <a name="contains-org.jfree.chart.axis.SegmentedTimeline.Segment-">
- <!-- -->
- </a>
- <ul class="blockList">
- <li class="blockList">
- <h4>contains</h4>
- <pre>public boolean <a href="../../../../src-html/org/jfree/chart/axis/SegmentedTimeline.Segment.html#line.1374">contains</a>(<a href="../../../../org/jfree/chart/axis/SegmentedTimeline.Segment.html" title="class in org.jfree.chart.axis">SegmentedTimeline.Segment</a> segment)</pre>
- <div class="block">Returns <code>true</code> if a segment is contained in this segment.</div>
- <dl>
- <dt><span class="paramLabel">Parameters:</span></dt>
- <dd><code>segment</code> - the segment to test for inclusion</dd>
- <dt><span class="returnLabel">Returns:</span></dt>
- <dd><code>true</code> if the segment is contained in this
- segment.</dd>
- </dl>
- </li>
- </ul>
- <a name="contained-long-long-">
- <!-- -->
- </a>
- <ul class="blockList">
- <li class="blockList">
- <h4>contained</h4>
- <pre>public boolean <a href="../../../../src-html/org/jfree/chart/axis/SegmentedTimeline.Segment.html#line.1386">contained</a>(long from,
- long to)</pre>
- <div class="block">Returns <code>true</code> if this segment is contained in an interval.</div>
- <dl>
- <dt><span class="paramLabel">Parameters:</span></dt>
- <dd><code>from</code> - the start of the interval.</dd>
- <dd><code>to</code> - the end of the interval.</dd>
- <dt><span class="returnLabel">Returns:</span></dt>
- <dd><code>true</code> if this segment is contained in the interval.</dd>
- </dl>
- </li>
- </ul>
- <a name="intersect-long-long-">
- <!-- -->
- </a>
- <ul class="blockList">
- <li class="blockList">
- <h4>intersect</h4>
- <pre>public <a href="../../../../org/jfree/chart/axis/SegmentedTimeline.Segment.html" title="class in org.jfree.chart.axis">SegmentedTimeline.Segment</a> <a href="../../../../src-html/org/jfree/chart/axis/SegmentedTimeline.Segment.html#line.1399">intersect</a>(long from,
- long to)</pre>
- <div class="block">Returns a segment that is the intersection of this segment and the
- interval.</div>
- <dl>
- <dt><span class="paramLabel">Parameters:</span></dt>
- <dd><code>from</code> - the start of the interval.</dd>
- <dd><code>to</code> - the end of the interval.</dd>
- <dt><span class="returnLabel">Returns:</span></dt>
- <dd>A segment.</dd>
- </dl>
- </li>
- </ul>
- <a name="before-org.jfree.chart.axis.SegmentedTimeline.Segment-">
- <!-- -->
- </a>
- <ul class="blockList">
- <li class="blockList">
- <h4>before</h4>
- <pre>public boolean <a href="../../../../src-html/org/jfree/chart/axis/SegmentedTimeline.Segment.html#line.1416">before</a>(<a href="../../../../org/jfree/chart/axis/SegmentedTimeline.Segment.html" title="class in org.jfree.chart.axis">SegmentedTimeline.Segment</a> other)</pre>
- <div class="block">Returns <code>true</code> if this segment is wholly before another
- segment.</div>
- <dl>
- <dt><span class="paramLabel">Parameters:</span></dt>
- <dd><code>other</code> - the other segment.</dd>
- <dt><span class="returnLabel">Returns:</span></dt>
- <dd>A boolean.</dd>
- </dl>
- </li>
- </ul>
- <a name="after-org.jfree.chart.axis.SegmentedTimeline.Segment-">
- <!-- -->
- </a>
- <ul class="blockList">
- <li class="blockList">
- <h4>after</h4>
- <pre>public boolean <a href="../../../../src-html/org/jfree/chart/axis/SegmentedTimeline.Segment.html#line.1428">after</a>(<a href="../../../../org/jfree/chart/axis/SegmentedTimeline.Segment.html" title="class in org.jfree.chart.axis">SegmentedTimeline.Segment</a> other)</pre>
- <div class="block">Returns <code>true</code> if this segment is wholly after another
- segment.</div>
- <dl>
- <dt><span class="paramLabel">Parameters:</span></dt>
- <dd><code>other</code> - the other segment.</dd>
- <dt><span class="returnLabel">Returns:</span></dt>
- <dd>A boolean.</dd>
- </dl>
- </li>
- </ul>
- <a name="equals-java.lang.Object-">
- <!-- -->
- </a>
- <ul class="blockList">
- <li class="blockList">
- <h4>equals</h4>
- <pre>public boolean <a href="../../../../src-html/org/jfree/chart/axis/SegmentedTimeline.Segment.html#line.1441">equals</a>(java.lang.Object object)</pre>
- <div class="block">Tests an object (usually another <code>Segment</code>) for equality
- with this segment.</div>
- <dl>
- <dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
- <dd><code>equals</code> in class <code>java.lang.Object</code></dd>
- <dt><span class="paramLabel">Parameters:</span></dt>
- <dd><code>object</code> - The other segment to compare with us</dd>
- <dt><span class="returnLabel">Returns:</span></dt>
- <dd><code>true</code> if we are the same segment</dd>
- </dl>
- </li>
- </ul>
- <a name="copy--">
- <!-- -->
- </a>
- <ul class="blockList">
- <li class="blockList">
- <h4>copy</h4>
- <pre>public <a href="../../../../org/jfree/chart/axis/SegmentedTimeline.Segment.html" title="class in org.jfree.chart.axis">SegmentedTimeline.Segment</a> <a href="../../../../src-html/org/jfree/chart/axis/SegmentedTimeline.Segment.html#line.1460">copy</a>()</pre>
- <div class="block">Returns a copy of ourselves or <code>null</code> if there was an
- exception during cloning.</div>
- <dl>
- <dt><span class="returnLabel">Returns:</span></dt>
- <dd>A copy of this segment.</dd>
- </dl>
- </li>
- </ul>
- <a name="compareTo-java.lang.Object-">
- <!-- -->
- </a>
- <ul class="blockList">
- <li class="blockList">
- <h4>compareTo</h4>
- <pre>public int <a href="../../../../src-html/org/jfree/chart/axis/SegmentedTimeline.Segment.html#line.1479">compareTo</a>(java.lang.Object object)</pre>
- <div class="block">Will compare this Segment with another Segment (from Comparable
- interface).</div>
- <dl>
- <dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
- <dd><code>compareTo</code> in interface <code>java.lang.Comparable</code></dd>
- <dt><span class="paramLabel">Parameters:</span></dt>
- <dd><code>object</code> - The other Segment to compare with</dd>
- <dt><span class="returnLabel">Returns:</span></dt>
- <dd>-1: this < object, 0: this.equal(object) and
- +1: this > object</dd>
- </dl>
- </li>
- </ul>
- <a name="inIncludeSegments--">
- <!-- -->
- </a>
- <ul class="blockList">
- <li class="blockList">
- <h4>inIncludeSegments</h4>
- <pre>public boolean <a href="../../../../src-html/org/jfree/chart/axis/SegmentedTimeline.Segment.html#line.1498">inIncludeSegments</a>()</pre>
- <div class="block">Returns true if we are an included segment and we are not an
- exception.</div>
- <dl>
- <dt><span class="returnLabel">Returns:</span></dt>
- <dd><code>true</code> or <code>false</code>.</dd>
- </dl>
- </li>
- </ul>
- <a name="inExcludeSegments--">
- <!-- -->
- </a>
- <ul class="blockList">
- <li class="blockList">
- <h4>inExcludeSegments</h4>
- <pre>public boolean <a href="../../../../src-html/org/jfree/chart/axis/SegmentedTimeline.Segment.html#line.1513">inExcludeSegments</a>()</pre>
- <div class="block">Returns true if we are an excluded segment.</div>
- <dl>
- <dt><span class="returnLabel">Returns:</span></dt>
- <dd><code>true</code> or <code>false</code>.</dd>
- </dl>
- </li>
- </ul>
- <a name="inExceptionSegments--">
- <!-- -->
- </a>
- <ul class="blockList">
- <li class="blockList">
- <h4>inExceptionSegments</h4>
- <pre>public boolean <a href="../../../../src-html/org/jfree/chart/axis/SegmentedTimeline.Segment.html#line.1546">inExceptionSegments</a>()</pre>
- <div class="block">Returns true if we are an exception segment. This is implemented via
- a binary search on the exceptionSegments sorted list.
- If the segment is not listed as an exception in our list and we have
- a baseTimeline, a check is performed to see if the segment is inside
- an excluded segment from our base. If so, it is also considered an
- exception.</div>
- <dl>
- <dt><span class="returnLabel">Returns:</span></dt>
- <dd><code>true</code> if we are an exception segment.</dd>
- </dl>
- </li>
- </ul>
- <a name="inc-long-">
- <!-- -->
- </a>
- <ul class="blockList">
- <li class="blockList">
- <h4>inc</h4>
- <pre>public void <a href="../../../../src-html/org/jfree/chart/axis/SegmentedTimeline.Segment.html#line.1556">inc</a>(long n)</pre>
- <div class="block">Increments the internal attributes of this segment by a number of
- segments.</div>
- <dl>
- <dt><span class="paramLabel">Parameters:</span></dt>
- <dd><code>n</code> - Number of segments to increment.</dd>
- </dl>
- </li>
- </ul>
- <a name="inc--">
- <!-- -->
- </a>
- <ul class="blockList">
- <li class="blockList">
- <h4>inc</h4>
- <pre>public void <a href="../../../../src-html/org/jfree/chart/axis/SegmentedTimeline.Segment.html#line.1568">inc</a>()</pre>
- <div class="block">Increments the internal attributes of this segment by one segment.
- The exact time incremented is segmentSize.</div>
- </li>
- </ul>
- <a name="dec-long-">
- <!-- -->
- </a>
- <ul class="blockList">
- <li class="blockList">
- <h4>dec</h4>
- <pre>public void <a href="../../../../src-html/org/jfree/chart/axis/SegmentedTimeline.Segment.html#line.1578">dec</a>(long n)</pre>
- <div class="block">Decrements the internal attributes of this segment by a number of
- segments.</div>
- <dl>
- <dt><span class="paramLabel">Parameters:</span></dt>
- <dd><code>n</code> - Number of segments to decrement.</dd>
- </dl>
- </li>
- </ul>
- <a name="dec--">
- <!-- -->
- </a>
- <ul class="blockList">
- <li class="blockList">
- <h4>dec</h4>
- <pre>public void <a href="../../../../src-html/org/jfree/chart/axis/SegmentedTimeline.Segment.html#line.1590">dec</a>()</pre>
- <div class="block">Decrements the internal attributes of this segment by one segment.
- The exact time decremented is segmentSize.</div>
- </li>
- </ul>
- <a name="moveIndexToStart--">
- <!-- -->
- </a>
- <ul class="blockList">
- <li class="blockList">
- <h4>moveIndexToStart</h4>
- <pre>public void <a href="../../../../src-html/org/jfree/chart/axis/SegmentedTimeline.Segment.html#line.1597">moveIndexToStart</a>()</pre>
- <div class="block">Moves the index of this segment to the beginning if the segment.</div>
- </li>
- </ul>
- <a name="moveIndexToEnd--">
- <!-- -->
- </a>
- <ul class="blockListLast">
- <li class="blockList">
- <h4>moveIndexToEnd</h4>
- <pre>public void <a href="../../../../src-html/org/jfree/chart/axis/SegmentedTimeline.Segment.html#line.1604">moveIndexToEnd</a>()</pre>
- <div class="block">Moves the index of this segment to the end of the segment.</div>
- </li>
- </ul>
- </li>
- </ul>
- </li>
- </ul>
- </div>
- </div>
- <!-- ========= END OF CLASS DATA ========= -->
- <!-- ======= START OF BOTTOM NAVBAR ====== -->
- <div class="bottomNav"><a name="navbar.bottom">
- <!-- -->
- </a>
- <div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div>
- <a name="navbar.bottom.firstrow">
- <!-- -->
- </a>
- <ul class="navList" title="Navigation">
- <li><a href="../../../../overview-summary.html">Overview</a></li>
- <li><a href="package-summary.html">Package</a></li>
- <li class="navBarCell1Rev">Class</li>
- <li><a href="class-use/SegmentedTimeline.Segment.html">Use</a></li>
- <li><a href="package-tree.html">Tree</a></li>
- <li><a href="../../../../deprecated-list.html">Deprecated</a></li>
- <li><a href="../../../../index-files/index-1.html">Index</a></li>
- <li><a href="../../../../help-doc.html">Help</a></li>
- </ul>
- </div>
- <div class="subNav">
- <ul class="navList">
- <li><a href="../../../../org/jfree/chart/axis/SegmentedTimeline.BaseTimelineSegmentRange.html" title="class in org.jfree.chart.axis"><span class="typeNameLink">Prev Class</span></a></li>
- <li><a href="../../../../org/jfree/chart/axis/SegmentedTimeline.SegmentRange.html" title="class in org.jfree.chart.axis"><span class="typeNameLink">Next Class</span></a></li>
- </ul>
- <ul class="navList">
- <li><a href="../../../../index.html?org/jfree/chart/axis/SegmentedTimeline.Segment.html" target="_top">Frames</a></li>
- <li><a href="SegmentedTimeline.Segment.html" target="_top">No Frames</a></li>
- </ul>
- <ul class="navList" id="allclasses_navbar_bottom">
- <li><a href="../../../../allclasses-noframe.html">All Classes</a></li>
- </ul>
- <div>
- <script type="text/javascript"><!--
- allClassesLink = document.getElementById("allclasses_navbar_bottom");
- if(window==top) {
- allClassesLink.style.display = "block";
- }
- else {
- allClassesLink.style.display = "none";
- }
- //-->
- </script>
- </div>
- <div>
- <ul class="subNavList">
- <li>Summary: </li>
- <li>Nested | </li>
- <li><a href="#field.summary">Field</a> | </li>
- <li><a href="#constructor.summary">Constr</a> | </li>
- <li><a href="#method.summary">Method</a></li>
- </ul>
- <ul class="subNavList">
- <li>Detail: </li>
- <li><a href="#field.detail">Field</a> | </li>
- <li><a href="#constructor.detail">Constr</a> | </li>
- <li><a href="#method.detail">Method</a></li>
- </ul>
- </div>
- <a name="skip.navbar.bottom">
- <!-- -->
- </a></div>
- <!-- ======== END OF BOTTOM NAVBAR ======= -->
- </body>
- </html>
|