/**
 * CalendarEvents.bbj
 * @author ndecker
 *
 * The <code>CalendarEvents</code> is a BBj Interface that defines custom events for the <code>BBjCalendarWidget</code>.
 * This file is part of the <code>BBjCalendarWidget</code> plugin.
 *
 * For the full copyright and license information, please see the LICENSE.txt files distributed with this source code in the appropriate lib directory.
 *
 * @see <a href = 'https://fullcalendar.io' target = '_blank'>FullCalendar</a> for further information on the underlying JavaScript-based calendar.
 *
 * @since BBj 21.00
*/
package BBjCalendarWidget;
import com.google.gson.JsonObject;
import com.google.gson.JsonArray;
/**
 * <code>CalendarEvent</code> is a BBj Interface that contains event information for
 * a <a href = 'BBjCalendarWidget.html' target = '_blank'>BBjCalendarWidget</a>. This is
 * the base class for all <code>BBjCalendarWidget</code> events.
 *
 * @since BBj 21.00
*/
public interface CalendarEvent {
/**
 * Returns the event number that corresponds to one of the <code>CalendarAPI.ON_CALENDAR_*</code> callback constants.
 *
 * @return BBjNumber The event number that corresponds to one of the <code>CalendarAPI.ON_CALENDAR_*</code> callback constants.
*/
public BBjNumber getEventNumber() { }
/**
 * Returns a unique ID that identifes the calendar instance to which the event belongs.
 *
 * @return BBjString The calendar instance's unique auto-generated ID that is used in the client to distinguish between instances of the class.
*/
public BBjString getCalendarUuid() { }
/**
 * Returns the calendar's <code>CalendarView</code> object.
 *
 * @return CalendarView The calendar's current <code>CalendarView</code> object.
*/
public CalendarView getCalendarView() { }
/**
 * Returns a stringified JsonObject representation of the <code>CalendarEvent</code>.
 *
 * @return BBjString The <code>CalendarEvent</code> in stringified JSON format.
*/
public BBjString getAsString() { }
/**
 * Returns a formatted, i.e. pretty-printed or beautified, stringified JsonObject representation of the <code>CalendarEvent</code> object.
 *
 * @return BBjString The <code>CalendarEvent</code> in stringified JSON format.
*/
public BBjString getAsFormattedString() { }
/**
 * Returns a JsonObject representation of the <code>CalendarEvent</code>.
 *
 * @return JsonObject The <code>CalendarEvent</code> as a JsonObject.
 * @see <a href = 'https://www.javadoc.io/doc/com.google.code.gson/gson/2.8.5/com/google/gson/JsonObject.html' target = '_blank'>JsonObject</a> for information about an object in JSON format.
*/
public JsonObject getAsJsonObject() { }
}
/**
 * <code>CalendarEventWithJavaScriptEvent</code> is a BBj Interface that contains event information for
 * a <a href = 'BBjCalendarWidget.html' target = '_blank'>BBjCalendarWidget</a>. This is
 * the base class for all <code>BBjCalendarWidget</code> events that also contain the underlying native JavaScript event object.
 *
 * This interface that provides methods that simplify retreiving useful information from the underly native JavaScript event object. For example,
 * it gives developers easy access to mouse coordinates for events that have a native JavaScript event (see the hyperlinked list of qualifying events below).
 * The data in this class is technically available in the JavaScript JSON event object if you call the <code>getJsEvent()</code> method and parse the resultant JSON for the desired coordinates.
 * The purpose of this class is to simplify getting the mouse coordinates from the <code>CalendarEvent</code> instead of having to parse them out of the native JavaScript event.
 * This makes it much easier to display a popup menu as a result of a user clicking on the calendar or a calendar entry, as you would usually call the
 * BBjPopupMenu::show() method which takes a control (the calendar's control) and X and Y coordinates that are relative to the control. For example:
 * <blockquote><pre><code><div style = 'background:#E1E6EA; border:1px solid #000; border-radius:1em; padding:0 1em;'>
 *
 * <i><span style = 'color:#080;'>rem Display the popup menu based on the calendar control and the mouse's X and Y positions</span></i>
 * myPopupMenu!.show(myCal!.getHtmlView(), myEvent!.getCalendarX(), myEvent!.getCalendarY())
 * </div></code></pre></blockquote>
 *
 * This class provides the X/Y coordinates of the user's mouse for calendar events that contain such information, namely:
 * <ul>
 * <li><code><a href = 'CalendarSelectEvent.html' target = '_blank'>CalendarSelectEvent</a></code></li>
 * <li><code><a href = 'CalendarUnselectEvent.html' target = '_blank'>CalendarUnselectEvent</a></code></li>
 * <li><code><a href = 'CalendarDateClickEvent.html' target = '_blank'>CalendarDateClickEvent</a></code></li>
 * <li><code><a href = 'CalendarEntryEvent.html' target = '_blank'>CalendarEntryEvent and the classes that extend it:</a></code></li>
 * <ul>
 * <li><code><a href = 'CalendarEntryResizeEvent.html' target = '_blank'>CalendarEntryResizeEvent</a></code></li>
 * <li><code><a href = 'CalendarEntryResizeStartEvent.html' target = '_blank'>CalendarEntryResizeStartEvent</a></code></li>
 * <li><code><a href = 'CalendarEntryResizeStopEvent.html' target = '_blank'>CalendarEntryResizeStopEvent</a></code></li>
 * <li><code><a href = 'CalendarEntryDropEvent.html' target = '_blank'>CalendarEntryDropEvent</a></code></li>
 * <li><code><a href = 'CalendarEntryClickEvent.html' target = '_blank'>CalendarEntryClickEvent</a></code></li>
 * <li><code><a href = 'CalendarEntryMouseEnterEvent.html' target = '_blank'>CalendarEntryMouseEnterEvent</a></code></li>
 * <li><code><a href = 'CalendarEntryMouseLeaveEvent.html' target = '_blank'>CalendarEntryMouseLeaveEvent</a></code></li>
 * </ul>
 * </ul>
 *
 * The class parses out X/Y coordinates from the native JavaScript event for the screenX, screenY, clientX, and clientY values. It
 * also provides computed coordinates called calendarX and calendarY. This values are relative to the calendar control, and they are determined
 * by taking the mouse's clientX value and subtracting the calendar's X coordinate. This makes the X/Y values relative to the calendar
 * control instead of the screen or client area of the browser.
 *
 * @since BBj 21.12
*/
public interface CalendarEventWithJavaScriptEvent extends CalendarEvent {
/**
 * Returns the native JavaScript event for the calendar event with low-level information such as click coordinates.
 *
 * @return JsonObject Returns the native JavaScript event for the calendar event in JSON format.
 * @since BBj 21.12
*/
public JsonObject getJsEvent() { }
/**
 * Returns a stringified JsonObject representation of the native JavaScript event.
 *
 * @return BBjString The native JavaScript event in stringified JSON format.
 * @since BBj 21.12
*/
public BBjString getJsEventAsString() { }
/**
 * Returns a formatted, i.e. pretty-printed or beautified, stringified JsonObject representation of the native JavaScript event object.
 *
 * @return BBjString The native JavaScript event in stringified JSON format.
 * @since BBj 21.12
*/
public BBjString getJsEventAsFormattedString() { }
/**
 * Returns the X-coordinate of the user's mouse relative to the screen.
 * <p>
 * In the BUI and DWC clients, this value increases as the browser's position moves further right on the screen.
 * In the GUI client, this value increases as the window moves further right on the screen.
 *
 * @return BBjNumber The X-coordinate of the user's mouse relative to the screen.
 * @since BBj 21.12
*/
public BBjNumber getScreenX() { }
/**
 * Returns the Y-coordinate of the user's mouse relative to the screen.
 *
 * @return BBjNumber The Y-coordinate of the user's mouse relative to the screen.
 * @since BBj 21.12
*/
public BBjNumber getScreenY() { }
/**
 * Returns the X-coordinate of the user's mouse relative to the calendar's window.
 * <p>
 * In the BUI and DWC clients, this value increases as the windows's position moves further right on the browser.
 * In the GUI client, this value increases as the mouse moves further right on the calendar.
 *
 * @return BBjNumber The X-coordinate of the user's mouse relative to the calendar's window.
 * @since BBj 21.12
*/
public BBjNumber getClientX() { }
/**
 * Returns the Y-coordinate of the user's mouse relative to the calendar's window.
 *
 * @return BBjNumber The Y-coordinate of the user's mouse relative to the calendar's window.
 * @since BBj 21.12
*/
public BBjNumber getClientY() { }
/**
 * Returns the X-coordinate of the user's mouse relative to the calendar control. This can be used along with <code>getCalendarY()</code> to show a popup at the user's click location relative to the calendar control.
 * <p>
 * This value is calculated to be the horizontal offset of the mouse compared to the calendar control. It's technically the clientX of the mouse minus the calendar's X coordinate.
 * This method can be used to show a popup when the user clicks on the calendar or an entry in the calendar:
 * <blockquote><pre><code><div style = 'background:#E1E6EA; border:1px solid #000; border-radius:1em; padding:0 1em;'>
 *
 * <i><span style = 'color:#080;'>rem Display the popup menu based on the calendar control and the click X and Y positions</span></i>
 * myPopupMenu!.show(myCal!.getHtmlView(), myEvent!.getCalendarX(), myEvent!.getCalendarY())
 * </div></code></pre></blockquote>
 *
 * @return BBjNumber The X-coordinate of the user's mouse relative to the calendar control.
 * @since BBj 21.12
*/
public BBjNumber getCalendarX() { }
/**
 * Returns the Y-coordinate of the user's mouse relative to the calendar control. This can be used along with <code>getCalendarX()</code> to show a popup at the user's click location relative to the calendar control.
 * <p>
 * This value is calculated to be the vertical offset of the mouse compared to the calendar control. It's technically the clientY of the mouse minus the calendar's Y coordinate.
 * This method can be used to show a popup when the user mouses on the calendar or an entry in the calendar:
 * <blockquote><pre><code><div style = 'background:#E1E6EA; border:1px solid #000; border-radius:1em; padding:0 1em;'>
 *
 * <i><span style = 'color:#080;'>rem Display the popup menu based on the calendar control and the click X and Y positions</span></i>
 * myPopupMenu!.show(myCal!.getHtmlView(), myEvent!.getCalendarX(), myEvent!.getCalendarY())
 * </div></code></pre></blockquote>
 *
 * @return BBjNumber The Y-coordinate of the user's mouse relative to the calendar control.
 * @since BBj 21.12
*/
public BBjNumber getCalendarY() { }
/**
 * Returns whether the user's control key was pressed when the event occurred.
 *
 * @return BBjNumber A BBjNumber acting as a boolean that determines whether the user's control key was pressed when the event occurred.
 * @see <a href = 'https://www.w3schools.com/jsref/obj_mouseevent.asp' target = '_blank'>HTML DOM MouseEvent</a> for information about a native HTML mouse event.
 * @since BBj 21.12
*/
public BBjNumber getControlKey() { }
/**
 * Returns whether the user's shift key was pressed when the event occurred.
 *
 * @return BBjNumber A BBjNumber acting as a boolean that determines whether the user's shift key was pressed when the event occurred.
 * @see <a href = 'https://www.w3schools.com/jsref/obj_mouseevent.asp' target = '_blank'>HTML DOM MouseEvent</a> for information about a native HTML mouse event.
 * @since BBj 21.12
*/
public BBjNumber getShiftKey() { }
/**
 * Returns whether the user's alt key was pressed when the event occurred.
 *
 * @return BBjNumber A BBjNumber acting as a boolean that determines whether the user's alt key was pressed when the event occurred.
 * @see <a href = 'https://www.w3schools.com/jsref/obj_mouseevent.asp' target = '_blank'>HTML DOM MouseEvent</a> for information about a native HTML mouse event.
 * @since BBj 21.12
*/
public BBjNumber getAltKey() { }
/**
 * Returns whether the user's meta key was pressed when the event occurred.
 *
 * @return BBjNumber A BBjNumber acting as a boolean that determines whether the user's meta key was pressed when the event occurred.
 * @see <a href = 'https://www.w3schools.com/jsref/obj_mouseevent.asp' target = '_blank'>HTML DOM MouseEvent</a> for information about a native HTML mouse event.
 * @since BBj 21.12
*/
public BBjNumber getMetaKey() { }
}
/**
 * <code>CalendarReadyEvent</code> is a BBj Interface that contains event information when the calendar has been initialized and may be interacted with.
 * This data class will be made available to your custom callback routine after the calendar has initialized and
 * you have previously executed the <code><a href = 'BBjCalendarWidget.html#setCallback' target = '_blank'>BBjCalendarWidget::setCallback()</a></code>
 * method to register for the <code><a href = 'CalendarAPI.html#ON_CALENDAR_READY' target = '_blank'>CalendarAPI.ON_CALENDAR_READY</a></code> event.
*/
public interface CalendarReadyEvent extends CalendarEvent {
}
/**
 * <code>CalendarViewChangeEvent</code> is a BBj Interface that contains event information for a calendar's view change event.
 * This data class will be made available to your custom callback routine after the user changes the calendar's view type and
 * you have previously executed the <code><a href = 'BBjCalendarWidget.html#setCallback' target = '_blank'>BBjCalendarWidget::setCallback()</a></code>
 * method to register for the <code><a href = 'CalendarAPI.html#ON_CALENDAR_VIEW_CHANGE' target = '_blank'>CalendarAPI.ON_CALENDAR_VIEW_CHANGE</a></code> event.
*/
public interface CalendarViewChangeEvent extends CalendarEvent {
/**
 * Returns the native HTML element with low-level information such as content, size, and position.
 *
 * @return JsonObject Returns the native HTML element with low-level information such as content, size, and position.
 * @see <a href = 'https://www.w3schools.com/jsref/dom_obj_all.asp' target = '_blank'>HTML DOM Element Object</a> for information about a native HTML element.
*/
public JsonObject getHtmlElement() { }
}
/**
 * <code>CalendarSelectEvent</code> is a BBj Interface that contains event information after the user selects a date and/or time.
 * This data class will be made available to your custom callback routine after the user clicks on a date or time and
 * you have previously executed the <code><a href = 'BBjCalendarWidget.html#setCallback' target = '_blank'>BBjCalendarWidget::setCallback()</a></code>
 * method to register for the <code><a href = 'CalendarAPI.html#ON_CALENDAR_SELECT' target = '_blank'>CalendarAPI.ON_CALENDAR_SELECT</a></code> event.
*/
public interface CalendarSelectEvent extends CalendarEventWithJavaScriptEvent {
/**
 * Returns the calendar's selected starting date, which may include timezone information.
 *
 * @return BBjString The calendar's selected starting date, which may include timezone information.
 *
 * @see <a href = 'https://www.w3.org/TR/NOTE-datetime' target = '_blank'>Date and Time Formats</a> for information on ISO 8601 date/time formats.
*/
public BBjString getStart() { }
/**
 * Returns the calendar's ending date of the selection, which may include timezone information and is <b><i>exclusive</b></i>.
 *
 * @return BBjString The calendar's ending date of the selection, which may include timezone information and is <b><i>exclusive</b></i>.
 *
 * @see <a href = 'https://www.w3.org/TR/NOTE-datetime' target = '_blank'>Date and Time Formats</a> for information on ISO 8601 date/time formats.
*/
public BBjString getEnd() { }
/**
 * Returns the calendar's selected starting date in ISO 8601 format. Depending on what the user selected, it may or may not include a time and time zone portion.
 *
 * @return BBjString The calendar's selected starting date in ISO 8601 format. Depending on what the user selected, it may or may not include a time and time zone portion.
 *
 * @see <a href = 'https://www.w3.org/TR/NOTE-datetime' target = '_blank'>Date and Time Formats</a> for information on ISO 8601 date/time formats.
*/
public BBjString getStartString() { }
/**
 * Returns the calendar's selected ending date in ISO 8601 format and is <b><i>exclusive</b></i>. Depending on what the user selected, it may or may not include a time and time zone portion.
 *
 * @return BBjString The calendar's selected ending date in ISO 8601 format and is <b><i>exclusive</b></i>. Depending on what the user selected, it may or may not include a time and time zone portion.
 *
 * @see <a href = 'https://www.w3.org/TR/NOTE-datetime' target = '_blank'>Date and Time Formats</a> for information on ISO 8601 date/time formats.
*/
public BBjString getEndString() { }
/**
 * Returns a BBjNumber acting as a boolean that determines whether the user selected all-day cells (1) or not (0).
 *
 * @return BBjNumber A BBjNumber acting as a boolean that determines whether the user selected all-day cells.
*/
public BBjNumber getAllDay() { }
}
/**
 * <code>CalendarUnselectEvent</code> is a BBj Interface that contains event information after the user deselects a
 * previously-selected date and/or time. This data class will be made available to your custom callback routine after the
 * user clears their date/time selection if you have previously executed the
 * <code><a href = 'BBjCalendarWidget.html#setCallback' target = '_blank'>BBjCalendarWidget::setCallback()</a></code>
 * method to register for the <code><a href = 'CalendarAPI.html#ON_CALENDAR_UNSELECT' target = '_blank'>CalendarAPI.ON_CALENDAR_UNSELECT</a></code> event.
*/
public interface CalendarUnselectEvent extends CalendarEventWithJavaScriptEvent {
}
/**
 * <code>CalendarDateClickEvent</code> is a BBj Interface that contains event information after the user clicks on a date or time.
 * This data class will be made available to your custom callback routine after the user clicks on a date or time and
 * you have previously executed the <code><a href = 'BBjCalendarWidget.html#setCallback' target = '_blank'>BBjCalendarWidget::setCallback()</a></code>
 * method to register for the <code><a href = 'CalendarAPI.html#ON_CALENDAR_DATE_CLICK' target = '_blank'>CalendarAPI.ON_CALENDAR_DATE_CLICK</a></code> event.
*/
public interface CalendarDateClickEvent extends CalendarEventWithJavaScriptEvent {
/**
 * Returns the native HTML element with low-level information such as content, size, and position.
 *
 * @return JsonObject Returns the native HTML element with low-level information such as content, size, and position.
 * @see <a href = 'https://www.w3schools.com/jsref/dom_obj_all.asp' target = '_blank'>HTML DOM Element Object</a> for information about a native HTML element.
*/
public JsonObject getHtmlElement() { }
/**
 * Returns the calendar's date (day/time) that was clicked.
 *
 * @return BBjString The calendar's date (day/time) that was clicked.
*/
public BBjString getDate() { }
/**
 * Returns the calendar's date in ISO 8601 format. Depending on what the user clicked, it may or may not include a time and time zone portion.
 *
 * @return BBjString The calendar's date in ISO 8601 format. Depending on what the user clicked, it may or may not include a time and time zone portion.
 *
 * @see <a href = 'https://www.w3.org/TR/NOTE-datetime' target = '_blank'>Date and Time Formats</a> for information on ISO 8601 date/time formats.
*/
public BBjString getDateString() { }
/**
 * Returns a BBjNumber acting as a boolean that determines whether the user clicked on an all-day cell (1) or not (0).
 *
 * @return BBjNumber A BBjNumber acting as a boolean that determines whether the user clicked on an all-day cell (1) or not (0).
*/
public BBjNumber getAllDay() { }
}
/**
 * <code>CalendarDatesSetEvent</code> is a BBj Interface that contains event information after the calendar's date range
 * has been initially set or changed in some way and the DOM has been updated. The dates can also change when the
 * current-date is manipulated via the API, such as when gotoDate is called.
 * This data class will be made available to your custom callback routine after the user clicks the prev/next buttons, changes the view, clicks a navlink, etc.
 * you have previously executed the <code><a href = 'BBjCalendarWidget.html#setCallback' target = '_blank'>BBjCalendarWidget::setCallback()</a></code>
 * method to register for the <code><a href = 'CalendarAPI.html#ON_CALENDAR_DATES_SET' target = '_blank'>CalendarAPI.ON_CALENDAR_DATES_SET</a></code> event.
*/
public interface CalendarDatesSetEvent extends CalendarEvent {
/**
 * Returns the calendar's starting date for the current range.
 *
 * @return BBjString The calendar's starting date for the current range.
 *
 * @see <a href = 'https://www.w3.org/TR/NOTE-datetime' target = '_blank'>Date and Time Formats</a> for information on ISO 8601 date/time formats.
*/
public BBjString getStart() { }
/**
 * Returns the calendar's ending date for the current range.
 *
 * @return BBjString The calendar's ending date for the current range.
 *
 * @see <a href = 'https://www.w3.org/TR/NOTE-datetime' target = '_blank'>Date and Time Formats</a> for information on ISO 8601 date/time formats.
*/
public BBjString getEnd() { }
/**
 * Returns the calendar's starting date in ISO 8601 format for the current range.
 *
 * @return BBjString The calendar's starting date in ISO 8601 format.
 *
 * @see <a href = 'https://www.w3.org/TR/NOTE-datetime' target = '_blank'>Date and Time Formats</a> for information on ISO 8601 date/time formats.
*/
public BBjString getStartStr() { }
/**
 * Returns the calendar's ending date in ISO 8601 format for the current range.
 *
 * @return BBjString The calendar's ending date in ISO 8601 format.
 *
 * @see <a href = 'https://www.w3.org/TR/NOTE-datetime' target = '_blank'>Date and Time Formats</a> for information on ISO 8601 date/time formats.
*/
public BBjString getEndStr() { }
/**
 * Returns the calendar's time zone setting.
 *
 * @return BBjString A BBjString with the calendar's time zone setting.
*/
public BBjString getTimeZone() { }
}
/**
 * <code>CalendarEntriesSetEvent</code> is a BBj Interface that contains event information after the calendar's entry data
 * has been initially set or changed in some way.
 * This data class will be made available to your custom callback routine after the user clicks the prev/next buttons, changes the view, adds events, clicks a navlink, etc.
 * you have previously executed the <code><a href = 'BBjCalendarWidget.html#setCallback' target = '_blank'>BBjCalendarWidget::setCallback()</a></code>
 * method to register for the <code><a href = 'CalendarAPI.html#ON_CALENDAR_ENTRIES_SET' target = '_blank'>CalendarAPI.ON_CALENDAR_ENTRIES_SET</a></code> event.
*/
public interface CalendarEntriesSetEvent extends CalendarEvent {
/**
 * Returns the calendar's entries as a BBjVector filled with <code>CalendarEntry</code> objects.
 *
 * @return BBjVector The calendar's entries as a BBjVector filled with <code>CalendarEntry</code> objects.
*/
public BBjVector getEntries() { }
}
/**
 * <code>CalendarEntryEvent</code> is a BBj Interface that contains event information for a calendar's entry
 * (appointment, event, etc.) object. It's the base class for several calendar events that deal with the calendar's
 * entries (appointments, events, etc.) including the <code>CalendarEntryClickEvent</code>,
 * <code>CalendarEntryMouseEnterEvent</code>, and <code>CalendarEntryMouseLeaveEvent</code>.
*/
public interface CalendarEntryEvent extends CalendarEventWithJavaScriptEvent {
/**
 * Returns the entry (appointment, event, etc.) from the calendar.
 *
 * @return CalendarEntry The calendar entry (appointment, event, etc.)
*/
public CalendarEntry getCalendarEntry() { }
/**
 * Returns the native HTML element with low-level information such as content, size, and position.
 *
 * @return JsonObject Returns the native HTML element with low-level information such as content, size, and position.
 * @see <a href = 'https://www.w3schools.com/jsref/dom_obj_all.asp' target = '_blank'>HTML DOM Element Object</a> for information about a native HTML element.
*/
public JsonObject getHtmlElement() { }
}
/**
 * <code>CalendarEntryResizeEvent</code> is a BBj Interface that contains event information for a calendar's entry resize event.
 * This data class will be made available to your custom callback routine after the user finishes resizing a calendar entry
 * if you have previously executed the <code><a href = 'BBjCalendarWidget.html#setCallback' target = '_blank'>BBjCalendarWidget::setCallback()</a></code>
 * method to register for the <code><a href = 'CalendarAPI.html#ON_CALENDAR_ENTRY_RESIZE' target = '_blank'>CalendarAPI.ON_CALENDAR_ENTRY_RESIZE()</a></code> event.
*/
public interface CalendarEntryResizeEvent extends CalendarEntryEvent {
/**
 * Returns the old version of the calendar entry, e.g. the entry as it existed before the user resized it.
 *
 * @return CalendarEntry The old verison of the calendar entry, e.g. the entry as it existed before the user resized it.
*/
public CalendarEntry getOldCalendarEntry() { }
/**
 * Returns a BBjVector filled with related entries, such as recurring entries or entries with the same groupId.
 *
 * @return BBjVector a BBjVector filled with related entries, such as recurring entries or entries with the same groupId.
*/
public BBjVector getRelatedEntries() { }
/**
 * Returns the native JavaScript Duration Object as a JsonObject that represents the amount of time the entry's start date was moved by.
 *
 * @return JsonObject The native JavaScript Duration Object as a JsonObject that represents the amount of time that the entry's start date was moved.
*/
public JsonObject getStartDelta() { }
/**
 * Returns the native JavaScript Duration Object as a JsonObject that represents the amount of time the entry's end date was moved by.
 *
 * @return JsonObject The native JavaScript Duration Object as a JsonObject that represents the amount of time that the entry's end date was moved.
*/
public JsonObject getEndDelta() { }
}
/**
 * <code>CalendarEntryDropEvent</code> is a BBj Interface that contains event information for a calendar's entry drop event.
 * This data class will be made available to your custom callback routine after the user finishes repositioning a calendar entry
 * if you have previously executed the <code><a href = 'BBjCalendarWidget.html#setCallback' target = '_blank'>BBjCalendarWidget::setCallback()</a></code>
 * method to register for the <code><a href = 'CalendarAPI.html#ON_CALENDAR_ENTRY_DROP' target = '_blank'>CalendarAPI.ON_CALENDAR_ENTRY_DROP()</a></code> event.
*/
public interface CalendarEntryDropEvent extends CalendarEntryEvent {
/**
 * Returns the old version of the calendar entry, e.g. the entry as it existed before the user resized it.
 *
 * @return CalendarEntry The old verison of the calendar entry, e.g. the entry as it existed before the user resized it.
*/
public CalendarEntry getOldCalendarEntry() { }
/**
 * Returns a BBjVector filled with related entries, such as recurring entries or entries with the same groupId.
 *
 * @return BBjVector a BBjVector filled with related entries, such as recurring entries or entries with the same groupId.
*/
public BBjVector getRelatedEntries() { }
/**
 * Returns the native JavaScript Duration Object as a JsonObject that represents the amount of time the entry's date/time was moved by.
 *
 * @return JsonObject The native JavaScript Duration Object as a JsonObject that represents the amount of time that the entry was moved.
*/
public JsonObject getDelta() { }
}
/**
 * <code>CalendarEntryClickEvent</code> is a BBj Interface that contains event information for a calendar's entry click.
 * This data class will be made available to your custom callback routine after the user executes a click on a calendar entry
 * if you have previously executed the <code><a href = 'BBjCalendarWidget.html#setCallback' target = '_blank'>BBjCalendarWidget::setCallback()</a></code>
 * method to register for the <code><a href = 'CalendarAPI.html#ON_CALENDAR_ENTRY_CLICK' target = '_blank'>CalendarAPI.ON_CALENDAR_ENTRY_CLICK</a></code> event.
*/
public interface CalendarEntryClickEvent extends CalendarEntryEvent {
}
/**
 * <code>CalendarEntryMouseEnterEvent</code> is a BBj Interface that contains event information for a calendar's entry mouse enter event.
 * This data class will be made available to your custom callback routine after mouses over a calendar entry if you have previously executed
 * the <code><a href = 'BBjCalendarWidget.html#setCallback' target = '_blank'>BBjCalendarWidget::setCallback()</a></code> method to
 * register for the <code><a href = 'CalendarAPI.html#ON_CALENDAR_ENTRY_MOUSE_ENTER' target = '_blank'>CalendarAPI.ON_CALENDAR_ENTRY_MOUSE_ENTER</a></code> event.
*/
public interface CalendarEntryMouseEnterEvent extends CalendarEntryEvent {
}
/**
 * <code>CalendarEntryMouseLeaveEvent</code> is a BBj Interface that contains event information for a calendar's entry mouse leave event.
 * This data class will be made available to your custom callback routine after mouses out of a calendar entry if you have previously executed
 * the <code><a href = 'BBjCalendarWidget.html#setCallback' target = '_blank'>BBjCalendarWidget::setCallback()</a></code> method to
 * register for the <code><a href = 'CalendarAPI.html#ON_CALENDAR_ENTRY_MOUSE_LEAVE' target = '_blank'>CalendarAPI.ON_CALENDAR_ENTRY_MOUSE_LEAVE</a></code> event.
*/
public interface CalendarEntryMouseLeaveEvent extends CalendarEntryEvent {
}
/**
 * <code>CalendarEntryModificationEvent</code> is a BBj Interface that contains event information for a calendar's
 * entry (appointment, event, etc.) object. It's never instantiated as it's the base class for several calendar
 * events that deal with the calendar's entries (appointments, events, etc.) including the <code>CalendarEntryAddEvent</code>,
 * <code>CalendarEntryRemoveEvent</code>, and <code>CalendarEntryChangeEvent</code>.
*/
public interface CalendarEntryModificationEvent extends CalendarEvent {
/**
 * Returns the entry (appointment, event, etc.) from the calendar.
 *
 * @return CalendarEntry The calendar entry (appointment, event, etc.)
*/
public CalendarEntry getCalendarEntry() { }
/**
 * Returns a BBjVector filled with related entries, such as recurring entries or entries with the same groupId.
 *
 * @return BBjVector a BBjVector filled with related entries, such as recurring entries or entries with the same groupId.
*/
public BBjVector getRelatedEntries() { }
}
/**
 * <code>CalendarEntryAddEvent</code> is a BBj Interface that contains event information for when a single entry (not an event source) has
 * been added to the calendar via the <code>BBjCalendarWidget::addEntry()</code> method. This data class will be made available to your
 * custom callback routine after mouses over a calendar entry if you have previously executed the
 * <code><a href = 'BBjCalendarWidget.html#setCallback' target = '_blank'>BBjCalendarWidget::setCallback()</a></code> method to
 * register for the <code><a href = 'CalendarAPI.html#ON_CALENDAR_ENTRY_ADD' target = '_blank'>CalendarAPI.ON_CALENDAR_ENTRY_ADD</a></code> event.
*/
public interface CalendarEntryAddEvent extends CalendarEntryModificationEvent {
}
/**
 * <code>CalendarEntryRemoveEvent</code> is a BBj Interface that contains event information when an entry has been removed from the calendar.
 * This data class will be made available to your custom callback routine after mouses over a calendar entry if you have previously executed
 * the <code><a href = 'BBjCalendarWidget.html#setCallback' target = '_blank'>BBjCalendarWidget::setCallback()</a></code> method to
 * register for the <code><a href = 'CalendarAPI.html#ON_CALENDAR_ENTRY_REMOVE' target = '_blank'>CalendarAPI.ON_CALENDAR_ENTRY_REMOVE</a></code> event.
*/
public interface CalendarEntryRemoveEvent extends CalendarEntryModificationEvent {
}
/**
 * <code>CalendarEntryChangeEvent</code> is a BBj Interface that contains event information for when a calendar entry has been changed.
 * This data class will be made available to your custom callback routine after the user changes calendar entry if you have previously executed
 * the <code><a href = 'BBjCalendarWidget.html#setCallback' target = '_blank'>BBjCalendarWidget::setCallback()</a></code> method to
 * register for the <code><a href = 'CalendarAPI.html#ON_CALENDAR_ENTRY_CHANGE' target = '_blank'>CalendarAPI.ON_CALENDAR_ENTRY_CHANGE</a></code> event.
*/
public interface CalendarEntryChangeEvent extends CalendarEntryModificationEvent {
/**
 * Returns the old version of the calendar entry, e.g. the entry as it existed before the changes were applied.
 *
 * @return CalendarEntry The old verison of the calendar entry, e.g. the entry as it existed before the changes were applied.
*/
public CalendarEntry getOldCalendarEntry() { }
}
/**
 * <code>CalendarEntrySourceSuccessEvent</code> is a BBj Interface that contains event information for the case where fetching a <code>CalendarEntrySource</code> succeeded.
 * This data class will be made available to your custom callback routine after the entry source was successfully queried if you have previously executed
 * the <a href = 'BBjCalendarWidget.html#setCallback-BBjNumber-BBjString-' target = '_blank'>BBjCalendarWidget::setCallback()</a> method to
 * register for the <code><a href = 'CalendarAPI.html#ON_CALENDAR_ENTRY_SOURCE_SUCCESS' target = '_blank'>CalendarAPI.ON_CALENDAR_ENTRY_SOURCE_SUCCESS</a></code> event.
*/
public interface CalendarEntrySourceSuccessEvent extends CalendarEvent {
/**
 * Returns a BBjVector filled with <code>CalendarEntry</code> objects for all the fetched entries.
 *
 * @return BBjVector A BBjVector that filled with the fetched entries from the source.
*/
public BBjVector getEntriesFetched() { }
/**
 * Returns the number of fetched entries.
 *
 * @return JsonObject The number of entries successfully fetched from the source.
*/
public BBjNumber getNumberOfEntriesFetched() { }
}
/**
 * <code>CalendarEntrySourceFailureEvent</code> is a BBj Interface that contains event information for the case where fetching a <code>CalendarEntrySource</code> failed.
 * This data class will be made available to your custom callback routine after fetching the entry source failed if you have previously executed
 * the <a href = 'BBjCalendarWidget.html#setCallback-BBjNumber-BBjString-' target = '_blank'>BBjCalendarWidget::setCallback()</a> method to
 * register for the <code><a href = 'CalendarAPI.html#ON_CALENDAR_ENTRY_SOURCE_FAILURE' target = '_blank'>CalendarAPI.ON_CALENDAR_ENTRY_SOURCE_FAILURE</a></code> event.
*/
public interface CalendarEntrySourceFailureEvent extends CalendarEvent {
/**
 * Returns a the error message associate with the fetching failure.
 *
 * @return BBjString A BBjString with the information associated with the fetching error.
*/
public BBjString getErrorMessage() { }
}