BBjCalendarWidget

```
public interface BBjCalendarWidget
```
BBjCalendarWidget is a BBj Interface that serves as a plug-in to the FullCalendar JavaScript-based calendar control.

For the full copyright and license information, please view the LICENSE file that was distributed with this source code.
THROWn Error Codes:
- 500: The calendar is not ready for interaction. Setting a callback for the CalendarAPI.ON_CALENDAR_READY event will result in your application getting a CalendarReadyEvent event signaling that the calendar is ready for interaction.
- 510: Invalid theme specified. The specified theme file does not exist. See the getThemes() method for more information on installing and getting valid theme names.
- 512: Invalid parameter. The parameter provided to a method is null() or invalid. The error message may indicate which method call failed.
- 514: Invalid configuration. The specified object has not been configured correctly or is missing required properties.
- 530: Invalid date or time specified. The specified date or time string is not valid or cannot be parsed.
- 700: Missing file. The specified file does not exist. This may occur when the library attempts to read in an HTML, CSS, JavaScript, or theme file.
See Also:
[ FullCalendar for information on the FullCalendar JavaScript-based calendar control.]
Since:
BBj 21.00

Method Summary

Methods
Modifier and Type	Method and Description
`void`	`addEntries(JsonArray entries!)` Adds several JsonObject entries in a JsonArray to the calendar at once for improved performance. Note: Adding multiple entries to the calendar via this method will not trigger the `CalendarAPI.ON_CALENDAR_ENTRY_ADD()` event.
`void`	`addEntries(BBjVector entries!)` Adds several entries of type `CalendarEntry` to the calendar at once for improved performance. Note: Adding multiple entries to the calendar via this method will not trigger the `CalendarAPI.ON_CALENDAR_ENTRY_ADD()` event.
`void`	`addEntry(JsonObject entry!)` Adds an entry to the calendar given a JsonObject representation of the calendar entry. Note: Adding entries to the calendar via this method will trigger the `CalendarAPI.ON_CALENDAR_ENTRY_ADD()` event.
`void`	`addEntry(CalendarEntry entry!)` Adds an entry to the calendar given a `CalendarEntry` object. Note: Adding entries to the calendar via this method will trigger the `CalendarAPI.ON_CALENDAR_ENTRY_ADD()` event.
`void`	`addEntrySource(CalendarEntrySource entrySource!)` Adds entries to the calendar from a `CalendarEntrySource`.
`boolean`	`addStyle(BBjString style!)` Adds the provided CSS style name to the widget.
`void`	`clearCallback(BBjNumber event!)` Removes the callback given the callback number.
`void`	`clearStyles()` Clears all the CSS styles from the widget.
`void`	`consoleLog(BBjString msg!)` Logs the provided string to the browser's console for debugging purposes *regardless* of whether the EnableDebug option has been set. If you provide a simple string, like "`Got Here!`" then you'll see an entry in the console that looks like "`BBjCalendarWidget Debug: Got Here!`" Note: If you provide a static string with single quotes, then you can print out JavaScript objects if they're not enclosed in the single quotes. For example, calling the method with the string "`'Calendar View: ', window.calendar.view.type`" (note the single quotes) results in the following message being printed in the console: "`BBjCalendarWidget Debug: Calendar View: timeGridWeek`". In other words, if you supply single quotes then the entire parameter is applied to the `console.log()` JavaScript function without any modifications.
`static BBjVector`	`convertEntriesArrayToBBjVector(JsonArray entries!)` A utility method that converts a JSON array of calendar entries, such as what's received from the JavaScript code, into a BBjVector filled with CalendarEntry objects.
`static BBjVector`	`convertEntriesArrayToBBjVector(BBjString entries!)` A utility method that converts a stringified JSON array of calendar entries, such as what's received from the JavaScript code, into a BBjVector filled with `CalendarEntry` objects.
`static JsonArray`	`convertEntriesBBjVectorToJsonArray(BBjVector entries!)` A utility method that converts a BBjVector filled with `CalendarEntry` object to a JSON array of calendar entries.
`void`	`debugLog(BBjString msg!)` Logs a debug string to the browser's console for debugging purposes if the EnableDebug option has been set. This method is used internally by the BBjCalendarWidget and may also be used in your applications. To *always* log information to the console regardless of whether the EnableDebug option has been set, use the `consoleLog()` method instead. If you provide a simple string, like "`Got Here!`" then you'll see an entry in the console that looks like "`BBjCalendarWidget Debug: Got Here!`" Note: If you provide a static string with single quotes, then you can print out JavaScript objects if they're not enclosed in the single quotes. For example, calling the method with the string "`'Calendar View: ', window.calendar.view.type`" (note the single quotes) results in the following message being printed in the console: "`BBjCalendarWidget Debug: Calendar View: timeGridWeek`". In other words, if you supply single quotes then the entire parameter is applied to the `console.log()` JavaScript function without any modifications.
`Object`	`executeScript(BBjString script!)` Executes the provided JavaScript via the BBjJavaScriptExecutor class which results in a debounced execution, which is useful when you don't need the return value from the script and the script can be batched with other scripts. If you need the return value from the script, then you need to call the `executeScriptImmediately()` method instead. Note: The executor handles JSNI automatically so you don't have to check for BUI and adjust the window and document JavaScript objects. If the BBjHtmlView is not ready yet then the script will be queued. After the BBjHtmlView control is ready then the executor will execute it on the client.
`Object`	`executeScriptImmediately(BBjString script!)` Executes the provided JavaScript immediately via the BBjJavaScriptExecutor class without debouncing, which is necessary when you need the return value from the script. Note: The executor handles JSNI automatically so you don't have to check for BUI and adjust the window and document JavaScript objects. If the BBjHtmlView is not ready then this method will throw an error 500. Setting a callback for the `CalendarAPI.ON_CALENDAR_READY` will result in your application getting a `CalendarReadyEvent` event signaling that the calendar is ready for interaction.
`BBjColor`	`getBackColor()` Returns the background color of the calendar's containing window.
`static JsonArray`	`getBBjVectorAsJsonArray(BBjVector vector!)` A utility method that returns a JSON array version of the supplied BBjVector.
`int`	`getControlType()` Returns the unique control type for the `BBjCalendarWidget`, which is 65050.
`BBjString`	`getDate()` Returns the calendar's currently selected date.
`BBjString`	`getDateAsISOString()` Returns the calendar's currently selected date in ISO format.
`BBjNumber`	`getEnableDebug()` Returns whether the `BBjCalendarWidget` should run in debug mode (1) or not (0).
`BBjVector`	`getEntries()` Returns all of the calendar's entries as a BBjVector of `CalendarEntry` objects.
`JsonArray`	`getEntriesAsJsonArray()` Returns all of the calendar's entries as a JsonArray of JsonObject events.
`BBjVector`	`getEntriesWithTag(BBjString tag!)` Returns all of the calendar's entries as a BBjVector of `CalendarEntry` objects.
`BBjVector`	`getEntriesWithTags(BBjVector tags!)` Returns all of the calendar's entries as a BBjVector of `CalendarEntry` objects.
`BBjVector`	`getEntrySourceIds()` Returns a BBjVector filled with IDs for all the `CalendarEntrySource` objects that have previously been added to the calendar via the `addEntrySource()` method.
`BBjString`	`getEventDescription(BBjNumber eventNumber!)` A utility method that returns a descriptive string given an event number based on the `CalendarAPI.ON_CALENDAR_*` callback constants.
`BBjNumber`	`getHeight()` Returns the widget's height.
`BBjVector`	`getHiddenTags()` Returns a BBjVector filled with optional custom tags that were previously set with the setHiddenTags() method and determine which calendar entries should be hidden. When dealing with entry tags, there are three sets to be aware of: The `CalendarEntry` custom class offers setTags() methods that give you the opportunity to add custom tags to any entry. The `BBjCalendarWidget::setVisibleTags()` methods allow you to set which entries will be visible in the calendar, as any entries that share a tag with the visible tag set will be displayed normally. The `BBjCalendarWidget::setHiddenTags()` methods allow you to set which entries will be hidden in the calendar, as any entries that share a tag with the hidden tag set will be be hidden from view. Note: If the `BBjCalendarWidget`'s set of visible tags is empty then all calendar entries will be visible. If the `BBjCalendarWidget`'s set of hidden tags is empty then all calendar entries will be visible. Note: You will typically affect the calendar's entry visibility by calling either the setVisibleTags() or setHiddenTags() methods, but not both.
`BBjHtmlView`	`getHtmlView()` Returns the underlying BBjHtmlView control that contains the JavaScript FullCalendar.
`BBjImage`	`getImage()` Returns a BBjImage screenshot of the `BBjCalendarWidget`.
`BBjNumber`	`getIsReady()` Returns a BBjNumber acting as a boolean that indicates whether the widget is ready to be interacted with (1) or not (0).
`static BBjVector`	`getJsonArrayAsBBjVector(JsonArray array!)` A utility method that returns a BBjVector version of the supplied JSON array.
`static BBjString`	`getJsonObjectAsFormattedString(JsonObject json!)` A utility method that returns a formatted, or pretty-printed version of the supplied JSON object sorted alphabetically by key.
`BBjNumber`	`getLocalTimeZoneOffsetFromUtc()` Returns the difference between the client's local time and UTC in minutes. For example, if your time zone is UTC+10, then -600 will be returned because UTC is 600 minutes behind the local time zone. Another way to view it is that the return value is the number of minutes that should be added to the local time in order to find UTC. Note that daylight savings time prevents this value from being a constant.
`String`	`getName()` Returns the widget's name as previously-set via the `setName()` method.
`CalendarOptions`	`getOptions()` Returns the calendar's current options in an instance of the `CalendarOptions` class.
`JsonObject`	`getOptionsAsJsonObject()` Returns the calendar's options as a JsonObject.
`BBjString`	`getStyle(BBjString property!)` Returns the value of the specified CSS property.
`BBjVector`	`getStyles()` Returns the widget's name as previously-set via the `setName()` method.
`static BBjVector`	`getThemes()` Returns all of the calendar's available themes as an alphabetized list in a BBjVector filled with the theme names. After determining which themes are available, you can call the `setTheme()` method specifying any of the theme names in the return vector to change the calendar's theme. Note that the installed themes are located in the BBjCalendarWidget's `lib/bootstrap/themes/` directory. The installed themes are free Bootstrap themes from `https://bootswatch.com/`, although free Bootstrap themes are available from many other sites such as `https://startbootstrap.com/themes`. If you would like to add more themes, create a subdirectory under the calendar's themes directory and copy the `bootstrap.css` and `bootstrap.min.css` files in the newly-created subdirectory. The calendar will attempt to find and use the `bootstrap.min.css` first due to its reduced size.
`Object`	`getUserData()` Returns the custom object that was previously associated with the widget by calling the `setUserData()` method.
`BBjString`	`getUuid()` Returns a unique auto-generated ID for the calendar instance that may be used to distinguish between instances of the class.
`BBjString`	`getValidDateString(BBjString dateString!)` Returns a date string formatted as YYYY-MM-DD if the provided date string can be parsed into a valid date, or null() if the date string is invalid. Note: An ISO 8601 formatted date/time string (`YYYY-MM-DDTHH:mm:ss.sssZ`) is never ambiguous, but this method exists to attempt to parse an ambiguous date/time string into an ISO 8601 formatted date/time string. If the provided string is ambiguous, there are no guarantees that the method will be able to resolve the date/time string correctly. The success of this method depends on the format of the supplied date/time string and the client's browser. For example, a date of `"1-2-3"` is very ambiguous and while the method may be able to return a valid date string, it may not be the particular date that you had in mind. That's because there is no good way to know which number corresponds to the year, month, and day. However, a string like `"Jan 1, 2000"` is far less ambiguous and will likely be parsed correctly in to `"2000-01-01"`. Additionally, since the method uses JavaScript when parsing dates, the success is dependant on the browser's JavaScript implementation. For example, at the time of this writing, Chrome can parse ambiguous dates like `"May 2020"` and `"May 15"`. However, Firefox returns an "Invalid Date" for those values.
`BBjString`	`getValidDateTimeString(BBjString dateTimeString!)` Returns an ISO 8601 formatted date/time string if the provided date/time string can be parsed into a valid date, or null() if it can't be parsed. Note: An ISO 8601 formatted date/time string (`YYYY-MM-DDTHH:mm:ss.sssZ`) is never ambiguous, but this method exists to attempt to parse an ambiguous date/time string into an ISO 8601 formatted date/time string. If the provided string is ambiguous, there are no guarantees that the method will be able to resolve the date/time string correctly. The success of this method depends on the format of the supplied date/time string and the client's browser. For example, a date of `"1-2-3"` is very ambiguous and while the method may be able to return a valid date string, it may not be the particular date that you had in mind. That's because there is no good way to know which number corresponds to the year, month, and day. However, a string like `"Jan 1, 2000"` is far less ambiguous and will likely be parsed correctly in to `"2000-01-01"`. Additionally, since the method uses JavaScript when parsing dates, the success is dependant on the browser's JavaScript implementation. For example, at the time of this writing, Chrome can parse ambiguous dates like `"May 2020"` and `"May 15"`. However, Firefox returns an "Invalid Date" for those values.
`BBjString`	`getValidTimeString(BBjString timeString!)` Returns a time string formatted as HH:MM:SS using 24-hour format if the provided time string can be parsed into a valid time, or null() if the time string is invalid. Note: An ISO 8601 formatted date/time string (`YYYY-MM-DDTHH:mm:ss.sssZ`) is never ambiguous, but this method exists to attempt to parse an ambiguous date/time string into an ISO 8601 formatted date/time string. If the provided string is ambiguous, there are no guarantees that the method will be able to resolve the date/time string correctly. The success of this method depends on the format of the supplied date/time string and the client's browser. For example, a date of `"1-2-3"` is very ambiguous and while the method may be able to return a valid date string, it may not be the particular date that you had in mind. That's because there is no good way to know which number corresponds to the year, month, and day. However, a string like `"Jan 1, 2000"` is far less ambiguous and will likely be parsed correctly in to `"2000-01-01"`. Additionally, since the method uses JavaScript when parsing dates, the success is dependant on the browser's JavaScript implementation. For example, at the time of this writing, Chrome can parse ambiguous dates like `"May 2020"` and `"May 15"`. However, Firefox returns an "Invalid Date" for those values.
`BBjString`	`getViewType()` Returns the calendar's view type which will be one of the following constants: `CalendarAPI.CALENDAR_VIEW_DAY_GRID_WEEK()`. `CalendarAPI.CALENDAR_VIEW_DAY_GRID_MONTH()`. `CalendarAPI.CALENDAR_VIEW_TIME_GRID_DAY()`. `CalendarAPI.CALENDAR_VIEW_TIME_GRID_WEEK()`. `CalendarAPI.CALENDAR_VIEW_LIST_DAY()`. `CalendarAPI.CALENDAR_VIEW_LIST_WEEK()`. `CalendarAPI.CALENDAR_VIEW_LIST_MONTH()`. `CalendarAPI.CALENDAR_VIEW_LIST_YEAR()`.
`BBjVector`	`getVisibleTags()` Returns a BBjVector filled with optional custom tags that were previously set with the setVisibleTags() method and determine which calendar entries should be displayed. When dealing with entry tags, there are three sets to be aware of: The `CalendarEntry` custom class offers setTags() methods that give you the opportunity to add custom tags to any entry. The `BBjCalendarWidget::setVisibleTags()` methods allow you to set which entries will be visible in the calendar, as any entries that share a tag with the visible tag set will be displayed normally. The `BBjCalendarWidget::setHiddenTags()` methods allow you to set which entries will be hidden in the calendar, as any entries that share a tag with the hidden tag set will be be hidden from view. Note: If the `BBjCalendarWidget`'s set of visible tags is empty then all calendar entries will be visible. If the `BBjCalendarWidget`'s set of hidden tags is empty then all calendar entries will be visible. Note: You will typically affect the calendar's entry visibility by calling either the setVisibleTags() or setHiddenTags() methods, but not both.
`BBjNumber`	`getWidth()` Returns the widget's width.
`BBjNumber`	`getX()` Returns the widget's X coordinate, or horizontal position.
`BBjNumber`	`getY()` Returns the widget's Y coordinate, or vertical position.
`void`	`injectCss(BBjString css!)` Injects the provided CSS string into the `<head>` element of the HTML document in the BBjHtmlView that contains the calendar. This method provides a simple way to add custom CSS that affects the calendar. For more advanced use cases, see the `injectCss()` method that takes several parameters to provide greater control over the injection.
`void`	`injectCss(BBjString css!, BBjString location!, BBjString description!, BBjNumber removePrevious!)` Injects the provided CSS string into the `head` or `body` of the HTML DOM (as specified by the location! parameter) in the BBjHtmlView that contains the calendar, as well as providing the ability to tag the CSS and replace it in subsequent calls.
`void`	`injectCssFile(BBjString cssPath!)` Injects the CSS contained in the specified file into the `<head>` element of the HTML document in the BBjHtmlView that contains the calendar. This is a convenience method that reads in the contents of the provided CSS file and injects it into the HtmlView control that contains the calendar.
`void`	`injectScript(BBjString script!)` Injects the provided JavaScript string at the top-level window.
`void`	`injectScriptFile(BBjString scriptPath!)` Injects the JavaScript contained in the specified script file into the top-level window. This is a convenience method that reads in the contents of the provided JavaScript file and injects it into the HtmlView control that contains the calendar.
`void`	`injectUrl(BBjString url!)` Injects the specified JavaScript URL into the HTML DOM, making it available for subsequent use by client-side JavaScript.
`boolean`	`isEnabled()` Returns whether the widget is enabled or disabled.
`boolean`	`isVisible()` Returns whether the widget is visible or hidden.
`void`	`navigateDate(BBjString date!)` Navigates the calendar programmatically to the specified date. To ensure the calendar navigates to the correct date, the provided date should be in the ISO 8601 format. However, this method attempts to parse ambiguous dates and is often able to construct a date in the format `"YYYY-MM-DD"` given a date string in another format. If the provided string is ambiguous, there are no guarantees that the method will be able to resolve the date/time string correctly. The success of this method depends on the format of the supplied date/time string and the client's browser. For example, a date of `"1-2-3"` is very ambiguous and while the method may be able to return a valid date string, it may not be the particular date that you had in mind. That's because there is no good way to know which number corresponds to the year, month, and day. However, a string like `"Jan 1, 2000"` is far less ambiguous and will likely be parsed correctly in to `"2000-01-01"`. Additionally, since the method uses JavaScript when parsing dates and time, the success is dependant on the browser's JavaScript implementation. For example, at the time of this writing, Chrome can parse ambiguous dates like `"May 2020"` and `"May 15"`. However, Firefox returns an "Invalid Date" for those values. The date string should ideally be in the `"YYYY-MM-DD"` format at a minimum, but the parser should be able to interpret various formats.
`void`	`navigateNext()` Navigates the calendar programmatically one step forward (by a month or week for example), and is the same as the user clicking on the 'next' toolbar button. The amount of time moved depends on the current view type.
`void`	`navigateNextYear()` Navigates the calendar programmatically forward one year, and is the same as the user clicking on the 'nextYear' toolbar button.
`void`	`navigatePrev()` Navigates the calendar programmatically one step back (by a month or week for example), and is the same as the user clicking on the 'prev' toolbar button. The amount of time moved depends on the current view type.
`void`	`navigatePrevYear()` Navigates the calendar programmatically back one year, and is the same as the user clicking on the 'prevYear' toolbar button.
`void`	`navigateTime(BBjString time!)` Navigates the calendar programmatically to the specified time. To ensure the calendar navigates to the correct time, the provided time should be in the ISO 8601 format or `"hh:mm"` format at a minimum.. However, this method attempts to parse ambiguous times and is often able to construct a time in the format `"hh:mm:ss"` given a time string in another format. If the provided string is ambiguous, there are no guarantees that the method will be able to resolve the date/time string correctly. The success of this method depends on the format of the supplied date/time string and the client's browser. For example, a date of `"1-2-3"` is very ambiguous and while the method may be able to return a valid date string, it may not be the particular date that you had in mind. That's because there is no good way to know which number corresponds to the year, month, and day. However, a string like `"Jan 1, 2000"` is far less ambiguous and will likely be parsed correctly in to `"2000-01-01"`. Additionally, since the method uses JavaScript when parsing dates and time, the success is dependant on the browser's JavaScript implementation. For example, at the time of this writing, Chrome can parse ambiguous dates like `"May 2020"` and `"May 15"`. However, Firefox returns an "Invalid Date" for those values. The time string should ideally be in one of the following formats. "hh:mm:ss.sss" "hh:mm:ss" "hh:mm" but the parser should be able to interpret various formats.
`void`	`navigateToday()` Navigates the calendar programmatically to the current date, and is the same as the user clicking on the 'today' toolbar button.
`static BBjNumber`	`ON_CALENDAR_DATE_CLICK()` A constant value that's used with the `BBjCalendarWidget::setCallback()` method that signals that the user has clicked on a date or time. Note that `ON_CALENDAR_DATE_CLICK` event is not fired when the user clicks a day heading in a list view. Setting a callback for this event type will result in your application getting a `CalendarDateClickEvent` object.
`static BBjNumber`	`ON_CALENDAR_DATES_SET()` A constant value that's used with the `BBjCalendarWidget::setCallback()` method that signals that the calendar's date range has changed in any way. Setting a callback for this event type will result in your application getting a `CalendarDatesSetEvent` object.
`static BBjNumber`	`ON_CALENDAR_DROP()` A constant value that's used with the `BBjCalendarWidget::setCallback()` method that signals that the user dropped an external draggable element or an event from another calendar onto this calendar.
`static BBjNumber`	`ON_CALENDAR_ENTRIES_SET()` A constant value that's used with the `BBjCalendarWidget::setCallback()` method that signals that the calendar's entry data has changed in any way. If you set a callback for this event, then add several entries to the calendar, your callback routine may be flooded because the event will fire for every entry that you add. When responding to this event, the `BBjSysGui::getLastEvent()` call will return a `CalendarEntriesSetEvent` object. You can call the `CalendarEntriesSetEvent::getEntries()` method to return a BBjVector of `CalendarEntry` objects that corresponds to all the known entries in the calendar at that instant in time. Setting a callback for this event type will result in your application getting a `CalendarEntriesSetEvent` object.
`static BBjNumber`	`ON_CALENDAR_ENTRY_ADD()` A constant value that's used with the `BBjCalendarWidget::setCallback()` method that signals that an event has been added to the calendar. Note: If you set a callback for this event, then add several events to the calendar, your callback routine may be flooded. Setting a callback for this event type will result in your application getting a `CalendarEntryAddEvent` object.
`static BBjNumber`	`ON_CALENDAR_ENTRY_CHANGE()` A constant value that's used with the `BBjCalendarWidget::setCallback()` method that signals that the calendar's event data has changed in any way. Setting a callback for this event type will result in your application getting a `CalendarEntryChangeEvent` object.
`static BBjNumber`	`ON_CALENDAR_ENTRY_CLICK()` A constant value that's used with the `BBjCalendarWidget::setCallback()` method that signals that the user has clicked on a calendar's event. Setting a callback for this event type will result in your application getting a `CalendarEntryClickEvent` object.
`static BBjNumber`	`ON_CALENDAR_ENTRY_DRAG_START()` A constant value that's used with the `BBjCalendarWidget::setCallback()` method that signals that the user has started dragging an event.
`static BBjNumber`	`ON_CALENDAR_ENTRY_DRAG_STOP()` A constant value that's used with the `BBjCalendarWidget::setCallback()` method that signals that the user has stopped dragging an event.
`static BBjNumber`	`ON_CALENDAR_ENTRY_DROP()` A constant value that's used with the `BBjCalendarWidget::setCallback()` method that signals that the user has dropped the event to a different day/time.
`static BBjNumber`	`ON_CALENDAR_ENTRY_LEAVE()` A constant value that's used with the `BBjCalendarWidget::setCallback()` method that signals that the user is about to drop one of the calendar events on to another calendar.
`static BBjNumber`	`ON_CALENDAR_ENTRY_MOUSE_ENTER()` A constant value that's used with the `BBjCalendarWidget::setCallback()` method that signals that the user moved the mouse into the bounds of a calendar event. Setting a callback for this event type will result in your application getting a `CalendarEntryMouseEnterEvent` object.
`static BBjNumber`	`ON_CALENDAR_ENTRY_MOUSE_LEAVE()` A constant value that's used with the `BBjCalendarWidget::setCallback()` method that signals that the user moved the mouse out of the bounds of a calendar event. Setting a callback for this event type will result in your application getting a `CalendarEntryMouseLeaveEvent` object.
`static BBjNumber`	`ON_CALENDAR_ENTRY_RECEIVE()` A constant value that's used with the `BBjCalendarWidget::setCallback()` method that signals that the calendar has received an external draggable element with event data from another source or another calendar.
`static BBjNumber`	`ON_CALENDAR_ENTRY_REMOVE()` A constant value that's used with the `BBjCalendarWidget::setCallback()` method that signals that an entry has been removed from the calendar. If you set a callback for this event, then remove several entries from the calendar, your callback routine may be flooded because the event will fire for every entry that was removed. Setting a callback for this event type will result in your application getting a `CalendarEntryRemoveEvent` object.
`static BBjNumber`	`ON_CALENDAR_ENTRY_RESIZE()` A constant value that's used with the `BBjCalendarWidget::setCallback()` method that signals that the user has stopped resizing an event and the event has a different duration.
`static BBjNumber`	`ON_CALENDAR_ENTRY_RESIZE_START()` A constant value that's used with the `BBjCalendarWidget::setCallback()` method that signals that the user has started resizing an event.
`static BBjNumber`	`ON_CALENDAR_ENTRY_RESIZE_STOP()` A constant value that's used with the `BBjCalendarWidget::setCallback()` method that signals that the user has stopped resizing an event.
`static BBjNumber`	`ON_CALENDAR_ENTRY_SOURCE_FAILURE()` A constant value that's used with the `BBjCalendarWidget::setCallback()` method that signals that fetching a `CalendarEntrySource` failed.
`static BBjNumber`	`ON_CALENDAR_ENTRY_SOURCE_SUCCESS()` A constant value that's used with the `BBjCalendarWidget::setCallback()` method that signals that fetching a `CalendarEntrySource` succeeded.
`static BBjNumber`	`ON_CALENDAR_READY()` A constant value that's used with the `BBjCalendarWidget::setCallback()` method that signals that the `BBjCalendarWidget` is ready. Setting a callback for this event type will result in your application getting a `CalendarReadyEvent` object.
`static BBjNumber`	`ON_CALENDAR_SELECT()` A constant value that's used with the `BBjCalendarWidget::setCallback()` method that signals that the user selected a date or time. Note: You must configure the calendar to enable user selections via the `CalendarOptions:setEnableSelectable()` method if you intend to set a callback for the `BBjCalendarWidget:ON_CALENDAR_SELECT` or `BBjCalendarWidget:ON_CALENDAR_UNSELECT` events. Setting a callback for this event type will result in your application getting a `CalendarSelectEvent` object.
`static BBjNumber`	`ON_CALENDAR_UNSELECT()` A constant value that's used with the `BBjCalendarWidget::setCallback()` method that signals that the user unselected a date or time. Note: You must configure the calendar to enable user selections via the `CalendarOptions:setEnableSelectable()` method if you intend to set a callback for the `BBjCalendarWidget:ON_CALENDAR_SELECT` or `BBjCalendarWidget:ON_CALENDAR_UNSELECT` events. A selection might be cleared for a number of reasons: The user clicks away from the current selection (doesn't happen when EnableUnselectAuto is false). The user makes a new selection. The unselect callback will be fired before the new selection occurs. The user moves forward or backward in the current view, or switches to a new view. The unselect method is called through the API. The `CalendarOptions::setEnableUnselectAuto()` impacts what causes the `BBjCalendarWidget.ON_CALENDAR_UNSELECT` event to be fired. If automatic unselection is enabled, then the unselection event will typically be fired after the user releases their selection mouse button. Setting a callback for this event type will result in your application getting a `CalendarUnselectEvent`.
`static BBjNumber`	`ON_CALENDAR_VIEW_CHANGE()` A constant value that's used with the `BBjCalendarWidget::setCallback()` method that signals that the user has changed the view type of the `BBjCalendarWidget`. Note: This only fires when the type of view changes, not when the user changes the view from one subtype to another. For example, the event will be triggered when the user switches from the `CalendarAPI.CALENDAR_VIEW_DAY_GRID_MONTH()` to the `CalendarAPI.CALENDAR_VIEW_LIST_MONTH()` view. But it won't be triggerd when the user changes from `CalendarAPI.CALENDAR_VIEW_DAY_GRID_MONTH()` to `CalendarAPI.CALENDAR_VIEW_DAY_GRID_WEEK()` since both views are the same type (dayGrid) and just the subtype (week vs. month) changes.
`void`	`onNativeEvent(BBjNativeJavaScriptEvent ev!)` An internal event handler for native JavaScript events from the BBjHtmlView control that converts a JavaScript calendar event to a BBj callback event.
`void`	`redraw(BBjNumber shouldCreate!)` Initially draws or redraws the widget whenever it needs to be rendered. Your application code won't ever have to call this method under normal conditions. It's typically only used internally to redraw the calendar after the the `setSize()` method has been called. However, if you may want to call the `render()` method if you modified the calendar's options inline (as opposed to using the `setOptions()` method.
`void`	`refetchAllEntries()` Causes the calendar to refetch entries from all sources and rerender. If you've previously added events to the calendar from a remote source, such as a web service or Google Calendar, then the calendar will requery those sources for an updated entry set. If the entries on the backend have changed, such as some entries have been added and others deleted, then those changes will be reflected on the calendar after calling this method.
`void`	`refetchAllEntrySources()` Refetches all `CalendarEntrySource objects in the calendar, causing them to retrieve their entries again.`
`void`	`refetchEntrySource(BBjString id!)` Refetches the `CalendarEntrySource object in the calendar given its unique ID, causing it to retrieve its entries again.`
`BBjNumber`	`removeAllEntries()` Removes all the entries in the calendar. Note: Removing entries from the calendar via this method will trigger the `CalendarAPI.ON_CALENDAR_ENTRY_REMOVE()` event for each entry that was removed.
`BBjNumber`	`removeAllEntrySources()` Removes all `CalendarEntrySource objects from the calendar.`
`BBjNumber`	`removeEntries(BBjVector entries!)` Removes all the entries contained in the BBjVector from the calendar. Note: Removing entries from the calendar via this method will trigger the `CalendarAPI.ON_CALENDAR_ENTRY_REMOVE()` event for each entry that was removed.
`BBjNumber`	`removeEntry(CalendarEntry entry!)` Removes an entry from the calendar.
`BBjNumber`	`removeEntryById(BBjString id!)` Removes an entry from the calendar given its optional unique ID which must have previously been set.
`void`	`removeEntrySource(BBjString id!)` Removes a `CalendarEntrySource and its entries from the calendar given its unique ID.`
`boolean`	`removeStyle(BBjString style!)` Removes the provided CSS style name from the widget.
`void`	`render()` Renders the calendar inside the HtmlView and applies the current calendar options. This composes the calendar configuration and sends it to the client for a full rerendering. This is the difference between the `render()` and the `redraw()` method - the `redraw()` method only instructs the calendar to repaint itself; it doesn't change or apply any configuration options. You can call this method to force the calendar to be updated after you modify its setup configuration, as in: `rem Get and then set the desired options inline dynamically, calling the render() method afterwards to force the calendar to update with the new configuration: myCal!.getOptions().setEnableEntryDurationEditable(1) myCal!.getOptions().setEnableEntryResizableFromStart(1) myCal!.getOptions().setEnableEntryStartEditable(1) myCal!.getOptions().setEnableSlotEntryOverlap(0) myCal!.render()` Note: You don't have to call the `render()` method if you update the calendar's configuration via the `setOptions()` method.
`void`	`saveAsPngImage(BBjString path!)` Saves a BBjImage screenshot of the `BBjCalendarWidget` to the specified file path.
`void`	`setBackColor(BBjColor backColor!)` Sets the background color of the calendar's containing window.
`void`	`setCallback(BBjNumber event!, BBjString callback!)` Registers a callback in a procedural program for the provided event type. These are the valid callback event type options: `CalendarAPI.ON_CALENDAR_READY` - the calendar is ready for interaction `CalendarAPI.ON_CALENDAR_VIEW_CHANGE` - the calendar's view has changed `CalendarAPI.ON_CALENDAR_ENTRIES_SET` - entries have been changed or initialized in any way `CalendarAPI.ON_CALENDAR_ENTRY_CLICK` - the user clicked on an entry `CalendarAPI.ON_CALENDAR_ENTRY_ADD` - an entry was added to the calendar `CalendarAPI.ON_CALENDAR_ENTRY_CHANGE` - the entry has been modified `CalendarAPI.ON_CALENDAR_ENTRY_REMOVE` - the entry has been removed from the calendar `CalendarAPI.ON_CALENDAR_ENTRY_MOUSE_ENTER` - the user moved the mouse on an entry `CalendarAPI.ON_CALENDAR_ENTRY_MOUSE_LEAVE` - the user moved the mouse off an entry `CalendarAPI.ON_CALENDAR_ENTRY_DRAG_START` - the user began dragging an entire entry `CalendarAPI.ON_CALENDAR_ENTRY_DRAG_STOP` - the user stopped dragging the entry `CalendarAPI.ON_CALENDAR_ENTRY_DROP` - the user has completed dragging and dropping the entire entry `CalendarAPI.ON_CALENDAR_ENTRY_RESIZE_START` - the user began to resize the entry to change its duration `CalendarAPI.ON_CALENDAR_ENTRY_RESIZE_STOP` - the user stopped resizing the entry `CalendarAPI.ON_CALENDAR_ENTRY_RESIZE` - the user completed resizing the entry resulting in a changed duration `CalendarAPI.ON_CALENDAR_ENTRY_RECEIVE` - Not Yet Implemented, deals with dragging and dropping entries from an external source `CalendarAPI.ON_CALENDAR_ENTRY_LEAVE` - Not Yet Implemented, deals with dragging and dropping entries from an external source `CalendarAPI.ON_CALENDAR_DROP` - Not Yet Implemented, deals with dragging and dropping entries from an external source `CalendarAPI.ON_CALENDAR_DATES_SET` - the calendar's range has been initially set or changed in some way `CalendarAPI.ON_CALENDAR_DATE_CLICK` - the user clicked on a date or time in the calendar `CalendarAPI.ON_CALENDAR_SELECT` - the user selected a date or time in the calendar (not an entry) `CalendarAPI.ON_CALENDAR_UNSELECT` - the date/time selection has been cleared `CalendarAPI.ON_CALENDAR_ENTRY_SOURCE_SUCCESS` - fetching a CalendarEntrySource has succeded `CalendarAPI.ON_CALENDAR_ENTRY_SOURCE_FAILURE` - fetching a CalendarEntrySource has failed Note: Callbacks associated with dragging/dropping calendar entries between two different calendars has not yet been implemented.
`void`	`setCallback(BBjNumber event!, CustomObject instance!, BBjString method!)` Registers a callback in an object-oriented program for the provided event type. These are the valid callback event type options: `CalendarAPI.ON_CALENDAR_READY` - the calendar is ready for interaction `CalendarAPI.ON_CALENDAR_VIEW_CHANGE` - the calendar's view has changed `CalendarAPI.ON_CALENDAR_ENTRIES_SET` - entries have been changed or initialized in any way `CalendarAPI.ON_CALENDAR_ENTRY_CLICK` - the user clicked on an entry `CalendarAPI.ON_CALENDAR_ENTRY_ADD` - an entry was added to the calendar `CalendarAPI.ON_CALENDAR_ENTRY_CHANGE` - the entry has been modified `CalendarAPI.ON_CALENDAR_ENTRY_REMOVE` - the entry has been removed from the calendar `CalendarAPI.ON_CALENDAR_ENTRY_MOUSE_ENTER` - the user moved the mouse on an entry `CalendarAPI.ON_CALENDAR_ENTRY_MOUSE_LEAVE` - the user moved the mouse off an entry `CalendarAPI.ON_CALENDAR_ENTRY_DRAG_START` - the user began dragging an entire entry `CalendarAPI.ON_CALENDAR_ENTRY_DRAG_STOP` - the user stopped dragging the entry `CalendarAPI.ON_CALENDAR_ENTRY_DROP` - the user has completed dragging and dropping the entire entry `CalendarAPI.ON_CALENDAR_ENTRY_RESIZE_START` - the user began to resize the entry to change its duration `CalendarAPI.ON_CALENDAR_ENTRY_RESIZE_STOP` - the user stopped resizing the entry `CalendarAPI.ON_CALENDAR_ENTRY_RESIZE` - the user completed resizing the entry resulting in a changed duration `CalendarAPI.ON_CALENDAR_ENTRY_RECEIVE` - Not Yet Implemented, deals with dragging and dropping entries from an external source `CalendarAPI.ON_CALENDAR_ENTRY_LEAVE` - Not Yet Implemented, deals with dragging and dropping entries from an external source `CalendarAPI.ON_CALENDAR_DROP` - Not Yet Implemented, deals with dragging and dropping entries from an external source `CalendarAPI.ON_CALENDAR_DATES_SET` - the calendar's range has been initially set or changed in some way `CalendarAPI.ON_CALENDAR_DATE_CLICK` - the user clicked on a date or time in the calendar `CalendarAPI.ON_CALENDAR_SELECT` - the user selected a date or time in the calendar (not an entry) `CalendarAPI.ON_CALENDAR_UNSELECT` - the date/time selection has been cleared `CalendarAPI.ON_CALENDAR_ENTRY_SOURCE_SUCCESS` - fetching a CalendarEntrySource has succeded `CalendarAPI.ON_CALENDAR_ENTRY_SOURCE_FAILURE` - fetching a CalendarEntrySource has failed Note: Callbacks associated with dragging/dropping calendar entries between two different calendars has not yet been implemented.
`void`	`setEnabled(boolean enabled!)` Sets whether the widget should be enabled.
`void`	`setEnableDebug(BBjNumber enableDebug)` Sets whether the `BBjCalendarWidget` should run in debug mode (1) or not (0), where the default is 0. When this is set to true (1), the `BBjCalendarWidget` will: use unminified JavaScript and CSS when possible display the debugger console in a browser when run in GUI if your `!CHROMIUM_SWITCHES` global string entry is properly set before instantiating the `BBjCalendarWidget`, as in: `chromium_switches$ = stbl("!CHROMIUM_SWITCHES", "--remote-debugging-port=9223")` log messages to the console from both the BBj programs and the JavaScript code
`void`	`setHiddenTags(BBjString tags!)` Sets one or more optional, custom tags that determine which calendar entries should be hidden. The `CalendarEntry` custom class offers setTags() methods that give you the opportunity to add custom tags to any entry. After adding tags to one or more entries, you can call methods on the calendar to show or hide entries based on their tags by calling the `BBjCalendarWidget::setVisibleTags()` and `BBjCalendarWidget::setHiddenTags()` methods. This is similar to the `setHiddenTags()` method that takes a BBjVector except that it takes a comma-delimted string of tags for succinctness.
`void`	`setHiddenTags(BBjVector tags!)` Sets one or more optional, custom tags that determine which calendar entries should be hidden. The `CalendarEntry` custom class offers setTags() methods that give you the opportunity to add custom tags to any entry. After adding tags to one or more entries, you can call methods on the calendar to show or hide entries based on their tags by calling the `BBjCalendarWidget::setVisibleTags()` and `BBjCalendarWidget::setHiddenTags()` methods.
`void`	`setLocation(BBjNumber x!, BBjNumber y!)` Sets the location of the calendar widget given the provided X and Y coordinates.
`void`	`setName(BBjString name!)` Sets the widget's name, which can later be retrieved via the `getName()` method. This value is propagated to the CSS class attribute of the HTML element representing the control in BUI.
`void`	`setOptions(CalendarOptions options!)` Sets the calendar's options given an instance of the `CalendarOptions` class. Note: After setting the calendar's options inline (see example #1 below), you will need to call the calendar's `render()` method to apply the changes to the calendar in order for them to take effect. There are a couple of ways to set options for the calendar: Get and then set the desired options inline dynamically, calling the render() method afterwards to force the calendar to update with the new configuration: `rem Get and then set the desired options inline dynamically, calling the render() method afterwards to force the calendar to update with the new configuration: myCal!.getOptions().setEnableEntryDurationEditable(1) myCal!.getOptions().setEnableEntryResizableFromStart(1) myCal!.getOptions().setEnableEntryStartEditable(1) myCal!.getOptions().setEnableSlotEntryOverlap(0) myCal!.render()` Get the options instance, call setter methods on it, then use it to set the calendar's options: `rem Get the calendar's options object, then call the desired set methods, then apply the updated options to the calendar: opts! = myCal!.getOptions() opts!.setEnableEntryDurationEditable(1) opts!.setEnableEntryResizableFromStart(1) opts!.setEnableEntryStartEditable(1) opts!.setEnableSlotEntryOverlap(0) myCal!.setOptions(opts!)`
`void`	`setPadding(BBjNumber padding!)` Sets the padding, or spacing around the calendar control, to the same number of pixels for all four sides. Using the default index.html template, the calendar is contained within the DIV that has the class 'BBjCalendarWidgetContainer'. This method modifies the CSS for the container DIV by setting its padding to the provided padding size in pixels.
`void`	`setPadding(BBjNumber paddingTop!, BBjNumber paddingRight!, BBjNumber paddingBottom!, BBjNumber paddingLeft!)` Sets the padding, or spacing around the calendar control, to the specified number of pixels for the top, right, bottom, and left sides. Using the default index.html template, the calendar is contained within the DIV that has the class 'BBjCalendarWidgetContainer'. This method modifies the CSS for the container DIV by setting its padding to the provided padding size in pixels.
`void`	`setSize(BBjNumber width!, BBjNumber height!)` Sets the size of the calendar widget given the provided width and height.
`void`	`setStyle(BBjString property!, BBjString style!)` Sets a CSS property on the widget.
`void`	`setTheme(BBjString theme!)` Sets the calendar's theme to one of the installed Boostrap themes, which modifies the calendar's fonts and color scheme. To determine which themes are available, you can call the `getThemes()` method which returns a BBjVector filled with the installed theme names. Note that the installed themes are located in the BBjCalendarWidget's `lib/bootstrap/themes/` directory. The installed themes are free Bootstrap themes from `https://bootswatch.com/`, although free Bootstrap themes are available from many other sites such as `https://startbootstrap.com/themes`. If you would like to add more themes, create a subdirectory under the calendar's themes directory and copy the `bootstrap.css` and `bootstrap.min.css` files in the newly-created subdirectory. The calendar will attempt to find and use the `bootstrap.min.css` first due to its reduced size.
`void`	`setUserData(Object userData!)` Sets a custom, arbitrary object to be associated with the widget which can be retrieved later via the `getUserData()` method.
`void`	`setViewType(BBjString viewType!)` Sets the calendar's view type. Note: Calling this method causes the calendar to change its view, which then results in a `CalendarAPI.ON_CALENDAR_VIEW_CHANGE` event. The provided view type should be one of the following constants: `CalendarAPI.CALENDAR_VIEW_DAY_GRID_WEEK()`. `CalendarAPI.CALENDAR_VIEW_DAY_GRID_MONTH()`. `CalendarAPI.CALENDAR_VIEW_TIME_GRID_DAY()`. `CalendarAPI.CALENDAR_VIEW_TIME_GRID_WEEK()`. `CalendarAPI.CALENDAR_VIEW_LIST_DAY()`. `CalendarAPI.CALENDAR_VIEW_LIST_WEEK()`. `CalendarAPI.CALENDAR_VIEW_LIST_MONTH()`. `CalendarAPI.CALENDAR_VIEW_LIST_YEAR()`.
`void`	`setVisible(boolean visible!)` Sets whether the widget should be visible or hidden.
`void`	`setVisibleTags(BBjString tags!)` Sets one or more optional, custom tags that determine which calendar entries should be displayed. The `CalendarEntry` custom class offers setTags() methods that give you the opportunity to add custom tags to any entry. After adding tags to one or more entries, you can call methods on the calendar to show or hide entries based on their tags by calling the `BBjCalendarWidget::setVisibleTags()` and `BBjCalendarWidget::setHiddenTags()` methods. This is similar to the `setVisibleTags()` method that takes a BBjVector except that it takes a comma-delimted string of tags for succinctness.
`void`	`setVisibleTags(BBjVector tags!)` Sets one or more optional, custom tags that determine which calendar entries should be displayed. The `CalendarEntry` custom class offers setTags() methods that give you the opportunity to add custom tags to any entry. After adding tags to one or more entries, you can call methods on the calendar to show or hide entries based on their tags by calling the `BBjCalendarWidget::setVisibleTags()` and `BBjCalendarWidget::setHiddenTags()` methods.
`void`	`suppressBuiDebouncing(BBjNumber suppress!)` Supresses JavaScript debouncing for BUI. Setting this to "0" may help to improve the communication performance between BBj and the calendar in the BBjHtmlViewControl when running in BUI.
`void`	`suppressDebouncing(BBjNumber suppress!)` Supressesss JavaScript debouncing for both GUI and BUI.
`void`	`suppressGuiDebouncing(BBjNumber suppress!)` Supresses JavaScript debouncing when running in GUI. Setting this to "0" may help to improve the communication performance between BBj and the calendar in the BBjHtmlViewControl when running in GUI.
`void`	`updateEntries(JsonArray entries!)` Updates several JsonObject entries in a JsonArray to the calendar at once for improved performance. This method iterates through the `CalendarEntry` objects and calls the same code as the `updateEntry()` method does. Therefore, it uses the `CalendarEntry`'s ID (if set) or UUID (if the ID isn't set) to find the entry in the calendar. If found, it removes the old version of the entry from the calendar, then adds the new version of the entry to the calendar. Because of that, if you've registered for the `CalendarAPI.ON_CALENDAR_ENTRY_ADD` or `CalendarAPI.ON_CALENDAR_ENTRY_REMOVE` events then your callback code will executed once for each entry in the array as a result of calling this method.
`void`	`updateEntries(BBjVector entries!)` Updates several entries of type `CalendarEntry` to the calendar at once for improved performance. This method iterates through the `CalendarEntry` objects and calls the same code as the `updateEntry()` method does. Therefore, it uses the `CalendarEntry`'s ID (if set) or UUID (if the ID isn't set) to find the entry in the calendar. If found, it removes the old version of the entry from the calendar, then adds the new version of the entry to the calendar. Because of that, if you've registered for the `CalendarAPI.ON_CALENDAR_ENTRY_ADD` or `CalendarAPI.ON_CALENDAR_ENTRY_REMOVE` events then your callback code will executed once for each `CalendarEntry` in the BBjVector as a result of calling this method.
`void`	`updateEntry(CalendarEntry entry!)` Updates an entry in the calendar. This method uses the `CalendarEntry`'s ID (if set) or UUID (if the ID isn't set) to find the entry in the calendar. If found, it removes the old version of the entry from the calendar, then adds the new version of the entry to the calendar. Because of that, if you've registered for the `CalendarAPI.ON_CALENDAR_ENTRY_ADD` or `CalendarAPI.ON_CALENDAR_ENTRY_REMOVE` events then your callback code will executed as a result of calling this method.
`void`	`updateSize()` Forces the calendar to resize itself based on the available space in the container DIV. Using the default index.html template, the calendar is contained within the DIV that has the class 'BBjCalendarWidgetContainer'. Whenever you modify the container DIV in such a way that it affects the calendar's size, such as dynamically changing its margin CSS, you may want to call this method afterwards to cause the calendar to adjust to the new container size. Note: If you call one of the setPadding() methods then this will be executed automatically after the padding has been added to the container DIV, so this method isn't likely to be needed very often.

- Method Detail
  - addEntries
```
public void addEntries(JsonArray entries!)
```
    Adds several JsonObject entries in a JsonArray to the calendar at once for improved performance.
    
    Note: Adding multiple entries to the calendar via this method will not trigger the CalendarAPI.ON_CALENDAR_ENTRY_ADD() event.
    Parameters:
    JsonArray entries! A JsonArray filled with JSON objects to be added to the calendar.
  - addEntries
```
public void addEntries(BBjVector entries!)
```
    Adds several entries of type CalendarEntry to the calendar at once for improved performance.
    
    Note: Adding multiple entries to the calendar via this method will not trigger the CalendarAPI.ON_CALENDAR_ENTRY_ADD() event.
    Parameters:
    BBjVector entries! A BBjVector filled with CalendarEntry objects to be added to the calendar.
  - addEntry
```
public void addEntry(JsonObject entry!)
```
    Adds an entry to the calendar given a JsonObject representation of the calendar entry.
    
    Note: Adding entries to the calendar via this method will trigger the CalendarAPI.ON_CALENDAR_ENTRY_ADD() event.
    Parameters:
    JsonObject entry! The entry to be added to the calendar.
  - addEntry
```
public void addEntry(CalendarEntry entry!)
```
    Adds an entry to the calendar given a CalendarEntry object.
    
    Note: Adding entries to the calendar via this method will trigger the CalendarAPI.ON_CALENDAR_ENTRY_ADD() event.
    Parameters:
    CalendarEntry entry! The CalendarEntry to be added to the calendar.
  - addEntrySource
