|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectcom.funambol.common.pim.vcalendar.BasicVCalendarFormatter
public abstract class BasicVCalendarFormatter
This class implements the basic vCalendar formatter listener which manages the formatting of common properties shared by the vCalendar 1.0 and iCalendar (vCalendar 2.0) formats.
NOTE: Implementations of the iCalendar and vCalendar formatters should extend this class.
Field Summary | |
---|---|
protected VAlarm |
alarm
|
protected java.lang.String |
defaultCharset
|
protected PimUtils |
pimUtils
|
Constructor Summary | |
---|---|
BasicVCalendarFormatter()
|
|
BasicVCalendarFormatter(java.lang.String defaultCharset)
Create a new BasicVCalendarFormatter using the provided default charset |
Method Summary | |
---|---|
protected java.lang.String |
encodeField(java.lang.String value)
Encode a field value if it requires encoding |
protected long |
fixEndDate(long endDate)
Add a day factor to the end date (used for allday events) |
void |
format(PIMItem pimItem,
java.io.OutputStream os,
boolean allFields)
Format the vCalendar item. |
protected abstract void |
formatAlarm(PIMItem pimItem,
java.io.OutputStream os,
boolean allFields)
|
protected void |
formatAttendees(PIMItem pimItem,
java.io.OutputStream os,
boolean allFields)
|
protected void |
formatCategories(PIMItem pimItem,
java.io.OutputStream os,
boolean allFields)
|
protected void |
formatClass(PIMItem pimItem,
int pimField,
java.io.OutputStream os,
boolean allFields)
|
protected void |
formatCompleted(PIMItem pimItem,
java.io.OutputStream os,
boolean allFields)
|
protected abstract void |
formatDateTimeField(java.io.OutputStream os,
PIMItem pimItem,
int pimField,
java.lang.String vCalField,
boolean checkAllDay,
boolean checkTimezone,
boolean allFields)
Format a date-time field. |
protected void |
formatDTEnd(PIMItem pimItem,
java.io.OutputStream os,
boolean allFields)
|
protected void |
formatDTStart(PIMItem pimItem,
java.io.OutputStream os,
boolean allFields)
|
protected void |
formatDue(PIMItem pimItem,
java.io.OutputStream os,
boolean allFields)
|
protected void |
formatEvent(PIMItem pimItem,
java.io.OutputStream os,
boolean allFields)
Format the Event common properties |
protected void |
formatFunambolAllday(PIMItem pimItem,
java.io.OutputStream os,
boolean allFields)
|
protected void |
formatLocation(PIMItem pimItem,
java.io.OutputStream os,
boolean allFields)
|
protected void |
formatNote(PIMItem pimItem,
int pimField,
java.io.OutputStream os,
boolean allFields)
|
protected void |
formatPriority(PIMItem pimItem,
java.io.OutputStream os,
boolean allFields)
|
protected void |
formatRevision(PIMItem pimItem,
int pimField,
java.io.OutputStream os,
boolean allFields)
|
protected void |
formatRRule(PIMItem pimItem,
java.io.OutputStream os,
boolean allFields)
|
protected void |
formatSimpleField(PIMItem pimItem,
int pimField,
java.lang.String vCalField,
java.io.OutputStream os,
boolean checkEncode,
boolean allFields)
Format a simple field. |
protected void |
formatStatus(PIMItem pimItem,
java.io.OutputStream os,
boolean allFields)
|
protected void |
formatSummary(PIMItem pimItem,
int pimField,
java.io.OutputStream os,
boolean allFields)
Sigle field formatters |
protected abstract void |
formatTimezone(PIMItem pimItem,
java.io.OutputStream os)
|
protected void |
formatToDo(PIMItem pimItem,
java.io.OutputStream os,
boolean allFields)
Format the ToDo common properties |
protected void |
formatUID(PIMItem pimItem,
int pimField,
java.io.OutputStream os,
boolean allFields)
|
protected int |
getTaskAlarmInterval(PIMItem pimItem)
|
protected abstract java.lang.String |
getVersion()
Get the version property string (e.g. |
protected boolean |
isAllDay(PIMItem pimItem)
|
protected boolean |
isSupported(PIMItem pimItem,
int pimField)
|
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Field Detail |
---|
protected java.lang.String defaultCharset
protected PimUtils pimUtils
protected VAlarm alarm
Constructor Detail |
---|
public BasicVCalendarFormatter(java.lang.String defaultCharset)
defaultCharset
- public BasicVCalendarFormatter()
Method Detail |
---|
public void format(PIMItem pimItem, java.io.OutputStream os, boolean allFields) throws PIMException
pimItem
- the PIMItem to formatos
- the output stream
javax.microedition.pim.PIMException
PIMException
protected void formatEvent(PIMItem pimItem, java.io.OutputStream os, boolean allFields) throws PIMException
pimItem
- the PIMItem to formatos
- the output stream
javax.microedition.pim.PIMException
PIMException
protected void formatToDo(PIMItem pimItem, java.io.OutputStream os, boolean allFields) throws PIMException
pimItem
- the PIMItem to formatos
- the output stream
javax.microedition.pim.PIMException
PIMException
protected abstract java.lang.String getVersion()
protected void formatSummary(PIMItem pimItem, int pimField, java.io.OutputStream os, boolean allFields) throws PIMException
PIMException
protected void formatNote(PIMItem pimItem, int pimField, java.io.OutputStream os, boolean allFields) throws PIMException
PIMException
protected void formatLocation(PIMItem pimItem, java.io.OutputStream os, boolean allFields) throws PIMException
PIMException
protected void formatUID(PIMItem pimItem, int pimField, java.io.OutputStream os, boolean allFields) throws PIMException
PIMException
protected void formatPriority(PIMItem pimItem, java.io.OutputStream os, boolean allFields) throws PIMException
PIMException
protected void formatStatus(PIMItem pimItem, java.io.OutputStream os, boolean allFields) throws PIMException
PIMException
protected void formatCategories(PIMItem pimItem, java.io.OutputStream os, boolean allFields) throws PIMException
PIMException
protected void formatClass(PIMItem pimItem, int pimField, java.io.OutputStream os, boolean allFields) throws PIMException
PIMException
protected void formatDTStart(PIMItem pimItem, java.io.OutputStream os, boolean allFields) throws PIMException
PIMException
protected void formatDTEnd(PIMItem pimItem, java.io.OutputStream os, boolean allFields) throws PIMException
PIMException
protected void formatDue(PIMItem pimItem, java.io.OutputStream os, boolean allFields) throws PIMException
PIMException
protected void formatRevision(PIMItem pimItem, int pimField, java.io.OutputStream os, boolean allFields) throws PIMException
PIMException
protected void formatCompleted(PIMItem pimItem, java.io.OutputStream os, boolean allFields) throws PIMException
PIMException
protected void formatRRule(PIMItem pimItem, java.io.OutputStream os, boolean allFields) throws PIMException
PIMException
protected void formatFunambolAllday(PIMItem pimItem, java.io.OutputStream os, boolean allFields) throws PIMException
PIMException
protected void formatAttendees(PIMItem pimItem, java.io.OutputStream os, boolean allFields) throws PIMException
PIMException
protected int getTaskAlarmInterval(PIMItem pimItem)
protected abstract void formatAlarm(PIMItem pimItem, java.io.OutputStream os, boolean allFields) throws PIMException
PIMException
protected abstract void formatTimezone(PIMItem pimItem, java.io.OutputStream os) throws PIMException
PIMException
protected void formatSimpleField(PIMItem pimItem, int pimField, java.lang.String vCalField, java.io.OutputStream os, boolean checkEncode, boolean allFields) throws PIMException
pimItem
- the PIMItem that contains the field valuepimField
- the PIMItem field indexvCalField
- the vCalendar field nameos
- the output streamcheckEncode
- check whether the field value shall be encoded
javax.microedition.pim.PIMException
PIMException
protected abstract void formatDateTimeField(java.io.OutputStream os, PIMItem pimItem, int pimField, java.lang.String vCalField, boolean checkAllDay, boolean checkTimezone, boolean allFields) throws PIMException
os
- The output stream to print the field in.pimItem
- The PIMItempimField
- The pim field index.vCalField
- The vCalendar field namecheckAllDay
- Check whether the allday property shall be updatedcheckTimezone
- Check whether the TZID param shall be added (only
for iCalendar implementations)
javax.microedition.pim.PIMException
PIMException
protected boolean isAllDay(PIMItem pimItem)
protected java.lang.String encodeField(java.lang.String value) throws PIMException
value
- the field value
javax.microedition.pim.PIMException
PIMException
protected boolean isSupported(PIMItem pimItem, int pimField)
protected long fixEndDate(long endDate)
endDate
-
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |