segmentedtimeline.html

JFreeChart 9.20的文档 需要用JAVA在网页上做统计图的东东

</DL>
</DD>
<DD><DL>

<DT><B>Returns:</B><DD>The number of segments.</DL>
</DD>
</DL>
<HR>

<A NAME="getSegmentsGroupSize()"><!-- --></A><H3>
getSegmentsGroupSize</H3>
<PRE>
public long <B>getSegmentsGroupSize</B>()</PRE>
<DL>
<DD>Returns the size in milliseconds of a segment group. This will be equal to
 size of the segments included plus the size of the segments excluded.
<P>
<DD><DL>
</DL>
</DD>
<DD><DL>

<DT><B>Returns:</B><DD>The segment group size in milliseconds.</DL>
</DD>
</DL>
<HR>

<A NAME="getSegmentsIncluded()"><!-- --></A><H3>
getSegmentsIncluded</H3>
<PRE>
public int <B>getSegmentsIncluded</B>()</PRE>
<DL>
<DD>Returns the number of segments included per segment group.
<P>
<DD><DL>
</DL>
</DD>
<DD><DL>

<DT><B>Returns:</B><DD>The number of segments.</DL>
</DD>
</DL>
<HR>

<A NAME="getSegmentsIncludedSize()"><!-- --></A><H3>
getSegmentsIncludedSize</H3>
<PRE>
public long <B>getSegmentsIncludedSize</B>()</PRE>
<DL>
<DD>Returns the size in ms of the segments included per segment group.
<P>
<DD><DL>
</DL>
</DD>
<DD><DL>

<DT><B>Returns:</B><DD>The segment size in milliseconds.</DL>
</DD>
</DL>
<HR>

<A NAME="getSegmentSize()"><!-- --></A><H3>
getSegmentSize</H3>
<PRE>
public long <B>getSegmentSize</B>()</PRE>
<DL>
<DD>Returns the size of one segment in ms.
<P>
<DD><DL>
</DL>
</DD>
<DD><DL>

<DT><B>Returns:</B><DD>The segment size in milliseconds.</DL>
</DD>
</DL>
<HR>

<A NAME="getExceptionSegments()"><!-- --></A><H3>
getExceptionSegments</H3>
<PRE>
public java.util.List <B>getExceptionSegments</B>()</PRE>
<DL>
<DD>Returns a list of all the exception segments. This list is not modifiable.
<P>
<DD><DL>
</DL>
</DD>
<DD><DL>

<DT><B>Returns:</B><DD>The exception segments.</DL>
</DD>
</DL>
<HR>

<A NAME="setExceptionSegments(java.util.List)"><!-- --></A><H3>
setExceptionSegments</H3>
<PRE>
public void <B>setExceptionSegments</B>(java.util.List&nbsp;exceptionSegments)</PRE>
<DL>
<DD>Sets the exception segments list.
<P>
<DD><DL>
</DL>
</DD>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>exceptionSegments</CODE> - the exception segments.</DL>
</DD>
</DL>
<HR>

<A NAME="getBaseTimeline()"><!-- --></A><H3>
getBaseTimeline</H3>
<PRE>
public <A HREF="../../../../org/jfree/chart/axis/SegmentedTimeline.html" title="class in org.jfree.chart.axis">SegmentedTimeline</A> <B>getBaseTimeline</B>()</PRE>
<DL>
<DD>Returns our baseTimeline, or <code>null</code> if none.
<P>
<DD><DL>
</DL>
</DD>
<DD><DL>

<DT><B>Returns:</B><DD>The base timeline.</DL>
</DD>
</DL>
<HR>

<A NAME="setBaseTimeline(org.jfree.chart.axis.SegmentedTimeline)"><!-- --></A><H3>
setBaseTimeline</H3>
<PRE>
public void <B>setBaseTimeline</B>(<A HREF="../../../../org/jfree/chart/axis/SegmentedTimeline.html" title="class in org.jfree.chart.axis">SegmentedTimeline</A>&nbsp;baseTimeline)</PRE>
<DL>
<DD>Sets the base timeline.
<P>
<DD><DL>
</DL>
</DD>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>baseTimeline</CODE> - the timeline.</DL>
</DD>
</DL>
<HR>