```
public void addEntrySource(CalendarEntrySource entrySource!)
```
    Adds entries to the calendar from a CalendarEntrySource.
    
    Parameters:
    CalendarEntrySource entrySource! A previously-defined CalendarEntrySource.
  - addStyle
```
public boolean addStyle(BBjString style!)
```
    Adds the provided CSS style name to the widget.
    
    Parameters:
    BBjString style! The CSS style name to add to the widget.
    Returns:
    boolean A boolean that indicates whether the style name was added to the widget (1) or not (0).
  - clearCallback
```
public void clearCallback(BBjNumber event!)
```
    Removes the callback given the callback number.
    
    Parameters:
    BBjNumber event! The event number which is one of the CalendarAPI.ON_CALENDAR_* constants.
  - clearStyles
```
public void clearStyles()
```
    Clears all the CSS styles from the widget.
  - consoleLog
```
public void consoleLog(BBjString msg!)
```
    Logs the provided string to the browser's console for debugging purposes regardless of whether the EnableDebug option has been set.
    
    If you provide a simple string, like
    "Got Here!"
    then you'll see an entry in the console that looks like
    "BBjCalendarWidget Debug: Got Here!"
    Note: If you provide a static string with single quotes, then you can print out JavaScript objects if they're not enclosed in the single quotes. For example, calling the method with the string
    "'Calendar View: ', window.calendar.view.type"
    (note the single quotes) results in the following message being printed in the console:
    "BBjCalendarWidget Debug: Calendar View: timeGridWeek".
    In other words, if you supply single quotes then the entire parameter is applied to the console.log() JavaScript function without any modifications.
    Since:
    BBj 21.12
  - convertEntriesArrayToBBjVector
