📄 eventlist.html
字号:
<P>
<DL>
<DT><B>See Also:</B><DD><A HREF="../../../constant-values.html#javax.microedition.pim.EventList.ENDING">Constant
Field Values</A></DD></DL>
</DD>
</DL>
<HR>
<A NAME="OCCURRING"><!-- --></A><H3>
OCCURRING</H3>
<PRE>
public static final int <B>OCCURRING</B></PRE>
<DL>
<DD>
Constant representing a search type for Events based on any occurrence of an
event during a time period.
<P>
<DL>
<DT><B>See Also:</B><DD><A HREF="../../../constant-values.html#javax.microedition.pim.EventList.OCCURRING">Constant
Field Values</A></DD></DL>
</DD>
</DL>
<!-- ========= 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="createEvent()"><!-- --></A><H3>
createEvent</H3>
<PRE>
public <A HREF="../../../javax/microedition/pim/Event.html">Event</A> <B>createEvent</B>()</PRE>
<DL>
<DD>
Factory method to create an Event for this event list. The Event is empty upon
creation with none of its fields containing any data (i.e. a call to the method <code>
Event.getFields()</code> returns an array of zero length). Even though it
is initially empty, the Event is <i>capable</i> of containing data for exactly
those fields that this list supports. Note that creation of the Event does not
add the Event 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></P>
<DD>
<DL>
</DL>
<DD>
<DL>
<DT><B>Returns:</B><DD>a new, empty Event object associated with this list. However,
the Event is still not persistent in the list until a call to <code>PIMItem.commit()</code>
for the Event is made.</DD></DL>
</DD>
</DL>
<HR>
<A NAME="importEvent(javax.microedition.pim.Event)"><!-- --></A><H3>
importEvent</H3>
<PRE>
public <A HREF="../../../javax/microedition/pim/Event.html">Event</A> <B>importEvent</B>(<A HREF="../../../javax/microedition/pim/Event.html">Event</A> item)</PRE>
<DL>
<DD>
Imports the given Event into this list by making a new Event for the list and
filling its information with as much information as it can from the provided
Event. If the input Event is already in the list, a new Event is still created
with information similar to the input item (but not necessarily identical).
<P></P>
<P>Note that not all data from the input Event may be supported in the new Event
due to field restrictions for the list instance. In this case, data fields not
supported are not transferred to the new Event object.
</P>
<P>Also note that creation of the Event does not add the Event 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>
</P>
<DD>
<DL>
</DL>
<DD>
<DL>
<DT><B>Parameters:</B><DD><CODE>item</CODE> - the Event to import into the list. <DT><B>Returns:</B><DD>a
newly created Event. <DT><B>Throws:</B>
<DD>
<CODE>java.lang.NullPointerException</CODE> - If the <code>item</code> is <code>null</code>.</DD></DL>
</DD>
</DL>
<HR>
<A NAME="removeEvent(javax.microedition.pim.Event)"><!-- --></A><H3>
removeEvent</H3>
<PRE>
public void <B>removeEvent</B>(<A HREF="../../../javax/microedition/pim/Event.html">Event</A> item)
throws <A HREF="../../../javax/microedition/pim/PIMException.html">PIMException</A></PRE>
<DL>
<DD>
Removes a specific Event from the list. The item must already exist in the list
for this method to succeed.
<P></P>
<DD>
<DL>
</DL>
<DD>
<DL>
<DT><B>Parameters:</B><DD><CODE>item</CODE> - the Event 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.NullPointerException</CODE> - If <code>item</code> is <code>null</code>.
<DD>
<CODE>java.lang.SecurityException</CODE> - if the application is not given
permission to write to the Event list or the list is opened READ_ONLY.</DD></DL>
</DD>
</DL>
<HR>
<A NAME="items(int, long, long, boolean)"><!-- --></A><H3>
items</H3>
<PRE>
public java.util.Enumeration <B>items</B>(int searchType,
long startDate,
long endDate,
boolean initialEventOnly)
throws <A HREF="../../../javax/microedition/pim/PIMException.html">PIMException</A></PRE>
<DL>
<DD>
Return an enumeration of all the Events where at least one of the Event's
occurrences falls in the specified range from startDate to endDate inclusive.
The search type specified determines the criteria for matching an event
occurrence; <code>STARTING</code> searches for events starting between
startDate and endDate, <code>ENDING</code> searches for events ending between
startDate and endDate, and <code>OCCURRING</code> searches for events that have
an part of the event occurring during the period specified by startDate and
endDate. The returned Events are sorted in ascending order by the starting
date-timestamp of the event's occurrence. An Event is returned in the
Enumeration only once if the event occurs more than once during the specified
time interval.
<P></P>
<DD>
<DL>
</DL>
<DD>
<DL>
<DT><B>Parameters:</B><DD><CODE>searchType</CODE> - the criteria used to determine
which Events are returned. Must be <A HREF="../../../javax/microedition/pim/EventList.html#STARTING">
<CODE>STARTING</CODE></A>, <A HREF="../../../javax/microedition/pim/EventList.html#ENDING">
<CODE>ENDING</CODE></A>, or <A HREF="../../../javax/microedition/pim/EventList.html#OCCURRING">
<CODE>OCCURRING</CODE></A>.<DD><CODE>startDate</CODE> - the inclusive start
date to begin looking for event occurrences 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 events beyond this date, returned
in milliseconds since the epoch (00:00:00 GMT, January 1, 1970)<DD><CODE>initialEventOnly</CODE>
- true indicates only search based on an Event's START and END values and do
not calculate repeating occurrences of the event. False indicates repeating
occurrences of an Event are included during the search. <DT><B>Returns:</B><DD>an
enumeration of all the Events with an occurrence between startDate and endDate <DT><B>Throws:</B>
<DD>
<CODE>java.lang.IllegalArgumentException</CODE> - if searchType is not <A HREF="../../../javax/microedition/pim/EventList.html#STARTING">
<CODE>STARTING</CODE></A>, <A HREF="../../../javax/microedition/pim/EventList.html#ENDING">
<CODE>ENDING</CODE></A>, or <A HREF="../../../javax/microedition/pim/EventList.html#OCCURRING">
<CODE>OCCURRING</CODE></A>, or <code>startDate</code> is greater than <code>endDate</code>.
<DD>
<CODE><A HREF="../../../javax/microedition/pim/PIMException.html">PIMException</A></CODE>
- If the operation is unsupported, an error occurs, or the list is no longer
accessible or closed.
<DD>
<CODE>java.lang.SecurityException</CODE> - if the application is not given
permission to read the Event list or the list is opened WRITE_ONLY.</DD></DL>
</DD>
</DL>
<HR>
<A NAME="getSupportedRepeatRuleFields(int)"><!-- --></A><H3>
getSupportedRepeatRuleFields</H3>
<PRE>
public int[] <B>getSupportedRepeatRuleFields</B>(int frequency)</PRE>
<DL>
<DD>
Returns the Repeat Rule fields that are settable by the class user and
supported by this EventList for the provided Repeat Rule frequency. Repeat Rule
frequencies are <A HREF="../../../javax/microedition/pim/RepeatRule.html#YEARLY"><CODE>RepeatRule.YEARLY</CODE></A>,
<A HREF="../../../javax/microedition/pim/RepeatRule.html#MONTHLY"><CODE>RepeatRule.MONTHLY</CODE></A>,
<A HREF="../../../javax/microedition/pim/RepeatRule.html#WEEKLY"><CODE>RepeatRule.WEEKLY</CODE></A>,
and <A HREF="../../../javax/microedition/pim/RepeatRule.html#DAILY"><CODE>RepeatRule.DAILY</CODE></A>.
The int values in the array represent a bitwise combination of Repeat Rule
fields that are valid for the given frequency. For example, if <code>MONTHLY</code>
was the frequency and this event list supported specifying monthly repeat rules
by either the day of the month or by a day in a specific week (e.g. Thursday of
the 3rd week in the month), then the returned int array would contain two
elements with one value being <code>DAY_IN_MONTH</code> and the other being <code>DAY_IN_WEEK
| WEEK_IN_MONTH</code>. All possible field combinations that are valid are
returned in the array.
<P></P>
<P>
If the given frequency is not supported by this list, a zero length array is
returned. If the frequency is supported but no fields are supported by this
list for that frequency, a one item array containing the integer 0 is returned.
In these conditions, any field that has a value set will be ignored by this
event list.
<P></P>
<DD>
<DL>
</DL>
<DD>
<DL>
<DT><B>Parameters:</B><DD><CODE>frequency</CODE> - Repeat Rule frequency for which the
supported fields are queried. <DT><B>Returns:</B><DD>an array of integer values
corresponding to the Repeat Rule fields that are supported by this list for the
given frequency. <DT><B>Throws:</B>
<DD>
<CODE>java.lang.IllegalArgumentException</CODE> - if frequncy is not <A HREF="../../../javax/microedition/pim/RepeatRule.html#YEARLY">
<CODE>RepeatRule.YEARLY</CODE></A>, <A HREF="../../../javax/microedition/pim/RepeatRule.html#MONTHLY">
<CODE>RepeatRule.MONTHLY</CODE></A>, <A HREF="../../../javax/microedition/pim/RepeatRule.html#WEEKLY">
<CODE>RepeatRule.WEEKLY</CODE></A>, or <A HREF="../../../javax/microedition/pim/RepeatRule.html#DAILY">
<CODE>RepeatRule.DAILY</CODE></A>.<DT><B>See Also:</B><DD><A HREF="../../../javax/microedition/pim/RepeatRule.html"><CODE>RepeatRule</CODE></A></DD></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> </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> Final Release<br>
Rev. 1.00</EM>
</TD>
</TR>
<TR>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> <A HREF="../../../javax/microedition/pim/Event.html"><B>PREV
CLASS</B></A> <A HREF="../../../javax/microedition/pim/PIMItem.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="EventList.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: NESTED | <A HREF="#field_summary">FIELD</A> | CONSTR | <A HREF="#method_summary">METHOD</A></FONT></TD>
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2"> DETAIL: <A HREF="#field_detail">FIELD</A> | CONSTR | <A HREF="#method_detail">METHOD</A></FONT></TD>
</TR>
</TABLE>
<!-- =========== END OF NAVBAR =========== -->
<HR>
<font size="-1">Copyright ⌨️ 快捷键说明
复制代码
Ctrl + C
搜索代码
Ctrl + F
全屏模式
F11
切换主题
Ctrl + Shift + D
显示快捷键
?
增大字号
Ctrl + =
减小字号
Ctrl + -