BBjCalendarWidget

Interface CalendarDateClickEvent

All Superinterfaces:

CalendarEvent, CalendarEventWithJavaScriptEvent

public interface CalendarDateClickEvent
extends CalendarEventWithJavaScriptEvent

CalendarDateClickEvent is a BBj Interface that contains event information after the user clicks on a date 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_DATE_CLICK event.

Method Summary

Modifier and Type	Method and Description
BBjNumber	getAllDay() Returns a BBjNumber acting as a boolean that determines whether the user clicked on an all-day cell (1) or not (0).
BBjString	getDate() Returns the calendar's date (day/time) that was clicked.
BBjString	getDateString() Returns the calendar's date in ISO 8601 format.
JsonObject	getHtmlElement() Returns the native HTML element with low-level information such as content, size, and position.

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

getHtmlElement

JsonObject getHtmlElement()

Returns the native HTML element with low-level information such as content, size, and position.

Returns:

JsonObject Returns the native HTML element with low-level information such as content, size, and position.

See Also:

HTML DOM Element Object for information about a native HTML element.

getDate

BBjString getDate()

Returns the calendar's date (day/time) that was clicked.

Returns:

BBjString The calendar's date (day/time) that was clicked.

getDateString

BBjString getDateString()

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

Returns:

BBjString The calendar's date in ISO 8601 format. Depending on what the user clicked, 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 clicked on an all-day cell (1) or not (0).

Returns:

BBjNumber A BBjNumber acting as a boolean that determines whether the user clicked on an all-day cell (1) or not (0).