io.jmix.ui.component

Interface Calendar<V>

Type Parameters:

V - type of value

All Superinterfaces:

Component, Component.BelongToFrame, Component.HasCaption, Component.HasDescription, Component.HasIcon, HasContextHelp, HasDatatype<V>, HasHtmlCaption, HasHtmlDescription, HasHtmlSanitizer

All Known Implementing Classes:

CalendarImpl

@StudioComponent(caption="Calendar",
                 category="Components",
                 xmlElement="calendar",
                 icon="io/jmix/ui/icon/component/calendar.svg",
                 canvasBehaviour=CALENDAR,
                 documentationURL="https://docs.jmix.io/jmix/%VERSION%/backoffice-ui/vcl/components/calendar.html")
public interface Calendar<V>
extends Component.BelongToFrame, Component.HasCaption, Component.HasIcon, HasContextHelp, HasHtmlCaption, HasHtmlDescription, HasDatatype<V>, HasHtmlSanitizer

Calendar is used for visualizing events in a calendar using week or month view.

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	Calendar.CalendarBackwardClickEvent<V> An event object that is fired when the user clicks backward navigation button.
static class	Calendar.CalendarDateClickEvent<V> An event object that is fired when the user clicks on a day number of the month.
static class	Calendar.CalendarDayClickEvent<V> An event object that is fired when the user clicks on an empty space in the day.
static class	Calendar.CalendarEventClickEvent<V> An event object that is fired when the user clicks on an event.
static class	Calendar.CalendarEventMoveEvent<V> An event object that is fired when the user changes an event position.
static class	Calendar.CalendarEventResizeEvent<V> An event object that is fired when the user changes an event duration.
static class	Calendar.CalendarForwardClickEvent<V> An event object that is fired when the user clicks forward navigation button.
static class	Calendar.CalendarRangeSelectEvent<V> An event object that is fired when the user drag-marks day or time cells using mouse.
static class	Calendar.CalendarWeekClickEvent<V> An event object that is fired when the user clicks on a week number.
static class	Calendar.TimeFormat

Nested classes/interfaces inherited from interface io.jmix.ui.component.Component

Component.Alignment, Component.BelongToFrame, Component.Disposable, Component.Editable, Component.Focusable, Component.HasCaption, Component.HasDescription, Component.HasIcon, Component.HasXmlDescriptor, Component.Wrapper

Nested classes/interfaces inherited from interface io.jmix.ui.component.HasContextHelp

HasContextHelp.ContextHelpIconClickEvent

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	NAME

Fields inherited from interface io.jmix.ui.component.Component

AUTO_SIZE, AUTO_SIZE_PX, FULL_SIZE

Method Summary

