CalendarEntrySource

All Known Subinterfaces:

CalendarEntrySourceGoogle, CalendarEntrySourceiCalendar
```
public interface CalendarEntrySource
```
CalendarEntrySource is a BBj Custom Class that defines entry feeds for the BBjCalendarWidget and serves as a base class for more specific entry sources such as the CalendarEntrySourceGoogle and CalendarEntrySourceiCalendar classes.
Entry source feeds are a way to add multiple calendar entries to the calendar at once from a source like a public Google calendar, a web service that provides entries in JSON format, an iCalendar (ICS) file or document, etc.

Since:

BBj 21.00

See Also:

FullCalendar for further information on the underlying JavaScript-based calendar, eventSources for information on the FullCalendar eventSources, events from Google Calendar for information integrating Google Calendars with the FullCalendar library, Google Calendar API for information about creating a Google developer account and creating an API key, events from an iCalendar feed for information integrating iCalendars with the FullCalendar library, https://icalendar.org/ for information on the iCalendar specification

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method and Description
`BBjString`	`getAsFormattedString()` Returns a formatted, i.e.
`JsonObject`	`getAsJsonObject()` Returns the options object as a JsonObject.
`BBjString`	`getAsString()` Returns a stringified JsonObject representation of the `CalendarEntrySource` object.
`BBjString`	`getBackgroundColor()` Returns the source's entry background color.
`BBjString`	`getBorderColor()` Returns the source's entry border color.
`BBjString`	`getClassName()` Returns the source's entry class name string.
`BBjString`	`getColor()` Returns the source's entry combined background and border color.
`BBjString`	`getDescription()` Returns a source's extended information that can be used to further describe the source.
`BBjString`	`getDisplay()` Returns the source's display style.
`BBjNumber`	`getEnableDurationEditable()` Returns the source's entry duration editable status that determines if the source's entry duration can be modified by the user by dragging (resizing).
`BBjNumber`	`getEnableEditable()` Returns the source's entry editable status that determines if the entry can be modified by the user.
`BBjNumber`	`getEnableOverlap()` Returns whether the source's entries being dragged and resized are allowed to overlap one other (1) or not (0).
`BBjNumber`	`getEnableStartEditable()` Returns the source's entry start time editable status that determines if the entry's start time can be modified by the user by dragging (resizing).
`BBjString`	`getId()` Returns the source's unique ID that identifes the entry source for later use, such as with the `getEntrySourceById()` method.
`BBjString`	`getTextColor()` Returns the source's entry text color.
`BBjString`	`getUrl()` Returns the source's URL parameter.
`void`	`setBackgroundColor(BBjString backgroundColor!)` Sets the source's entry background color.
`void`	`setBorderColor(BBjString borderColor!)` Sets the source's entry border color.
`void`	`setClassName(BBjString className!)` Sets the source's entry class name string (or CSS style).
`void`	`setColor(BBjString color!)` Sets the source's entry combined background and border color.
`void`	`setDescription(BBjString description!)` Sets the source's extended information that can be used to further describe the source.
`void`	`setDisplay(BBjString display!)` Sets a source's alternate rendering style.
`void`	`setEnableDurationEditable(BBjNumber durationEditable!)` Sets the source's entry duration editable status that determines if the source's entry duration can be modified by the user by dragging (resizing).
`void`	`setEnableEditable(BBjNumber editable!)` Sets the source's entry editable status that determines if the entry can be modified by the user.
`void`	`setEnableOverlap(BBjNumber overlap!)` Sets whether the source's entries being dragged and resized are allowed to overlap one other (1) or not (0), where the default value is 1.
`void`	`setEnableStartEditable(BBjNumber startEditable!)` Sets the source's entry start time editable status that determines if the source's entry start time can be modified by the user by dragging (resizing).
`void`	`setTextColor(BBjString textColor!)` Sets the source's entry text color.
`void`	`setUrl(BBjString url!)` Sets the source's URL parameter.

- Method Detail
  - getId
```
BBjString getId()
```
    Returns the source's unique ID that identifes the entry source for later use, such as with the getEntrySourceById() method.
    Note that if you create a CalendarEntrySource with a constructor that doesn't take any parameters then the ID will be set automatically. If you wish to specify the ID, you should use the constructor that takes an ID as a parameter.
    
    Returns:
    
    BBjString The entry source's unique ID.
  - setUrl
```
void setUrl(BBjString url!)
```
    Sets the source's URL parameter.
    
    Parameters:
    
    BBjString - url! A BBjString filled with the URL for the entry source.
  - getUrl
