todolist.html

J2ME手机编程规范JSR-75文档

<P>

<!-- ============ FIELD DETAIL =========== -->


<!-- ========= CONSTRUCTOR DETAIL ======== -->


<!-- ============ METHOD DETAIL ========== -->

<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>

<A NAME="createToDo()"><!-- --></A><H3>
createToDo</H3>
<PRE>
public <A HREF="../../../javax/microedition/pim/ToDo.html">ToDo</A> <B>createToDo</B>()</PRE>
<DL>
<DD>Factory method to create a ToDo entry for this ToDo list.  The ToDo
 is empty upon creation with none of its fields containing any data (i.e. a
 call to the method <code>ToDo.getFields()</code> will return an array
 of zero length). Even though it is initially empty, the ToDo is
 <i>capable</i> of containing data for exactly those fields that this list
 supports.
 Note that creation of the ToDo does not add the ToDo to the list
 from which the item was created; a specific call to
 <code>PIMItem.commit()</code> must be made to commit the item and
 its data to the list.
<P>
<DD><DL>
</DL>
</DD>
<DD><DL>

<DT><B>Returns:</B><DD>a new, empty ToDo object associated with this list.  However,
           the ToDo is still not persistent in the list until a call to
           <code>PIMItem.commit()</code> for the ToDo is made.</DL>
</DD>
</DL>
<HR>

<A NAME="importToDo(javax.microedition.pim.ToDo)"><!-- --></A><H3>
importToDo</H3>
<PRE>
public <A HREF="../../../javax/microedition/pim/ToDo.html">ToDo</A> <B>importToDo</B>(<A HREF="../../../javax/microedition/pim/ToDo.html">ToDo</A>&nbsp;item)</PRE>
<DL>
<DD>Imports the given ToDo into this list by making a new ToDo for the
 list and filling its information with as much information as it can from
 the provided ToDo.  If the input ToDo is already an item of the list,
 a new ToDo is still created with information similar to the input item
 (but not necessarily identical). </P>
 <P>Note that not all data from the input ToDo may be supported in the
 new ToDo due to field restrictions for the list instance.  In this
 case, data fields not supported are not transferred to the new ToDo
 object. </P>
 <P>Also note that creation of the ToDo does not add the ToDo
 to this list; a specific call to <code>PIMItem.commit()</code> must be
 made to commit the item and its data to the list. </P>
<P>
<DD><DL>
</DL>
</DD>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>item</CODE> - the ToDo to import into the list.
<DT><B>Returns:</B><DD>a newly created ToDo item.
<DT><B>Throws:</B>
<DD><CODE>java.lang.IllegalArgumentException</CODE> - If the input ToDo is
           <code>null</code>.</DL>
</DD>
</DL>
<HR>

<A NAME="removeToDo(javax.microedition.pim.ToDo)"><!-- --></A><H3>
removeToDo</H3>
<PRE>
public void <B>removeToDo</B>(<A HREF="../../../javax/microedition/pim/ToDo.html">ToDo</A>&nbsp;item)
                throws <A HREF="../../../javax/microedition/pim/PIMException.html">PIMException</A></PRE>
<DL>
<DD>Removes a specific ToDo from the list.  The item must already
 exist in the list for this method to succeed.
<P>
<DD><DL>
</DL>
</DD>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>item</CODE> - the ToDo to be removed from the list.
<DT><B>Throws:</B>
<DD><CODE><A HREF="../../../javax/microedition/pim/PIMException.html">PIMException</A></CODE> - If an error occurs deleting the item
           or the list is no longer accessible or closed.
<DD><CODE>java.lang.IllegalArgumentException</CODE> - If the ToDo is
           <code>null</code>.
<DD><CODE>java.lang.SecurityException</CODE> - if the application is not given
           permission to write to the ToDo list or the list is opened
           READ_ONLY.</DL>
</DD>
</DL>
<HR>

