Serialized Form

Package org.vaadin.addons.componentfactory.schedulexcalendar

Class org.vaadin.addons.componentfactory.schedulexcalendar.BaseScheduleXCalendar

class BaseScheduleXCalendar extends com.vaadin.flow.component.html.Div implements Serializable

Serialized Fields

calendarRendered

boolean calendarRendered

calendars

Map<String,Calendar> calendars

Map of calendar IDs to their configuration. The key will be used as the JS object key on the client.

configuration

Configuration configuration

Optional global calendar configuration settings.

container

com.vaadin.flow.component.html.Div container

Div containing the calendar.

dataProvider

com.vaadin.flow.data.provider.CallbackDataProvider<Event,EventQueryFilter> dataProvider

refreshRegistration

com.vaadin.flow.shared.Registration refreshRegistration

view

ViewType view

Current calendar view being shown.

views

List<? extends ViewType> views

Views available to the user.

Class org.vaadin.addons.componentfactory.schedulexcalendar.BaseScheduleXCalendar.CalendarEventAddedEvent

class CalendarEventAddedEvent extends com.vaadin.flow.component.ComponentEvent<BaseScheduleXCalendar> implements Serializable

Serialized Fields

eventId

String eventId

Class org.vaadin.addons.componentfactory.schedulexcalendar.BaseScheduleXCalendar.CalendarEventClickEvent

class CalendarEventClickEvent extends com.vaadin.flow.component.ComponentEvent<BaseScheduleXCalendar> implements Serializable

Serialized Fields

end

LocalDateTime end

eventId

String eventId

start

LocalDateTime start

Class org.vaadin.addons.componentfactory.schedulexcalendar.BaseScheduleXCalendar.CalendarEventRemovedEvent

class CalendarEventRemovedEvent extends com.vaadin.flow.component.ComponentEvent<BaseScheduleXCalendar> implements Serializable

Serialized Fields

eventId

String eventId

Class org.vaadin.addons.componentfactory.schedulexcalendar.BaseScheduleXCalendar.CalendarEventUpdatedEvent

class CalendarEventUpdatedEvent extends com.vaadin.flow.component.ComponentEvent<BaseScheduleXCalendar> implements Serializable

Serialized Fields

eventId

String eventId

Class org.vaadin.addons.componentfactory.schedulexcalendar.BaseScheduleXCalendar.CalendarViewAndDateChangeEvent

class CalendarViewAndDateChangeEvent extends com.vaadin.flow.component.ComponentEvent<BaseScheduleXCalendar> implements Serializable

Serialized Fields

selectedDate

LocalDate selectedDate

viewType

ViewType viewType

Class org.vaadin.addons.componentfactory.schedulexcalendar.BaseScheduleXCalendar.EventUpdateEvent

class EventUpdateEvent extends com.vaadin.flow.component.ComponentEvent<BaseScheduleXCalendar> implements Serializable

Serialized Fields

endDate

LocalDateTime endDate

eventId

String eventId

startDate

LocalDateTime startDate

Class org.vaadin.addons.componentfactory.schedulexcalendar.BaseScheduleXCalendar.SelectedDateUpdateEvent

class SelectedDateUpdateEvent extends com.vaadin.flow.component.ComponentEvent<BaseScheduleXCalendar> implements Serializable

Serialized Fields

selectedDate

LocalDate selectedDate

Class org.vaadin.addons.componentfactory.schedulexcalendar.Configuration

class Configuration extends org.vaadin.addons.componentfactory.schedulexcalendar.BaseConfiguration implements Serializable

Serialized Fields

currentTimeIndicatorConfig

Configuration.CurrentTimeIndicatorConfig currentTimeIndicatorConfig

dayBoundaries

Configuration.DayBoundaries dayBoundaries

defaultView

ViewType defaultView

The preferred view to display when the calendar is first rendered. all views that you import have a "name" property, which helps you identify them. Defaults to the first view in the "views" list.

dragAndDropInterval

TimeInterval dragAndDropInterval

Time interval that can be configured for drag and drop of an event.

Available values are 15 (default), 30 and 60.