Modifier and Type	Method and Description
io.jmix.core.common.event.Subscription	addBackwardClickListener(java.util.function.Consumer<Calendar.CalendarBackwardClickEvent<V>> listener) Adds a listener that is invoked when the user clicks backward navigation button.
io.jmix.core.common.event.Subscription	addDateClickListener(java.util.function.Consumer<Calendar.CalendarDateClickEvent<V>> listener) Adds a listener that is invoked when the user clicks on a day number of the month.
io.jmix.core.common.event.Subscription	addDayClickListener(java.util.function.Consumer<Calendar.CalendarDayClickEvent<V>> listener) Adds a listener that is invoked when the user clicks on an empty space in the day.
io.jmix.core.common.event.Subscription	addEventClickListener(java.util.function.Consumer<Calendar.CalendarEventClickEvent<V>> listener) Adds a listener that is invoked when the user clicks on an event.
io.jmix.core.common.event.Subscription	addEventMoveListener(java.util.function.Consumer<Calendar.CalendarEventMoveEvent<V>> listener) Adds a listener that is invoked when the user changes an event position.
io.jmix.core.common.event.Subscription	addEventResizeListener(java.util.function.Consumer<Calendar.CalendarEventResizeEvent<V>> listener) Adds a listener that is invoked when the user changes an event duration.
io.jmix.core.common.event.Subscription	addForwardClickListener(java.util.function.Consumer<Calendar.CalendarForwardClickEvent<V>> listener) Adds a listener that is invoked when the user clicks forward navigation button.
io.jmix.core.common.event.Subscription	addRangeSelectListener(java.util.function.Consumer<Calendar.CalendarRangeSelectEvent<V>> listener) Adds a listener that is invoked when the user drag-marks day or time cells using mouse.
io.jmix.core.common.event.Subscription	addWeekClickListener(java.util.function.Consumer<Calendar.CalendarWeekClickEvent<V>> listener) Adds a listener that is invoked when the user clicks on a week number.
java.util.Map<java.time.DayOfWeek,java.lang.String>	getDayNames()
V	getEndDate()
CalendarEventProvider	getEventProvider()
int	getFirstVisibleDayOfWeek()
int	getFirstVisibleHourOfDay()
int	getLastVisibleDayOfWeek()
int	getLastVisibleHourOfDay()
java.util.Map<java.time.Month,java.lang.String>	getMonthNames()
V	getStartDate()
Calendar.TimeFormat	getTimeFormat()
java.util.TimeZone	getTimeZone()
java.lang.String	getWeeklyCaptionFormat()
boolean	isNavigationButtonsVisible()
void	setDayNames(java.util.Map<java.time.DayOfWeek,java.lang.String> dayNames) Sets localized Calendar day names.
void	setEndDate(V date) Set end date for the calendar's range.
void	setEventProvider(CalendarEventProvider calendarEventProvider) Set the calendar event provider.
void	setFirstDayOfWeek(java.lang.Integer dayOfWeek) Allows setting first day of week independent of Locale.
void	setFirstVisibleDayOfWeek(int firstDay) Set first day of the week to show.
void	setFirstVisibleHourOfDay(int firstHour) Set first hour of the day to show.
void	setLastVisibleDayOfWeek(int lastDay) Set last day of the week to show.
void	setLastVisibleHourOfDay(int lastHour) Set last hour of the day to show.
void	setMonthNames(java.util.Map<java.time.Month,java.lang.String> monthNames) Sets localized Calendar month names.
void	setNavigationButtonsVisible(boolean value) Set visibility for the backward and forward buttons.
void	setStartDate(V date) Set start date for the calendar range.
void	setTimeFormat(Calendar.TimeFormat format) Set format for time.
void	setTimeZone(java.util.TimeZone zone) Set timezone.
void	setWeeklyCaptionFormat(java.lang.String dateFormatPattern) Set date caption format for the weekly view.

Methods inherited from interface io.jmix.ui.component.Component.BelongToFrame

getFrame, setFrame

Methods inherited from interface io.jmix.ui.component.Component

addStyleName, getAlignment, getHeight, getHeightSizeUnit, getId, getParent, getStyleName, getWidth, getWidthSizeUnit, isEnabled, isEnabledRecursive, isResponsive, isVisible, isVisibleRecursive, removeStyleName, setAlignment, setEnabled, setHeight, setHeightAuto, setHeightFull, setId, setParent, setResponsive, setSizeAuto, setSizeFull, setStyleName, setVisible, setWidth, setWidthAuto, setWidthFull, unwrap, unwrapComposition, unwrapCompositionOrNull, unwrapOrNull, withUnwrapped, withUnwrappedComposition

Methods inherited from interface io.jmix.ui.component.Component.HasIcon

getIcon, setIcon, setIconFromSet

Methods inherited from interface io.jmix.ui.component.HasContextHelp

getContextHelpIconClickHandler, getContextHelpText, isContextHelpTextHtmlEnabled, setContextHelpIconClickHandler, setContextHelpText, setContextHelpTextHtmlEnabled

Methods inherited from interface io.jmix.ui.component.HasHtmlCaption

isCaptionAsHtml, setCaptionAsHtml

Methods inherited from interface io.jmix.ui.component.Component.HasCaption

getCaption, setCaption

Methods inherited from interface io.jmix.ui.component.Component.HasDescription

