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.
Modifier and Type | Method and Description |
---|---|
BBjString | getAsFormattedString() Returns a formatted, i.e. pretty-printed or beautified, stringified JsonObject representation of the |
JsonObject | getAsJsonObject() Returns the options object as a JsonObject. |
BBjString | getAsString() Returns a stringified JsonObject representation of the |
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
Note that if you create a |
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.
Note: Colors may be specified using any valid CSS color syntax, so |
void | setBorderColor(BBjString borderColor!) Sets the source's entry border color.
Note: Colors may be specified using any valid CSS color syntax, so |
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.
Note: Colors may be specified using any valid CSS color syntax, so |
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. This overrides the calendar's master EntryDisplay option for this specific entry. The display style may be one of the following constants:
|
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. This overrides the calendar's master EnableEditable option for this specific entry. |
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.
Note: Colors may be specified using any valid CSS color syntax, so |
void | setUrl(BBjString url!) Sets the source's URL parameter. |
public BBjString getAsFormattedString()
Returns a formatted, i.e. pretty-printed or beautified, stringified JsonObject representation of the CalendarEntrySource
object.
CalendarEntrySource
in formatted stringified JSON format.public JsonObject getAsJsonObject()
Returns the options object as a JsonObject.
CalendarEntrySource
object as a JsonObject. JsonObject for information about an object in JSON format.
public BBjString getAsString()
Returns a stringified JsonObject representation of the CalendarEntrySource
object.
CalendarEntrySource
object in stringified JSON format.public BBjString getBackgroundColor()
Returns the source's entry background color.
public BBjString getBorderColor()
Returns the source's entry border color.
public BBjString getClassName()
Returns the source's entry class name string.
public BBjString getColor()
Returns the source's entry combined background and border color.
public BBjString getDescription()
Returns a source's extended information that can be used to further describe the source.
public BBjString getDisplay()
Returns the source's display style.
public 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).
public BBjNumber getEnableEditable()
Returns the source's entry editable status that determines if the entry can be modified by the user.
public BBjNumber getEnableOverlap()
Returns whether the source's entries being dragged and resized are allowed to overlap one other (1) or not (0).
public 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).
public 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.
public BBjString getTextColor()
Returns the source's entry text color.
public BBjString getUrl()
Returns the source's URL parameter.
public void setBackgroundColor(BBjString backgroundColor!)
Sets the source's entry background color.
Note: Colors may be specified using any valid CSS color syntax, so "red"
, "rgb(255, 0, 0)"
, "#ff0000"
, "#f00"
, "hsl(0, 100%, 50%)"
, and all forms of those formats that include an alpha channel are valid methods of denoting the color red.
BBjString
backgroundColor! A string that contains the color for the entry's background.public void setBorderColor(BBjString borderColor!)
Sets the source's entry border color.
Note: Colors may be specified using any valid CSS color syntax, so "red"
, "rgb(255, 0, 0)"
, "#ff0000"
, "#f00"
, "hsl(0, 100%, 50%)"
, and all forms of those formats that include an alpha channel are valid methods of denoting the color red.
BBjString
borderColor! A string that contains the color for the entry's border.public void setClassName(BBjString className!)
Sets the source's entry class name string (or CSS style).
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.public void setColor(BBjString color!)
Sets the source's entry combined background and border color.
Note: Colors may be specified using any valid CSS color syntax, so "red"
, "rgb(255, 0, 0)"
, "#ff0000"
, "#f00"
, "hsl(0, 100%, 50%)"
, and all forms of those formats that include an alpha channel are valid methods of denoting the color red.
BBjString
color! A string that contains the color for the entry's background and border.public void setDescription(BBjString description!)
Sets the source's extended information that can be used to further describe the source.
BBjString
description! A string that's used to further describe the source.public 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.BBjString
display! A constant that denotes the desired entry display style.public 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).
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.public 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.
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.public 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.
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).public 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).
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.public void setTextColor(BBjString textColor!)
Sets the source's entry text color.
Note: Colors may be specified using any valid CSS color syntax, so "red"
, "rgb(255, 0, 0)"
, "#ff0000"
, "#f00"
, "hsl(0, 100%, 50%)"
, and all forms of those formats that include an alpha channel are valid methods of denoting the color red.
BBjString
textColor! A string that contains the color for the entry's text.public void setUrl(BBjString url!)
Sets the source's URL parameter.
BBjString
url! A BBjString filled with the URL for the entry source.