drawOptions

Configuration.DrawOptions drawOptions

firstDayOfWeek

Integer firstDayOfWeek

Set which day is to be considered the starting day of the week. 0 = Sunday, 1 = Monday, (...other days) 6 = Saturday Defaults to 1 (Monday)

iCal

Configuration.ICal iCal

isDark

boolean isDark

Render the calendar in dark mode. Defaults to false.

isResponsive

boolean isResponsive

Toggle automatic view change when the calendar is resized below a certain width breakpoint. Defaults to true.

locale

Locale locale

Set the language. List of supported languages: https://schedule-x.dev/docs/calendar/language Defaults to 'en-US'.

maxDate

LocalDate maxDate

The maximum date that can be displayed.

minDate

LocalDate minDate

The minimum date that can be displayed.

monthGridOptions

Configuration.MonthGridOptions monthGridOptions

resizeInterval

TimeInterval resizeInterval

Time interval that can be configured for event resizing.

Available values are 15 (default), 30 and 60.

scrollControllerConfig

Configuration.ScrollControllerConfig scrollControllerConfig

selectedDate

LocalDate selectedDate

The default date to display when the calendar is first rendered. Only accepts YYYY-MM-DD format. Defaults to the current date.

showWeekNumbers

boolean showWeekNumbers

Display week numbers. Not 100% according to ISO 8601, which considers a week to start on Monday and end on Sunday. Since Schedule-X enables to configure the first day of the week, the week numbers are calculated based on that.

skipValidation

boolean skipValidation

Skip validating events when initializing the calendar. This can help you gain a bit of performance if you are loading a lot of events, and you are sure that the events are valid.

weekOptions

Configuration.WeekOptions weekOptions

Class org.vaadin.addons.componentfactory.schedulexcalendar.Configuration.CurrentTimeIndicatorConfig

class CurrentTimeIndicatorConfig extends org.vaadin.addons.componentfactory.schedulexcalendar.BaseConfigurationSection implements Serializable

Serialized Fields

fullWeekWidth

Boolean fullWeekWidth

Whether the indicator should be displayed in the full width of the week. Defaults to false

timeZoneOffset

Integer timeZoneOffset

Time zone offset in minutes. Can be any offset valid according to UTC (-720 to 840).

Class org.vaadin.addons.componentfactory.schedulexcalendar.Configuration.DayBoundaries

class DayBoundaries extends org.vaadin.addons.componentfactory.schedulexcalendar.BaseConfigurationSection implements Serializable

Serialized Fields

end

LocalTime end

start

LocalTime start

Class org.vaadin.addons.componentfactory.schedulexcalendar.Configuration.DrawOptions

class DrawOptions extends org.vaadin.addons.componentfactory.schedulexcalendar.BaseConfigurationSection implements Serializable

Serialized Fields

defaultTitle

String defaultTitle

Default title to use when drawing an event.

snapDrawDuration

TimeInterval snapDrawDuration

Time interval that can be configured, in minutes, at which a time grid-event can be drawn. Valid values: 15, 30, 60

Class org.vaadin.addons.componentfactory.schedulexcalendar.Configuration.ICal

class ICal extends Object implements Serializable

Serialized Fields

iCal

String iCal

iCalendar source.

Class org.vaadin.addons.componentfactory.schedulexcalendar.Configuration.MonthGridOptions

class MonthGridOptions extends org.vaadin.addons.componentfactory.schedulexcalendar.BaseConfigurationSection implements Serializable

Serialized Fields

nEventsPerDay

Integer nEventsPerDay

Number of events to display in a day cell before the "+ N events" button is shown.

Class org.vaadin.addons.componentfactory.schedulexcalendar.Configuration.ScrollControllerConfig

class ScrollControllerConfig extends org.vaadin.addons.componentfactory.schedulexcalendar.BaseConfigurationSection implements Serializable

Serialized Fields

initialScroll

LocalTime initialScroll

Initial scroll value.

Class org.vaadin.addons.componentfactory.schedulexcalendar.Configuration.WeekOptions

