912 lines
		
	
	
	
		
			23 KiB
		
	
	
	
		
			HTML
		
	
	
	
	
	
		
		
			
		
	
	
			912 lines
		
	
	
	
		
			23 KiB
		
	
	
	
		
			HTML
		
	
	
	
	
	
|  | <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN""http://www.w3.org/TR/REC-html40/loose.dtd"> | ||
|  | <!--NewPage--> | ||
|  | <HTML> | ||
|  | <HEAD> | ||
|  | <TITLE> | ||
|  | jala.Date.Calendar | ||
|  | </TITLE> | ||
|  | <LINK REL ="stylesheet" TYPE="text/css" HREF="stylesheet.css" TITLE="Style"> | ||
|  | </HEAD> | ||
|  | <SCRIPT> | ||
|  | function asd() | ||
|  | { | ||
|  | parent.document.title="jala.Date.Calendar"; | ||
|  | } | ||
|  | </SCRIPT> | ||
|  | <BODY BGCOLOR="white" onload="asd();"> | ||
|  | 
 | ||
|  | <!-- ========== START OF NAVBAR ========== --> | ||
|  | <A NAME="navbar_bottom"><!-- --></A> | ||
|  | <TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0"> | ||
|  | <TR> | ||
|  | <TD COLSPAN=3 BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> | ||
|  | <A NAME="navbar_bottom_firstrow"><!-- --></A> | ||
|  | <TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3"> | ||
|  |   <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="overview-summary-Date.js.html"><FONT CLASS="NavBarFont1"><B>File</B></FONT></A> </TD> | ||
|  |   <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> <FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT> </TD> | ||
|  |   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="overview-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A> </TD> | ||
|  |   <!--TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"-->    <!--A HREF="deprecated-list.html"--><!--FONT CLASS="NavBarFont1">Deprecated</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> | ||
|  | <B>Jala 1.3</B> | ||
|  | </EM> | ||
|  | </TD | ||
|  | </TR> | ||
|  | 
 | ||
|  | <TR> | ||
|  | <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> | ||
|  |  <A HREF="jala.Date.html"><B>PREV CLASS</B></A><!-- 
 | ||
|  |    NEXT CLASS  | ||
|  | --> | ||
|  |  <A HREF="jala.Date.Calendar.Renderer.html"><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="jala.Date.Calendar.html" TARGET="_top"><B>NO FRAMES</B></A>    | ||
|  |   | ||
|  | <SCRIPT> | ||
|  |   <!--
 | ||
|  |   if(window==top) { | ||
|  |     document.writeln('<A HREF="allclasses-noframe.html" TARGET=""><B>All Classes</B></A>'); | ||
|  |   } | ||
|  |   //--> | ||
|  | </SCRIPT> | ||
|  | <NOSCRIPT> | ||
|  | <A HREF="allclasses-noframe.html" TARGET=""><B>All Classes</B></A> | ||
|  | </NOSCRIPT> | ||
|  | </FONT></TD> | ||
|  | </TR> | ||
|  | <TR> | ||
|  | <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2"> | ||
|  |   SUMMARY: <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> | ||
|  | <!-- =========== END OF NAVBAR =========== --> | ||
|  | <HR> | ||
|  | 
 | ||
|  | <!-- ======== START OF CLASS DATA ======== --> | ||
|  | <H2>Class jala.Date.Calendar</H2> | ||
|  | <PRE>Object | ||
|  |    | | ||
|  |    +--<b>jala.Date.Calendar</b> | ||
|  | </PRE> | ||
|  | 
 | ||
|  | 
 | ||
|  | <HR> | ||
|  | <DL> | ||
|  |    <!-- Class definition --> | ||
|  |    <DT>class  | ||
|  |    <B>jala.Date.Calendar</B> | ||
|  |     | ||
|  | 
 | ||
|  | </DL> | ||
|  |     | ||
|  |    <P> | ||
|  |    <BR/>This class represents a calendar based based on a grouped | ||
|  |  collection of HopObjects. It provides several methods for rendering | ||
|  |  the calendar plus defining locale and timezone settings. | ||
|  |  <BR/><I>Defined in <a href='overview-summary-Date.js.html'>Date.js</a></I><BR/><BR/> | ||
|  |    </P> | ||
|  |     | ||
|  |    <HR> | ||
|  | 
 | ||
|  | <!-- ======== NESTED CLASS SUMMARY ======== --> | ||
|  | 
 | ||
|  | <A NAME="inner_classes"><!-- --></A> | ||
|  | <TABLE BORDER="1" CELLPADDING="3" CELLSPACING="0" WIDTH="100%"> | ||
|  | <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor"> | ||
|  | <TD COLSPAN=2><FONT SIZE="+2"> | ||
|  | <B>Nested Class Summary</B></FONT></TD> | ||
|  | </TR> | ||
|  | 
 | ||
|  |    <TR BGCOLOR="white" CLASS="TableRowColor"> | ||
|  |    <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> | ||
|  |    <CODE><static class></CODE></FONT></TD> | ||
|  |    <TD><CODE><B><A HREF="jala.Date.Calendar.Renderer.html">jala.Date.Calendar.Renderer</A></B></CODE></TD> | ||
|  |    </TR> | ||
|  | 
 | ||
