/lib/docs/api/com/toedter/calendar/DateUtil.html
HTML | 465 lines | 388 code | 53 blank | 24 comment | 0 complexity | 1ae3d37887d8c4c11ff55dbec6e8f8f3 MD5 | raw file
1<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd"> 2<!--NewPage--> 3<HTML> 4<HEAD> 5<!-- Generated by javadoc (build 1.5.0_06) on Sun Jun 04 15:41:05 CEST 2006 --> 6<TITLE> 7DateUtil (JCalendar API) 8</TITLE> 9 10<META NAME="keywords" CONTENT="com.toedter.calendar.DateUtil class"> 11 12<LINK REL ="stylesheet" TYPE="text/css" HREF="../../../stylesheet.css" TITLE="Style"> 13 14<SCRIPT type="text/javascript"> 15function windowTitle() 16{ 17 parent.document.title="DateUtil (JCalendar API)"; 18} 19</SCRIPT> 20<NOSCRIPT> 21</NOSCRIPT> 22 23</HEAD> 24 25<BODY BGCOLOR="white" onload="windowTitle();"> 26 27 28<!-- ========= START OF TOP NAVBAR ======= --> 29<A NAME="navbar_top"><!-- --></A> 30<A HREF="#skip-navbar_top" title="Skip navigation links"></A> 31<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY=""> 32<TR> 33<TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> 34<A NAME="navbar_top_firstrow"><!-- --></A> 35<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY=""> 36 <TR ALIGN="center" VALIGN="top"> 37 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A> </TD> 38 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A> </TD> 39 <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> <FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT> </TD> 40 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A> </TD> 41 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A> </TD> 42 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A> </TD> 43 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A> </TD> 44 </TR> 45</TABLE> 46</TD> 47<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM> 48</EM> 49</TD> 50</TR> 51 52<TR> 53<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> 54 PREV CLASS 55 <A HREF="../../../com/toedter/calendar/IDateEditor.html" title="interface in com.toedter.calendar"><B>NEXT CLASS</B></A></FONT></TD> 56<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> 57 <A HREF="../../../index.html?com/toedter/calendar/DateUtil.html" target="_top"><B>FRAMES</B></A> 58 <A HREF="DateUtil.html" target="_top"><B>NO FRAMES</B></A> 59 <SCRIPT type="text/javascript"> 60 <!-- 61 if(window==top) { 62 document.writeln('<A HREF="../../../allclasses-noframe.html"><B>All Classes</B></A>'); 63 } 64 //--> 65</SCRIPT> 66<NOSCRIPT> 67 <A HREF="../../../allclasses-noframe.html"><B>All Classes</B></A> 68</NOSCRIPT> 69 70 71</FONT></TD> 72</TR> 73<TR> 74<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2"> 75 SUMMARY: NESTED | <A HREF="#field_summary">FIELD</A> | <A HREF="#constructor_summary">CONSTR</A> | <A HREF="#method_summary">METHOD</A></FONT></TD> 76<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2"> 77DETAIL: <A HREF="#field_detail">FIELD</A> | <A HREF="#constructor_detail">CONSTR</A> | <A HREF="#method_detail">METHOD</A></FONT></TD> 78</TR> 79</TABLE> 80<A NAME="skip-navbar_top"></A> 81<!-- ========= END OF TOP NAVBAR ========= --> 82 83<HR> 84<!-- ======== START OF CLASS DATA ======== --> 85<H2> 86<FONT SIZE="-1"> 87com.toedter.calendar</FONT> 88<BR> 89Class DateUtil</H2> 90<PRE> 91java.lang.Object 92 <IMG SRC="../../../resources/inherit.gif" ALT="extended by "><B>com.toedter.calendar.DateUtil</B> 93</PRE> 94<HR> 95<DL> 96<DT><PRE>public class <B>DateUtil</B><DT>extends java.lang.Object</DL> 97</PRE> 98 99<P> 100A utility class for some date operations. 101<P> 102 103<P> 104<DL> 105<DT><B>Version:</B></DT> 106 <DD>$LastChangedRevision: 95 $, $LastChangedDate: 2006-05-05 18:43:15 +0200 (Fr, 05 Mai 2006) $</DD> 107<DT><B>Author:</B></DT> 108 <DD>Kai Toedter</DD> 109</DL> 110<HR> 111 112<P> 113<!-- =========== FIELD SUMMARY =========== --> 114 115<A NAME="field_summary"><!-- --></A> 116<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> 117<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor"> 118<TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2"> 119<B>Field Summary</B></FONT></TH> 120</TR> 121<TR BGCOLOR="white" CLASS="TableRowColor"> 122<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> 123<CODE>protected java.util.Date</CODE></FONT></TD> 124<TD><CODE><B><A HREF="../../../com/toedter/calendar/DateUtil.html#defaultMaxSelectableDate">defaultMaxSelectableDate</A></B></CODE> 125 126<BR> 127 </TD> 128</TR> 129<TR BGCOLOR="white" CLASS="TableRowColor"> 130<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> 131<CODE>protected java.util.Date</CODE></FONT></TD> 132<TD><CODE><B><A HREF="../../../com/toedter/calendar/DateUtil.html#defaultMinSelectableDate">defaultMinSelectableDate</A></B></CODE> 133 134<BR> 135 </TD> 136</TR> 137<TR BGCOLOR="white" CLASS="TableRowColor"> 138<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> 139<CODE>protected java.util.Date</CODE></FONT></TD> 140<TD><CODE><B><A HREF="../../../com/toedter/calendar/DateUtil.html#maxSelectableDate">maxSelectableDate</A></B></CODE> 141 142<BR> 143 </TD> 144</TR> 145<TR BGCOLOR="white" CLASS="TableRowColor"> 146<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> 147<CODE>protected java.util.Date</CODE></FONT></TD> 148<TD><CODE><B><A HREF="../../../com/toedter/calendar/DateUtil.html#minSelectableDate">minSelectableDate</A></B></CODE> 149 150<BR> 151 </TD> 152</TR> 153</TABLE> 154 155<!-- ======== CONSTRUCTOR SUMMARY ======== --> 156 157<A NAME="constructor_summary"><!-- --></A> 158<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> 159<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor"> 160<TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2"> 161<B>Constructor Summary</B></FONT></TH> 162</TR> 163<TR BGCOLOR="white" CLASS="TableRowColor"> 164<TD><CODE><B><A HREF="../../../com/toedter/calendar/DateUtil.html#DateUtil()">DateUtil</A></B>()</CODE> 165 166<BR> 167 </TD> 168</TR> 169</TABLE> 170 171<!-- ========== METHOD SUMMARY =========== --> 172 173<A NAME="method_summary"><!-- --></A> 174<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> 175<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor"> 176<TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2"> 177<B>Method Summary</B></FONT></TH> 178</TR> 179<TR BGCOLOR="white" CLASS="TableRowColor"> 180<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> 181<CODE> boolean</CODE></FONT></TD> 182<TD><CODE><B><A HREF="../../../com/toedter/calendar/DateUtil.html#checkDate(java.util.Date)">checkDate</A></B>(java.util.Date date)</CODE> 183 184<BR> 185 Checks a given date if it is in the formally specified date range.</TD> 186</TR> 187<TR BGCOLOR="white" CLASS="TableRowColor"> 188<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> 189<CODE> java.util.Date</CODE></FONT></TD> 190<TD><CODE><B><A HREF="../../../com/toedter/calendar/DateUtil.html#getMaxSelectableDate()">getMaxSelectableDate</A></B>()</CODE> 191 192<BR> 193 Gets the maximum selectable date.</TD> 194</TR> 195<TR BGCOLOR="white" CLASS="TableRowColor"> 196<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> 197<CODE> java.util.Date</CODE></FONT></TD> 198<TD><CODE><B><A HREF="../../../com/toedter/calendar/DateUtil.html#getMinSelectableDate()">getMinSelectableDate</A></B>()</CODE> 199 200<BR> 201 Gets the minimum selectable date.</TD> 202</TR> 203<TR BGCOLOR="white" CLASS="TableRowColor"> 204<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> 205<CODE> java.util.Date</CODE></FONT></TD> 206<TD><CODE><B><A HREF="../../../com/toedter/calendar/DateUtil.html#setMaxSelectableDate(java.util.Date)">setMaxSelectableDate</A></B>(java.util.Date max)</CODE> 207 208<BR> 209 Sets the maximum selectable date.</TD> 210</TR> 211<TR BGCOLOR="white" CLASS="TableRowColor"> 212<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> 213<CODE> java.util.Date</CODE></FONT></TD> 214<TD><CODE><B><A HREF="../../../com/toedter/calendar/DateUtil.html#setMinSelectableDate(java.util.Date)">setMinSelectableDate</A></B>(java.util.Date min)</CODE> 215 216<BR> 217 Sets the minimum selectable date.</TD> 218</TR> 219<TR BGCOLOR="white" CLASS="TableRowColor"> 220<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> 221<CODE> void</CODE></FONT></TD> 222<TD><CODE><B><A HREF="../../../com/toedter/calendar/DateUtil.html#setSelectableDateRange(java.util.Date, java.util.Date)">setSelectableDateRange</A></B>(java.util.Date min, 223 java.util.Date max)</CODE> 224 225<BR> 226 Sets a valid date range for selectable dates.</TD> 227</TR> 228</TABLE> 229 <A NAME="methods_inherited_from_class_java.lang.Object"><!-- --></A> 230<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> 231<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor"> 232<TH ALIGN="left"><B>Methods inherited from class java.lang.Object</B></TH> 233</TR> 234<TR BGCOLOR="white" CLASS="TableRowColor"> 235<TD><CODE>clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait</CODE></TD> 236</TR> 237</TABLE> 238 239<P> 240 241<!-- ============ FIELD DETAIL =========== --> 242 243<A NAME="field_detail"><!-- --></A> 244<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> 245<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor"> 246<TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2"> 247<B>Field Detail</B></FONT></TH> 248</TR> 249</TABLE> 250 251<A NAME="minSelectableDate"><!-- --></A><H3> 252minSelectableDate</H3> 253<PRE> 254protected java.util.Date <B>minSelectableDate</B></PRE> 255<DL> 256<DL> 257</DL> 258</DL> 259<HR> 260 261<A NAME="maxSelectableDate"><!-- --></A><H3> 262maxSelectableDate</H3> 263<PRE> 264protected java.util.Date <B>maxSelectableDate</B></PRE> 265<DL> 266<DL> 267</DL> 268</DL> 269<HR> 270 271<A NAME="defaultMinSelectableDate"><!-- --></A><H3> 272defaultMinSelectableDate</H3> 273<PRE> 274protected java.util.Date <B>defaultMinSelectableDate</B></PRE> 275<DL> 276<DL> 277</DL> 278</DL> 279<HR> 280 281<A NAME="defaultMaxSelectableDate"><!-- --></A><H3> 282defaultMaxSelectableDate</H3> 283<PRE> 284protected java.util.Date <B>defaultMaxSelectableDate</B></PRE> 285<DL> 286<DL> 287</DL> 288</DL> 289 290<!-- ========= CONSTRUCTOR DETAIL ======== --> 291 292<A NAME="constructor_detail"><!-- --></A> 293<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> 294<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor"> 295<TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2"> 296<B>Constructor Detail</B></FONT></TH> 297</TR> 298</TABLE> 299 300<A NAME="DateUtil()"><!-- --></A><H3> 301DateUtil</H3> 302<PRE> 303public <B>DateUtil</B>()</PRE> 304<DL> 305</DL> 306 307<!-- ============ METHOD DETAIL ========== --> 308 309<A NAME="method_detail"><!-- --></A> 310<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> 311<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor"> 312<TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2"> 313<B>Method Detail</B></FONT></TH> 314</TR> 315</TABLE> 316 317<A NAME="setSelectableDateRange(java.util.Date, java.util.Date)"><!-- --></A><H3> 318setSelectableDateRange</H3> 319<PRE> 320public void <B>setSelectableDateRange</B>(java.util.Date min, 321 java.util.Date max)</PRE> 322<DL> 323<DD>Sets a valid date range for selectable dates. If max is before min, the 324 default range with no limitation is set. 325<P> 326<DD><DL> 327<DT><B>Parameters:</B><DD><CODE>min</CODE> - the minimum selectable date or null (then the minimum date is 328 set to 01\01\0001)<DD><CODE>max</CODE> - the maximum selectable date or null (then the maximum date is 329 set to 01\01\9999)</DL> 330</DD> 331</DL> 332<HR> 333 334<A NAME="setMaxSelectableDate(java.util.Date)"><!-- --></A><H3> 335setMaxSelectableDate</H3> 336<PRE> 337public java.util.Date <B>setMaxSelectableDate</B>(java.util.Date max)</PRE> 338<DL> 339<DD>Sets the maximum selectable date. If null, the date 01\01\9999 will be set instead. 340<P> 341<DD><DL> 342<DT><B>Parameters:</B><DD><CODE>max</CODE> - the maximum selectable date 343<DT><B>Returns:</B><DD>the maximum selectable date</DL> 344</DD> 345</DL> 346<HR> 347 348<A NAME="setMinSelectableDate(java.util.Date)"><!-- --></A><H3> 349setMinSelectableDate</H3> 350<PRE> 351public java.util.Date <B>setMinSelectableDate</B>(java.util.Date min)</PRE> 352<DL> 353<DD>Sets the minimum selectable date. If null, the date 01\01\0001 will be set instead. 354<P> 355<DD><DL> 356<DT><B>Parameters:</B><DD><CODE>min</CODE> - the minimum selectable date 357<DT><B>Returns:</B><DD>the minimum selectable date</DL> 358</DD> 359</DL> 360<HR> 361 362<A NAME="getMaxSelectableDate()"><!-- --></A><H3> 363getMaxSelectableDate</H3> 364<PRE> 365public java.util.Date <B>getMaxSelectableDate</B>()</PRE> 366<DL> 367<DD>Gets the maximum selectable date. 368<P> 369<DD><DL> 370 371<DT><B>Returns:</B><DD>the maximum selectable date</DL> 372</DD> 373</DL> 374<HR> 375 376<A NAME="getMinSelectableDate()"><!-- --></A><H3> 377getMinSelectableDate</H3> 378<PRE> 379public java.util.Date <B>getMinSelectableDate</B>()</PRE> 380<DL> 381<DD>Gets the minimum selectable date. 382<P> 383<DD><DL> 384 385<DT><B>Returns:</B><DD>the minimum selectable date</DL> 386</DD> 387</DL> 388<HR> 389 390<A NAME="checkDate(java.util.Date)"><!-- --></A><H3> 391checkDate</H3> 392<PRE> 393public boolean <B>checkDate</B>(java.util.Date date)</PRE> 394<DL> 395<DD>Checks a given date if it is in the formally specified date range. 396<P> 397<DD><DL> 398<DT><B>Parameters:</B><DD><CODE>date</CODE> - the date to check 399<DT><B>Returns:</B><DD>true, if the date is within minSelectableDate and 400 maxSelectableDate</DL> 401</DD> 402</DL> 403<!-- ========= END OF CLASS DATA ========= --> 404<HR> 405 406 407<!-- ======= START OF BOTTOM NAVBAR ====== --> 408<A NAME="navbar_bottom"><!-- --></A> 409<A HREF="#skip-navbar_bottom" title="Skip navigation links"></A> 410<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY=""> 411<TR> 412<TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> 413<A NAME="navbar_bottom_firstrow"><!-- --></A> 414<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY=""> 415 <TR ALIGN="center" VALIGN="top"> 416 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A> </TD> 417 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A> </TD> 418 <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> <FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT> </TD> 419 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A> </TD> 420 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A> </TD> 421 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A> </TD> 422 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A> </TD> 423 </TR> 424</TABLE> 425</TD> 426<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM> 427</EM> 428</TD> 429</TR> 430 431<TR> 432<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> 433 PREV CLASS 434 <A HREF="../../../com/toedter/calendar/IDateEditor.html" title="interface in com.toedter.calendar"><B>NEXT CLASS</B></A></FONT></TD> 435<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> 436 <A HREF="../../../index.html?com/toedter/calendar/DateUtil.html" target="_top"><B>FRAMES</B></A> 437 <A HREF="DateUtil.html" target="_top"><B>NO FRAMES</B></A> 438 <SCRIPT type="text/javascript"> 439 <!-- 440 if(window==top) { 441 document.writeln('<A HREF="../../../allclasses-noframe.html"><B>All Classes</B></A>'); 442 } 443 //--> 444</SCRIPT> 445<NOSCRIPT> 446 <A HREF="../../../allclasses-noframe.html"><B>All Classes</B></A> 447</NOSCRIPT> 448 449 450</FONT></TD> 451</TR> 452<TR> 453<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2"> 454 SUMMARY: NESTED | <A HREF="#field_summary">FIELD</A> | <A HREF="#constructor_summary">CONSTR</A> | <A HREF="#method_summary">METHOD</A></FONT></TD> 455<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2"> 456DETAIL: <A HREF="#field_detail">FIELD</A> | <A HREF="#constructor_detail">CONSTR</A> | <A HREF="#method_detail">METHOD</A></FONT></TD> 457</TR> 458</TABLE> 459<A NAME="skip-navbar_bottom"></A> 460<!-- ======== END OF BOTTOM NAVBAR ======= --> 461 462<HR> 463Copyright © 1999 - 2006 Kai Toedter. 464</BODY> 465</HTML>