class WeekOptions extends org.vaadin.addons.componentfactory.schedulexcalendar.BaseConfigurationSection implements Serializable

Serialized Fields

eventOverlap

boolean eventOverlap

Determines whether concurrent events can overlap. Defaults to true. Set to false to disable overlapping.

eventWidth

Integer eventWidth

The width in percentage of the event element in the week grid. Defaults to 100, but can be used to leave a small margin to the right of the event.

gridHeight

Integer gridHeight

The total height in px of the week grid (week and day views).

nDays

Integer nDays

The number of days to display in week view.

timeAxisFormatOptions

Map<String,String> timeAxisFormatOptions

Intl.DateTimeFormatOptions used to format the hour labels on the time axis.

Default: { hour: 'numeric' }.

Example: { hour: '2-digit', minute: '2-digit' }.

Class org.vaadin.addons.componentfactory.schedulexcalendar.ResourceSchedulerConfig

class ResourceSchedulerConfig extends org.vaadin.addons.componentfactory.schedulexcalendar.BaseConfiguration implements Serializable

Serialized Fields

dayWidth

Integer dayWidth

Width of a column in the daily view.

dragAndDrop

boolean dragAndDrop

Whether drag and drop should be enabled.

eventHeight

Integer eventHeight

Height of an event.

hourWidth

Integer hourWidth

Width of a column in the hourly view.

infiniteScroll

boolean infiniteScroll

Whether infinite scroll should be enabled.

initialDays

com.vaadin.flow.internal.Pair<LocalDate,LocalDate> initialDays

Optionally sets the initially displayed days in the daily view.

initialHours

com.vaadin.flow.internal.Pair<LocalDateTime,LocalDateTime> initialHours

Optionally sets the initially displayed hours in the hourly view.

resize

boolean resize

Whether resizing should be enabled.

resourceHeight

Integer resourceHeight

Height of a resource row.

resources

List<Resource> resources

List of resources to display.

Class org.vaadin.addons.componentfactory.schedulexcalendar.ScheduleXCalendar

class ScheduleXCalendar extends BaseScheduleXCalendar implements Serializable

Serialized Fields

drawnEventValidationCallback

ScheduleXCalendar.DrawnEventValidationCallback drawnEventValidationCallback

Class org.vaadin.addons.componentfactory.schedulexcalendar.ScheduleXCalendar.CalendarEventDrawnEvent

class CalendarEventDrawnEvent extends com.vaadin.flow.component.ComponentEvent<BaseScheduleXCalendar> implements Serializable

Serialized Fields

event

Event event

Class org.vaadin.addons.componentfactory.schedulexcalendar.ScheduleXResourceScheduler

class ScheduleXResourceScheduler extends BaseScheduleXCalendar implements Serializable

Serialized Fields

resourceSchedulerConfig

ResourceSchedulerConfig resourceSchedulerConfig

schedulingAssistantConfig

SchedulingAssistantConfig schedulingAssistantConfig

Class org.vaadin.addons.componentfactory.schedulexcalendar.ScheduleXResourceScheduler.SchedulingAssistantUpdateEvent

class SchedulingAssistantUpdateEvent extends com.vaadin.flow.component.ComponentEvent<ScheduleXResourceScheduler> implements Serializable

Serialized Fields

currentEnd

String currentEnd

currentStart

String currentStart

hasCollision

boolean hasCollision

Class org.vaadin.addons.componentfactory.schedulexcalendar.SchedulingAssistantConfig

class SchedulingAssistantConfig extends org.vaadin.addons.componentfactory.schedulexcalendar.BaseConfiguration implements Serializable

Serialized Fields

initialEnd

LocalDateTime initialEnd

initialStart

LocalDateTime initialStart

Package org.vaadin.addons.componentfactory.schedulexcalendar.model

Class org.vaadin.addons.componentfactory.schedulexcalendar.model.Calendar

class Calendar extends Object implements Serializable

Serialized Fields

colorName

String colorName

Used internally as a CSS part (lowercase, no spaces).

darkColors

Calendar.ColorDefinition darkColors

Optional colors for dark theme.

lightColors

Calendar.ColorDefinition lightColors