|  | </TABLE> | ||
|  |   | ||
|  | 
 | ||
|  | <!-- ======== END NESTED CLASS SUMMARY ======== --> | ||
|  | 
 | ||
|  | 
 | ||
|  | <!-- =========== FIELD SUMMARY =========== --> | ||
|  | 
 | ||
|  | 
 | ||
|  |     | ||
|  | 
 | ||
|  | <!-- =========== END FIELD SUMMARY =========== --> | ||
|  | 
 | ||
|  | 
 | ||
|  | <!-- ======== CONSTRUCTOR SUMMARY ======== --> | ||
|  | 
 | ||
|  | <A NAME="constructor_summary"><!-- --></A> | ||
|  | <TABLE BORDER="1" CELLPADDING="3" CELLSPACING="0" WIDTH="100%"> | ||
|  | <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor"> | ||
|  | <TD COLSPAN=2><FONT SIZE="+2"> | ||
|  | <B>Constructor Summary</B></FONT></TD> | ||
|  | </TR> | ||
|  | <TR BGCOLOR="white" CLASS="TableRowColor"> | ||
|  |    <TD> | ||
|  |       <CODE> | ||
|  | 	 <B> | ||
|  | 	    <A HREF="jala.Date.Calendar.html#jala.Date.Calendar()">jala.Date.Calendar</A>  | ||
|  | 	 </B> | ||
|  | 	 (<<a href="HopObject.html">HopObject</a>> collection) | ||
|  |       </CODE> | ||
|  |       <BR> | ||
|  |                   | ||
|  |       Creates a new instance of jala.Data.Calendar | ||
|  |       </TD> | ||
|  | </TR> | ||
|  | </TABLE> | ||
|  | 
 | ||
|  | <!-- ======== END CONSTRUCTOR SUMMARY ======== --> | ||
|  | 
 | ||
|  |   | ||
|  | 
 | ||
|  | <!-- ========== METHOD SUMMARY =========== --> | ||
|  | 
 | ||
|  | <A NAME="method_summary"><!-- --></A> | ||
|  | <TABLE BORDER="1" CELLPADDING="3" CELLSPACING="0" WIDTH="100%"> | ||
|  | <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor"> | ||
|  | <TD COLSPAN=2><FONT SIZE="+2"> | ||
|  | <B>Method Summary</B></FONT></TD> | ||
|  | </TR> | ||
|  | 
 | ||
|  | 
 | ||
|  |    <TR BGCOLOR="white" CLASS="TableRowColor"> | ||
|  |       <TD ALIGN="right" VALIGN="top" WIDTH="1%"> | ||
|  | 	 <FONT SIZE="-1"> | ||
|  | 	    <CODE> String</CODE> | ||
|  | 	 </FONT> | ||
|  |       </TD> | ||
|  |       <TD> | ||
|  | 	 <CODE> | ||
|  | 	    <B> | ||
|  | 	       <A HREF="#getAccessNameFormat">getAccessNameFormat</A></B>() | ||
|  | 	 </CODE> | ||
|  | 	 <BR> | ||
|  | 	            | ||
|  | 	 Returns the format of the access name used by this calendar to access | ||
|  |  child group objects of the collection this calendar is operating on. | ||
|  |       </TD> | ||
|  |    </TR> | ||
|  | 
 | ||
|  |    <TR BGCOLOR="white" CLASS="TableRowColor"> | ||
|  |       <TD ALIGN="right" VALIGN="top" WIDTH="1%"> | ||
|  | 	 <FONT SIZE="-1"> | ||
|  | 	    <CODE> String</CODE> | ||
|  | 	 </FONT> | ||
|  |       </TD> | ||
|  |       <TD> | ||
|  | 	 <CODE> | ||
|  | 	    <B> | ||
|  | 	       <A HREF="#getCalendar">getCalendar</A></B>(today) | ||
|  | 	 </CODE> | ||
|  | 	 <BR> | ||
|  | 	            | ||
|  | 	 Returns a rendered calendar | ||
|  |       </TD> | ||
|  |    </TR> | ||
|  | 
 | ||
|  |    <TR BGCOLOR="white" CLASS="TableRowColor"> | ||
|  |       <TD ALIGN="right" VALIGN="top" WIDTH="1%"> | ||
|  | 	 <FONT SIZE="-1"> | ||
|  | 	    <CODE> <a href="HopObject.html">HopObject</a></CODE> | ||
|  | 	 </FONT> | ||
|  |       </TD> | ||
|  |       <TD> | ||
|  | 	 <CODE> | ||
|  | 	    <B> | ||
|  | 	       <A HREF="#getCollection">getCollection</A></B>() | ||
|  | 	 </CODE> | ||
|  | 	 <BR> | ||
|  | 	            | ||
|  | 	 Returns the collection this calendar object works on | ||
|  |       </TD> | ||
|  |    </TR> | ||
|  | 
 | ||