```
public static BBjVector convertEntriesArrayToBBjVector(JsonArray entries!)
```
    A utility method that converts a JSON array of calendar entries, such as what's received from the JavaScript code, into a BBjVector filled with CalendarEntry objects.
    
    Parameters:
    JsonArray entries! A JsonArray of calendar entries.
    Returns:
    BBjVector A BBjVector filled with CalendarEntry objects.
  - convertEntriesArrayToBBjVector
```
public static BBjVector convertEntriesArrayToBBjVector(BBjString entries!)
```
    A utility method that converts a stringified JSON array of calendar entries, such as what's received from the JavaScript code, into a BBjVector filled with CalendarEntry objects.
    
    Parameters:
    BBjString entries! A stringified JSON array of calendar entries.
    Returns:
    BBjVector A BBjVector filled with CalendarEntry objects.
  - convertEntriesBBjVectorToJsonArray
```
public static JsonArray convertEntriesBBjVectorToJsonArray(BBjVector entries!)
```
    A utility method that converts a BBjVector filled with CalendarEntry object to a JSON array of calendar entries.
    
    Parameters:
    BBjVector entries! A BBjVector filled with CalendarEntry objects.
    Returns:
    JsonArray A JsonArray filled with Json entry objects.
  - debugLog
```
public void debugLog(BBjString msg!)
```
    Logs a debug string to the browser's console for debugging purposes if the EnableDebug option has been set. This method is used internally by the BBjCalendarWidget and may also be used in your applications. To always log information to the console regardless of whether the EnableDebug option has been set, use the consoleLog() method instead.
    
    If you provide a simple string, like
    "Got Here!"
    then you'll see an entry in the console that looks like
    "BBjCalendarWidget Debug: Got Here!"
    Note: If you provide a static string with single quotes, then you can print out JavaScript objects if they're not enclosed in the single quotes. For example, calling the method with the string
    "'Calendar View: ', window.calendar.view.type"
    (note the single quotes) results in the following message being printed in the console:
    "BBjCalendarWidget Debug: Calendar View: timeGridWeek".
    In other words, if you supply single quotes then the entire parameter is applied to the console.log() JavaScript function without any modifications.
  - executeScript
```
public Object executeScript(BBjString script!)
```
    Executes the provided JavaScript via the BBjJavaScriptExecutor class which results in a debounced execution, which is useful when you don't need the return value from the script and the script can be batched with other scripts. If you need the return value from the script, then you need to call the executeScriptImmediately() method instead.
    
    Note: The executor handles JSNI automatically so you don't have to check for BUI and adjust the window and document JavaScript objects.
    If the BBjHtmlView is not ready yet then the script will be queued. After the BBjHtmlView control is ready then the executor will execute it on the client.
    
    Parameters:
    BBjString script$ The JavaScript code to execute.
    Returns:
    Object The result of the JavaScript code execution if the script returns a value.
  - executeScriptImmediately
```
public Object executeScriptImmediately(BBjString script!)
```
    Executes the provided JavaScript immediately via the BBjJavaScriptExecutor class without debouncing, which is necessary when you need the return value from the script.
    
    Note: The executor handles JSNI automatically so you don't have to check for BUI and adjust the window and document JavaScript objects.
    If the BBjHtmlView is not ready then this method will throw an error 500. Setting a callback for the CalendarAPI.ON_CALENDAR_READY will result in your application getting a CalendarReadyEvent event signaling that the calendar is ready for interaction.
    
    Parameters:
    BBjString script$ The JavaScript code to execute.
    Returns:
    Object The result of the JavaScript code execution if the script returns a value.
  - getBackColor
```
public BBjColor getBackColor()
```
    Returns the background color of the calendar's containing window.
    
    Returns:
    BBjColor The containing window's background color as a BBjColor.
  - getBBjVectorAsJsonArray
```
public static JsonArray getBBjVectorAsJsonArray(BBjVector vector!)
```
    A utility method that returns a JSON array version of the supplied BBjVector.
    
    Parameters:
    BBjVector vector! The BBjVector to be converted to a JSON array.
    Returns:
    JsonArray A JSON array version of the supplied BBjVector.
  - getControlType
```
public int getControlType()
```
    Returns the unique control type for the BBjCalendarWidget, which is 65050.
    
    Returns:
    int controlType = 65050
  - getDate
```
public BBjString getDate()
```
    Returns the calendar's currently selected date.
    
    Returns:
    BBjString The calendar's current date as a string.
  - getDateAsISOString
```
public BBjString getDateAsISOString()
```
    Returns the calendar's currently selected date in ISO format.
    
    Returns:
    BBjString The calendar's current date as a string in 8601 format (YYYY-MM-DD), such as "2020-12-31"
    See Also:
    Date and Time Formats for information on ISO 8601 date/time formats.
  - getEnableDebug
