BBjCalendarWidget

Interface CalendarDatesSetEvent

All Superinterfaces:

CalendarEvent

public interface CalendarDatesSetEvent
extends CalendarEvent

CalendarDatesSetEvent is a BBj Interface that contains event information after the calendar's date range has been initially set or changed in some way and the DOM has been updated. The dates can also change when the current-date is manipulated via the API, such as when gotoDate is called. This data class will be made available to your custom callback routine after the user clicks the prev/next buttons, changes the view, clicks a navlink, etc. you have previously executed the BBjCalendarWidget::setCallback() method to register for the CalendarAPI.ON_CALENDAR_DATES_SET event.

Method Summary

Modifier and Type	Method and Description
BBjString	getEnd() Returns the calendar's ending date for the current range.
BBjString	getEndStr() Returns the calendar's ending date in ISO 8601 format for the current range.
BBjString	getStart() Returns the calendar's starting date for the current range.
BBjString	getStartStr() Returns the calendar's starting date in ISO 8601 format for the current range.
BBjString	getTimeZone() Returns the calendar's time zone setting.

Methods inherited from interface BBjCalendarWidget.CalendarEvent

getAsFormattedString, getAsJsonObject, getAsString, getCalendarUuid, getCalendarView, getEventNumber

Method Detail

getStart

BBjString getStart()

Returns the calendar's starting date for the current range.

Returns:

BBjString The calendar's starting date for the current range.

See Also:

Date and Time Formats for information on ISO 8601 date/time formats.

getEnd

BBjString getEnd()

Returns the calendar's ending date for the current range.

Returns:

BBjString The calendar's ending date for the current range.

See Also:

Date and Time Formats for information on ISO 8601 date/time formats.

getStartStr

BBjString getStartStr()

Returns the calendar's starting date in ISO 8601 format for the current range.

Returns:

BBjString The calendar's starting date in ISO 8601 format.

See Also:

Date and Time Formats for information on ISO 8601 date/time formats.

getEndStr

BBjString getEndStr()

Returns the calendar's ending date in ISO 8601 format for the current range.

Returns:

BBjString The calendar's ending date in ISO 8601 format.

See Also:

Date and Time Formats for information on ISO 8601 date/time formats.

getTimeZone

BBjString getTimeZone()

Returns the calendar's time zone setting.

Returns:

BBjString A BBjString with the calendar's time zone setting.