BBjCalendarWidget

Interface CalendarSelectEvent

All Superinterfaces:

CalendarEvent, CalendarEventWithJavaScriptEvent

public interface CalendarSelectEvent
extends CalendarEventWithJavaScriptEvent

CalendarSelectEvent is a BBj Interface that contains event information after the user selects a date and/or time. This data class will be made available to your custom callback routine after the user clicks on a date or time and you have previously executed the BBjCalendarWidget::setCallback() method to register for the CalendarAPI.ON_CALENDAR_SELECT event.

Method Summary

Modifier and Type	Method and Description
BBjNumber	getAllDay() Returns a BBjNumber acting as a boolean that determines whether the user selected all-day cells (1) or not (0).
BBjString	getEnd() Returns the calendar's ending date of the selection, which may include timezone information and is exclusive.
BBjString	getEndString() Returns the calendar's selected ending date in ISO 8601 format and is exclusive.
BBjString	getStart() Returns the calendar's selected starting date, which may include timezone information.
BBjString	getStartString() Returns the calendar's selected starting date in ISO 8601 format.

Methods inherited from interface BBjCalendarWidget.CalendarEventWithJavaScriptEvent

getAltKey, getCalendarX, getCalendarY, getClientX, getClientY, getControlKey, getJsEvent, getJsEventAsFormattedString, getJsEventAsString, getMetaKey, getScreenX, getScreenY, getShiftKey

Methods inherited from interface BBjCalendarWidget.CalendarEvent

getAsFormattedString, getAsJsonObject, getAsString, getCalendarUuid, getCalendarView, getEventNumber

Method Detail

getStart

BBjString getStart()

Returns the calendar's selected starting date, which may include timezone information.

Returns:

BBjString The calendar's selected starting date, which may include timezone information.

See Also:

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

getEnd

BBjString getEnd()

Returns the calendar's ending date of the selection, which may include timezone information and is exclusive.

Returns:

BBjString The calendar's ending date of the selection, which may include timezone information and is exclusive.

See Also:

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

getStartString

BBjString getStartString()

Returns the calendar's selected starting date in ISO 8601 format. Depending on what the user selected, it may or may not include a time and time zone portion.

Returns:

BBjString The calendar's selected starting date in ISO 8601 format. Depending on what the user selected, it may or may not include a time and time zone portion.

See Also:

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

getEndString

BBjString getEndString()

Returns the calendar's selected ending date in ISO 8601 format and is exclusive. Depending on what the user selected, it may or may not include a time and time zone portion.

Returns:

BBjString The calendar's selected ending date in ISO 8601 format and is exclusive. Depending on what the user selected, it may or may not include a time and time zone portion.

See Also:

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

getAllDay

BBjNumber getAllDay()

Returns a BBjNumber acting as a boolean that determines whether the user selected all-day cells (1) or not (0).

Returns:

BBjNumber A BBjNumber acting as a boolean that determines whether the user selected all-day cells.