```
public BBjNumber getEnableDebug()
```
    Returns whether the BBjCalendarWidget should run in debug mode (1) or not (0).
    
    Returns:
    BBjNumber A BBjNumber acting as a boolean that indicates whether the BBjCalendarWidget is running in debug mode.
  - getEntries
```
public BBjVector getEntries()
```
    Returns all of the calendar's entries as a BBjVector of CalendarEntry objects.
    
    Returns:
    BBjVector A BBjVector filled with CalendarEntry objects for all the events in the calendar.
    See Also:
    BBjVector
  - getEntriesAsJsonArray
```
public JsonArray getEntriesAsJsonArray()
```
    Returns all of the calendar's entries as a JsonArray of JsonObject events.
    
    Returns:
    JsonArray A JsonArray filled with JsonObjects for all the events in the calendar.
  - getEntriesWithTag
```
public BBjVector getEntriesWithTag(BBjString tag!)
```
    Returns all of the calendar's entries as a BBjVector of CalendarEntry objects.
    
    Returns:
    BBjVector A BBjVector filled with CalendarEntry objects for all the events in the calendar.
    See Also:
    BBjVector
  - getEntriesWithTags
```
public BBjVector getEntriesWithTags(BBjVector tags!)
```
    Returns all of the calendar's entries as a BBjVector of CalendarEntry objects.
    
    Returns:
    BBjVector A BBjVector filled with CalendarEntry objects for all the events in the calendar.
    See Also:
    BBjVector
  - getEntrySourceIds
```
public BBjVector getEntrySourceIds()
```
    Returns a BBjVector filled with IDs for all the CalendarEntrySource objects that have previously been added to the calendar via the addEntrySource() method.
    
    Returns:
    BBjVector A BBjVector filled with the current CalendarEntrySource object IDs that have previously been added to the calendar, or null() if none have been added.
  - getEventDescription
```
public BBjString getEventDescription(BBjNumber eventNumber!)
```
    A utility method that returns a descriptive string given an event number based on the CalendarAPI.ON_CALENDAR_* callback constants.
    
    Parameters:
    BBjNumber eventNumber! The event number that is one of the CalendarAPI.ON_CALENDAR_* callback constants.
    Returns:
    BBjString A string description of the event number.
  - getHeight
```
public BBjNumber getHeight()
```
    Returns the widget's height.
    
    Returns:
    BBjNumber The widget's height.
  - getHiddenTags
```
public BBjVector getHiddenTags()
```
    Returns a BBjVector filled with optional custom tags that were previously set with the setHiddenTags() method and determine which calendar entries should be hidden.
    
    When dealing with entry tags, there are three sets to be aware of:
    1. The CalendarEntry custom class offers setTags() methods that give you the opportunity to add custom tags to any entry.
    2. The BBjCalendarWidget::setVisibleTags() methods allow you to set which entries will be visible in the calendar, as any entries that share a tag with the visible tag set will be displayed normally.
    3. The BBjCalendarWidget::setHiddenTags() methods allow you to set which entries will be hidden in the calendar, as any entries that share a tag with the hidden tag set will be be hidden from view.
    Note: If the BBjCalendarWidget's set of visible tags is empty then all calendar entries will be visible. If the BBjCalendarWidget's set of hidden tags is empty then all calendar entries will be visible.
    Note: You will typically affect the calendar's entry visibility by calling either the setVisibleTags() or setHiddenTags() methods, but not both.
    Returns:
    BBjVector A vector filled with tags such as "work", "programming", "meeting", etc. that has been previously filled via one of the BBjCalendarWidget::setVisibleTags() methods.
    See Also:
    BBjVector
  - getHtmlView
```
public BBjHtmlView getHtmlView()
```
    Returns the underlying BBjHtmlView control that contains the JavaScript FullCalendar.
    
    Returns:
    BBjHtmlView The underlying BBjHtmlView control that contains the JavaScript FullCalendar.
    See Also:
    BBjHtmlView for more information on the BBjHtmlView control.
  - getImage
```
public BBjImage getImage()
```
    Returns a BBjImage screenshot of the BBjCalendarWidget.
    
    Returns:
    BBjImage A screenshot of the calendar in BBjImage format.
    See Also:
    BBjImage
  - getIsReady
```
public BBjNumber getIsReady()
```
    Returns a BBjNumber acting as a boolean that indicates whether the widget is ready to be interacted with (1) or not (0).
    
    Returns:
    BBjNumber A BBjNumber acting as a boolean that indicates whether the widget is ready to be interacted with (1) or not (0).
  - getJsonArrayAsBBjVector
```
public static BBjVector getJsonArrayAsBBjVector(JsonArray array!)
```
    A utility method that returns a BBjVector version of the supplied JSON array.
    
    Parameters:
    JsonArray array! The JSON array to be converted to a BBjVector.
    Returns:
    BBjVector A BBjVector version of the supplied JSON array.
  - getJsonObjectAsFormattedString
```
public static BBjString getJsonObjectAsFormattedString(JsonObject json!)
```
    A utility method that returns a formatted, or pretty-printed version of the supplied JSON object sorted alphabetically by key.
    
    Parameters:
    JsonObject json! The JSON object to be formatted.
    Returns:
    BBjString A BBjString that is a string representation of the supplied JSON object after it has been formatted, or an empty string if the provided JsonObject was null().
  - getLocalTimeZoneOffsetFromUtc
```
public BBjNumber getLocalTimeZoneOffsetFromUtc()
```
    Returns the difference between the client's local time and UTC in minutes. For example, if your time zone is UTC+10, then -600 will be returned because UTC is 600 minutes behind the local time zone. Another way to view it is that the return value is the number of minutes that should be added to the local time in order to find UTC. Note that daylight savings time prevents this value from being a constant.
    
    Returns:
    BBjNumber The number of minutes needed to add to the local time to result in UTC.
    Since:
    BBj 22.00
  - getName
```
public String getName()
```
    Returns the widget's name as previously-set via the setName() method.
    
    Returns:
    String The widget's name.
  - getOptions
```
public CalendarOptions getOptions()
```
    Returns the calendar's current options in an instance of the CalendarOptions class.
    
    Returns:
    CalendarOptions
  - getOptionsAsJsonObject
```
public JsonObject getOptionsAsJsonObject()
```
    Returns the calendar's options as a JsonObject.
    
    Returns:
    JsonObject The calendar's options as a JsonObject.
    See Also:
    JsonObject for information about an object in JSON format.
  - getStyle
```
public BBjString getStyle(BBjString property!)
```
    Returns the value of the specified CSS property.
    
    Parameters:
    BBjString property! The CSS property name to get the value of.
    Returns:
    BBjString The value of the specified CSS property.
  - getStyles
```
public BBjVector getStyles()
```
    Returns the widget's name as previously-set via the setName() method.
    
    Returns:
    BBjVector A BBjVector filled with a list of all the CSS style names that have been added to the widget.
  - getThemes
```
public static BBjVector getThemes()
```
    Returns all of the calendar's available themes as an alphabetized list in a BBjVector filled with the theme names.
    
    After determining which themes are available, you can call the setTheme() method specifying any of the theme names in the return vector to change the calendar's theme.
    Note that the installed themes are located in the BBjCalendarWidget's lib/bootstrap/themes/ directory. The installed themes are free Bootstrap themes from https://bootswatch.com/, although free Bootstrap themes are available from many other sites such as https://startbootstrap.com/themes. If you would like to add more themes, create a subdirectory under the calendar's themes directory and copy the bootstrap.css and bootstrap.min.css files in the newly-created subdirectory. The calendar will attempt to find and use the bootstrap.min.css first due to its reduced size.
    Returns:
    BBjVector A BBjVector filled with the alphabetized list of available theme names.
  - getUserData
```
public Object getUserData()
```
    Returns the custom object that was previously associated with the widget by calling the setUserData() method.
    
    Returns:
    Object The custom object associated with the widget.
  - getUuid
```
public BBjString getUuid()
```
    Returns a unique auto-generated ID for the calendar instance that may be used to distinguish between instances of the class.
    
    Returns:
    BBjString The calendar's unique ID.
  - getValidDateString
```
public BBjString getValidDateString(BBjString dateString!)
```
    Returns a date string formatted as YYYY-MM-DD if the provided date string can be parsed into a valid date, or null() if the date string is invalid.
    
    Note: An ISO 8601 formatted date/time string (YYYY-MM-DDTHH:mm:ss.sssZ) is never ambiguous, but this method exists to attempt to parse an ambiguous date/time string into an ISO 8601 formatted date/time string. If the provided string is ambiguous, there are no guarantees that the method will be able to resolve the date/time string correctly. The success of this method depends on the format of the supplied date/time string and the client's browser. For example, a date of "1-2-3" is very ambiguous and while the method may be able to return a valid date string, it may not be the particular date that you had in mind. That's because there is no good way to know which number corresponds to the year, month, and day. However, a string like "Jan 1, 2000" is far less ambiguous and will likely be parsed correctly in to "2000-01-01".
    Additionally, since the method uses JavaScript when parsing dates, the success is dependant on the browser's JavaScript implementation. For example, at the time of this writing, Chrome can parse ambiguous dates like "May 2020" and "May 15". However, Firefox returns an "Invalid Date" for those values.
    Parameters:
    BBjString dateString! A string that contains a date representation. If you provide a ISO formatted date, such as 2022-12-25, then
    Returns:
    BBjString A YYYY-MM-DD formatted date representation of the provided date string, or null() if the date string cannot be parsed into an ISO formatted date.
    Since:
    BBj 22.00
  - getValidDateTimeString
```
public BBjString getValidDateTimeString(BBjString dateTimeString!)
```
    Returns an ISO 8601 formatted date/time string if the provided date/time string can be parsed into a valid date, or null() if it can't be parsed.
    
    Note: An ISO 8601 formatted date/time string (YYYY-MM-DDTHH:mm:ss.sssZ) is never ambiguous, but this method exists to attempt to parse an ambiguous date/time string into an ISO 8601 formatted date/time string. If the provided string is ambiguous, there are no guarantees that the method will be able to resolve the date/time string correctly. The success of this method depends on the format of the supplied date/time string and the client's browser. For example, a date of "1-2-3" is very ambiguous and while the method may be able to return a valid date string, it may not be the particular date that you had in mind. That's because there is no good way to know which number corresponds to the year, month, and day. However, a string like "Jan 1, 2000" is far less ambiguous and will likely be parsed correctly in to "2000-01-01".
    Additionally, since the method uses JavaScript when parsing dates, the success is dependant on the browser's JavaScript implementation. For example, at the time of this writing, Chrome can parse ambiguous dates like "May 2020" and "May 15". However, Firefox returns an "Invalid Date" for those values.
    Parameters:
    BBjString dateTimeString! A string that contains a date/time representation.
    Returns:
    BBjString An ISO 8601 formatted date representation of the provided date string, or null() if the date string cannot be parsed into an ISO formatted date/time string.
    Since:
    BBj 22.00
  - getValidTimeString
```
public BBjString getValidTimeString(BBjString timeString!)
```
    Returns a time string formatted as HH:MM:SS using 24-hour format if the provided time string can be parsed into a valid time, or null() if the time string is invalid.
    
    Note: An ISO 8601 formatted date/time string (YYYY-MM-DDTHH:mm:ss.sssZ) is never ambiguous, but this method exists to attempt to parse an ambiguous date/time string into an ISO 8601 formatted date/time string. If the provided string is ambiguous, there are no guarantees that the method will be able to resolve the date/time string correctly. The success of this method depends on the format of the supplied date/time string and the client's browser. For example, a date of "1-2-3" is very ambiguous and while the method may be able to return a valid date string, it may not be the particular date that you had in mind. That's because there is no good way to know which number corresponds to the year, month, and day. However, a string like "Jan 1, 2000" is far less ambiguous and will likely be parsed correctly in to "2000-01-01".
    Additionally, since the method uses JavaScript when parsing dates, the success is dependant on the browser's JavaScript implementation. For example, at the time of this writing, Chrome can parse ambiguous dates like "May 2020" and "May 15". However, Firefox returns an "Invalid Date" for those values.
    Parameters:
    BBjString timeString! A string that contains a time representation.
    Returns:
    BBjString A 24-hour HH:MM:SS formatted time representation of the provided time string, or null() if the time string cannot be parsed into an ISO formatted time.
    Since:
    BBj 22.00
  - getViewType
```
public BBjString getViewType()
```
    Returns the calendar's view type which will be one of the following constants:
    Returns:
    BBjString The calendar's current view type, such as CalendarAPI.CALENDAR_VIEW_DAY_GRID_WEEK().
  - getVisibleTags
```
public BBjVector getVisibleTags()
```
    Returns a BBjVector filled with optional custom tags that were previously set with the setVisibleTags() method and determine which calendar entries should be displayed.
    
    When dealing with entry tags, there are three sets to be aware of:
    1. The CalendarEntry custom class offers setTags() methods that give you the opportunity to add custom tags to any entry.
    2. The BBjCalendarWidget::setVisibleTags() methods allow you to set which entries will be visible in the calendar, as any entries that share a tag with the visible tag set will be displayed normally.
    3. The BBjCalendarWidget::setHiddenTags() methods allow you to set which entries will be hidden in the calendar, as any entries that share a tag with the hidden tag set will be be hidden from view.
    Note: If the BBjCalendarWidget's set of visible tags is empty then all calendar entries will be visible. If the BBjCalendarWidget's set of hidden tags is empty then all calendar entries will be visible.
    Note: You will typically affect the calendar's entry visibility by calling either the setVisibleTags() or setHiddenTags() methods, but not both.
    Returns:
    BBjVector A vector filled with tags such as "work", "programming", "meeting", etc. that has been previously filled via one of the BBjCalendarWidget::setVisibleTags() methods.
    See Also:
    BBjVector
  - getWidth
```
public BBjNumber getWidth()
```
    Returns the widget's width.
    
    Returns:
    BBjNumber The widget's width.
  - getX
```
public BBjNumber getX()
```
    Returns the widget's X coordinate, or horizontal position.
    
    Returns:
    BBjNumber The widget's X coordinate.
  - getY
```
public BBjNumber getY()
```
    Returns the widget's Y coordinate, or vertical position.
    
    Returns:
    BBjNumber The widget's Y coordinate.
  - injectCss
