|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object | +--superwaba.ext.palm.io.builtin.Datebook
Provides a link to the standard Palm Datebook database.
Field Summary | |
static int |
ALARM_DAYS
|
static int |
ALARM_HOURS
|
static int |
ALARM_MINUTES
|
int |
alarmAdvance
The number of alarmUnit s before startDate
that the alarm should go off, or -1 for no alarm. |
int |
alarmUnits
The units of time that the alarm should go off before the start date. |
String |
description
A description for this appointment |
Time |
endTime
The time this datebook item is to end - date info is ignored. |
Time[] |
exceptions
An array of dates in chronological order that the appointment shouldn't repeat on. |
protected static int |
noDateOrTime
Palm notation for no date or time |
String |
note
A note giving extra information |
static int |
REPEAT_DAILY
|
static int |
REPEAT_MONTHLY_BY_DATE
|
static int |
REPEAT_MONTHLY_BY_DAY
|
static int |
REPEAT_NONE
|
static int |
REPEAT_WEEKLY
|
static int |
REPEAT_YEARLY
|
Time |
repeatEndDate
The end date for repeating (or null for forever) |
int |
repeatFrequency
The interval (in repeatTypes) between repetitions |
int |
repeatMonthlyCount
Indicates the number of repeatMonthlyDay s into each month
this appointment should repeat. |
int |
repeatMonthlyDay
Indicates the day of week to repeat. |
int |
repeatType
The type of repeat (one of the REPEAT_XXX constants) |
boolean[] |
repeatWeekdays
Indicates which days of the week to repeat on. |
boolean |
repeatWeekStartsOnMonday
Indicated whether the week display should start with Sunday (false) or Monday (true). |
Time |
startDate
The time and date this datebook item is to start |
Constructor Summary | |
Datebook()
Constructs a new empty datebook |
Method Summary | |
static boolean |
addDate(Datebook datebook)
Adds a new Datebook to the database |
static int |
datebookCount()
Gets the number of Datebook's in the database |
static boolean |
delDate(int i)
Deletes a Datebook entry in the database |
static int |
findDatePosition(Datebook d)
Finds the suitable position for a new datebook entry |
static Datebook |
getDate(int i)
Gets a Datebook from the database |
static boolean |
getDate(int i,
Datebook datebook)
Gets a Datebook from the database and places it into the given Datebook. |
byte |
getID()
Gets a unique ID for this class. |
Storable |
getInstance()
Returns an object of the same class as this object. |
static int |
getRepeatRange()
Gets the first date which is not a repeatable date |
static boolean |
insertDate(Datebook datebook)
Inserts a new Datebook to the database at the proper position in the dates sort order. |
void |
loadState(DataStream ds)
Load state information from the given DataStream into this object If any Storable objects need to be loaded as part of the state, their loadState() method can be called too. |
protected void |
readDate(int packedDate,
Time date)
Reads date information from a short read from a stream in DateType format |
protected void |
readTime(int packedTime,
Time time)
Reads time information from a short read from a stream in TimeType format |
void |
saveState(DataStream ds)
Send the state information of this object to the given object catalog using the given DataStream. |
protected void |
writeDate(DataStream ds,
Time date)
Writes the date information to the stream as a Palm DateType |
protected void |
writeTime(DataStream ds,
Time time)
Writes the time information to the stream as a Palm TimeType |
Methods inherited from class java.lang.Object |
equals,
getClass,
hashCode,
notify,
toString,
wait,
wait |
Field Detail |
public static final int ALARM_MINUTES
public static final int ALARM_HOURS
public static final int ALARM_DAYS
public static final int REPEAT_NONE
public static final int REPEAT_DAILY
public static final int REPEAT_WEEKLY
public static final int REPEAT_MONTHLY_BY_DAY
public static final int REPEAT_MONTHLY_BY_DATE
public static final int REPEAT_YEARLY
public Time startDate
public Time endTime
public int alarmUnits
public int alarmAdvance
alarmUnit
s before startDate
that the alarm should go off, or -1 for no alarm.public int repeatType
REPEAT_XXX
constants)public Time repeatEndDate
public int repeatFrequency
public int repeatMonthlyDay
repeatType
is REPEAT_MONTHLY_BY_DAY
.
Should be in the range 0 (Sunday) to 6 (Saturday). This field is used
in conjunction with repeatMonthlyCount
to represent
things like the 3rd Sunday every month by setting
repeatMonthlyDay
to 0 and repeatMonthlyCount
to 3.public int repeatMonthlyCount
repeatMonthlyDay
s into each month
this appointment should repeat. Only applicable when repeatType is
REPEAT_MONTHLY_BY_DAY.public boolean[] repeatWeekdays
public boolean repeatWeekStartsOnMonday
public String note
public Time[] exceptions
public String description
protected static int noDateOrTime
Constructor Detail |
public Datebook()
Method Detail |
public static int datebookCount()
public static Datebook getDate(int i)
i
- the index to getpublic static boolean getDate(int i, Datebook datebook)
i
- the index to getdatebook
- the datebook object to place the datebook into.public static boolean addDate(Datebook datebook)
datebook
- the datebook to addpublic static boolean insertDate(Datebook datebook)
datebook
- the datebook to addpublic static int getRepeatRange()
public static int findDatePosition(Datebook d)
datebook
- the Datebook objectpublic static boolean delDate(int i)
i
- the index to deletepublic void saveState(DataStream ds)
public void loadState(DataStream ds)
public byte getID()
public Storable getInstance()
protected void writeTime(DataStream ds, Time time)
ds
- the stream to write totime
- the time to write (only hour and minutes used)protected void writeDate(DataStream ds, Time date)
ds
- the stream to write todate
- the date to write (only day, month, year used)protected void readTime(int packedTime, Time time)
packedTime
- the packed representationtime
- the object to load the information into. (h,m,s,millis set)protected void readDate(int packedDate, Time date)
packedDate
- the packed representationdate
- the object to load the information into (day,month,year set)
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |