BBjCalendarWidget

Interface CalendarToolbarSection

public interface CalendarToolbarSection

The CalendarToolbarSection is a BBj Custom Class that defines a section (start, center, end) of the CalendarToolbar. There are three possible alignments, or positions, for the section that include:

• CalendarAPI.CALENDAR_TOOLBAR_ALIGNMENT_START() - The left-most section of the toolbar (in LeftToRight mode).
• CalendarAPI.CALENDAR_TOOLBAR_ALIGNMENT_CENTER() - The center section of the toolbar.
• CalendarAPI.CALENDAR_TOOLBAR_ALIGNMENT_END() - The right-most section of the toolbar (in LeftToRight mode).

See Also:

FullCalendar Toolbar for further information on the toolbar.

Method Summary

Modifier and Type	Method and Description
BBjString	getAlignment() Returns the section's horizontal alignement as one of the three possible alignments constants.
BBjString	getAsFormattedString() Returns a formatted, i.e.
JsonObject	getAsJsonObject() Returns the component's JSON representation.
BBjString	getAsString() Returns a stringified JsonObject representation of CalendarToolbarSection object.
void	setAlignment(BBjString alignment!) Sets the section's horizontal alignement to one of the three possible alignments, or positions, for the section that include: CalendarAPI.CALENDAR_TOOLBAR_ALIGNMENT_START() - The left-most section of the toolbar (in LeftToRight mode). CalendarAPI.CALENDAR_TOOLBAR_ALIGNMENT_CENTER() - The center section of the toolbar. CalendarAPI.CALENDAR_TOOLBAR_ALIGNMENT_END() - The right-most section of the toolbar (in LeftToRight mode).
CalendarToolbarSection	setObjects(BBjString objects!) Sets the objects to be included in this toolbar section via a comma-separated list of string values like CalendarAPI.CALENDAR_TOOLBAR_OBJECT_*.
CalendarToolbarSection	setObjects(BBjVector objects!) Sets the objects to be included in this toolbar section via a list of string values like CalendarAPI.CALENDAR_TOOLBAR_OBJECT_* contained in a BBjVector.

Method Detail

setAlignment

void setAlignment(BBjString alignment!)

Sets the section's horizontal alignement to one of the three possible alignments, or positions, for the section that include:

• CalendarAPI.CALENDAR_TOOLBAR_ALIGNMENT_START() - The left-most section of the toolbar (in LeftToRight mode).
• CalendarAPI.CALENDAR_TOOLBAR_ALIGNMENT_CENTER() - The center section of the toolbar.
• CalendarAPI.CALENDAR_TOOLBAR_ALIGNMENT_END() - The right-most section of the toolbar (in LeftToRight mode).

Parameters:

BBjString - alignment! A BBjString that is one of the three possible alignment constants.

getAlignment

BBjString getAlignment()

Returns the section's horizontal alignement as one of the three possible alignments constants.

Returns:

BBjString A BBjString that is one of the three possible alignment constants.

setObjects

CalendarToolbarSection setObjects(BBjString objects!)

Sets the objects to be included in this toolbar section via a comma-separated list of string values like CalendarAPI.CALENDAR_TOOLBAR_OBJECT_*.

Note: If you choose to set the toolbar section objects via a BBjVector see the other setObjects() method.

Parameters:

BBjString - objects! A comma-separated list of objects to include in the section, like CalendarAPI.CALENDAR_TOOLBAR_OBJECT_*.

Returns:

CalendarToolbarSection The CalendarToolbarSection instance, so that method chaining is possible.

setObjects

CalendarToolbarSection setObjects(BBjVector objects!)

Sets the objects to be included in this toolbar section via a list of string values like CalendarAPI.CALENDAR_TOOLBAR_OBJECT_* contained in a BBjVector.

Note: If you choose to set the toolbar section objects via a BBjString see the other setObjects() method.

Parameters:

BBjVector - objects! A BBjVector filled with a list of objects to include in the section, like CalendarAPI.CALENDAR_TOOLBAR_OBJECT_*

Returns:

CalendarToolbarSection The CalendarToolbarSection instance, so that method chaining is possible.

getAsJsonObject

JsonObject getAsJsonObject()

Returns the component's JSON representation.

Returns:

JsonObject The toolbar's component as a JsonObject.

See Also:

JsonObject for information about an object in JSON format.

getAsString

BBjString getAsString()

Returns a stringified JsonObject representation of CalendarToolbarSection object.

Returns:

BBjString The CalendarToolbarSection object in stringified JSON format.

getAsFormattedString

BBjString getAsFormattedString()

Returns a formatted, i.e. pretty-printed or beautified, stringified JsonObject representation of the CalendarToolbarSection object.

Returns:

BBjString The CalendarToolbarSection in stringified JSON format.