```
public void injectCss(BBjString css!)
```
    Injects the provided CSS string into the <head> element of the HTML document in the BBjHtmlView that contains the calendar.
    
    This method provides a simple way to add custom CSS that affects the calendar. For more advanced use cases, see the injectCss() method that takes several parameters to provide greater control over the injection.
    Parameters:
    BBjString css! The CSS to inject into the BBjHtmlView's DOM.
  - injectCss
```
public void injectCss(BBjString css!, BBjString location!, BBjString description!, BBjNumber removePrevious!)
```
    Injects the provided CSS string into the head or body of the HTML DOM (as specified by the location! parameter) in the BBjHtmlView that contains the calendar, as well as providing the ability to tag the CSS and replace it in subsequent calls.
    
    Parameters:
    BBjString css! The CSS to inject into the BBjHtmlView's DOM.
    BBjString location! The target for injection which can be 'head' or 'body'. If it's an empty string, it will default to 'body'.
    BBjString description! The description of the CSS, which is used to replace it in subsequent calls.
    BBjNumber removePrevious! A BBjNumber acting as a boolean that determines whether the CSS should replace existing CSS with the same description.
  - injectCssFile
```
public void injectCssFile(BBjString cssPath!)
```
    Injects the CSS contained in the specified file into the <head> element of the HTML document in the BBjHtmlView that contains the calendar. This is a convenience method that reads in the contents of the provided CSS file and injects it into the HtmlView control that contains the calendar.
    
    Parameters:
    BBjString cssPath! A string representing the full path and filename of the file that contains the CSS to be injected.
  - injectScript
```
public void injectScript(BBjString script!)
```
    Injects the provided JavaScript string at the top-level window.
    
    Parameters:
    BBjString script! The JavaScript to inject into the BBjHtmlView.
    See Also:
    BBjHtmlView::injectScript.
  - injectScriptFile
```
public void injectScriptFile(BBjString scriptPath!)
```
    Injects the JavaScript contained in the specified script file into the top-level window. This is a convenience method that reads in the contents of the provided JavaScript file and injects it into the HtmlView control that contains the calendar.
    
    Parameters:
    BBjString scriptPath! A string representing the full path and filename of the file that contains the JavaScript to be injected.
    See Also:
    BBjHtmlView::injectScript.
  - injectUrl
```
public void injectUrl(BBjString url!)
```
    Injects the specified JavaScript URL into the HTML DOM, making it available for subsequent use by client-side JavaScript.
    
    Parameters:
    BBjString url! The URL string containing JavaScript to be injected into the HTML DOM.
  - isEnabled
```
public boolean isEnabled()
```
    Returns whether the widget is enabled or disabled.
    
    Returns:
    boolean A boolean that indicates whether the widget is enabled (1) or not (0).
  - isVisible
```
public boolean isVisible()
```
    Returns whether the widget is visible or hidden.
    
    Returns:
    boolean A boolean that indicates whether the widget is visible (1) or not (0).
  - navigateDate
```
public void navigateDate(BBjString date!)
```
    Navigates the calendar programmatically to the specified date. To ensure the calendar navigates to the correct date, the provided date should be in the ISO 8601 format. However, this method attempts to parse ambiguous dates and is often able to construct a date in the format "YYYY-MM-DD" given a date string in another format.
    
    If the provided string is ambiguous, there are no guarantees that the method will be able to resolve the date/time string correctly. The success of this method depends on the format of the supplied date/time string and the client's browser. For example, a date of "1-2-3" is very ambiguous and while the method may be able to return a valid date string, it may not be the particular date that you had in mind. That's because there is no good way to know which number corresponds to the year, month, and day. However, a string like "Jan 1, 2000" is far less ambiguous and will likely be parsed correctly in to "2000-01-01".
    Additionally, since the method uses JavaScript when parsing dates and time, the success is dependant on the browser's JavaScript implementation. For example, at the time of this writing, Chrome can parse ambiguous dates like "May 2020" and "May 15". However, Firefox returns an "Invalid Date" for those values.
    The date string should ideally be in the "YYYY-MM-DD" format at a minimum, but the parser should be able to interpret various formats.
    Parameters:
    BBjString date! The date string that will be parsed and then passed to the FullCalendar's gotoDate() method.
    See Also:
    Date and Time Formats for information on ISO 8601 date/time formats.
    Calendar::gotoDate for information on the FullCalendar's gotoDate() method.
  - navigateNext
```
public void navigateNext()
```
    Navigates the calendar programmatically one step forward (by a month or week for example), and is the same as the user clicking on the 'next' toolbar button. The amount of time moved depends on the current view type.
  - navigateNextYear
```
public void navigateNextYear()
```
    Navigates the calendar programmatically forward one year, and is the same as the user clicking on the 'nextYear' toolbar button.
  - navigatePrev
```
public void navigatePrev()
```
    Navigates the calendar programmatically one step back (by a month or week for example), and is the same as the user clicking on the 'prev' toolbar button. The amount of time moved depends on the current view type.
  - navigatePrevYear
```
public void navigatePrevYear()
```
    Navigates the calendar programmatically back one year, and is the same as the user clicking on the 'prevYear' toolbar button.
  - navigateTime
```
public void navigateTime(BBjString time!)
```
    Navigates the calendar programmatically to the specified time. To ensure the calendar navigates to the correct time, the provided time should be in the ISO 8601 format or "hh:mm" format at a minimum.. However, this method attempts to parse ambiguous times and is often able to construct a time in the format "hh:mm:ss" given a time string in another format.
    
    If the provided string is ambiguous, there are no guarantees that the method will be able to resolve the date/time string correctly. The success of this method depends on the format of the supplied date/time string and the client's browser. For example, a date of "1-2-3" is very ambiguous and while the method may be able to return a valid date string, it may not be the particular date that you had in mind. That's because there is no good way to know which number corresponds to the year, month, and day. However, a string like "Jan 1, 2000" is far less ambiguous and will likely be parsed correctly in to "2000-01-01".
    Additionally, since the method uses JavaScript when parsing dates and time, the success is dependant on the browser's JavaScript implementation. For example, at the time of this writing, Chrome can parse ambiguous dates like "May 2020" and "May 15". However, Firefox returns an "Invalid Date" for those values.
    The time string should ideally be in one of the following formats.
    - "hh:mm:ss.sss"
    - "hh:mm:ss"
    - "hh:mm"
    but the parser should be able to interpret various formats.
    Parameters:
    BBjString time! The time string that will be parsed and then passed to the FullCalendar's scrollToTime() method.
    See Also:
    Date and Time Formats for information on ISO 8601 date/time formats.
    Calendar::scrollToTime for information on the FullCalendar's scrollToTime() method.
    Since:
    BBj 22.00
  - navigateToday
```
public void navigateToday()
```
    Navigates the calendar programmatically to the current date, and is the same as the user clicking on the 'today' toolbar button.
  - ON_CALENDAR_DATE_CLICK
```
public static BBjNumber ON_CALENDAR_DATE_CLICK()
```
    A constant value that's used with the BBjCalendarWidget::setCallback() method that signals that the user has clicked on a date or time.
    
    Note that ON_CALENDAR_DATE_CLICK event is not fired when the user clicks a day heading in a list view.
    Setting a callback for this event type will result in your application getting a CalendarDateClickEvent object.
  - ON_CALENDAR_DATES_SET
```
public static BBjNumber ON_CALENDAR_DATES_SET()
```
    A constant value that's used with the BBjCalendarWidget::setCallback() method that signals that the calendar's date range has changed in any way.
    
    Setting a callback for this event type will result in your application getting a CalendarDatesSetEvent object.
  - ON_CALENDAR_DROP
```
public static BBjNumber ON_CALENDAR_DROP()
```
    A constant value that's used with the BBjCalendarWidget::setCallback() method that signals that the user dropped an external draggable element or an event from another calendar onto this calendar.
  - ON_CALENDAR_ENTRIES_SET
```
public static BBjNumber ON_CALENDAR_ENTRIES_SET()
```
    A constant value that's used with the BBjCalendarWidget::setCallback() method that signals that the calendar's entry data has changed in any way. If you set a callback for this event, then add several entries to the calendar, your callback routine may be flooded because the event will fire for every entry that you add.
    
    When responding to this event, the BBjSysGui::getLastEvent() call will return a CalendarEntriesSetEvent object. You can call the CalendarEntriesSetEvent::getEntries() method to return a BBjVector of CalendarEntry objects that corresponds to all the known entries in the calendar at that instant in time.
    Setting a callback for this event type will result in your application getting a CalendarEntriesSetEvent object.
    See Also:
    BBjVector.
  - ON_CALENDAR_ENTRY_ADD
```
public static BBjNumber ON_CALENDAR_ENTRY_ADD()
```
    A constant value that's used with the BBjCalendarWidget::setCallback() method that signals that an event has been added to the calendar.
    
    Note: If you set a callback for this event, then add several events to the calendar, your callback routine may be flooded.
    Setting a callback for this event type will result in your application getting a CalendarEntryAddEvent object.
  - ON_CALENDAR_ENTRY_CHANGE
```
public static BBjNumber ON_CALENDAR_ENTRY_CHANGE()
```
    A constant value that's used with the BBjCalendarWidget::setCallback() method that signals that the calendar's event data has changed in any way.
    
    Setting a callback for this event type will result in your application getting a CalendarEntryChangeEvent object.
  - ON_CALENDAR_ENTRY_CLICK
```
public static BBjNumber ON_CALENDAR_ENTRY_CLICK()
```
    A constant value that's used with the BBjCalendarWidget::setCallback() method that signals that the user has clicked on a calendar's event.
    
    Setting a callback for this event type will result in your application getting a CalendarEntryClickEvent object.
  - ON_CALENDAR_ENTRY_DRAG_START
```
public static BBjNumber ON_CALENDAR_ENTRY_DRAG_START()
```
    A constant value that's used with the BBjCalendarWidget::setCallback() method that signals that the user has started dragging an event.
  - ON_CALENDAR_ENTRY_DRAG_STOP
```
public static BBjNumber ON_CALENDAR_ENTRY_DRAG_STOP()
```
    A constant value that's used with the BBjCalendarWidget::setCallback() method that signals that the user has stopped dragging an event.
  - ON_CALENDAR_ENTRY_DROP
```
public static BBjNumber ON_CALENDAR_ENTRY_DROP()
```
    A constant value that's used with the BBjCalendarWidget::setCallback() method that signals that the user has dropped the event to a different day/time.
  - ON_CALENDAR_ENTRY_LEAVE
```
public static BBjNumber ON_CALENDAR_ENTRY_LEAVE()
```
    A constant value that's used with the BBjCalendarWidget::setCallback() method that signals that the user is about to drop one of the calendar events on to another calendar.
  - ON_CALENDAR_ENTRY_MOUSE_ENTER
```
public static BBjNumber ON_CALENDAR_ENTRY_MOUSE_ENTER()
```
    A constant value that's used with the BBjCalendarWidget::setCallback() method that signals that the user moved the mouse into the bounds of a calendar event.
    
    Setting a callback for this event type will result in your application getting a CalendarEntryMouseEnterEvent object.
  - ON_CALENDAR_ENTRY_MOUSE_LEAVE
```
public static BBjNumber ON_CALENDAR_ENTRY_MOUSE_LEAVE()
```
    A constant value that's used with the BBjCalendarWidget::setCallback() method that signals that the user moved the mouse out of the bounds of a calendar event.
    
    Setting a callback for this event type will result in your application getting a CalendarEntryMouseLeaveEvent object.
  - ON_CALENDAR_ENTRY_RECEIVE
```
public static BBjNumber ON_CALENDAR_ENTRY_RECEIVE()
```
    A constant value that's used with the BBjCalendarWidget::setCallback() method that signals that the calendar has received an external draggable element with event data from another source or another calendar.
  - ON_CALENDAR_ENTRY_REMOVE
```
public static BBjNumber ON_CALENDAR_ENTRY_REMOVE()
```
    A constant value that's used with the BBjCalendarWidget::setCallback() method that signals that an entry has been removed from the calendar. If you set a callback for this event, then remove several entries from the calendar, your callback routine may be flooded because the event will fire for every entry that was removed.
    
    Setting a callback for this event type will result in your application getting a CalendarEntryRemoveEvent object.
  - ON_CALENDAR_ENTRY_RESIZE
```
public static BBjNumber ON_CALENDAR_ENTRY_RESIZE()
```
    A constant value that's used with the BBjCalendarWidget::setCallback() method that signals that the user has stopped resizing an event and the event has a different duration.
  - ON_CALENDAR_ENTRY_RESIZE_START
```
public static BBjNumber ON_CALENDAR_ENTRY_RESIZE_START()
```
    A constant value that's used with the BBjCalendarWidget::setCallback() method that signals that the user has started resizing an event.
  - ON_CALENDAR_ENTRY_RESIZE_STOP
```
public static BBjNumber ON_CALENDAR_ENTRY_RESIZE_STOP()
```
    A constant value that's used with the BBjCalendarWidget::setCallback() method that signals that the user has stopped resizing an event.
  - ON_CALENDAR_ENTRY_SOURCE_FAILURE
```
public static BBjNumber ON_CALENDAR_ENTRY_SOURCE_FAILURE()
```
    A constant value that's used with the BBjCalendarWidget::setCallback() method that signals that fetching a CalendarEntrySource failed.
  - ON_CALENDAR_ENTRY_SOURCE_SUCCESS
```
public static BBjNumber ON_CALENDAR_ENTRY_SOURCE_SUCCESS()
```
    A constant value that's used with the BBjCalendarWidget::setCallback() method that signals that fetching a CalendarEntrySource succeeded.
  - ON_CALENDAR_READY
```
public static BBjNumber ON_CALENDAR_READY()
```
    A constant value that's used with the BBjCalendarWidget::setCallback() method that signals that the BBjCalendarWidget is ready.
    
    Setting a callback for this event type will result in your application getting a CalendarReadyEvent object.
  - ON_CALENDAR_SELECT