getDescription, setDescription

Methods inherited from interface io.jmix.ui.component.HasHtmlDescription

isDescriptionAsHtml, setDescriptionAsHtml

Methods inherited from interface io.jmix.ui.component.HasDatatype

getDatatype, setDatatype

Methods inherited from interface io.jmix.ui.component.HasHtmlSanitizer

isHtmlSanitizerEnabled, setHtmlSanitizerEnabled

Field Detail

NAME

static final java.lang.String NAME

See Also:

Constant Field Values

Method Detail

setStartDate

@StudioProperty(name="startDate",
                type=DATE)
void setStartDate(@Nullable
                                                                               V date)

Set start date for the calendar range.

getStartDate

@Nullable
V getStartDate()

Returns:

the start date for the calendar range.

setEndDate

@StudioProperty(name="endDate",
                type=DATE)
void setEndDate(@Nullable
                                                                           V date)

Set end date for the calendar's range.

getEndDate

@Nullable
V getEndDate()

Returns:

the last date for the calendar range.

setTimeZone

void setTimeZone(java.util.TimeZone zone)

Set timezone.

getTimeZone

java.util.TimeZone getTimeZone()

Returns:

timezone.

setTimeFormat

@StudioProperty(name="timeFormat",
                type=ENUMERATION,
                defaultValue="24H",
                options={"12H","24H"})
void setTimeFormat(Calendar.TimeFormat format)

Set format for time. 12H/24H.

getTimeFormat

Calendar.TimeFormat getTimeFormat()

Returns:

enumeration of ite format.

setFirstVisibleDayOfWeek

@StudioProperty(name="firstVisibleDayOfWeek",
                defaultValue="1")
 @Min(value=1L)
 @Max(value=7L)
void setFirstVisibleDayOfWeek(int firstDay)

Set first day of the week to show.

getFirstVisibleDayOfWeek

int getFirstVisibleDayOfWeek()

Returns:

first showed day of the week.

setLastVisibleDayOfWeek

@StudioProperty(name="lastVisibleDayOfWeek",
                defaultValue="7")
 @Min(value=1L)
 @Max(value=7L)
void setLastVisibleDayOfWeek(int lastDay)

Set last day of the week to show.

getLastVisibleDayOfWeek

int getLastVisibleDayOfWeek()

Returns:

last showed day of the week.

setFirstVisibleHourOfDay

@StudioProperty(name="firstVisibleHourOfDay",
                defaultValue="0")
 @Min(value=0L)
 @Max(value=23L)
void setFirstVisibleHourOfDay(int firstHour)

Set first hour of the day to show.

getFirstVisibleHourOfDay

int getFirstVisibleHourOfDay()

Returns:

first showed hour of the day.

setLastVisibleHourOfDay

@StudioProperty(name="lastVisibleHourOfDay",
                defaultValue="23")
 @Min(value=0L)
 @Max(value=23L)
void setLastVisibleHourOfDay(int lastHour)

Set last hour of the day to show.

getLastVisibleHourOfDay

int getLastVisibleHourOfDay()

Returns:

last showed hour of the day.

setFirstDayOfWeek

void setFirstDayOfWeek(java.lang.Integer dayOfWeek)

Allows setting first day of week independent of Locale.

Pass null to use a day of week defined by current locale.

Parameters:

dayOfWeek - any of java.util.Calendar.SUNDAY ... java.util.Calendar.SATURDAY or null to revert to default first day of week by locale

setWeeklyCaptionFormat

@StudioProperty(name="weeklyCaptionFormat",
                type=DATE_FORMAT)
void setWeeklyCaptionFormat(java.lang.String dateFormatPattern)

Set date caption format for the weekly view.

getWeeklyCaptionFormat

java.lang.String getWeeklyCaptionFormat()

Returns:

date pattern of captions.

setEventProvider

void setEventProvider(@Nullable
                      CalendarEventProvider calendarEventProvider)

Set the calendar event provider. Provider can contain calendar events.

Parameters:

calendarEventProvider - an event provider with events