|  |    <TR BGCOLOR="white" CLASS="TableRowColor"> | ||
|  |       <TD ALIGN="right" VALIGN="top" WIDTH="1%"> | ||
|  | 	 <FONT SIZE="-1"> | ||
|  | 	    <CODE> String</CODE> | ||
|  | 	 </FONT> | ||
|  |       </TD> | ||
|  |       <TD> | ||
|  | 	 <CODE> | ||
|  | 	    <B> | ||
|  | 	       <A HREF="#getHrefFormat">getHrefFormat</A></B>() | ||
|  | 	 </CODE> | ||
|  | 	 <BR> | ||
|  | 	            | ||
|  | 	 Returns the date formatting pattern used to render hrefs. | ||
|  |       </TD> | ||
|  |    </TR> | ||
|  | 
 | ||
|  |    <TR BGCOLOR="white" CLASS="TableRowColor"> | ||
|  |       <TD ALIGN="right" VALIGN="top" WIDTH="1%"> | ||
|  | 	 <FONT SIZE="-1"> | ||
|  | 	    <CODE> java.util.Locale</CODE> | ||
|  | 	 </FONT> | ||
|  |       </TD> | ||
|  |       <TD> | ||
|  | 	 <CODE> | ||
|  | 	    <B> | ||
|  | 	       <A HREF="#getLocale">getLocale</A></B>() | ||
|  | 	 </CODE> | ||
|  | 	 <BR> | ||
|  | 	            | ||
|  | 	 Returns the locale used within this calendar instance. | ||
|  |       </TD> | ||
|  |    </TR> | ||
|  | 
 | ||
|  |    <TR BGCOLOR="white" CLASS="TableRowColor"> | ||
|  |       <TD ALIGN="right" VALIGN="top" WIDTH="1%"> | ||
|  | 	 <FONT SIZE="-1"> | ||
|  | 	    <CODE> Object</CODE> | ||
|  | 	 </FONT> | ||
|  |       </TD> | ||
|  |       <TD> | ||
|  | 	 <CODE> | ||
|  | 	    <B> | ||
|  | 	       <A HREF="#getRenderer">getRenderer</A></B>() | ||
|  | 	 </CODE> | ||
|  | 	 <BR> | ||
|  | 	            | ||
|  | 	 Returns the renderer used by this calendar. | ||
|  |       </TD> | ||
|  |    </TR> | ||
|  | 
 | ||
|  |    <TR BGCOLOR="white" CLASS="TableRowColor"> | ||
|  |       <TD ALIGN="right" VALIGN="top" WIDTH="1%"> | ||
|  | 	 <FONT SIZE="-1"> | ||
|  | 	    <CODE> java.util.Locale</CODE> | ||
|  | 	 </FONT> | ||
|  |       </TD> | ||
|  |       <TD> | ||
|  | 	 <CODE> | ||
|  | 	    <B> | ||
|  | 	       <A HREF="#getTimeZone">getTimeZone</A></B>() | ||
|  | 	 </CODE> | ||
|  | 	 <BR> | ||
|  | 	            | ||
|  | 	 Returns the locale used within this calendar instance. | ||
|  |       </TD> | ||
|  |    </TR> | ||
|  | 
 | ||
|  |    <TR BGCOLOR="white" CLASS="TableRowColor"> | ||
|  |       <TD ALIGN="right" VALIGN="top" WIDTH="1%"> | ||
|  | 	 <FONT SIZE="-1"> | ||
|  | 	    <CODE> void</CODE> | ||
|  | 	 </FONT> | ||
|  |       </TD> | ||
|  |       <TD> | ||
|  | 	 <CODE> | ||
|  | 	    <B> | ||
|  | 	       <A HREF="#render">render</A></B>(today) | ||
|  | 	 </CODE> | ||
|  | 	 <BR> | ||
|  | 	            | ||
|  | 	 Renders the calendar using either a custom renderer defined | ||
|  |  using <a href="#setRenderer">setRenderer()</a> or the default one. | ||
|  |       </TD> | ||
|  |    </TR> | ||
|  | 
 | ||
|  |    <TR BGCOLOR="white" CLASS="TableRowColor"> | ||
|  |       <TD ALIGN="right" VALIGN="top" WIDTH="1%"> | ||
|  | 	 <FONT SIZE="-1"> | ||
|  | 	    <CODE> void</CODE> | ||
|  | 	 </FONT> | ||
|  |       </TD> | ||
|  |       <TD> | ||
|  | 	 <CODE> | ||
|  | 	    <B> | ||
|  | 	       <A HREF="#setAccessNameFormat">setAccessNameFormat</A></B>(<String> fmt) | ||
|  | 	 </CODE> | ||
|  | 	 <BR> | ||
|  | 	            | ||
|  | 	 Sets the format of the group name to use when trying to access | ||
|  |  child objects of the collection this calendar is operating on. | ||
|  |       </TD> | ||
|  |    </TR> | ||
|  | 
 | ||
