CalendarView

```
public interface CalendarView
```
The CalendarView is a BBj Interface that defines different calendar views and is used in combination with the BBjCalendarWidget.

See Also:
[]

Method Summary

Methods
Modifier and Type	Method and Description
`static BBjString`	`CALENDAR_VIEW_DAY_GRID_MONTH()` A constant value that defines the `dayGridMonth` (grid view for the month) calendar view.
`static BBjString`	`CALENDAR_VIEW_DAY_GRID_WEEK()` A constant value that defines the `dayGridWeek` (grid view for the week) calendar view.
`static BBjString`	`CALENDAR_VIEW_LIST_DAY()` A constant value that defines the `listDay` (agenda for the day) calendar view.
`static BBjString`	`CALENDAR_VIEW_LIST_MONTH()` A constant value that defines the `listMonth` (agenda for the month) calendar view.
`static BBjString`	`CALENDAR_VIEW_LIST_WEEK()` A constant value that defines the `listWeek` (agenda for the week) calendar view.
`static BBjString`	`CALENDAR_VIEW_LIST_YEAR()` A constant value that defines the `listYear` (agenda for the year) calendar view.
`static BBjString`	`CALENDAR_VIEW_TIME_GRID_DAY()` A constant value that defines the `timeGridDay` (time grid view for the day) calendar view.
`static BBjString`	`CALENDAR_VIEW_TIME_GRID_WEEK()` A constant value that defines the `timeGridWeek` (time grid view for the week) calendar view.
`BBjString`	`getActiveEnd()` Returns the calendar's last visible day as a date string. Note: This value is exclusive, as are all ending dates.
`BBjString`	`getActiveStart()` Returns the calendar's first visible day as a date string.
`static BBjVector`	`getAllViewTypes()` Returns a BBjVector filled with all possible calendar view types.
`BBjString`	`getAsFormattedString()` Returns a formatted, i.e. pretty-printed or beautified, stringified JsonObject representation of the CalendarView object.
`JsonObject`	`getAsJsonObject()` Returns a JsonObject representation of the calendar view object.
`BBjString`	`getAsString()` Returns a stringified JsonObject representation of the calendar view object.
`BBjString`	`getCalendarUuid()` Returns a unique ID that identifes the calendar instance to which the view belongs.
`BBjString`	`getCurrentEnd()` Returns the calendar's date that is the end of the interval the view is trying to represent. Note: This value is exclusive, as are all ending dates.
`BBjString`	`getCurrentStart()` Returns the calendar's start date of the interval the view is trying to represent.
`BBjString`	`getTitle()` Returns the view's current title, which is a property for users of the class. It's the title text that's displayed at the top of the header toolbar, such as "September 2020" or "Sep 7 - 13 2020".
`BBjString`	`getType()` Returns the calendar's view type.
`void`	`setActiveEnd(BBjString activeEndDate!)` Sets the calendar's last visible day to the provided date string. Note: This value is exclusive, as are all ending dates.
`void`	`setActiveStart(BBjString activeStartDate!)` Sets the calendar's first visible day to the provided date string. In month view, this value is often before the 1st day of the month, because most months do not begin on the first day-of-week.
`void`	`setCurrentEnd(BBjString currentEndDate!)` Sets the calendar's date that is the end of the interval the view is trying to represent. For example, in month view, this will be the day after the last day of the month. This value disregards hidden days. Note: This value is exclusive, as are all ending dates.
`void`	`setCurrentStart(BBjString currentStartDate!)` Sets the calendar's start date of the interval the view is trying to represent. For example, in month view, this will be the first of the month. This value disregards hidden days.
`void`	`setType(BBjString viewType!)` Sets the calendar's view type using one of the view type constants such as `CalendarAPI.CALENDAR_VIEW_DAY_GRID_MONTH()`, `CalendarAPI.CALENDAR_VIEW_TIME_GRID_WEEK()`, etc.

- Method Detail
  - CALENDAR_VIEW_DAY_GRID_MONTH
```
public static BBjString CALENDAR_VIEW_DAY_GRID_MONTH()
```
    A constant value that defines the dayGridMonth (grid view for the month) calendar view.
    
    Returns:
    A BBjString with the dayGridMonth calendar view style.
  - CALENDAR_VIEW_DAY_GRID_WEEK