See Also:

ContainerCalendarEventProvider

getEventProvider

CalendarEventProvider getEventProvider()

Returns:

calendar event provider.

setNavigationButtonsVisible

@StudioProperty(name="navigationButtonsVisible",
                defaultValue="false")
void setNavigationButtonsVisible(boolean value)

Set visibility for the backward and forward buttons.

isNavigationButtonsVisible

boolean isNavigationButtonsVisible()

Returns:

backward and forward buttons visibility.

getDayNames

java.util.Map<java.time.DayOfWeek,java.lang.String> getDayNames()

Returns:

DayOfWeek values matched to localized day names

setDayNames

void setDayNames(java.util.Map<java.time.DayOfWeek,java.lang.String> dayNames)

Sets localized Calendar day names.

Parameters:

dayNames - DayOfWeek values matched to localized day names

getMonthNames

java.util.Map<java.time.Month,java.lang.String> getMonthNames()

Returns:

Month values matched to localized month names

setMonthNames

void setMonthNames(java.util.Map<java.time.Month,java.lang.String> monthNames)

Sets localized Calendar month names.

Parameters:

monthNames - Month values matched to localized month names

addDateClickListener

io.jmix.core.common.event.Subscription addDateClickListener(java.util.function.Consumer<Calendar.CalendarDateClickEvent<V>> listener)

Adds a listener that is invoked when the user clicks on a day number of the month.

Parameters:

listener - a listener to add

Returns:

a registration object for removing an event listener

addEventClickListener

io.jmix.core.common.event.Subscription addEventClickListener(java.util.function.Consumer<Calendar.CalendarEventClickEvent<V>> listener)

Adds a listener that is invoked when the user clicks on an event.

Parameters:

listener - a listener to add

Returns:

a registration object for removing an event listener

addEventResizeListener

io.jmix.core.common.event.Subscription addEventResizeListener(java.util.function.Consumer<Calendar.CalendarEventResizeEvent<V>> listener)

Adds a listener that is invoked when the user changes an event duration.

Parameters:

listener - a listener to add

Returns:

a registration object for removing an event listener

addEventMoveListener

io.jmix.core.common.event.Subscription addEventMoveListener(java.util.function.Consumer<Calendar.CalendarEventMoveEvent<V>> listener)

Adds a listener that is invoked when the user changes an event position.

Parameters:

listener - a listener to add

Returns:

a registration object for removing an event listener

addWeekClickListener

io.jmix.core.common.event.Subscription addWeekClickListener(java.util.function.Consumer<Calendar.CalendarWeekClickEvent<V>> listener)

Adds a listener that is invoked when the user clicks on a week number.

Parameters:

listener - a listener to add

Returns:

a registration object for removing an event listener

addForwardClickListener

io.jmix.core.common.event.Subscription addForwardClickListener(java.util.function.Consumer<Calendar.CalendarForwardClickEvent<V>> listener)

Adds a listener that is invoked when the user clicks forward navigation button.

Parameters:

listener - a listener to add

Returns:

a registration object for removing an event listener

addBackwardClickListener

io.jmix.core.common.event.Subscription addBackwardClickListener(java.util.function.Consumer<Calendar.CalendarBackwardClickEvent<V>> listener)

Adds a listener that is invoked when the user clicks backward navigation button.

Parameters:

listener - a listener to add

Returns:

a registration object for removing an event listener

addRangeSelectListener

io.jmix.core.common.event.Subscription addRangeSelectListener(java.util.function.Consumer<Calendar.CalendarRangeSelectEvent<V>> listener)

Adds a listener that is invoked when the user drag-marks day or time cells using mouse.

Parameters:

listener - a listener to add

Returns:

a registration object for removing an event listener

addDayClickListener

io.jmix.core.common.event.Subscription addDayClickListener(java.util.function.Consumer<Calendar.CalendarDayClickEvent<V>> listener)

Adds a listener that is invoked when the user clicks on an empty space in the day.

Parameters:

listener - a listener to add

Returns:

a registration object for removing an event listener