|  |    <TR BGCOLOR="white" CLASS="TableRowColor"> | ||
|  |       <TD ALIGN="right" VALIGN="top" WIDTH="1%"> | ||
|  | 	 <FONT SIZE="-1"> | ||
|  | 	    <CODE> void</CODE> | ||
|  | 	 </FONT> | ||
|  |       </TD> | ||
|  |       <TD> | ||
|  | 	 <CODE> | ||
|  | 	    <B> | ||
|  | 	       <A HREF="#setHrefFormat">setHrefFormat</A></B>(<String> fmt) | ||
|  | 	 </CODE> | ||
|  | 	 <BR> | ||
|  | 	            | ||
|  | 	 Sets the format of the hrefs to render by this calendar | ||
|  |  to the format pattern passed as argument. | ||
|  |       </TD> | ||
|  |    </TR> | ||
|  | 
 | ||
|  |    <TR BGCOLOR="white" CLASS="TableRowColor"> | ||
|  |       <TD ALIGN="right" VALIGN="top" WIDTH="1%"> | ||
|  | 	 <FONT SIZE="-1"> | ||
|  | 	    <CODE> void</CODE> | ||
|  | 	 </FONT> | ||
|  |       </TD> | ||
|  |       <TD> | ||
|  | 	 <CODE> | ||
|  | 	    <B> | ||
|  | 	       <A HREF="#setLocale">setLocale</A></B>(<java.util.Locale> loc) | ||
|  | 	 </CODE> | ||
|  | 	 <BR> | ||
|  | 	            | ||
|  | 	 Sets the locale to use within this calendar object | ||
|  |       </TD> | ||
|  |    </TR> | ||
|  | 
 | ||
|  |    <TR BGCOLOR="white" CLASS="TableRowColor"> | ||
|  |       <TD ALIGN="right" VALIGN="top" WIDTH="1%"> | ||
|  | 	 <FONT SIZE="-1"> | ||
|  | 	    <CODE> void</CODE> | ||
|  | 	 </FONT> | ||
|  |       </TD> | ||
|  |       <TD> | ||
|  | 	 <CODE> | ||
|  | 	    <B> | ||
|  | 	       <A HREF="#setRenderer">setRenderer</A></B>(<Object> r) | ||
|  | 	 </CODE> | ||
|  | 	 <BR> | ||
|  | 	            | ||
|  | 	 Sets the renderer to use. | ||
|  |       </TD> | ||
|  |    </TR> | ||
|  | 
 | ||
|  |    <TR BGCOLOR="white" CLASS="TableRowColor"> | ||
|  |       <TD ALIGN="right" VALIGN="top" WIDTH="1%"> | ||
|  | 	 <FONT SIZE="-1"> | ||
|  | 	    <CODE> void</CODE> | ||
|  | 	 </FONT> | ||
|  |       </TD> | ||
|  |       <TD> | ||
|  | 	 <CODE> | ||
|  | 	    <B> | ||
|  | 	       <A HREF="#setTimeZone">setTimeZone</A></B>(tz) | ||
|  | 	 </CODE> | ||
|  | 	 <BR> | ||
|  | 	            | ||
|  | 	 Sets the locale to use within this calendar object | ||
|  |       </TD> | ||
|  |    </TR> | ||
|  | 
 | ||
|  | 
 | ||
|  | </TABLE> | ||
|  | 
 | ||
|  | 
 | ||
|  | 
 | ||
|  | <P> | ||
|  | <!-- ========== END METHOD SUMMARY =========== --> | ||
|  | 
 | ||
|  | 
 | ||
|  | <!-- ============ FIELD DETAIL START =========== --> | ||
|  | 
 | ||
|  | 
 | ||
|  | <!-- ============ FIELD DETAIL END =========== --> | ||
|  | 
 | ||
|  |     <!-- ========= CONSTRUCTOR DETAIL START ======== --> | ||
|  | 
 | ||
|  | <A NAME="constructor_detail"><!-- --></A> | ||
|  | <TABLE BORDER="1" CELLPADDING="3" CELLSPACING="0" WIDTH="100%"> | ||
|  |    <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor"> | ||
|  |       <TD COLSPAN=1> | ||
|  |       <FONT SIZE="+2"><B>Constructor Detail</B></FONT> | ||
|  |       </TD> | ||
|  |    </TR> | ||
|  | </TABLE> | ||
|  | 
 | ||
|  | <A NAME="jala.Date.Calendar()"><!-- --></A><H3> | ||
|  | jala.Date.Calendar</H3> | ||
|  | <PRE><B>jala.Date.Calendar</B>(<<a href="HopObject.html">HopObject</a>> collection)</PRE> | ||
|  | 
 | ||
|  | 
 | ||
|  | <UL> | ||
|  |    Creates a new instance of jala.Data.Calendar | ||
|  | </UL> | ||
|  | 
 | ||
|  | 
 | ||
|  | 
 | ||
|  |    <UL> | ||
|  |    <B>Parameters:</B> | ||
|  |     | ||
|  |      <UL><CODE>collection</CODE> -  A grouped HopObject collection to work on   | ||
|  |      </UL> | ||
|  |     | ||
|  |     | ||
|  |    </UL> | ||
|  | 
 | ||
|  | 
 | ||
|  | <!-- Constructor return value(s) --> | ||
|  | 
 | ||
|  |    <UL> | ||
|  |    <B>Returns:</B> | ||
|  |      <UL> | ||
|  |      A newly created jala.Date.Calendar instance    | ||
|  |      </UL> | ||
|  |    </UL> | ||
|  | 
 | ||