```
public static BBjString CALENDAR_VIEW_DAY_GRID_WEEK()
```
    A constant value that defines the dayGridWeek (grid view for the week) calendar view.
    
    Returns:
    A BBjString with the dayGridWeek calendar view style.
  - CALENDAR_VIEW_LIST_DAY
```
public static BBjString CALENDAR_VIEW_LIST_DAY()
```
    A constant value that defines the listDay (agenda for the day) calendar view.
    
    Returns:
    A BBjString with the listDay calendar view style.
  - CALENDAR_VIEW_LIST_MONTH
```
public static BBjString CALENDAR_VIEW_LIST_MONTH()
```
    A constant value that defines the listMonth (agenda for the month) calendar view.
    
    Returns:
    A BBjString with the listMonth calendar view style.
  - CALENDAR_VIEW_LIST_WEEK
```
public static BBjString CALENDAR_VIEW_LIST_WEEK()
```
    A constant value that defines the listWeek (agenda for the week) calendar view.
    
    Returns:
    A BBjString with the listWeek calendar view style.
  - CALENDAR_VIEW_LIST_YEAR
```
public static BBjString CALENDAR_VIEW_LIST_YEAR()
```
    A constant value that defines the listYear (agenda for the year) calendar view.
    
    Returns:
    A BBjString with the listYear calendar view style.
  - CALENDAR_VIEW_TIME_GRID_DAY
```
public static BBjString CALENDAR_VIEW_TIME_GRID_DAY()
```
    A constant value that defines the timeGridDay (time grid view for the day) calendar view.
    
    Returns:
    A BBjString with the timeGridDay calendar view style.
  - CALENDAR_VIEW_TIME_GRID_WEEK
```
public static BBjString CALENDAR_VIEW_TIME_GRID_WEEK()
```
    A constant value that defines the timeGridWeek (time grid view for the week) calendar view.
    
    Returns:
    A BBjString with the timeGridWeek calendar view style.
  - getActiveEnd
```
public BBjString getActiveEnd()
```
    Returns the calendar's last visible day as a date string.
    
    Note: This value is exclusive, as are all ending dates.
    Returns:
    BBjString The calendar's last visible date.
    See Also:
    Date and Time Formats for information on ISO 8601 date/time formats.
  - getActiveStart
```
public BBjString getActiveStart()
```
    Returns the calendar's first visible day as a date string.
    
    Returns:
    BBjString The calendar's first visible date.
    See Also:
    Date and Time Formats for information on ISO 8601 date/time formats.
  - getAllViewTypes
```
public static BBjVector getAllViewTypes()
```
    Returns a BBjVector filled with all possible calendar view types.
    
    Returns:
    BBjVector A BBjVector filled with all possible calendar view type constants such as CalendarAPI.CALENDAR_VIEW_DAY_GRID_MONTH(), CalendarAPI.CALENDAR_VIEW_TIME_GRID_WEEK(), etc.
  - getAsFormattedString
```
public BBjString getAsFormattedString()
```
    Returns a formatted, i.e. pretty-printed or beautified, stringified JsonObject representation of the CalendarView object.
    
    Returns:
    BBjString The calendar view in formatted, stringified JSON format.
  - getAsJsonObject
```
public JsonObject getAsJsonObject()
```
    Returns a JsonObject representation of the calendar view object.
    
    Returns:
    JsonObject The calendar view in JSON format.
    See Also:
    JsonObject for information about an object in JSON format.
  - getAsString
```
public BBjString getAsString()
```
    Returns a stringified JsonObject representation of the calendar view object.
    
    Returns:
    BBjString The calendar view in stringified JSON format.
  - getCalendarUuid
```
public BBjString getCalendarUuid()
```
    Returns a unique ID that identifes the calendar instance to which the view belongs.
    
    Returns:
    BBjString The calendar instance's unique auto-generated ID that is used in the client to distinguish between instances of the class.
  - getCurrentEnd