```
BBjString getUrl()
```
    Returns the source's URL parameter.
    
    Returns:
    
    BBjString A BBjString filled with the URL for the entry source.
  - setBackgroundColor
```
void setBackgroundColor(BBjString backgroundColor!)
```
    Sets the source's entry background color.
    Colors may be specified as any valid CSS color, so "red", "rgb(255, 0, 0)", "#ff0000", "#f00", "hsl(0, 100%, 50%)", and all the versions of those formats that include an alpha channel are valid ways of specifying the color red.
    
    Parameters:
    
    BBjString - backgroundColor! A string that contains the color for the entry's background.
  - getBackgroundColor
```
BBjString getBackgroundColor()
```
    Returns the source's entry background color.
    
    Returns:
    
    BBjString The entry's entry's background color.
  - setBorderColor
```
void setBorderColor(BBjString borderColor!)
```
    Sets the source's entry border color.
    Colors may be specified as any valid CSS color, so "red", "rgb(255, 0, 0)", "#ff0000", "#f00", "hsl(0, 100%, 50%)", and all the versions of those formats that include an alpha channel are valid ways of specifying the color red.
    
    Parameters:
    
    BBjString - borderColor! A string that contains the color for the entry's border.
  - getBorderColor
```
BBjString getBorderColor()
```
    Returns the source's entry border color.
    
    Returns:
    
    BBjString The entry's border color.
  - setTextColor
```
void setTextColor(BBjString textColor!)
```
    Sets the source's entry text color.
    Colors may be specified as any valid CSS color, so "red", "rgb(255, 0, 0)", "#ff0000", "#f00", "hsl(0, 100%, 50%)", and all the versions of those formats that include an alpha channel are valid ways of specifying the color red.
    
    Parameters:
    
    BBjString - textColor! A string that contains the color for the entry's text.
  - getTextColor
```
BBjString getTextColor()
```
    Returns the source's entry text color.
    
    Returns:
    
    BBjString The entry's text color.
  - setColor
```
void setColor(BBjString color!)
```
    Sets the source's entry combined background and border color.
    Colors may be specified as any valid CSS color, so "red", "rgb(255, 0, 0)", "#ff0000", "#f00", "hsl(0, 100%, 50%)", and all the versions of those formats that include an alpha channel are valid ways of specifying the color red.
    
    Parameters:
    
    BBjString - color! A string that contains the color for the entry's background and border.
  - getColor
```
BBjString getColor()
```
    Returns the source's entry combined background and border color.
    
    Returns:
    
    BBjString The entry's combined background and border color.
  - setClassName
```
void setClassName(BBjString className!)
```
    Sets the source's entry class name string (or CSS style).
    
    Parameters:
    
    BBjString - className! A string that contains a class name string (or CSS style), such as "myclass1", that determines the HTML class that's associated with the entry.
  - getClassName
```
BBjString getClassName()
```
    Returns the source's entry class name string.
    
    Returns:
    
    BBjString The entry's a class name string.
  - setEnableOverlap
```
void setEnableOverlap(BBjNumber overlap!)
```
    Sets whether the source's entries being dragged and resized are allowed to overlap one other (1) or not (0), where the default value is 1.
    
    Parameters:
    
    BBjNumber - enableOverlap A BBjNumber acting as a boolean that determines whether entries being dragged and resized are allowed to overlap one other (1) or not (0).
  - getEnableOverlap
```
BBjNumber getEnableOverlap()
```
    Returns whether the source's entries being dragged and resized are allowed to overlap one other (1) or not (0).
    
    Returns:
    
    BBjNumber A BBjNumber acting as a boolean that indicates whether entries being dragged and resized are allowed to overlap one other (1) or not (0).
  - setDescription
```
void setDescription(BBjString description!)
```
    Sets the source's extended information that can be used to further describe the source.
    
    Parameters:
    
    BBjString - description! A string that's used to further describe the source.
  - getDescription
```
BBjString getDescription()
```
    Returns a source's extended information that can be used to further describe the source.
    
    Returns:
    
    BBjString The source's description.
  - setDisplay