|  | <!-- End constructor return value(s) --> | ||
|  | 
 | ||
|  | <!-- ADDITIONAL ATTRIBUTES --> | ||
|  | 
 | ||
|  | <HR/> | ||
|  | <!-- END ADDITIONAL ATTRIBUTES  --> | ||
|  | 
 | ||
|  | <!-- ========= CONSTRUCTOR DETAIL END ======== --> | ||
|  | 
 | ||
|  | 
 | ||
|  | <!-- ============ METHOD DETAIL START ========== --> | ||
|  | 
 | ||
|  | <A NAME="method_detail"><!-- --></A> | ||
|  | <TABLE BORDER="1" CELLPADDING="3" CELLSPACING="0" WIDTH="100%"> | ||
|  |    <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor"> | ||
|  |       <TD COLSPAN=1><FONT SIZE="+2"> | ||
|  |          <B>Method Detail</B></FONT> | ||
|  |       </TD> | ||
|  |    </TR> | ||
|  | </TABLE> | ||
|  | 
 | ||
|  | <!-- One single method detail entry --> | ||
|  | 
 | ||
|  |    <A NAME="getAccessNameFormat"><!-- --></A> | ||
|  |    <H3>getAccessNameFormat</H3> | ||
|  |    <PRE>String <B>getAccessNameFormat</B>()</PRE> | ||
|  |     | ||
|  |       <UL>Returns the format of the access name used by this calendar to access | ||
|  |  child group objects of the collection this calendar is operating on. | ||
|  |  The default format is "yyyyMMdd".</UL> | ||
|  |     | ||
|  | 
 | ||
|  |    <!-- METHOD PARAMETERS START --> | ||
|  |     | ||
|  |    <!-- METHOD PARAMETERS END --> | ||
|  | 
 | ||
|  |     | ||
|  |    <UL> | ||
|  |    <B>Returns:</B> | ||
|  |         <UL> | ||
|  |         The date formatting pattern used to access child objects    | ||
|  |         </UL> | ||
|  |    </UL> | ||
|  |     | ||
|  | 
 | ||
|  |    <!-- ADDITIONAL ATTRIBUTES START --> | ||
|  |     | ||
|  |    <UL>    | ||
|  |    <B>See:</B><UL>- <a href="#setAccessNameFormat">setAccessNameFormat()</a></UL> | ||
|  |    </UL> | ||
|  |     | ||
|  |    <!-- ADDITIONAL ATTRIBUTES  END --> | ||
|  | <HR> | ||
|  | 
 | ||
|  |    <A NAME="getCalendar"><!-- --></A> | ||
|  |    <H3>getCalendar</H3> | ||
|  |    <PRE>String <B>getCalendar</B>(today)</PRE> | ||
|  |     | ||
|  |       <UL>Returns a rendered calendar</UL> | ||
|  |     | ||
|  | 
 | ||
|  |    <!-- METHOD PARAMETERS START --> | ||
|  |     | ||
|  |    <!-- METHOD PARAMETERS END --> | ||
|  | 
 | ||
|  |     | ||
|  | 
 | ||
|  |    <!-- ADDITIONAL ATTRIBUTES START --> | ||
|  |     | ||
|  |    <UL>    | ||
|  |    <B>See:</B><UL>- <a href="#renderCalendar">renderCalendar</a></UL> | ||
|  |    </UL> | ||
|  |     | ||
|  |    <!-- ADDITIONAL ATTRIBUTES  END --> | ||
|  | <HR> | ||
|  | 
 | ||
|  |    <A NAME="getCollection"><!-- --></A> | ||
|  |    <H3>getCollection</H3> | ||
|  |    <PRE><a href="HopObject.html">HopObject</a> <B>getCollection</B>()</PRE> | ||
|  |     | ||
|  |       <UL>Returns the collection this calendar object works on</UL> | ||
|  |     | ||
|  | 
 | ||
|  |    <!-- METHOD PARAMETERS START --> | ||
|  |     | ||
|  |    <!-- METHOD PARAMETERS END --> | ||
|  | 
 | ||
|  |     | ||
|  |    <UL> | ||
|  |    <B>Returns:</B> | ||
|  |         <UL> | ||
|  |         The HopObject collection of this calendar    | ||
|  |         </UL> | ||
|  |    </UL> | ||
|  |     | ||
|  | 
 | ||
|  |    <!-- ADDITIONAL ATTRIBUTES START --> | ||
|  |     | ||
|  |    <!-- ADDITIONAL ATTRIBUTES  END --> | ||
|  | <HR> | ||
|  | 
 | ||
|  |    <A NAME="getHrefFormat"><!-- --></A> | ||
|  |    <H3>getHrefFormat</H3> | ||
|  |    <PRE>String <B>getHrefFormat</B>()</PRE> | ||
|  |     | ||
|  |       <UL>Returns the date formatting pattern used to render hrefs. The default | ||
|  |  format is "yyyyMMdd".</UL> | ||
|  |     | ||
|  | 
 | ||
|  |    <!-- METHOD PARAMETERS START --> | ||
|  |     | ||
|  |    <!-- METHOD PARAMETERS END --> | ||
|  | 
 | ||