<A NAME="toTimelineValue(long)"><!-- --></A><H3>
toTimelineValue</H3>
<PRE>
public long <B>toTimelineValue</B>(long&nbsp;millisecond)</PRE>
<DL>
<DD>Translates a value relative to the domain value (all Dates) into a value
 relative to the segmented timeline. The values relative to the segmented timeline
 are all consecutives starting at zero at the startTime.
<P>
<DD><DL>
<DT><B>Specified by:</B><DD><CODE><A HREF="../../../../org/jfree/chart/axis/Timeline.html#toTimelineValue(long)">toTimelineValue</A></CODE> in interface <CODE><A HREF="../../../../org/jfree/chart/axis/Timeline.html" title="interface in org.jfree.chart.axis">Timeline</A></CODE></DL>
</DD>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>millisecond</CODE> - the millisecond (as encoded by java.util.Date).
<DT><B>Returns:</B><DD>The timeline value.</DL>
</DD>
</DL>
<HR>

<A NAME="toTimelineValue(java.util.Date)"><!-- --></A><H3>
toTimelineValue</H3>
<PRE>
public long <B>toTimelineValue</B>(java.util.Date&nbsp;date)</PRE>
<DL>
<DD>Translates a date into a value relative to the segmented timeline. The values relative 
 to the segmented timeline are all consecutives starting at zero at the startTime.
<P>
<DD><DL>
<DT><B>Specified by:</B><DD><CODE><A HREF="../../../../org/jfree/chart/axis/Timeline.html#toTimelineValue(java.util.Date)">toTimelineValue</A></CODE> in interface <CODE><A HREF="../../../../org/jfree/chart/axis/Timeline.html" title="interface in org.jfree.chart.axis">Timeline</A></CODE></DL>
</DD>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>date</CODE> - date relative to the domain.
<DT><B>Returns:</B><DD>The timeline value (in milliseconds).</DL>
</DD>
</DL>
<HR>

<A NAME="toMillisecond(long)"><!-- --></A><H3>
toMillisecond</H3>
<PRE>
public long <B>toMillisecond</B>(long&nbsp;timelineValue)</PRE>
<DL>
<DD>Translates a value relative to the timeline into a millisecond.
<P>
<DD><DL>
<DT><B>Specified by:</B><DD><CODE><A HREF="../../../../org/jfree/chart/axis/Timeline.html#toMillisecond(long)">toMillisecond</A></CODE> in interface <CODE><A HREF="../../../../org/jfree/chart/axis/Timeline.html" title="interface in org.jfree.chart.axis">Timeline</A></CODE></DL>
</DD>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>timelineValue</CODE> - the timeline value (in milliseconds).
<DT><B>Returns:</B><DD>The domain value (in milliseconds).<DT><B>See Also:</B><DD><A HREF="../../../../org/jfree/chart/axis/SegmentedTimeline.html" title="class in org.jfree.chart.axis"><CODE>SegmentedTimeline</CODE></A></DL>
</DD>
</DL>
<HR>

<A NAME="getTimeFromLong(long)"><!-- --></A><H3>
getTimeFromLong</H3>
<PRE>
public long <B>getTimeFromLong</B>(long&nbsp;date)</PRE>
<DL>
<DD>Converts a date/time value to take account of daylight savings time.
<P>
<DD><DL>
</DL>
</DD>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>date</CODE> - the milliseconds.
<DT><B>Returns:</B><DD>The milliseconds.</DL>
</DD>
</DL>
<HR>

<A NAME="containsDomainValue(long)"><!-- --></A><H3>
containsDomainValue</H3>
<PRE>
public boolean <B>containsDomainValue</B>(long&nbsp;millisecond)</PRE>
<DL>
<DD>Returns <code>true</code> if a value is contained in the timeline.
<P>
<DD><DL>
<DT><B>Specified by:</B><DD><CODE><A HREF="../../../../org/jfree/chart/axis/Timeline.html#containsDomainValue(long)">containsDomainValue</A></CODE> in interface <CODE><A HREF="../../../../org/jfree/chart/axis/Timeline.html" title="interface in org.jfree.chart.axis">Timeline</A></CODE></DL>
</DD>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>millisecond</CODE> - the value to verify.
<DT><B>Returns:</B><DD><code>true</code> if value is contained in the timeline.</DL>
</DD>
</DL>
<HR>