```
void setDisplay(BBjString display!)
```
    Sets a source's alternate rendering style. This overrides the calendar's master EntryDisplay option for this specific entry.
    The display style may be one of the following constants:
    - CalendarAPI.CALENDAR_ENTRY_DISPLAY_AUTO() - (default) When in daygrid, renders the event as a solid rectangle if it is all-day or multi-day. If a timed event, will render it with a dot. When in other views, will render normally.
    - CalendarAPI.CALENDAR_ENTRY_DISPLAY_BLOCK() - When in daygrid, renders the event as a solid rectangle. When in other views, will render normally.
    - CalendarAPI.CALENDAR_ENTRY_DISPLAY_LIST_ITEM() - When in daygrid, renders the event with a dot. When in other views, will render normally.
    - CalendarAPI.CALENDAR_ENTRY_DISPLAY_BACKGROUND() - Highlights the background of the entry's container.
    - CalendarAPI.CALENDAR_ENTRY_DISPLAY_INVERSE_BACKGROUND() - Hightlights the spans of time not occupied by an entry, or the opposite of the background.
    - CalendarAPI.CALENDAR_ENTRY_DISPLAY_NONE() - Disables the rendering of the event.
    Parameters:
    
    BBjString - display! A constant that denotes the desired entry display style.
  - getDisplay
```
BBjString getDisplay()
```
    Returns the source's display style.
    
    Returns:
    
    BBjString The source's display style.
  - setEnableEditable
```
void setEnableEditable(BBjNumber editable!)
```
    Sets the source's entry editable status that determines if the entry can be modified by the user. This overrides the calendar's master EnableEditable option for this specific entry.
    
    Parameters:
    
    BBjNumber - editable! A BBjNumber acting as a boolean that indicates whether the source's entries can be modified by the user, where 1 = editable and 0 = read-only.
  - getEnableEditable
```
BBjNumber getEnableEditable()
```
    Returns the source's entry editable status that determines if the entry can be modified by the user.
    
    Returns:
    
    BBjNumber A BBjNumber acting as a boolean that indicates whether the source's entry editable status, where 1 = editable and 0 = read-only.
  - setEnableStartEditable
```
void setEnableStartEditable(BBjNumber startEditable!)
```
    Sets the source's entry start time editable status that determines if the source's entry start time can be modified by the user by dragging (resizing).
    
    Parameters:
    
    BBjNumber - startEditable! A BBjNumber acting as a boolean that indicates whether the source's entry starting time can be modified by the user, where 1 = editable and 0 = not editable.
  - getEnableStartEditable
```
BBjNumber getEnableStartEditable()
```
    Returns the source's entry start time editable status that determines if the entry's start time can be modified by the user by dragging (resizing).
    
    Returns:
    
    BBjNumber A BBjNumber acting as a boolean that indicates whether the sources entry starting time can be modified by the user, where 1 = editable and 0 = not editable.
  - setEnableDurationEditable
```
void setEnableDurationEditable(BBjNumber durationEditable!)
```
    Sets the source's entry duration editable status that determines if the source's entry duration can be modified by the user by dragging (resizing).
    
    Parameters:
    
    BBjNumber - durationEditable! A BBjNumber acting as a boolean that indicates whether the source's entry duration can be modified by the user, where 1 = editable and 0 = not editable.
  - getEnableDurationEditable
```
BBjNumber getEnableDurationEditable()
```
    Returns the source's entry duration editable status that determines if the source's entry duration can be modified by the user by dragging (resizing).
    
    Returns:
    
    BBjNumber A BBjNumber acting as a boolean that indicates whether the source's entry duration can be modified by the user, where 1 = editable and 0 = not editable.
  - getAsJsonObject
```
JsonObject getAsJsonObject()
```
    Returns the options object as a JsonObject.
    
    Returns:
    
    JsonObject The CalendarEntrySource object as a JsonObject.
    
    See Also:
    
    JsonObject for information about an object in JSON format.
  - getAsString
```
BBjString getAsString()
```
    Returns a stringified JsonObject representation of the CalendarEntrySource object.
    
    Returns:
    
    BBjString The CalendarEntrySource object in stringified JSON format.
  - getAsFormattedString
```
BBjString getAsFormattedString()
```
    Returns a formatted, i.e. pretty-printed or beautified, stringified JsonObject representation of the CalendarEntrySource object.
    
    Returns:
    
    BBjString The CalendarEntrySource in formatted stringified JSON format.

Interface CalendarEntrySource

Method Summary

Method Detail

getId

setUrl

getUrl

setBackgroundColor

getBackgroundColor

setBorderColor

getBorderColor

setTextColor

getTextColor

setColor

getColor

setClassName

getClassName

setEnableOverlap

getEnableOverlap

setDescription

getDescription

setDisplay

getDisplay

setEnableEditable

getEnableEditable

setEnableStartEditable

getEnableStartEditable

setEnableDurationEditable

getEnableDurationEditable

getAsJsonObject

getAsString

getAsFormattedString