V
- type of valuepublic interface Calendar<V> extends Component.BelongToFrame, Component.HasCaption, Component.HasIcon, HasContextHelp, HasHtmlCaption, HasHtmlDescription, HasDatatype<V>, HasHtmlSanitizer
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 |
Component.Alignment, Component.BelongToFrame, Component.Disposable, Component.Editable, Component.Focusable, Component.HasCaption, Component.HasDescription, Component.HasIcon, Component.HasXmlDescriptor, Component.OptionsStyleProvider, Component.Wrapper
HasContextHelp.ContextHelpIconClickEvent
Modifier and Type | Field and Description |
---|---|
static java.lang.String |
NAME |
AUTO_SIZE, AUTO_SIZE_PX, FULL_SIZE, UNITS_PERCENTAGE, UNITS_PIXELS
Modifier and Type | Method and Description |
---|---|
Subscription |
addBackwardClickListener(java.util.function.Consumer<Calendar.CalendarBackwardClickEvent<V>> listener)
Adds a listener that is invoked when the user clicks backward navigation button.
|
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.
|
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.
|
Subscription |
addEventClickListener(java.util.function.Consumer<Calendar.CalendarEventClickEvent<V>> listener)
Adds a listener that is invoked when the user clicks on an event.
|
Subscription |
addEventMoveListener(java.util.function.Consumer<Calendar.CalendarEventMoveEvent<V>> listener)
Adds a listener that is invoked when the user changes an event position.
|
Subscription |
addEventResizeListener(java.util.function.Consumer<Calendar.CalendarEventResizeEvent<V>> listener)
Adds a listener that is invoked when the user changes an event duration.
|
Subscription |
addForwardClickListener(java.util.function.Consumer<Calendar.CalendarForwardClickEvent<V>> listener)
Adds a listener that is invoked when the user clicks forward navigation button.
|
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.
|
Subscription |
addWeekClickListener(java.util.function.Consumer<Calendar.CalendarWeekClickEvent<V>> listener)
Adds a listener that is invoked when the user clicks on a week number.
|
CollectionDatasource |
getDatasource()
Deprecated.
Use
getEventProvider() instead |
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 |
removeBackwardClickListener(java.util.function.Consumer<Calendar.CalendarBackwardClickEvent<V>> listener)
Deprecated.
Use
Subscription instead |
void |
removeDateClickListener(java.util.function.Consumer<Calendar.CalendarDateClickEvent<V>> listener)
Deprecated.
Use
Subscription instead |
void |
removeEventClickListener(java.util.function.Consumer<Calendar.CalendarEventClickEvent<V>> listener)
Deprecated.
Use
Subscription instead |
void |
removeEventMoveListener(java.util.function.Consumer<Calendar.CalendarEventMoveEvent<V>> listener)
Deprecated.
Use
Subscription instead |
void |
removeEventResizeListener(java.util.function.Consumer<Calendar.CalendarEventResizeEvent<V>> listener)
Deprecated.
Use
Subscription instead |
void |
removeForwardClickListener(java.util.function.Consumer<Calendar.CalendarForwardClickEvent<V>> listener)
Deprecated.
Use
Subscription instead |
void |
removeRangeSelectListener(java.util.function.Consumer<Calendar.CalendarRangeSelectEvent<V>> listener)
Deprecated.
Use
Subscription instead |
void |
removeWeekClickListener(java.util.function.Consumer<Calendar.CalendarWeekClickEvent<V>> listener)
Deprecated.
Use
Subscription instead |
void |
setDatasource(CollectionDatasource datasource)
Deprecated.
@deprecated Use
setEventProvider(CalendarEventProvider)
with EntityCalendarEventProvider instead |
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.
|
getFrame, setFrame
addStyleName, getAlignment, getHeight, getHeightSizeUnit, getHeightUnits, getId, getParent, getStyleName, getWidth, getWidthSizeUnit, getWidthUnits, isEnabled, isEnabledItself, isEnabledRecursive, isResponsive, isVisible, isVisibleItself, isVisibleRecursive, removeStyleName, requestFocus, setAlignment, setEnabled, setHeight, setHeightAuto, setHeightFull, setId, setParent, setResponsive, setSizeAuto, setSizeFull, setStyleName, setVisible, setWidth, setWidthAuto, setWidthFull, unwrap, unwrapComposition, unwrapCompositionOrNull, unwrapOrNull, withUnwrapped, withUnwrappedComposition
getIcon, setIcon, setIconFromSet
getContextHelpIconClickHandler, getContextHelpText, isContextHelpTextHtmlEnabled, setContextHelpIconClickHandler, setContextHelpText, setContextHelpTextHtmlEnabled
isCaptionAsHtml, setCaptionAsHtml
getCaption, setCaption
getDescription, setDescription
isDescriptionAsHtml, setDescriptionAsHtml
getDatatype, setDatatype
isHtmlSanitizerEnabled, setHtmlSanitizerEnabled
static final java.lang.String NAME
void setStartDate(V date)
V getStartDate()
void setEndDate(V date)
V getEndDate()
void setTimeZone(java.util.TimeZone zone)
java.util.TimeZone getTimeZone()
@Deprecated void setDatasource(CollectionDatasource datasource)
setEventProvider(CalendarEventProvider)
with EntityCalendarEventProvider
insteaddatasource
- a datasource to set@Nullable @Deprecated CollectionDatasource getDatasource()
getEventProvider()
insteadvoid setTimeFormat(Calendar.TimeFormat format)
Calendar.TimeFormat getTimeFormat()
void setFirstVisibleDayOfWeek(int firstDay)
int getFirstVisibleDayOfWeek()
void setLastVisibleDayOfWeek(int lastDay)
int getLastVisibleDayOfWeek()
void setFirstVisibleHourOfDay(int firstHour)
int getFirstVisibleHourOfDay()
void setLastVisibleHourOfDay(int lastHour)
int getLastVisibleHourOfDay()
void setFirstDayOfWeek(java.lang.Integer dayOfWeek)
Pass null
to use a day of week defined by current locale.
dayOfWeek
- any of java.util.Calendar.SUNDAY ... java.util.Calendar.SATURDAY
or null to revert to default first day of week by localevoid setWeeklyCaptionFormat(java.lang.String dateFormatPattern)
java.lang.String getWeeklyCaptionFormat()
void setEventProvider(CalendarEventProvider calendarEventProvider)
calendarEventProvider
- an event provider with eventsContainerCalendarEventProvider
,
EntityCalendarEventProvider
CalendarEventProvider getEventProvider()
void setNavigationButtonsVisible(boolean value)
boolean isNavigationButtonsVisible()
java.util.Map<java.time.DayOfWeek,java.lang.String> getDayNames()
DayOfWeek
values matched to localized day namesvoid setDayNames(java.util.Map<java.time.DayOfWeek,java.lang.String> dayNames)
dayNames
- DayOfWeek
values matched to localized day namesjava.util.Map<java.time.Month,java.lang.String> getMonthNames()
Month
values matched to localized month namesvoid setMonthNames(java.util.Map<java.time.Month,java.lang.String> monthNames)
monthNames
- Month
values matched to localized month namesSubscription addDateClickListener(java.util.function.Consumer<Calendar.CalendarDateClickEvent<V>> listener)
listener
- a listener to add@Deprecated void removeDateClickListener(java.util.function.Consumer<Calendar.CalendarDateClickEvent<V>> listener)
Subscription
insteadlistener
- a listener to removeSubscription addEventClickListener(java.util.function.Consumer<Calendar.CalendarEventClickEvent<V>> listener)
listener
- a listener to add@Deprecated void removeEventClickListener(java.util.function.Consumer<Calendar.CalendarEventClickEvent<V>> listener)
Subscription
insteadlistener
- a listener to removeSubscription addEventResizeListener(java.util.function.Consumer<Calendar.CalendarEventResizeEvent<V>> listener)
listener
- a listener to add@Deprecated void removeEventResizeListener(java.util.function.Consumer<Calendar.CalendarEventResizeEvent<V>> listener)
Subscription
insteadlistener
- a listener to removeSubscription addEventMoveListener(java.util.function.Consumer<Calendar.CalendarEventMoveEvent<V>> listener)
listener
- a listener to add@Deprecated void removeEventMoveListener(java.util.function.Consumer<Calendar.CalendarEventMoveEvent<V>> listener)
Subscription
insteadlistener
- a listener to removeSubscription addWeekClickListener(java.util.function.Consumer<Calendar.CalendarWeekClickEvent<V>> listener)
listener
- a listener to add@Deprecated void removeWeekClickListener(java.util.function.Consumer<Calendar.CalendarWeekClickEvent<V>> listener)
Subscription
insteadlistener
- a listener to removeSubscription addForwardClickListener(java.util.function.Consumer<Calendar.CalendarForwardClickEvent<V>> listener)
listener
- a listener to add@Deprecated void removeForwardClickListener(java.util.function.Consumer<Calendar.CalendarForwardClickEvent<V>> listener)
Subscription
insteadlistener
- a listener to removeSubscription addBackwardClickListener(java.util.function.Consumer<Calendar.CalendarBackwardClickEvent<V>> listener)
listener
- a listener to add@Deprecated void removeBackwardClickListener(java.util.function.Consumer<Calendar.CalendarBackwardClickEvent<V>> listener)
Subscription
insteadlistener
- a listener to removeSubscription addRangeSelectListener(java.util.function.Consumer<Calendar.CalendarRangeSelectEvent<V>> listener)
listener
- a listener to add@Deprecated void removeRangeSelectListener(java.util.function.Consumer<Calendar.CalendarRangeSelectEvent<V>> listener)
Subscription
insteadlistener
- a listener to removeSubscription addDayClickListener(java.util.function.Consumer<Calendar.CalendarDayClickEvent<V>> listener)
listener
- a listener to add