<A NAME="containsDomainValue(java.util.Date)"><!-- --></A><H3>
containsDomainValue</H3>
<PRE>
public boolean <B>containsDomainValue</B>(java.util.Date&nbsp;date)</PRE>
<DL>
<DD>Returns true if a value is contained in the timeline.
<P>
<DD><DL>
<DT><B>Specified by:</B><DD><CODE><A HREF="../../../../org/jfree/chart/axis/Timeline.html#containsDomainValue(java.util.Date)">containsDomainValue</A></CODE> in interface <CODE><A HREF="../../../../org/jfree/chart/axis/Timeline.html" title="interface in org.jfree.chart.axis">Timeline</A></CODE></DL>
</DD>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>date</CODE> - date to verify
<DT><B>Returns:</B><DD>true if value is contained in the timeline</DL>
</DD>
</DL>
<HR>

<A NAME="containsDomainRange(long, long)"><!-- --></A><H3>
containsDomainRange</H3>
<PRE>
public boolean <B>containsDomainRange</B>(long&nbsp;domainValueStart,
                                   long&nbsp;domainValueEnd)</PRE>
<DL>
<DD>Returns true if a range of values are contained in the timeline. This is
 implemented verifying that all segments are in the range.
<P>
<DD><DL>
<DT><B>Specified by:</B><DD><CODE><A HREF="../../../../org/jfree/chart/axis/Timeline.html#containsDomainRange(long, long)">containsDomainRange</A></CODE> in interface <CODE><A HREF="../../../../org/jfree/chart/axis/Timeline.html" title="interface in org.jfree.chart.axis">Timeline</A></CODE></DL>
</DD>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>domainValueStart</CODE> - start of the range to verify<DD><CODE>domainValueEnd</CODE> - end of the range to verify
<DT><B>Returns:</B><DD>true if the range is contained in the timeline</DL>
</DD>
</DL>
<HR>

<A NAME="containsDomainRange(java.util.Date, java.util.Date)"><!-- --></A><H3>
containsDomainRange</H3>
<PRE>
public boolean <B>containsDomainRange</B>(java.util.Date&nbsp;dateDomainValueStart,
                                   java.util.Date&nbsp;dateDomainValueEnd)</PRE>
<DL>
<DD>Returns true if a range of values are contained in the timeline. This is
 implemented verifying that all segments are in the range.
<P>
<DD><DL>
<DT><B>Specified by:</B><DD><CODE><A HREF="../../../../org/jfree/chart/axis/Timeline.html#containsDomainRange(java.util.Date, java.util.Date)">containsDomainRange</A></CODE> in interface <CODE><A HREF="../../../../org/jfree/chart/axis/Timeline.html" title="interface in org.jfree.chart.axis">Timeline</A></CODE></DL>
</DD>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>dateDomainValueStart</CODE> - start of the range to verify<DD><CODE>dateDomainValueEnd</CODE> - end of the range to verify
<DT><B>Returns:</B><DD>true if the range is contained in the timeline</DL>
</DD>
</DL>
<HR>

<A NAME="addException(long)"><!-- --></A><H3>
addException</H3>
<PRE>
public void <B>addException</B>(long&nbsp;millisecond)</PRE>
<DL>
<DD>Adds a segment as an exception. An exception segment is defined as a segment
 to exclude from what would otherwise be considered a valid segment of the timeline.
 An exception segment can not be contained inside an already excluded segment.
 If so, no action will occur (the proposed exception segment will be discarded).
 <p>
 The segment is identified by a domainValue into any part of the segment.
 Therefore the segmentStart <= domainValue <= segmentEnd.
<P>
<DD><DL>
</DL>
</DD>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>millisecond</CODE> - domain value to treat as an exception</DL>
</DD>
</DL>
<HR>

<A NAME="addException(long, long)"><!-- --></A><H3>
addException</H3>
<PRE>
public void <B>addException</B>(long&nbsp;fromDomainValue,
                         long&nbsp;toDomainValue)</PRE>
<DL>
<DD>Adds a segment range as an exception. An exception segment is defined as a segment
 to exclude from what would otherwise be considered a valid segment of the timeline.
 An exception segment can not be contained inside an already excluded segment.
 If so, no action will occur (the proposed exception segment will be discarded).
 <p>