```
public BBjString getCurrentEnd()
```
    Returns the calendar's date that is the end of the interval the view is trying to represent.
    
    Note: This value is exclusive, as are all ending dates.
    Returns:
    BBjString The calendar interval ending date.
    See Also:
    Date and Time Formats for information on ISO 8601 date/time formats.
  - getCurrentStart
```
public BBjString getCurrentStart()
```
    Returns the calendar's start date of the interval the view is trying to represent.
    
    Returns:
    BBjString The calendar interval starting date.
    See Also:
    Date and Time Formats for information on ISO 8601 date/time formats.
  - getTitle
```
public BBjString getTitle()
```
    Returns the view's current title, which is a property for users of the class. It's the title text that's displayed at the top of the header toolbar, such as "September 2020" or "Sep 7 - 13 2020".
    
    Returns:
    BBjString The calendar view's current title.
  - getType
```
public BBjString getType()
```
    Returns the calendar's view type.
    
    Returns:
    BBjString The calendar's view type that is one of the view type constants such as CalendarAPI.CALENDAR_VIEW_DAY_GRID_MONTH(), CalendarAPI.CALENDAR_VIEW_TIME_GRID_WEEK(), etc.
  - setActiveEnd
```
public void setActiveEnd(BBjString activeEndDate!)
```
    Sets the calendar's last visible day to the provided date string.
    
    Note: This value is exclusive, as are all ending dates.
    Parameters:
    BBjString activeEndDate! A date string denoting the calendar's last visible day.
    See Also:
    Date and Time Formats for information on ISO 8601 date/time formats.
  - setActiveStart
```
public void setActiveStart(BBjString activeStartDate!)
```
    Sets the calendar's first visible day to the provided date string. In month view, this value is often before the 1st day of the month, because most months do not begin on the first day-of-week.
    
    Parameters:
    BBjString activeStartDate! A date string denoting the calendar's first visible day.
    See Also:
    Date and Time Formats for information on ISO 8601 date/time formats.
  - setCurrentEnd
```
public void setCurrentEnd(BBjString currentEndDate!)
```
    Sets the calendar's date that is the end of the interval the view is trying to represent. For example, in month view, this will be the day after the last day of the month. This value disregards hidden days.
    
    Note: This value is exclusive, as are all ending dates.
    Parameters:
    BBjString currentEndDate! A date string denoting the calendar interval ending date.
    See Also:
    Date and Time Formats for information on ISO 8601 date/time formats.
  - setCurrentStart
```
public void setCurrentStart(BBjString currentStartDate!)
```
    Sets the calendar's start date of the interval the view is trying to represent. For example, in month view, this will be the first of the month. This value disregards hidden days.
    
    Parameters:
    BBjString currentStartDate! A date string denoting the calendar interval starting date.
    See Also:
    Date and Time Formats for information on ISO 8601 date/time formats.
  - setType
```
public void setType(BBjString viewType!)
```
    Sets the calendar's view type using one of the view type constants such as CalendarAPI.CALENDAR_VIEW_DAY_GRID_MONTH(), CalendarAPI.CALENDAR_VIEW_TIME_GRID_WEEK(), etc.
    
    Parameters:
    BBjString viewType! One of the view type constants such as CalendarAPI.CALENDAR_VIEW_DAY_GRID_MONTH(), CalendarAPI.CALENDAR_VIEW_TIME_GRID_WEEK(), etc.

Interface CalendarView

Method Summary

Method Detail

CALENDAR_VIEW_DAY_GRID_MONTH

CALENDAR_VIEW_DAY_GRID_WEEK

CALENDAR_VIEW_LIST_DAY

CALENDAR_VIEW_LIST_MONTH

CALENDAR_VIEW_LIST_WEEK

CALENDAR_VIEW_LIST_YEAR

CALENDAR_VIEW_TIME_GRID_DAY

CALENDAR_VIEW_TIME_GRID_WEEK

getActiveEnd

getActiveStart

getAllViewTypes

getAsFormattedString

getAsJsonObject

getAsString

getCalendarUuid

getCurrentEnd

getCurrentStart

getTitle

getType

setActiveEnd

setActiveStart

setCurrentEnd

setCurrentStart

setType