```
public static BBjNumber ON_CALENDAR_SELECT()
```
    A constant value that's used with the BBjCalendarWidget::setCallback() method that signals that the user selected a date or time.
    
    Note: You must configure the calendar to enable user selections via the CalendarOptions:setEnableSelectable() method if you intend to set a callback for the BBjCalendarWidget:ON_CALENDAR_SELECT or BBjCalendarWidget:ON_CALENDAR_UNSELECT events.
    Setting a callback for this event type will result in your application getting a CalendarSelectEvent object.
  - ON_CALENDAR_UNSELECT
```
public static BBjNumber ON_CALENDAR_UNSELECT()
```
    A constant value that's used with the BBjCalendarWidget::setCallback() method that signals that the user unselected a date or time.
    
    Note: You must configure the calendar to enable user selections via the CalendarOptions:setEnableSelectable() method if you intend to set a callback for the BBjCalendarWidget:ON_CALENDAR_SELECT or BBjCalendarWidget:ON_CALENDAR_UNSELECT events.
    A selection might be cleared for a number of reasons:
    - The user clicks away from the current selection (doesn't happen when EnableUnselectAuto is false).
    - The user makes a new selection. The unselect callback will be fired before the new selection occurs.
    - The user moves forward or backward in the current view, or switches to a new view.
    - The unselect method is called through the API.
    The CalendarOptions::setEnableUnselectAuto() impacts what causes the BBjCalendarWidget.ON_CALENDAR_UNSELECT event to be fired. If automatic unselection is enabled, then the unselection event will typically be fired after the user releases their selection mouse button.
    Setting a callback for this event type will result in your application getting a CalendarUnselectEvent.
  - ON_CALENDAR_VIEW_CHANGE
```
public static BBjNumber ON_CALENDAR_VIEW_CHANGE()
```
    A constant value that's used with the BBjCalendarWidget::setCallback() method that signals that the user has changed the view type of the BBjCalendarWidget.
    
    Note: This only fires when the type of view changes, not when the user changes the view from one subtype to another. For example, the event will be triggered when the user switches from the CalendarAPI.CALENDAR_VIEW_DAY_GRID_MONTH() to the CalendarAPI.CALENDAR_VIEW_LIST_MONTH() view. But it won't be triggerd when the user changes from CalendarAPI.CALENDAR_VIEW_DAY_GRID_MONTH() to CalendarAPI.CALENDAR_VIEW_DAY_GRID_WEEK() since both views are the same type (dayGrid) and just the subtype (week vs. month) changes.
  - onNativeEvent
```
public void onNativeEvent(BBjNativeJavaScriptEvent ev!)
```
    An internal event handler for native JavaScript events from the BBjHtmlView control that converts a JavaScript calendar event to a BBj callback event.
    
    Parameters:
    BBjNativeJavaScriptEvent ev! The Javascript event from the client.
  - redraw
```
public void redraw(BBjNumber shouldCreate!)
```
    Initially draws or redraws the widget whenever it needs to be rendered.
    
    Your application code won't ever have to call this method under normal conditions. It's typically only used internally to redraw the calendar after the the setSize() method has been called. However, if you may want to call the render() method if you modified the calendar's options inline (as opposed to using the setOptions() method.
    Parameters:
    BBjNumber shouldCreate! A BBjNumber acting as a boolean that indicates if the control should be (re)created (1) or just redrawn (0).
    See Also:
    render()
  - refetchAllEntries
```
public void refetchAllEntries()
```
    Causes the calendar to refetch entries from all sources and rerender.
    
    If you've previously added events to the calendar from a remote source, such as a web service or Google Calendar, then the calendar will requery those sources for an updated entry set. If the entries on the backend have changed, such as some entries have been added and others deleted, then those changes will be reflected on the calendar after calling this method.
  - refetchAllEntrySources
```
public void refetchAllEntrySources()
```
    Refetches all CalendarEntrySource objects in the calendar, causing them to retrieve their entries again.
  refetchEntrySource public void refetchEntrySource(BBjString id!) Refetches the CalendarEntrySource object in the calendar given its unique ID, causing it to retrieve its entries again. Parameters: BBjString id! A BBjString filled with the unique ID for the CalendarEntrySource to remove. removeAllEntries public BBjNumber removeAllEntries() Removes all the entries in the calendar. Note: Removing entries from the calendar via this method will trigger the CalendarAPI.ON_CALENDAR_ENTRY_REMOVE() event for each entry that was removed. Returns: BBjNumber A BBjNumber indicating the number of entries that were removed from the calendar. removeAllEntrySources public BBjNumber removeAllEntrySources() Removes all CalendarEntrySource objects from the calendar. Returns: BBjNumber A BBjNumber indicating the number of entries that were removed from the calendar. removeEntries public BBjNumber removeEntries(BBjVector entries!) Removes all the entries contained in the BBjVector from the calendar. Note: Removing entries from the calendar via this method will trigger the CalendarAPI.ON_CALENDAR_ENTRY_REMOVE() event for each entry that was removed. Parameters: BBjVector entries! A BBjVector filled with the CalendarEntry objects to remove from the the calendar. Returns: BBjNumber A BBjNumber indicating the number of entries that were removed from the calendar. removeEntry public BBjNumber removeEntry(CalendarEntry entry!) Removes an entry from the calendar. Parameters: CalendarEntry entry! The CalendarEntry to remove from the calendar. Returns: BBjNumber A BBjNumber acting as a boolean that indicates whether the event was removed (1) or not (0). removeEntryById public BBjNumber removeEntryById(BBjString id!) Removes an entry from the calendar given its optional unique ID which must have previously been set. Parameters: BBjString id! A BBjString containing the entry's unique ID. Returns: BBjNumber A BBjNumber acting as a boolean that indicates whether the event was removed (1) or not (0). removeEntrySource public void removeEntrySource(BBjString id!) Removes a CalendarEntrySource and its entries from the calendar given its unique ID. Parameters: BBjString id! A BBjString filled with the unique ID for the CalendarEntrySource to remove. removeStyle public boolean removeStyle(BBjString style!) Removes the provided CSS style name from the widget. Parameters: BBjString style! The CSS style name to remove from the widget. Returns: boolean A boolean that indicates whether the style name was removed from the widget (1) or not (0). render public void render() Renders the calendar inside the HtmlView and applies the current calendar options. This composes the calendar configuration and sends it to the client for a full rerendering. This is the difference between the render() and the redraw() method - the redraw() method only instructs the calendar to repaint itself; it doesn't change or apply any configuration options. You can call this method to force the calendar to be updated after you modify its setup configuration, as in: rem Get and then set the desired options inline dynamically, calling the render() method afterwards to force the calendar to update with the new configuration: myCal!.getOptions().setEnableEntryDurationEditable(1) myCal!.getOptions().setEnableEntryResizableFromStart(1) myCal!.getOptions().setEnableEntryStartEditable(1) myCal!.getOptions().setEnableSlotEntryOverlap(0) myCal!.render() Note: You don't have to call the render() method if you update the calendar's configuration via the setOptions() method. saveAsPngImage public void saveAsPngImage(BBjString path!) Saves a BBjImage screenshot of the BBjCalendarWidget to the specified file path. Parameters: BBjString path! A string representing the full path and filename for the saved screenshot of the calendar. setBackColor public void setBackColor(BBjColor backColor!) Sets the background color of the calendar's containing window. Parameters: BBjColor backColor! A BBjColor that defines the containing window's background color. setCallback public void setCallback(BBjNumber event!, BBjString callback!) Registers a callback in a procedural program for the provided event type. These are the valid callback event type options: CalendarAPI.ON_CALENDAR_READY - the calendar is ready for interaction CalendarAPI.ON_CALENDAR_VIEW_CHANGE - the calendar's view has changed CalendarAPI.ON_CALENDAR_ENTRIES_SET - entries have been changed or initialized in any way CalendarAPI.ON_CALENDAR_ENTRY_CLICK - the user clicked on an entry CalendarAPI.ON_CALENDAR_ENTRY_ADD - an entry was added to the calendar CalendarAPI.ON_CALENDAR_ENTRY_CHANGE - the entry has been modified CalendarAPI.ON_CALENDAR_ENTRY_REMOVE - the entry has been removed from the calendar CalendarAPI.ON_CALENDAR_ENTRY_MOUSE_ENTER - the user moved the mouse on an entry CalendarAPI.ON_CALENDAR_ENTRY_MOUSE_LEAVE - the user moved the mouse off an entry CalendarAPI.ON_CALENDAR_ENTRY_DRAG_START - the user began dragging an entire entry CalendarAPI.ON_CALENDAR_ENTRY_DRAG_STOP - the user stopped dragging the entry CalendarAPI.ON_CALENDAR_ENTRY_DROP - the user has completed dragging and dropping the entire entry CalendarAPI.ON_CALENDAR_ENTRY_RESIZE_START - the user began to resize the entry to change its duration CalendarAPI.ON_CALENDAR_ENTRY_RESIZE_STOP - the user stopped resizing the entry CalendarAPI.ON_CALENDAR_ENTRY_RESIZE - the user completed resizing the entry resulting in a changed duration CalendarAPI.ON_CALENDAR_ENTRY_RECEIVE - Not Yet Implemented, deals with dragging and dropping entries from an external source CalendarAPI.ON_CALENDAR_ENTRY_LEAVE - Not Yet Implemented, deals with dragging and dropping entries from an external source CalendarAPI.ON_CALENDAR_DROP - Not Yet Implemented, deals with dragging and dropping entries from an external source CalendarAPI.ON_CALENDAR_DATES_SET - the calendar's range has been initially set or changed in some way CalendarAPI.ON_CALENDAR_DATE_CLICK - the user clicked on a date or time in the calendar CalendarAPI.ON_CALENDAR_SELECT - the user selected a date or time in the calendar (not an entry) CalendarAPI.ON_CALENDAR_UNSELECT - the date/time selection has been cleared CalendarAPI.ON_CALENDAR_ENTRY_SOURCE_SUCCESS - fetching a CalendarEntrySource has succeded CalendarAPI.ON_CALENDAR_ENTRY_SOURCE_FAILURE - fetching a CalendarEntrySource has failed Note: Callbacks associated with dragging/dropping calendar entries between two different calendars has not yet been implemented. Parameters: BBjNumber event! The event number which is one of the CalendarAPI.ON_CALENDAR_* constants. BBjString callback! The program's callback subroutine label. setCallback public void setCallback(BBjNumber event!, CustomObject instance!, BBjString method!) Registers a callback in an object-oriented program for the provided event type. These are the valid callback event type options: CalendarAPI.ON_CALENDAR_READY - the calendar is ready for interaction CalendarAPI.ON_CALENDAR_VIEW_CHANGE - the calendar's view has changed CalendarAPI.ON_CALENDAR_ENTRIES_SET - entries have been changed or initialized in any way CalendarAPI.ON_CALENDAR_ENTRY_CLICK - the user clicked on an entry CalendarAPI.ON_CALENDAR_ENTRY_ADD - an entry was added to the calendar CalendarAPI.ON_CALENDAR_ENTRY_CHANGE - the entry has been modified CalendarAPI.ON_CALENDAR_ENTRY_REMOVE - the entry has been removed from the calendar CalendarAPI.ON_CALENDAR_ENTRY_MOUSE_ENTER - the user moved the mouse on an entry CalendarAPI.ON_CALENDAR_ENTRY_MOUSE_LEAVE - the user moved the mouse off an entry CalendarAPI.ON_CALENDAR_ENTRY_DRAG_START - the user began dragging an entire entry CalendarAPI.ON_CALENDAR_ENTRY_DRAG_STOP - the user stopped dragging the entry CalendarAPI.ON_CALENDAR_ENTRY_DROP - the user has completed dragging and dropping the entire entry CalendarAPI.ON_CALENDAR_ENTRY_RESIZE_START - the user began to resize the entry to change its duration CalendarAPI.ON_CALENDAR_ENTRY_RESIZE_STOP - the user stopped resizing the entry CalendarAPI.ON_CALENDAR_ENTRY_RESIZE - the user completed resizing the entry resulting in a changed duration CalendarAPI.ON_CALENDAR_ENTRY_RECEIVE - Not Yet Implemented, deals with dragging and dropping entries from an external source CalendarAPI.ON_CALENDAR_ENTRY_LEAVE - Not Yet Implemented, deals with dragging and dropping entries from an external source CalendarAPI.ON_CALENDAR_DROP - Not Yet Implemented, deals with dragging and dropping entries from an external source CalendarAPI.ON_CALENDAR_DATES_SET - the calendar's range has been initially set or changed in some way CalendarAPI.ON_CALENDAR_DATE_CLICK - the user clicked on a date or time in the calendar CalendarAPI.ON_CALENDAR_SELECT - the user selected a date or time in the calendar (not an entry) CalendarAPI.ON_CALENDAR_UNSELECT - the date/time selection has been cleared CalendarAPI.ON_CALENDAR_ENTRY_SOURCE_SUCCESS - fetching a CalendarEntrySource has succeded CalendarAPI.ON_CALENDAR_ENTRY_SOURCE_FAILURE - fetching a CalendarEntrySource has failed Note: Callbacks associated with dragging/dropping calendar entries between two different calendars has not yet been implemented. Parameters: BBjNumber event! The event number which is one of the CalendarAPI.ON_CALENDAR_* constants. CustomObject instance! The program's custom class instance, usually #this! BBjString method! The program's custom class's method name. setEnabled public void setEnabled(boolean enabled!) Sets whether the widget should be enabled. Parameters: boolean enabled! A boolean that indicates whether the widget should be enabled (1) or not (0). setEnableDebug public void setEnableDebug(BBjNumber enableDebug) Sets whether the BBjCalendarWidget should run in debug mode (1) or not (0), where the default is 0. When this is set to true (1), the BBjCalendarWidget will: use unminified JavaScript and CSS when possible display the debugger console in a browser when run in GUI if your !CHROMIUM_SWITCHES global string entry is properly set before instantiating the BBjCalendarWidget, as in: chromium_switches$ = stbl("!CHROMIUM_SWITCHES", "--remote-debugging-port=9223") log messages to the console from both the BBj programs and the JavaScript code Parameters: BBjNumber enableDebug A BBjNumber acting as a boolean that determines whether the BBjCalendarWidget should run in debug mode (1) or not (0). setHiddenTags public void setHiddenTags(BBjString tags!) Sets one or more optional, custom tags that determine which calendar entries should be hidden. The CalendarEntry custom class offers setTags() methods that give you the opportunity to add custom tags to any entry. After adding tags to one or more entries, you can call methods on the calendar to show or hide entries based on their tags by calling the BBjCalendarWidget::setVisibleTags() and BBjCalendarWidget::setHiddenTags() methods. This is similar to the setHiddenTags() method that takes a BBjVector except that it takes a comma-delimted string of tags for succinctness. Parameters: BBjString A comma-delimted string of tags such as "work, programming, personal". setHiddenTags public void setHiddenTags(BBjVector tags!) Sets one or more optional, custom tags that determine which calendar entries should be hidden. The CalendarEntry custom class offers setTags() methods that give you the opportunity to add custom tags to any entry. After adding tags to one or more entries, you can call methods on the calendar to show or hide entries based on their tags by calling the BBjCalendarWidget::setVisibleTags() and BBjCalendarWidget::setHiddenTags() methods. Parameters: BBjVector A vector filled with tags such as "work", "programming", "meeting", etc. setLocation public void setLocation(BBjNumber x!, BBjNumber y!) Sets the location of the calendar widget given the provided X and Y coordinates. Parameters: BBjNumber x! The widget's X coordinate. BBjNumber y! The widget's Y coordinate. setName public void setName(BBjString name!) Sets the widget's name, which can later be retrieved via the getName() method. This value is propagated to the CSS class attribute of the HTML element representing the control in BUI. Parameters: BBjString name! The widget's name. setOptions public void setOptions(CalendarOptions options!) Sets the calendar's options given an instance of the CalendarOptions class. Note: After setting the calendar's options inline (see example #1 below), you will need to call the calendar's render() method to apply the changes to the calendar in order for them to take effect. There are a couple of ways to set options for the calendar: Get and then set the desired options inline dynamically, calling the render() method afterwards to force the calendar to update with the new configuration: rem Get and then set the desired options inline dynamically, calling the render() method afterwards to force the calendar to update with the new configuration: myCal!.getOptions().setEnableEntryDurationEditable(1) myCal!.getOptions().setEnableEntryResizableFromStart(1) myCal!.getOptions().setEnableEntryStartEditable(1) myCal!.getOptions().setEnableSlotEntryOverlap(0) myCal!.render() Get the options instance, call setter methods on it, then use it to set the calendar's options: rem Get the calendar's options object, then call the desired set methods, then apply the updated options to the calendar: opts! = myCal!.getOptions() opts!.setEnableEntryDurationEditable(1) opts!.setEnableEntryResizableFromStart(1) opts!.setEnableEntryStartEditable(1) opts!.setEnableSlotEntryOverlap(0) myCal!.setOptions(opts!) Parameters: CalendarOptions options! An instance of the CalendarOptions class that has been configured with the desired settings. setPadding public void setPadding(BBjNumber padding!) Sets the padding, or spacing around the calendar control, to the same number of pixels for all four sides. Using the default index.html template, the calendar is contained within the DIV that has the class 'BBjCalendarWidgetContainer'. This method modifies the CSS for the container DIV by setting its padding to the provided padding size in pixels. Parameters: BBjNumber padding! The numeric value of the desired padding in pixels, e.g. '5' for a 5-pixel padding on all sides. setPadding public void setPadding(BBjNumber paddingTop!, BBjNumber paddingRight!, BBjNumber paddingBottom!, BBjNumber paddingLeft!) Sets the padding, or spacing around the calendar control, to the specified number of pixels for the top, right, bottom, and left sides. Using the default index.html template, the calendar is contained within the DIV that has the class 'BBjCalendarWidgetContainer'. This method modifies the CSS for the container DIV by setting its padding to the provided padding size in pixels. Parameters: BBjNumber paddingTop! The numeric value of the desired top padding in pixels, e.g. '5' for a 5-pixel padding on the top of the container. BBjNumber paddingRight! The numeric value of the desired right padding in pixels, e.g. '5' for a 5-pixel padding on the right side of the container. BBjNumber paddingBottom! The numeric value of the desired bottom padding in pixels, e.g. '5' for a 5-pixel padding on the bottom of the container. BBjNumber paddingLeft! The numeric value of the desired left in pixels, e.g. '5' for a 5-pixel padding on the left side of the container. setSize public void setSize(BBjNumber width!, BBjNumber height!) Sets the size of the calendar widget given the provided width and height. Parameters: BBjNumber width! The widget's width. BBjNumber height! The widget's height. setStyle public void setStyle(BBjString property!, BBjString style!) Sets a CSS property on the widget. Parameters: BBjString property! The CSS property name to set. BBjString style! The CSS value to be assigned to the provided CSS property. setTheme public void setTheme(BBjString theme!) Sets the calendar's theme to one of the installed Boostrap themes, which modifies the calendar's fonts and color scheme. To determine which themes are available, you can call the getThemes() method which returns a BBjVector filled with the installed theme names. Note that the installed themes are located in the BBjCalendarWidget's lib/bootstrap/themes/ directory. The installed themes are free Bootstrap themes from https://bootswatch.com/, although free Bootstrap themes are available from many other sites such as https://startbootstrap.com/themes. If you would like to add more themes, create a subdirectory under the calendar's themes directory and copy the bootstrap.css and bootstrap.min.css files in the newly-created subdirectory. The calendar will attempt to find and use the bootstrap.min.css first due to its reduced size. Parameters: BBjString theme! setUserData public void setUserData(Object userData!) Sets a custom, arbitrary object to be associated with the widget which can be retrieved later via the getUserData() method. Parameters: Object userData! The object to associate with the widget. setViewType public void setViewType(BBjString viewType!) Sets the calendar's view type. Note: Calling this method causes the calendar to change its view, which then results in a CalendarAPI.ON_CALENDAR_VIEW_CHANGE event. The provided view type should be one of the following constants: CalendarAPI.CALENDAR_VIEW_DAY_GRID_WEEK(). CalendarAPI.CALENDAR_VIEW_DAY_GRID_MONTH(). CalendarAPI.CALENDAR_VIEW_TIME_GRID_DAY(). CalendarAPI.CALENDAR_VIEW_TIME_GRID_WEEK(). CalendarAPI.CALENDAR_VIEW_LIST_DAY(). CalendarAPI.CALENDAR_VIEW_LIST_WEEK(). CalendarAPI.CALENDAR_VIEW_LIST_MONTH(). CalendarAPI.CALENDAR_VIEW_LIST_YEAR(). Parameters: BBjString viewType! The desired calendar view type, such as CalendarAPI.CALENDAR_VIEW_TIME_GRID_WEEK(). setVisible public void setVisible(boolean visible!) Sets whether the widget should be visible or hidden. Parameters: boolean visible! A boolean that indicates whether the widget should be visible (1) or not (0). setVisibleTags public void setVisibleTags(BBjString tags!) Sets one or more optional, custom tags that determine which calendar entries should be displayed. The CalendarEntry custom class offers setTags() methods that give you the opportunity to add custom tags to any entry. After adding tags to one or more entries, you can call methods on the calendar to show or hide entries based on their tags by calling the BBjCalendarWidget::setVisibleTags() and BBjCalendarWidget::setHiddenTags() methods. This is similar to the setVisibleTags() method that takes a BBjVector except that it takes a comma-delimted string of tags for succinctness. Parameters: BBjString tags! A comma-delimted string of tags such as "work, programming". setVisibleTags public void setVisibleTags(BBjVector tags!) Sets one or more optional, custom tags that determine which calendar entries should be displayed. The CalendarEntry custom class offers setTags() methods that give you the opportunity to add custom tags to any entry. After adding tags to one or more entries, you can call methods on the calendar to show or hide entries based on their tags by calling the BBjCalendarWidget::setVisibleTags() and BBjCalendarWidget::setHiddenTags() methods. Parameters: BBjVector A vector filled with tags such as "work", "programming", "meeting", etc. suppressBuiDebouncing public void suppressBuiDebouncing(BBjNumber suppress!) Supresses JavaScript debouncing for BUI. Setting this to "0" may help to improve the communication performance between BBj and the calendar in the BBjHtmlViewControl when running in BUI. Parameters: BBjNumber suppress! A BBjNumber acting as a boolean that determines whether the BBjJavaScriptExecutor should disable debouncing or not where 1=suppressDebouncing and 0=doNotSuppressDebouncing (default). See Also: #suppressDebouncing(). #suppressGuiDebouncing(). suppressDebouncing public void suppressDebouncing(BBjNumber suppress!) Supressesss JavaScript debouncing for both GUI and BUI. Parameters: BBjNumber suppress! A BBjNumber acting as a boolean that determines whether the BBjJavaScriptExecutor should disable debouncing or not where 1=suppressDebouncing and 0=doNotSuppressDebouncing (default). See Also: #suppressBuiDebouncing(). #suppressGuiDebouncing(). suppressGuiDebouncing public void suppressGuiDebouncing(BBjNumber suppress!) Supresses JavaScript debouncing when running in GUI. Setting this to "0" may help to improve the communication performance between BBj and the calendar in the BBjHtmlViewControl when running in GUI. Parameters: BBjNumber suppress! A BBjNumber acting as a boolean that determines whether the BBjJavaScriptExecutor should disable debouncing or not where 1=suppressDebouncing and 0=doNotSuppressDebouncing (default). See Also: #suppressDebouncing(). #suppressBuiDebouncing(). updateEntries public void updateEntries(JsonArray entries!) Updates several JsonObject entries in a JsonArray to the calendar at once for improved performance. This method iterates through the CalendarEntry objects and calls the same code as the updateEntry() method does. Therefore, it uses the CalendarEntry's ID (if set) or UUID (if the ID isn't set) to find the entry in the calendar. If found, it removes the old version of the entry from the calendar, then adds the new version of the entry to the calendar. Because of that, if you've registered for the CalendarAPI.ON_CALENDAR_ENTRY_ADD or CalendarAPI.ON_CALENDAR_ENTRY_REMOVE events then your callback code will executed once for each entry in the array as a result of calling this method. Parameters: JsonArray entries! A JsonArray filled with JSON objects to be added to the calendar. Since: BBj 21.12 updateEntries public void updateEntries(BBjVector entries!) Updates several entries of type CalendarEntry to the calendar at once for improved performance. This method iterates through the CalendarEntry objects and calls the same code as the updateEntry() method does. Therefore, it uses the CalendarEntry's ID (if set) or UUID (if the ID isn't set) to find the entry in the calendar. If found, it removes the old version of the entry from the calendar, then adds the new version of the entry to the calendar. Because of that, if you've registered for the CalendarAPI.ON_CALENDAR_ENTRY_ADD or CalendarAPI.ON_CALENDAR_ENTRY_REMOVE events then your callback code will executed once for each CalendarEntry in the BBjVector as a result of calling this method. Parameters: BBjVector entries! A BBjVector filled with CalendarEntry objects to be updated in the calendar. Since: BBj 21.12 updateEntry public void updateEntry(CalendarEntry entry!) Updates an entry in the calendar. This method uses the CalendarEntry's ID (if set) or UUID (if the ID isn't set) to find the entry in the calendar. If found, it removes the old version of the entry from the calendar, then adds the new version of the entry to the calendar. Because of that, if you've registered for the CalendarAPI.ON_CALENDAR_ENTRY_ADD or CalendarAPI.ON_CALENDAR_ENTRY_REMOVE events then your callback code will executed as a result of calling this method. Parameters: CalendarEntry entry! The updated CalendarEntry object Returns: BBjNumber A BBjNumber acting as a boolean that indicates whether the event was updated (1) or not (0). If the entry could not be found in the calendar, the method will return a 0. Since: BBj 21.12 updateSize public void updateSize() Forces the calendar to resize itself based on the available space in the container DIV. Using the default index.html template, the calendar is contained within the DIV that has the class 'BBjCalendarWidgetContainer'. Whenever you modify the container DIV in such a way that it affects the calendar's size, such as dynamically changing its margin CSS, you may want to call this method afterwards to cause the calendar to adjust to the new container size. Note: If you call one of the setPadding() methods then this will be executed automatically after the padding has been added to the container DIV, so this method isn't likely to be needed very often.

Interface BBjCalendarWidget

Method Summary

Method Detail

addEntries

addEntries

addEntry

addEntry

addEntrySource

addStyle

clearCallback

clearStyles

consoleLog

convertEntriesArrayToBBjVector

convertEntriesArrayToBBjVector

convertEntriesBBjVectorToJsonArray

debugLog

executeScript

executeScriptImmediately

getBackColor

getBBjVectorAsJsonArray

getControlType

getDate

getDateAsISOString

getEnableDebug

getEntries

getEntriesAsJsonArray

getEntriesWithTag

getEntriesWithTags

getEntrySourceIds

getEventDescription

getHeight

getHiddenTags

getHtmlView

getImage

getIsReady

getJsonArrayAsBBjVector

getJsonObjectAsFormattedString

getLocalTimeZoneOffsetFromUtc

getName

getOptions

getOptionsAsJsonObject

getStyle

getStyles

getThemes

getUserData

getUuid

getValidDateString

getValidDateTimeString

getValidTimeString

getViewType

getVisibleTags

getWidth

getX

getY

injectCss

injectCss

injectCssFile

injectScript

injectScriptFile

injectUrl

isEnabled

isVisible

navigateDate

navigateNext

navigateNextYear

navigatePrev

navigatePrevYear

navigateTime

navigateToday

ON_CALENDAR_DATE_CLICK

ON_CALENDAR_DATES_SET

ON_CALENDAR_DROP

ON_CALENDAR_ENTRIES_SET

ON_CALENDAR_ENTRY_ADD

ON_CALENDAR_ENTRY_CHANGE

ON_CALENDAR_ENTRY_CLICK

ON_CALENDAR_ENTRY_DRAG_START

ON_CALENDAR_ENTRY_DRAG_STOP

ON_CALENDAR_ENTRY_DROP

ON_CALENDAR_ENTRY_LEAVE