|  |     | ||
|  |    <UL> | ||
|  |    <B>Returns:</B> | ||
|  |         <UL> | ||
|  |         The date formatting pattern    | ||
|  |         </UL> | ||
|  |    </UL> | ||
|  |     | ||
|  | 
 | ||
|  |    <!-- ADDITIONAL ATTRIBUTES START --> | ||
|  |     | ||
|  |    <UL>    | ||
|  |    <B>See:</B><UL>- <a href="#setHrefFormat">setHrefFormat()</a></UL> | ||
|  |    </UL> | ||
|  |     | ||
|  |    <!-- ADDITIONAL ATTRIBUTES  END --> | ||
|  | <HR> | ||
|  | 
 | ||
|  |    <A NAME="getLocale"><!-- --></A> | ||
|  |    <H3>getLocale</H3> | ||
|  |    <PRE>java.util.Locale <B>getLocale</B>()</PRE> | ||
|  |     | ||
|  |       <UL>Returns the locale used within this calendar instance.  By default | ||
|  |  the locale used by this calendar is the default locale of the | ||
|  |  Java Virtual Machine running Helma.</UL> | ||
|  |     | ||
|  | 
 | ||
|  |    <!-- METHOD PARAMETERS START --> | ||
|  |     | ||
|  |    <!-- METHOD PARAMETERS END --> | ||
|  | 
 | ||
|  |     | ||
|  |    <UL> | ||
|  |    <B>Returns:</B> | ||
|  |         <UL> | ||
|  |         The locale of this calendar    | ||
|  |         </UL> | ||
|  |    </UL> | ||
|  |     | ||
|  | 
 | ||
|  |    <!-- ADDITIONAL ATTRIBUTES START --> | ||
|  |     | ||
|  |    <UL>    | ||
|  |    <B>See:</B><UL>- <a href="#setLocale">setLocale()</a></UL> | ||
|  |    </UL> | ||
|  |     | ||
|  |    <!-- ADDITIONAL ATTRIBUTES  END --> | ||
|  | <HR> | ||
|  | 
 | ||
|  |    <A NAME="getRenderer"><!-- --></A> | ||
|  |    <H3>getRenderer</H3> | ||
|  |    <PRE>Object <B>getRenderer</B>()</PRE> | ||
|  |     | ||
|  |       <UL>Returns the renderer used by this calendar.</UL> | ||
|  |     | ||
|  | 
 | ||
|  |    <!-- METHOD PARAMETERS START --> | ||
|  |     | ||
|  |    <!-- METHOD PARAMETERS END --> | ||
|  | 
 | ||
|  |     | ||
|  |    <UL> | ||
|  |    <B>Returns:</B> | ||
|  |         <UL> | ||
|  |         The calendar renderer    | ||
|  |         </UL> | ||
|  |    </UL> | ||
|  |     | ||
|  | 
 | ||
|  |    <!-- ADDITIONAL ATTRIBUTES START --> | ||
|  |     | ||
|  |    <UL>    | ||
|  |    <B>See:</B><UL>- <a href="#setRenderer">setRenderer()</a></UL> | ||
|  |    </UL> | ||
|  |     | ||
|  |    <!-- ADDITIONAL ATTRIBUTES  END --> | ||
|  | <HR> | ||
|  | 
 | ||
|  |    <A NAME="getTimeZone"><!-- --></A> | ||
|  |    <H3>getTimeZone</H3> | ||
|  |    <PRE>java.util.Locale <B>getTimeZone</B>()</PRE> | ||
|  |     | ||
|  |       <UL>Returns the locale used within this calendar instance. By default | ||
|  |  the timezone used by this calendar is the default timezone | ||
|  |  of the Java Virtual Machine running Helma.</UL> | ||
|  |     | ||
|  | 
 | ||
|  |    <!-- METHOD PARAMETERS START --> | ||
|  |     | ||
|  |    <!-- METHOD PARAMETERS END --> | ||
|  | 
 | ||
|  |     | ||
|  |    <UL> | ||
|  |    <B>Returns:</B> | ||
|  |         <UL> | ||
|  |         The locale of this calendar    | ||
|  |         </UL> | ||
|  |    </UL> | ||
|  |     | ||
|  | 
 | ||
|  |    <!-- ADDITIONAL ATTRIBUTES START --> | ||
|  |     | ||
|  |    <UL>    | ||
|  |    <B>See:</B><UL>- <a href="#setTimeZone">setTimeZone()</a></UL> | ||
|  |    </UL> | ||
|  |     | ||
|  |    <!-- ADDITIONAL ATTRIBUTES  END --> | ||
|  | <HR> | ||
|  | 
 | ||
|  |    <A NAME="render"><!-- --></A> | ||
|  |    <H3>render</H3> | ||
|  |    <PRE>void <B>render</B>(today)</PRE> | ||
|  |     | ||
|  |       <UL>Renders the calendar using either a custom renderer defined | ||
|  |  using <a href="#setRenderer">setRenderer()</a> or the default one.</UL> | ||
|  |     | ||
|  | 
 | ||