<A NAME="items(int, long, long)"><!-- --></A><H3>
items</H3>
<PRE>
public java.util.Enumeration <B>items</B>(int&nbsp;field,
                                   long&nbsp;startDate,
                                   long&nbsp;endDate)
                            throws <A HREF="../../../javax/microedition/pim/PIMException.html">PIMException</A></PRE>
<DL>
<DD>Return an enumeration of all the ToDos in the list where the value of the
 specified date field falls in the range from startDate to endDate
 inclusive. The field must have a data type of DATE. The items are in
 sorted and ascending order by the from the start date to the end date.
<P>
<DD><DL>
</DL>
</DD>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>field</CODE> - the date field on which the matching is based. Must be
          <A HREF="../../../javax/microedition/pim/ToDo.html#DUE"><CODE>ToDo.DUE</CODE></A> or <A HREF="../../../javax/microedition/pim/ToDo.html#COMPLETION_DATE"><CODE>ToDo.COMPLETION_DATE</CODE></A>.<DD><CODE>startDate</CODE> - the inclusive start date to begin looking for todos on
          or after this date, returned in milliseconds since the epoch
          (00:00:00 GMT, January 1, 1970).<DD><CODE>endDate</CODE> - the inclusive stop date to end looking for todos beyond
          this date, returned in milliseconds since the epoch
          (00:00:00 GMT, January 1, 1970).
<DT><B>Returns:</B><DD>an enumeration of all the ToDos with specified date field
          between startDate and endDate
<DT><B>Throws:</B>
<DD><CODE>java.lang.IllegalArgumentException</CODE> - if the data type of the field
          argument is not DATE, or the field argument is not ToDo.DUE or
          ToDo.COMPLETION_DATE, or if <code>endDate</code> is less than
           <code>startDate</code>.
<DD><CODE><A HREF="../../../javax/microedition/pim/PIMException.html">PIMException</A></CODE> - If the operation is unsupported, an error occurs,
           or is no longer accessible or closed.
<DD><CODE>java.lang.SecurityException</CODE> - if the application is not given
           permission to write to the ToDo list or the list is opened
           WRITE_ONLY.</DL>
</DD>
</DL>
<!-- ========= END OF CLASS DATA ========= -->
<HR>

<!-- ========== 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>&nbsp;</TD>
  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A>&nbsp;</TD>
  <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> &nbsp;<FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT>&nbsp;</TD>
  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A>&nbsp;</TD>
  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A>&nbsp;</TD>
  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A>&nbsp;</TD>
  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A>&nbsp;</TD>
  </TR>
</TABLE>
</TD>
<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
Proposed Final Draft<br>Rev. 0.24</EM>
</TD>
</TR>

<TR>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
&nbsp;<A HREF="../../../javax/microedition/pim/ToDo.html"><B>PREV CLASS</B></A>&nbsp;
&nbsp;NEXT CLASS</FONT></TD>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
  <A HREF="../../../index.html" TARGET="_top"><B>FRAMES</B></A>  &nbsp;
&nbsp;<A HREF="ToDoList.html" TARGET="_top"><B>NO FRAMES</B></A>  &nbsp;
&nbsp;
<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:&nbsp;NESTED&nbsp;|&nbsp;FIELD&nbsp;|&nbsp;CONSTR&nbsp;|&nbsp;<A HREF="#method_summary">METHOD</A></FONT></TD>
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
DETAIL:&nbsp;FIELD&nbsp;|&nbsp;CONSTR&nbsp;|&nbsp;<A HREF="#method_detail">METHOD</A></FONT></TD>
</TR>
</TABLE>
<!-- =========== END OF NAVBAR =========== -->

<HR>
<font size=-1>Copyright &copy; 2002-2003 PalmSource, Inc.  All Rights Reserved.<br>Java is a trademark of Sun Microsystems, Inc.</font>
</BODY>
</HTML>