BBjCalendarWidget

Interface CalendarEvent

All Known Subinterfaces:

CalendarDateClickEvent, CalendarDatesSetEvent, CalendarEntriesSetEvent, CalendarEntryAddEvent, CalendarEntryChangeEvent, CalendarEntryClickEvent, CalendarEntryDropEvent, CalendarEntryEvent, CalendarEntryModificationEvent, CalendarEntryMouseEnterEvent, CalendarEntryMouseLeaveEvent, CalendarEntryRemoveEvent, CalendarEntryResizeEvent, CalendarEntrySourceFailureEvent, CalendarEntrySourceSuccessEvent, CalendarEventWithJavaScriptEvent, CalendarReadyEvent, CalendarSelectEvent, CalendarUnselectEvent, CalendarViewChangeEvent

public interface CalendarEvent

CalendarEvent is a BBj Interface that contains event information for a BBjCalendarWidget. This is the base class for all BBjCalendarWidget events.

Since:

BBj 21.00

Method Summary

Modifier and Type	Method and Description
BBjString	getAsFormattedString() Returns a formatted, i.e.
JsonObject	getAsJsonObject() Returns a JsonObject representation of the CalendarEvent.
BBjString	getAsString() Returns a stringified JsonObject representation of the CalendarEvent.
BBjString	getCalendarUuid() Returns a unique ID that identifes the calendar instance to which the event belongs.
CalendarView	getCalendarView() Returns the calendar's CalendarView object.
BBjNumber	getEventNumber() Returns the event number that corresponds to one of the CalendarAPI.ON_CALENDAR_* callback constants.

Method Detail

getEventNumber

BBjNumber getEventNumber()

Returns the event number that corresponds to one of the CalendarAPI.ON_CALENDAR_* callback constants.

Returns:

BBjNumber The event number that corresponds to one of the CalendarAPI.ON_CALENDAR_* callback constants.

getCalendarUuid

BBjString getCalendarUuid()

Returns a unique ID that identifes the calendar instance to which the event belongs.

Returns:

BBjString The calendar instance's unique auto-generated ID that is used in the client to distinguish between instances of the class.

getCalendarView

CalendarView getCalendarView()

Returns the calendar's CalendarView object.

Returns:

CalendarView The calendar's current CalendarView object.

getAsString

BBjString getAsString()

Returns a stringified JsonObject representation of the CalendarEvent.

Returns:

BBjString The CalendarEvent in stringified JSON format.

getAsFormattedString

BBjString getAsFormattedString()

Returns a formatted, i.e. pretty-printed or beautified, stringified JsonObject representation of the CalendarEvent object.

Returns:

BBjString The CalendarEvent in stringified JSON format.

getAsJsonObject

JsonObject getAsJsonObject()

Returns a JsonObject representation of the CalendarEvent.

Returns:

JsonObject The CalendarEvent as a JsonObject.

See Also:

JsonObject for information about an object in JSON format.