|  |    <!-- METHOD PARAMETERS START --> | ||
|  |     | ||
|  |    <!-- METHOD PARAMETERS END --> | ||
|  | 
 | ||
|  |     | ||
|  | 
 | ||
|  |    <!-- ADDITIONAL ATTRIBUTES START --> | ||
|  |     | ||
|  |    <UL>    | ||
|  |    <B>See:</B><UL>- <a href="#setRenderer">setRenderer()</a><BR/>- <a href="jala.Date.Calendar.Renderer.html#">jala.Date.Calendar.Renderer</a></UL> | ||
|  |    </UL> | ||
|  |     | ||
|  |    <!-- ADDITIONAL ATTRIBUTES  END --> | ||
|  | <HR> | ||
|  | 
 | ||
|  |    <A NAME="setAccessNameFormat"><!-- --></A> | ||
|  |    <H3>setAccessNameFormat</H3> | ||
|  |    <PRE>void <B>setAccessNameFormat</B>(<String> fmt)</PRE> | ||
|  |     | ||
|  |       <UL>Sets the format of the group name to use when trying to access | ||
|  |  child objects of the collection this calendar is operating on.</UL> | ||
|  |     | ||
|  | 
 | ||
|  |    <!-- METHOD PARAMETERS START --> | ||
|  |     | ||
|  |    <UL> | ||
|  |    <B>Parameters:</B> | ||
|  |     | ||
|  |      <UL><CODE>fmt</CODE> -  The date format pattern to use for  accessing child objects   | ||
|  |       </UL>  | ||
|  |     | ||
|  |    </UL> | ||
|  |     | ||
|  |    <!-- METHOD PARAMETERS END --> | ||
|  | 
 | ||
|  |     | ||
|  | 
 | ||
|  |    <!-- ADDITIONAL ATTRIBUTES START --> | ||
|  |     | ||
|  |    <UL>    | ||
|  |    <B>See:</B><UL>- <a href="#getAccessNameFormat">getAccessNameFormat()</a></UL> | ||
|  |    </UL> | ||
|  |     | ||
|  |    <!-- ADDITIONAL ATTRIBUTES  END --> | ||
|  | <HR> | ||
|  | 
 | ||
|  |    <A NAME="setHrefFormat"><!-- --></A> | ||
|  |    <H3>setHrefFormat</H3> | ||
|  |    <PRE>void <B>setHrefFormat</B>(<String> fmt)</PRE> | ||
|  |     | ||
|  |       <UL>Sets the format of the hrefs to render by this calendar | ||
|  |  to the format pattern passed as argument.</UL> | ||
|  |     | ||
|  | 
 | ||
|  |    <!-- METHOD PARAMETERS START --> | ||
|  |     | ||
|  |    <UL> | ||
|  |    <B>Parameters:</B> | ||
|  |     | ||
|  |      <UL><CODE>fmt</CODE> -  The date format pattern to use for  rendering the href   | ||
|  |       </UL>  | ||
|  |     | ||
|  |    </UL> | ||
|  |     | ||
|  |    <!-- METHOD PARAMETERS END --> | ||
|  | 
 | ||
|  |     | ||
|  | 
 | ||
|  |    <!-- ADDITIONAL ATTRIBUTES START --> | ||
|  |     | ||
|  |    <UL>    | ||
|  |    <B>See:</B><UL>- <a href="#getHrefFormat">getHrefFormat()</a></UL> | ||
|  |    </UL> | ||
|  |     | ||
|  |    <!-- ADDITIONAL ATTRIBUTES  END --> | ||
|  | <HR> | ||
|  | 
 | ||
|  |    <A NAME="setLocale"><!-- --></A> | ||
|  |    <H3>setLocale</H3> | ||
|  |    <PRE>void <B>setLocale</B>(<java.util.Locale> loc)</PRE> | ||
|  |     | ||
|  |       <UL>Sets the locale to use within this calendar object</UL> | ||
|  |     | ||
|  | 
 | ||
|  |    <!-- METHOD PARAMETERS START --> | ||
|  |     | ||
|  |    <UL> | ||
|  |    <B>Parameters:</B> | ||
|  |     | ||
|  |      <UL><CODE>loc</CODE> -  The locale to use   | ||
|  |       </UL>  | ||
|  |     | ||
|  |    </UL> | ||
|  |     | ||
|  |    <!-- METHOD PARAMETERS END --> | ||
|  | 
 | ||
|  |     | ||
|  | 
 | ||
|  |    <!-- ADDITIONAL ATTRIBUTES START --> | ||
|  |     | ||
|  |    <UL>    | ||
|  |    <B>See:</B><UL>- <a href="#getLocale">getLocale()</a></UL> | ||
|  |    </UL> | ||
|  |     | ||
|  |    <!-- ADDITIONAL ATTRIBUTES  END --> | ||
|  | <HR> | ||
|  | 
 | ||
|  |    <A NAME="setRenderer"><!-- --></A> | ||
|  |    <H3>setRenderer</H3> | ||
|  |    <PRE>void <B>setRenderer</B>(<Object> r)</PRE> | ||
|  |     | ||
|  |       <UL>Sets the renderer to use.</UL> | ||
|  |     | ||
|  | 
 | ||
|  |    <!-- METHOD PARAMETERS START --> | ||
|  |     | ||
|  |    <UL> | ||
|  |    <B>Parameters:</B> | ||
|  |     | ||
|  |      <UL><CODE>r</CODE> -  The renderer to use   | ||
|  |       </UL>  | ||
|  |     | ||
|  |    </UL> | ||
|  |     | ||
|  |    <!-- METHOD PARAMETERS END --> | ||
|  | 
 | ||
|  |     | ||
|  | 
 | ||
|  |    <!-- ADDITIONAL ATTRIBUTES START --> | ||
|  |     | ||
|  |    <UL>    | ||
|  |    <B>See:</B><UL>- <a href="#getRenderer">getRenderer()</a></UL> | ||
|  |    </UL> | ||
|  |     | ||
|  |    <!-- ADDITIONAL ATTRIBUTES  END --> | ||
|  | <HR> | ||
|  | 
 | ||
|  |    <A NAME="setTimeZone"><!-- --></A> | ||
|  |    <H3>setTimeZone</H3> | ||
|  |    <PRE>void <B>setTimeZone</B>(tz)</PRE> | ||
|  |     | ||
|  |       <UL>Sets the locale to use within this calendar object</UL> | ||
|  |     | ||
|  | 
 | ||
|  |    <!-- METHOD PARAMETERS START --> | ||
|  |     | ||
|  |    <UL> | ||
|  |    <B>Parameters:</B> | ||
|  |     | ||
|  |      <UL><CODE>loc</CODE> -  The locale to use   | ||
|  |       </UL>  | ||
|  |     | ||
|  |    </UL> | ||
|  |     | ||
|  |    <!-- METHOD PARAMETERS END --> | ||
|  | 
 | ||
|  |     | ||
|  | 
 | ||
|  |    <!-- ADDITIONAL ATTRIBUTES START --> | ||
|  |     | ||
|  |    <UL>    | ||
|  |    <B>See:</B><UL>- <a href="#getTimeZone">getTimeZone()</a></UL> | ||
|  |    </UL> | ||
|  |     | ||
|  |    <!-- ADDITIONAL ATTRIBUTES  END --> | ||
|  | <HR> | ||
|  | 
 | ||
|  | 
 | ||
|  | 
 | ||
|  | <!-- ============ METHOD DETAIL END ========== --> | ||
|  | 
 | ||
|  | <!-- ========= END OF CLASS DATA ========= --> | ||
|  | 
 | ||
|  | <!-- ========== START OF NAVBAR ========== --> | ||
|  | <A NAME="navbar_bottom"><!-- --></A> | ||
|  | <TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0"> | ||
|  | <TR> | ||
|  | <TD COLSPAN=3 BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> | ||
|  | <A NAME="navbar_bottom_firstrow"><!-- --></A> | ||
|  | <TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3"> | ||
|  |   <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="overview-summary-Date.js.html"><FONT CLASS="NavBarFont1"><B>File</B></FONT></A> </TD> | ||
|  |   <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev">  <FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT> </TD> | ||
|  |   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="overview-tree.html"><FONT CLASS="NavBarFont1"><b>Tree</b></FONT></A> </TD> | ||
|  |   <!--TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"-->    <!--A HREF="deprecated-list.html"--><!--FONT CLASS="NavBarFont1">Deprecated</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> | ||
|  | <B>Jala 1.3</B> | ||
|  | </EM> | ||
|  | </TD | ||
|  | </TR> | ||
|  | 
 | ||
|  | <TR> | ||
|  | <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> | ||
|  |  <A HREF="jala.Date.html"><B>PREV CLASS</B></A><!-- 
 | ||
|  |    NEXT CLASS  | ||
|  | --> | ||
|  |  <A HREF="jala.Date.Calendar.Renderer.html"><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="jala.Date.Calendar.html" TARGET="_top"><B>NO FRAMES</B></A>    | ||
|  |   | ||
|  | <SCRIPT> | ||
|  |   <!--
 | ||
|  |   if(window==top) { | ||
|  |     document.writeln('<A HREF="allclasses-noframe.html" TARGET=""><B>All Classes</B></A>'); | ||
|  |   } | ||
|  |   //--> | ||
|  | </SCRIPT> | ||
|  | <NOSCRIPT> | ||
|  | <A HREF="allclasses-noframe.html" TARGET=""><B>All Classes</B></A> | ||
|  | </NOSCRIPT> | ||
|  | </FONT></TD> | ||
|  | </TR> | ||
|  | <TR> | ||
|  | <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2"> | ||
|  |   SUMMARY: <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> | ||
|  | 
 | ||
|  | <!-- =========== END OF NAVBAR =========== --> | ||
|  | 
 | ||
|  | <HR> | ||
|  | <FONT SIZE="-1"> | ||
|  | 
 | ||
|  | </FONT> | ||
|  | <div class="jsdoc_ctime">Documentation generated by <a href="http://jsdoc.sourceforge.net/" target="_parent">JSDoc</a> on Tue Jan  8 15:45:31 2008</div> | ||
|  | </BODY> | ||
|  | </HTML> |