diff options
Diffstat (limited to 'javadoc/shared/CalendarEvent.html')
| -rw-r--r-- | javadoc/shared/CalendarEvent.html | 809 |
1 files changed, 809 insertions, 0 deletions
diff --git a/javadoc/shared/CalendarEvent.html b/javadoc/shared/CalendarEvent.html new file mode 100644 index 0000000..d8de0c9 --- /dev/null +++ b/javadoc/shared/CalendarEvent.html @@ -0,0 +1,809 @@ +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd"> +<!--NewPage--> +<HTML> +<HEAD> +<!-- Generated by javadoc (build 1.4.2-p8) on Sat Apr 29 14:43:47 CEST 2006 --> +<TITLE> +CalendarEvent +</TITLE> + +<META NAME="keywords" CONTENT="shared.CalendarEvent class"> + +<LINK REL ="stylesheet" TYPE="text/css" HREF="../stylesheet.css" TITLE="Style"> + +<SCRIPT type="text/javascript"> +function windowTitle() +{ + parent.document.title="CalendarEvent"; +} +</SCRIPT> + +</HEAD> + +<BODY BGCOLOR="white" onload="windowTitle();"> + + +<!-- ========= START OF TOP NAVBAR ======= --> +<A NAME="navbar_top"><!-- --></A> +<A HREF="#skip-navbar_top" 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_top_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="class-use/CalendarEvent.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A> </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-files/index-1.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="../shared/CalendarCategory.html" title="class in shared"><B>PREV CLASS</B></A> + <A HREF="../shared/Config.html" title="class in shared"><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="CalendarEvent.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: NESTED | FIELD | <A HREF="#constructor_summary">CONSTR</A> | <A HREF="#method_summary">METHOD</A></FONT></TD> +<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2"> +DETAIL: FIELD | <A HREF="#constructor_detail">CONSTR</A> | <A HREF="#method_detail">METHOD</A></FONT></TD> +</TR> +</TABLE> +<A NAME="skip-navbar_top"></A> +<!-- ========= END OF TOP NAVBAR ========= --> + +<HR> +<!-- ======== START OF CLASS DATA ======== --> +<H2> +<FONT SIZE="-1"> +shared</FONT> +<BR> +Class CalendarEvent</H2> +<PRE> +java.lang.Object + <IMG SRC="../resources/inherit.gif" ALT="extended by"><B>shared.CalendarEvent</B> +</PRE> +<DL> +<DT><B>All Implemented Interfaces:</B> <DD>java.io.Serializable</DD> +</DL> +<HR> +<DL> +<DT>public class <B>CalendarEvent</B><DT>extends java.lang.Object<DT>implements java.io.Serializable</DL> + +<P> +This class specifies calendar events. Calendar event objects are the most used objects of the + whole netcalendar suite. +<P> + +<P> +<DL> +<DT><B>Author:</B></DT> + <DD>buetow</DD> +<DT><B>See Also:</B><DD><A HREF="../serialized-form.html#shared.CalendarEvent">Serialized Form</A></DL> +<HR> + +<P> +<!-- ======== NESTED CLASS SUMMARY ======== --> + + +<!-- =========== FIELD SUMMARY =========== --> + + +<!-- ======== CONSTRUCTOR SUMMARY ======== --> + +<A NAME="constructor_summary"><!-- --></A> +<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> +<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="../shared/CalendarEvent.html#CalendarEvent(shared.CalendarCategory)">CalendarEvent</A></B>(<A HREF="../shared/CalendarCategory.html" title="class in shared">CalendarCategory</A> category)</CODE> + +<BR> + Simple constructor, creates an event object and increments iEventIDCount by one.</TD> +</TR> +<TR BGCOLOR="white" CLASS="TableRowColor"> +<TD><CODE><B><A HREF="../shared/CalendarEvent.html#CalendarEvent(java.lang.String)">CalendarEvent</A></B>(java.lang.String sCategoryName)</CODE> + +<BR> + Simple constructor, creates an event object and increments iEventIDCount by one.</TD> +</TR> +</TABLE> + +<!-- ========== METHOD SUMMARY =========== --> + +<A NAME="method_summary"><!-- --></A> +<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> +<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> <A HREF="../shared/CalendarCategory.html" title="class in shared">CalendarCategory</A></CODE></FONT></TD> +<TD><CODE><B><A HREF="../shared/CalendarEvent.html#getCategory()">getCategory</A></B>()</CODE> + +<BR> + This event returns the event's calendar category.</TD> +</TR> +<TR BGCOLOR="white" CLASS="TableRowColor"> +<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> +<CODE> java.lang.String</CODE></FONT></TD> +<TD><CODE><B><A HREF="../shared/CalendarEvent.html#getCategoryName()">getCategoryName</A></B>()</CODE> + +<BR> + This method returns the event's category name.</TD> +</TR> +<TR BGCOLOR="white" CLASS="TableRowColor"> +<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> +<CODE> <A HREF="../shared/MyDate.html" title="class in shared">MyDate</A></CODE></FONT></TD> +<TD><CODE><B><A HREF="../shared/CalendarEvent.html#getDate()">getDate</A></B>()</CODE> + +<BR> + This method returns the event's date object.</TD> +</TR> +<TR BGCOLOR="white" CLASS="TableRowColor"> +<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> +<CODE> java.lang.String</CODE></FONT></TD> +<TD><CODE><B><A HREF="../shared/CalendarEvent.html#getDescription()">getDescription</A></B>()</CODE> + +<BR> + This method returns the event's description string.</TD> +</TR> +<TR BGCOLOR="white" CLASS="TableRowColor"> +<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> +<CODE> int</CODE></FONT></TD> +<TD><CODE><B><A HREF="../shared/CalendarEvent.html#getEventID()">getEventID</A></B>()</CODE> + +<BR> + This method returns the event's ID number.</TD> +</TR> +<TR BGCOLOR="white" CLASS="TableRowColor"> +<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> +<CODE> java.lang.String</CODE></FONT></TD> +<TD><CODE><B><A HREF="../shared/CalendarEvent.html#getPlace()">getPlace</A></B>()</CODE> + +<BR> + This method returns the event's place string.</TD> +</TR> +<TR BGCOLOR="white" CLASS="TableRowColor"> +<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> +<CODE> boolean</CODE></FONT></TD> +<TD><CODE><B><A HREF="../shared/CalendarEvent.html#isYearly()">isYearly</A></B>()</CODE> + +<BR> + This method checks if this event occurs yearly or not.</TD> +</TR> +<TR BGCOLOR="white" CLASS="TableRowColor"> +<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> +<CODE> boolean</CODE></FONT></TD> +<TD><CODE><B><A HREF="../shared/CalendarEvent.html#matches(java.util.regex.Pattern)">matches</A></B>(java.util.regex.Pattern pattern)</CODE> + +<BR> + Checks if the current event matches all available data of the event agains + a given regular expression pattern.</TD> +</TR> +<TR BGCOLOR="white" CLASS="TableRowColor"> +<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> +<CODE> boolean</CODE></FONT></TD> +<TD><CODE><B><A HREF="../shared/CalendarEvent.html#matchesCategory(java.util.regex.Pattern)">matchesCategory</A></B>(java.util.regex.Pattern pattern)</CODE> + +<BR> + Checks if the current event's category name matches agains a regular expression pattern</TD> +</TR> +<TR BGCOLOR="white" CLASS="TableRowColor"> +<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> +<CODE> boolean</CODE></FONT></TD> +<TD><CODE><B><A HREF="../shared/CalendarEvent.html#matchesCategoryName(java.util.regex.Pattern)">matchesCategoryName</A></B>(java.util.regex.Pattern pattern)</CODE> + +<BR> + Checks if the current event's name matches agains a regular expression pattern.</TD> +</TR> +<TR BGCOLOR="white" CLASS="TableRowColor"> +<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> +<CODE> boolean</CODE></FONT></TD> +<TD><CODE><B><A HREF="../shared/CalendarEvent.html#matchesDateString(java.util.regex.Pattern)">matchesDateString</A></B>(java.util.regex.Pattern pattern)</CODE> + +<BR> + Checks if the current event's date string matches agains a regular expression pattern</TD> +</TR> +<TR BGCOLOR="white" CLASS="TableRowColor"> +<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> +<CODE> boolean</CODE></FONT></TD> +<TD><CODE><B><A HREF="../shared/CalendarEvent.html#matchesDescription(java.util.regex.Pattern)">matchesDescription</A></B>(java.util.regex.Pattern pattern)</CODE> + +<BR> + Checks if the current event's description string matches agains a regular expression pattern.</TD> +</TR> +<TR BGCOLOR="white" CLASS="TableRowColor"> +<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> +<CODE> boolean</CODE></FONT></TD> +<TD><CODE><B><A HREF="../shared/CalendarEvent.html#matchesPlace(java.util.regex.Pattern)">matchesPlace</A></B>(java.util.regex.Pattern pattern)</CODE> + +<BR> + Checks if the current event's place string matches agains a regular expression pattern.</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="../shared/CalendarEvent.html#removeFromCurrentCategory()">removeFromCurrentCategory</A></B>()</CODE> + +<BR> + Removes the calendar event from its current category and sets the + category reference to null.</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="../shared/CalendarEvent.html#setCategory(shared.CalendarCategory)">setCategory</A></B>(<A HREF="../shared/CalendarCategory.html" title="class in shared">CalendarCategory</A> category)</CODE> + +<BR> + This method sets the event's category.</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="../shared/CalendarEvent.html#setCategoryName(java.lang.String)">setCategoryName</A></B>(java.lang.String sCategoryName)</CODE> + +<BR> + This methos sets thhe event's category name.</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="../shared/CalendarEvent.html#setDate(java.util.Date)">setDate</A></B>(java.util.Date date)</CODE> + +<BR> + This method sets the event's date.</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="../shared/CalendarEvent.html#setDescription(java.lang.String)">setDescription</A></B>(java.lang.String sDescription)</CODE> + +<BR> + This method sets the event's descriptions tring.</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="../shared/CalendarEvent.html#setEventID(int)">setEventID</A></B>(int iEventID)</CODE> + +<BR> + This method sets the event's ID number.</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="../shared/CalendarEvent.html#setPlace(java.lang.String)">setPlace</A></B>(java.lang.String sPlace)</CODE> + +<BR> + This method sets the event's place string.</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="../shared/CalendarEvent.html#setYearly(boolean)">setYearly</A></B>(boolean bYearly)</CODE> + +<BR> + This method specifies if this event occurs yearly or not.</TD> +</TR> +<TR BGCOLOR="white" CLASS="TableRowColor"> +<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> +<CODE> java.lang.String</CODE></FONT></TD> +<TD><CODE><B><A HREF="../shared/CalendarEvent.html#toString()">toString</A></B>()</CODE> + +<BR> + This method is needed for a text representation of the object.</TD> +</TR> +</TABLE> + <A NAME="methods_inherited_from_class_java.lang.Object"><!-- --></A> +<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> +<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor"> +<TD><B>Methods inherited from class java.lang.Object</B></TD> +</TR> +<TR BGCOLOR="white" CLASS="TableRowColor"> +<TD><CODE>equals, getClass, hashCode, notify, notifyAll, wait, wait, wait</CODE></TD> +</TR> +</TABLE> + +<P> + +<!-- ============ FIELD DETAIL =========== --> + + +<!-- ========= CONSTRUCTOR DETAIL ======== --> + +<A NAME="constructor_detail"><!-- --></A> +<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> +<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor"> +<TD COLSPAN=1><FONT SIZE="+2"> +<B>Constructor Detail</B></FONT></TD> +</TR> +</TABLE> + +<A NAME="CalendarEvent(shared.CalendarCategory)"><!-- --></A><H3> +CalendarEvent</H3> +<PRE> +public <B>CalendarEvent</B>(<A HREF="../shared/CalendarCategory.html" title="class in shared">CalendarCategory</A> category)</PRE> +<DL> +<DD>Simple constructor, creates an event object and increments iEventIDCount by one. +<P> +<DT><B>Parameters:</B><DD><CODE>category</CODE> - Specifies the event's category.</DL> +<HR> + +<A NAME="CalendarEvent(java.lang.String)"><!-- --></A><H3> +CalendarEvent</H3> +<PRE> +public <B>CalendarEvent</B>(java.lang.String sCategoryName)</PRE> +<DL> +<DD>Simple constructor, creates an event object and increments iEventIDCount by one. +<P> +<DT><B>Parameters:</B><DD><CODE>sCategoryName</CODE> - Specifies the event's category name.</DL> + +<!-- ============ METHOD DETAIL ========== --> + +<A NAME="method_detail"><!-- --></A> +<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> +<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor"> +<TD COLSPAN=1><FONT SIZE="+2"> +<B>Method Detail</B></FONT></TD> +</TR> +</TABLE> + +<A NAME="setDate(java.util.Date)"><!-- --></A><H3> +setDate</H3> +<PRE> +public void <B>setDate</B>(java.util.Date date)</PRE> +<DL> +<DD>This method sets the event's date. +<P> +<DD><DL> +</DL> +</DD> +<DD><DL> +<DT><B>Parameters:</B><DD><CODE>date</CODE> - Specifies the event's date.</DL> +</DD> +</DL> +<HR> + +<A NAME="setCategory(shared.CalendarCategory)"><!-- --></A><H3> +setCategory</H3> +<PRE> +public void <B>setCategory</B>(<A HREF="../shared/CalendarCategory.html" title="class in shared">CalendarCategory</A> category)</PRE> +<DL> +<DD>This method sets the event's category. +<P> +<DD><DL> +</DL> +</DD> +<DD><DL> +<DT><B>Parameters:</B><DD><CODE>category</CODE> - Specifies the event's category.</DL> +</DD> +</DL> +<HR> + +<A NAME="getCategory()"><!-- --></A><H3> +getCategory</H3> +<PRE> +public <A HREF="../shared/CalendarCategory.html" title="class in shared">CalendarCategory</A> <B>getCategory</B>()</PRE> +<DL> +<DD>This event returns the event's calendar category. +<P> +<DD><DL> +</DL> +</DD> +<DD><DL> + +<DT><B>Returns:</B><DD>Returns the event's calenda category.</DL> +</DD> +</DL> +<HR> + +<A NAME="setCategoryName(java.lang.String)"><!-- --></A><H3> +setCategoryName</H3> +<PRE> +public void <B>setCategoryName</B>(java.lang.String sCategoryName)</PRE> +<DL> +<DD>This methos sets thhe event's category name. +<P> +<DD><DL> +</DL> +</DD> +<DD><DL> +<DT><B>Parameters:</B><DD><CODE>sCategoryName</CODE> - Specifies the event's category name.</DL> +</DD> +</DL> +<HR> + +<A NAME="setDescription(java.lang.String)"><!-- --></A><H3> +setDescription</H3> +<PRE> +public void <B>setDescription</B>(java.lang.String sDescription)</PRE> +<DL> +<DD>This method sets the event's descriptions tring. +<P> +<DD><DL> +</DL> +</DD> +<DD><DL> +<DT><B>Parameters:</B><DD><CODE>sDescription</CODE> - Specifies the event's description string.</DL> +</DD> +</DL> +<HR> + +<A NAME="setPlace(java.lang.String)"><!-- --></A><H3> +setPlace</H3> +<PRE> +public void <B>setPlace</B>(java.lang.String sPlace)</PRE> +<DL> +<DD>This method sets the event's place string. +<P> +<DD><DL> +</DL> +</DD> +<DD><DL> +<DT><B>Parameters:</B><DD><CODE>sPlace</CODE> - Specifies the event's place string.</DL> +</DD> +</DL> +<HR> + +<A NAME="setEventID(int)"><!-- --></A><H3> +setEventID</H3> +<PRE> +public void <B>setEventID</B>(int iEventID)</PRE> +<DL> +<DD>This method sets the event's ID number. +<P> +<DD><DL> +</DL> +</DD> +<DD><DL> +<DT><B>Parameters:</B><DD><CODE>iEventID</CODE> - specifies the event's ID number.</DL> +</DD> +</DL> +<HR> + +<A NAME="setYearly(boolean)"><!-- --></A><H3> +setYearly</H3> +<PRE> +public void <B>setYearly</B>(boolean bYearly)</PRE> +<DL> +<DD>This method specifies if this event occurs yearly or not. +<P> +<DD><DL> +</DL> +</DD> +<DD><DL> +<DT><B>Parameters:</B><DD><CODE>bYearly</CODE> - Specifies if this event occury yearly or not.</DL> +</DD> +</DL> +<HR> + +<A NAME="getCategoryName()"><!-- --></A><H3> +getCategoryName</H3> +<PRE> +public java.lang.String <B>getCategoryName</B>()</PRE> +<DL> +<DD>This method returns the event's category name. +<P> +<DD><DL> +</DL> +</DD> +<DD><DL> + +<DT><B>Returns:</B><DD>Returns the event's category name.</DL> +</DD> +</DL> +<HR> + +<A NAME="getDescription()"><!-- --></A><H3> +getDescription</H3> +<PRE> +public java.lang.String <B>getDescription</B>()</PRE> +<DL> +<DD>This method returns the event's description string. +<P> +<DD><DL> +</DL> +</DD> +<DD><DL> + +<DT><B>Returns:</B><DD>Returns the event's description string.</DL> +</DD> +</DL> +<HR> + +<A NAME="getPlace()"><!-- --></A><H3> +getPlace</H3> +<PRE> +public java.lang.String <B>getPlace</B>()</PRE> +<DL> +<DD>This method returns the event's place string. +<P> +<DD><DL> +</DL> +</DD> +<DD><DL> + +<DT><B>Returns:</B><DD>Returns the event's place string.</DL> +</DD> +</DL> +<HR> + +<A NAME="getDate()"><!-- --></A><H3> +getDate</H3> +<PRE> +public <A HREF="../shared/MyDate.html" title="class in shared">MyDate</A> <B>getDate</B>()</PRE> +<DL> +<DD>This method returns the event's date object. +<P> +<DD><DL> +</DL> +</DD> +<DD><DL> + +<DT><B>Returns:</B><DD>Returns the event's date object.</DL> +</DD> +</DL> +<HR> + +<A NAME="getEventID()"><!-- --></A><H3> +getEventID</H3> +<PRE> +public int <B>getEventID</B>()</PRE> +<DL> +<DD>This method returns the event's ID number. +<P> +<DD><DL> +</DL> +</DD> +<DD><DL> + +<DT><B>Returns:</B><DD>Returns the event's ID number.</DL> +</DD> +</DL> +<HR> + +<A NAME="isYearly()"><!-- --></A><H3> +isYearly</H3> +<PRE> +public boolean <B>isYearly</B>()</PRE> +<DL> +<DD>This method checks if this event occurs yearly or not. +<P> +<DD><DL> +</DL> +</DD> +<DD><DL> + +<DT><B>Returns:</B><DD>Returns true if the event occurs yearly, else it returns false.</DL> +</DD> +</DL> +<HR> + +<A NAME="matches(java.util.regex.Pattern)"><!-- --></A><H3> +matches</H3> +<PRE> +public boolean <B>matches</B>(java.util.regex.Pattern pattern)</PRE> +<DL> +<DD>Checks if the current event matches all available data of the event agains + a given regular expression pattern. +<P> +<DD><DL> +</DL> +</DD> +<DD><DL> +<DT><B>Parameters:</B><DD><CODE>pattern</CODE> - Specifies the pattern to match against. +<DT><B>Returns:</B><DD>Returns true if one element of the event matches.</DL> +</DD> +</DL> +<HR> + +<A NAME="matchesCategoryName(java.util.regex.Pattern)"><!-- --></A><H3> +matchesCategoryName</H3> +<PRE> +public boolean <B>matchesCategoryName</B>(java.util.regex.Pattern pattern)</PRE> +<DL> +<DD>Checks if the current event's name matches agains a regular expression pattern. +<P> +<DD><DL> +</DL> +</DD> +<DD><DL> +<DT><B>Parameters:</B><DD><CODE>pattern</CODE> - Specifies the pattern to be matched against. +<DT><B>Returns:</B><DD>Returns true if the event matches, else false will be returned. If the pattern is null, true will be returned.</DL> +</DD> +</DL> +<HR> + +<A NAME="matchesDescription(java.util.regex.Pattern)"><!-- --></A><H3> +matchesDescription</H3> +<PRE> +public boolean <B>matchesDescription</B>(java.util.regex.Pattern pattern)</PRE> +<DL> +<DD>Checks if the current event's description string matches agains a regular expression pattern. +<P> +<DD><DL> +</DL> +</DD> +<DD><DL> +<DT><B>Parameters:</B><DD><CODE>pattern</CODE> - Specifies the pattern to match against. +<DT><B>Returns:</B><DD>Returns true if the event matches, else false will be returned. If the pattern is null, true will be returned.</DL> +</DD> +</DL> +<HR> + +<A NAME="matchesPlace(java.util.regex.Pattern)"><!-- --></A><H3> +matchesPlace</H3> +<PRE> +public boolean <B>matchesPlace</B>(java.util.regex.Pattern pattern)</PRE> +<DL> +<DD>Checks if the current event's place string matches agains a regular expression pattern. +<P> +<DD><DL> +</DL> +</DD> +<DD><DL> +<DT><B>Parameters:</B><DD><CODE>pattern</CODE> - Specifies the pattern to match against. +<DT><B>Returns:</B><DD>Returns true if the event matches, else false will be returned. If the pattern is null, true will be returned.</DL> +</DD> +</DL> +<HR> + +<A NAME="matchesCategory(java.util.regex.Pattern)"><!-- --></A><H3> +matchesCategory</H3> +<PRE> +public boolean <B>matchesCategory</B>(java.util.regex.Pattern pattern)</PRE> +<DL> +<DD>Checks if the current event's category name matches agains a regular expression pattern +<P> +<DD><DL> +</DL> +</DD> +<DD><DL> +<DT><B>Parameters:</B><DD><CODE>pattern</CODE> - Specifies the pattern to match against. +<DT><B>Returns:</B><DD>Returns true if the event matches, else false will be returned. If the pattern is null, true will be returned.</DL> +</DD> +</DL> +<HR> + +<A NAME="matchesDateString(java.util.regex.Pattern)"><!-- --></A><H3> +matchesDateString</H3> +<PRE> +public boolean <B>matchesDateString</B>(java.util.regex.Pattern pattern)</PRE> +<DL> +<DD>Checks if the current event's date string matches agains a regular expression pattern +<P> +<DD><DL> +</DL> +</DD> +<DD><DL> +<DT><B>Parameters:</B><DD><CODE>pattern</CODE> - Specifies the pattern to match against. +<DT><B>Returns:</B><DD>Returns true if the event matches, else false will be returned. If the pattern is null, true will be returned.</DL> +</DD> +</DL> +<HR> + +<A NAME="removeFromCurrentCategory()"><!-- --></A><H3> +removeFromCurrentCategory</H3> +<PRE> +public void <B>removeFromCurrentCategory</B>()</PRE> +<DL> +<DD>Removes the calendar event from its current category and sets the + category reference to null. +<P> +<DD><DL> +</DL> +</DD> +<DD><DL> +</DL> +</DD> +</DL> +<HR> + +<A NAME="toString()"><!-- --></A><H3> +toString</H3> +<PRE> +public java.lang.String <B>toString</B>()</PRE> +<DL> +<DD>This method is needed for a text representation of the object. +<P> +<DD><DL> +</DL> +</DD> +<DD><DL> + +<DT><B>Returns:</B><DD>Returns object represented as a String.</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="class-use/CalendarEvent.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A> </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-files/index-1.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="../shared/CalendarCategory.html" title="class in shared"><B>PREV CLASS</B></A> + <A HREF="../shared/Config.html" title="class in shared"><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="CalendarEvent.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: NESTED | FIELD | <A HREF="#constructor_summary">CONSTR</A> | <A HREF="#method_summary">METHOD</A></FONT></TD> +<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2"> +DETAIL: FIELD | <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> |