📄 segmentedtimeline.html
字号:
The segment range is identified by a domainValue that begins a valid segment and ends with a domainValue that ends a valid segment. Therefore the range will contain all segments whose segmentStart <= domainValue and segmentEnd <= toDomainValue.<P><DD><DL></DL></DD><DD><DL><DT><B>Parameters:</B><DD><CODE>fromDomainValue</CODE> - start of domain range to treat as an exception<DD><CODE>toDomainValue</CODE> - end of domain range to treat as an exception</DL></DD></DL><HR><A NAME="addException(java.util.Date)"><!-- --></A><H3>addException</H3><PRE>public void <B>addException</B>(java.util.Date exceptionDate)</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 Date into any part of the segment.<P><DD><DL></DL></DD><DD><DL><DT><B>Parameters:</B><DD><CODE>exceptionDate</CODE> - Date into the segment to exclude.</DL></DD></DL><HR><A NAME="addExceptions(java.util.List)"><!-- --></A><H3>addExceptions</H3><PRE>public void <B>addExceptions</B>(java.util.List exceptionList)</PRE><DL><DD>Adds a list of dates as segment exceptions. Each 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 Date into any part of the segment.<P><DD><DL></DL></DD><DD><DL><DT><B>Parameters:</B><DD><CODE>exceptionList</CODE> - List of Date objects that identify the segments to exclude.</DL></DD></DL><HR><A NAME="addBaseTimelineException(long)"><!-- --></A><H3>addBaseTimelineException</H3><PRE>public void <B>addBaseTimelineException</B>(long domainValue)</PRE><DL><DD>Adds a segment relative to the baseTimeline as an exception. Because a base segment is normally larger than our segments, this may add one or more segment ranges to the exception list. <p> 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 baseTimeline segment.<P><DD><DL></DL></DD><DD><DL><DT><B>Parameters:</B><DD><CODE>domainValue</CODE> - domain value to teat as a baseTimeline exception.</DL></DD></DL><HR><A NAME="addBaseTimelineException(java.util.Date)"><!-- --></A><H3>addBaseTimelineException</H3><PRE>public void <B>addBaseTimelineException</B>(java.util.Date date)</PRE><DL><DD>Adds a segment relative to the baseTimeline 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 occure (the proposed exception segment will be discarted). <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>date</CODE> - date domain value to treat as a baseTimeline exception</DL></DD></DL><HR><A NAME="addBaseTimelineExclusions(long, long)"><!-- --></A><H3>addBaseTimelineExclusions</H3><PRE>public void <B>addBaseTimelineExclusions</B>(long fromBaseDomainValue, long toBaseDomainValue)</PRE><DL><DD>Adds all excluded segments from the BaseTimeline as exceptions to our timeline. This allows us to combine two timelines for more complex calculations.<P><DD><DL></DL></DD><DD><DL><DT><B>Parameters:</B><DD><CODE>fromBaseDomainValue</CODE> - Start of the range where exclusions will be extracted.<DD><CODE>toBaseDomainValue</CODE> - End of the range to process.</DL></DD></DL><HR><A NAME="getExceptionSegmentCount(long, long)"><!-- --></A><H3>getExceptionSegmentCount</H3><PRE>public long <B>getExceptionSegmentCount</B>(long fromMillisecond, long toMillisecond)</PRE><DL><DD>Returns the number of exception segments wholly contained in the (fromDomainValue, toDomainValue) interval.<P><DD><DL></DL></DD><DD><DL><DT><B>Parameters:</B><DD><CODE>fromMillisecond</CODE> - the beginning of the interval.<DD><CODE>toMillisecond</CODE> - the end of the interval.<DT><B>Returns:</B><DD>Number of exception segments contained in the interval.</DL></DD></DL><HR><A NAME="getSegment(long)"><!-- --></A><H3>getSegment</H3><PRE>public <A HREF="../../../../org/jfree/chart/axis/SegmentedTimeline.Segment.html" title="class in org.jfree.chart.axis">SegmentedTimeline.Segment</A> <B>getSegment</B>(long millisecond)</PRE><DL><DD>Returns a segment that contains a domainValue. If the domainValue is not contained in the timeline (because it is not contained in the baseTimeline), a Segment that contains <code>index + segmentSize*m</code> will be returned for the smallest <code>m</code> possible.<P><DD><DL></DL></DD><DD><DL><DT><B>Parameters:</B><DD><CODE>millisecond</CODE> - index into the segment<DT><B>Returns:</B><DD>a Segment that contains index, or the next possible Segment.</DL></DD></DL><HR><A NAME="getSegment(java.util.Date)"><!-- --></A><H3>getSegment</H3><PRE>public <A HREF="../../../../org/jfree/chart/axis/SegmentedTimeline.Segment.html" title="class in org.jfree.chart.axis">SegmentedTimeline.Segment</A> <B>getSegment</B>(java.util.Date date)</PRE><DL><DD>Returns a segment that contains a date. For accurate calculations, the calendar should use TIME_ZONE for its calculation (or any other similar time zone). If the date is not contained in the timeline (because it is not contained in the baseTimeline), a Segment that contains <code>date + segmentSize*m</code> will be returned for the smallest <code>m</code> possible.<P><DD><DL></DL></DD><DD><DL><DT><B>Parameters:</B><DD><CODE>date</CODE> - date into the segment<DT><B>Returns:</B><DD>a Segment that contains date, or the next possible Segment.</DL></DD></DL><HR><A NAME="equals(java.lang.Object)"><!-- --></A><H3>equals</H3><PRE>public boolean <B>equals</B>(java.lang.Object o)</PRE><DL><DD>Returns true if we are equal to the parameter<P><DD><DL></DL></DD><DD><DL><DT><B>Parameters:</B><DD><CODE>o</CODE> - Object to verify with us<DT><B>Returns:</B><DD>true or false</DL></DD></DL><HR><A NAME="getTime(java.util.Date)"><!-- --></A><H3>getTime</H3><PRE>public long <B>getTime</B>(java.util.Date date)</PRE><DL><DD>Special method that handles conversion between the Default Time Zone and a UTC time zone with no DST. This is needed so all days have the same size. This method is the prefered way of converting a Data into milliseconds for usage in this class.<P><DD><DL></DL></DD><DD><DL><DT><B>Parameters:</B><DD><CODE>date</CODE> - Date to convert to long.<DT><B>Returns:</B><DD>The milliseconds.</DL></DD></DL><HR><A NAME="getDate(long)"><!-- --></A><H3>getDate</H3><PRE>public java.util.Date <B>getDate</B>(long value)</PRE><DL><DD>Converts a millisecond value into a <CODE>Date</CODE> object.<P><DD><DL></DL></DD><DD><DL><DT><B>Parameters:</B><DD><CODE>value</CODE> - the millisecond value.<DT><B>Returns:</B><DD>The date.</DL></DD></DL><HR><A NAME="clone()"><!-- --></A><H3>clone</H3><PRE>public java.lang.Object <B>clone</B>() throws java.lang.CloneNotSupportedException</PRE><DL><DD>Returns a clone of the timeline.<P><DD><DL></DL></DD><DD><DL><DT><B>Returns:</B><DD>A clone.<DT><B>Throws:</B><DD><CODE>java.lang.CloneNotSupportedException</CODE> - ??.</DL></DD></DL><!-- ========= END OF CLASS DATA ========= --><HR><!-- ======= START OF BOTTOM NAVBAR ====== --><A NAME="navbar_bottom"><!-- --></A><A HREF="#skip-navbar_bottom" title="Skip navigation links"></A><TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY=""><TR><TD COLSPAN=3 BGCOLOR="#EEEEFF" CLASS="NavBarCell1"><A NAME="navbar_bottom_firstrow"><!-- --></A><TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY=""> <TR ALIGN="center" VALIGN="top"> <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A> </TD> <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A> </TD> <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> <FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT> </TD> <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A> </TD> <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A> </TD> <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A> </TD> <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A> </TD> </TR></TABLE></TD><TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM></EM></TD></TR><TR><TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> <A HREF="../../../../org/jfree/chart/axis/NumberTickUnit.html" title="class in org.jfree.chart.axis"><B>PREV CLASS</B></A> <A HREF="../../../../org/jfree/chart/axis/SegmentedTimeline.BaseTimelineSegmentRange.html" title="class in org.jfree.chart.axis"><B>NEXT CLASS</B></A></FONT></TD><TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> <A HREF="../../../../index.html" target="_top"><B>FRAMES</B></A> <A HREF="SegmentedTimeline.html" target="_top"><B>NO FRAMES</B></A> <SCRIPT type="text/javascript"> <!-- if(window==top) { document.writeln('<A HREF="../../../../allclasses-noframe.html"><B>All Classes</B></A>'); } //--></SCRIPT><NOSCRIPT> <A HREF="../../../../allclasses-noframe.html"><B>All Classes</B></A></NOSCRIPT></FONT></TD></TR><TR><TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2"> SUMMARY: <A HREF="#nested_class_summary">NESTED</A> | <A HREF="#field_summary">FIELD</A> | <A HREF="#constructor_summary">CONSTR</A> | <A HREF="#method_summary">METHOD</A></FONT></TD><TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">DETAIL: <A HREF="#field_detail">FIELD</A> | <A HREF="#constructor_detail">CONSTR</A> | <A HREF="#method_detail">METHOD</A></FONT></TD></TR></TABLE><A NAME="skip-navbar_bottom"></A><!-- ======== END OF BOTTOM NAVBAR ======= --><HR></BODY></HTML>
⌨️ 快捷键说明
复制代码
Ctrl + C
搜索代码
Ctrl + F
全屏模式
F11
切换主题
Ctrl + Shift + D
显示快捷键
?
增大字号
Ctrl + =
减小字号
Ctrl + -