Optional colors for light theme.

Class org.vaadin.addons.componentfactory.schedulexcalendar.model.Calendar.ColorDefinition

class ColorDefinition extends Object implements Serializable

Serialized Fields

container

String container

main

String main

onContainer

String onContainer

Class org.vaadin.addons.componentfactory.schedulexcalendar.model.Event

class Event extends Object implements Serializable

Serialized Fields

calendarId

String calendarId

Id of the calendar. This is the calendarId which links to a specific calendar (e.g., "work", "leisure"). See Calendar

customContent

Event.EventCustomContent customContent

description

String description

A description of the event.

end

LocalDateTime end

The end date time of the event.

excludedDates

List<LocalDateTime> excludedDates

List of date-times to be excluded from the recurrence set.

id

String id

A unique identifier for the event.

location

String location

The location of the event.

options

Event.EventOptions options

people

List<String> people

Names of the participants.

recurrenceRule

RecurrenceRule recurrenceRule

The recurrence rule for the events if applicable.

resourceId

String resourceId

Id of the resource, only for Resource View

start

LocalDateTime start

The start date time of the event.

title

String title

The title of the event.

Class org.vaadin.addons.componentfactory.schedulexcalendar.model.Event.EventCustomContent

class EventCustomContent extends Object implements Serializable

Serialized Fields

dateGrid

String dateGrid

Custom HTML to display in the date grid of week/day views.

monthAgenda

String monthAgenda

Custom HTML to display in the month agenda view.

monthGrid

String monthGrid

Custom HTML to display in the month view.

timeGrid

String timeGrid

Custom HTML to display in the time grid of week/day views.

Class org.vaadin.addons.componentfactory.schedulexcalendar.model.Event.EventOptions

class EventOptions extends Object implements Serializable

Serialized Fields

additionalClasses

List<String> additionalClasses

Additional classes to add to the event.

disableDND

Boolean disableDND

Disables drag and drop for the event.

disableResize

Boolean disableResize

Disables resizing for the event.

Class org.vaadin.addons.componentfactory.schedulexcalendar.model.EventQuery

class EventQuery extends com.vaadin.flow.data.provider.Query<Event,EventQueryFilter> implements Serializable

Class org.vaadin.addons.componentfactory.schedulexcalendar.model.RecurrenceRule

class RecurrenceRule extends Object implements Serializable

Serialized Fields

byDay

List<RecurrenceRule.Day> byDay

The BYDAY rule part specifies a COMMA-separated list of days of the week; SU indicates Sunday; MO indicates Monday; TU indicates Tuesday; WE indicates Wednesday; TH indicates Thursday; FR indicates Friday; and SA indicates Saturday.

Compatible with Frequency.DAILY and Frequency.WEEKLY

byMonthDay

List<Integer> byMonthDay

The BYMONTHDAY rule part specifies a COMMA-separated list of days of the month.

Compatible with Frequency.MONTHLY

count

Integer count

The COUNT rule part defines the number of occurrences at which to range-bound the recurrence.

freq

RecurrenceRule.Frequency freq

The FREQ rule part identifies the type of recurrence rule. This rule part MUST be specified in the recurrence rule.

interval

Integer interval

The INTERVAL rule part contains a positive integer representing at which intervals the recurrence rule repeats.

until

RecurrenceRule.Until until

wkst

RecurrenceRule.Day wkst

The WKST rule part specifies the day on which the workweek starts. Valid values are MO, TU, WE, TH, FR, SA, and SU.

Class org.vaadin.addons.componentfactory.schedulexcalendar.model.RecurrenceRule.Until

class Until extends Object implements Serializable

Serialized Fields

date

LocalDate date

time

LocalTime time

Class org.vaadin.addons.componentfactory.schedulexcalendar.model.Resource

class Resource extends Object implements Serializable

Serialized Fields

colorName

String colorName

darkColors

Calendar.ColorDefinition darkColors

id

String id

isOpen

boolean isOpen

label

String label

labelHtml

String labelHtml

lightColors

Calendar.ColorDefinition lightColors

resources

List<Resource> resources