Package io.jmix.fullcalendarflowui.kit.component.model

Class CustomCalendarDisplayMode

java.lang.Object

io.jmix.fullcalendarflowui.kit.component.model.option.CalendarOption

io.jmix.fullcalendarflowui.kit.component.model.AbstractCalendarDisplayModeProperties

io.jmix.fullcalendarflowui.kit.component.model.CustomCalendarDisplayMode

All Implemented Interfaces:

Serializable

public class CustomCalendarDisplayMode
extends AbstractCalendarDisplayModeProperties

Custom calendar display mode properties. It enables to create new display mode with custom date range and use it along with other display modes. If a date range is not specified it can be managed by JmixFullCalendar.setVisibleRange(LocalDate, LocalDate).

See Also:

• Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class io.jmix.fullcalendarflowui.kit.component.model.option.CalendarOption

CalendarOption.OptionChangeEvent

Field Summary

Fields

Modifier and Type	Field	Description
protected CalendarDisplayMode	baseDisplayMode
protected Integer	dayCount
protected CalendarDisplayMode	displayMode
protected CalendarDuration	duration

Fields inherited from class io.jmix.fullcalendarflowui.kit.component.model.AbstractCalendarDisplayModeProperties

properties

Fields inherited from class io.jmix.fullcalendarflowui.kit.component.model.option.CalendarOption

dirty, eventBus, name

Constructor Summary

Constructors

Constructor	Description
CustomCalendarDisplayMode(String id)	Creates new instance of custom display mode with the specified ID.
CustomCalendarDisplayMode(String id, @Nullable CalendarDisplayMode baseDisplayMode)	Creates new instance of custom display mode with the specified ID and base display mode: GenericCalendarDisplayModes.

Method Summary

Modifier and Type	Method	Description
CalendarDisplayMode	getBaseDisplayMode()
@Nullable Integer	getDayCount()
CalendarDisplayMode	getDisplayMode()
@Nullable CalendarDuration	getDuration()
void	setDayCount(@Nullable Integer dayCount)	Sets the exact number of days displayed in a custom display mode, regardless of JmixFullCalendar.isWeekendsVisible() or hidden days.
void	setDuration(@Nullable CalendarDuration duration)	Sets the exact duration of a custom display mode.
CustomCalendarDisplayMode	withDayCount(@Nullable Integer dayCount)	Sets the exact number of days displayed in a custom display mode, regardless of JmixFullCalendar.isWeekendsVisible() or hidden days.
CustomCalendarDisplayMode	withDuration(@Nullable CalendarDuration duration)	Sets the exact duration of a custom display mode.

Methods inherited from class io.jmix.fullcalendarflowui.kit.component.model.AbstractCalendarDisplayModeProperties

addProperty, getProperties, removeProperty

Methods inherited from class io.jmix.fullcalendarflowui.kit.component.model.option.CalendarOption

addChangeListener, fireChangeEvent, getName, getValueToSerialize, isDirty, markAsDirty, unmarkAsDirty

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details

displayMode

protected CalendarDisplayMode displayMode

baseDisplayMode

protected CalendarDisplayMode baseDisplayMode

duration

protected CalendarDuration duration

dayCount

protected Integer dayCount

Constructor Details

CustomCalendarDisplayMode

public CustomCalendarDisplayMode(String id)

Creates new instance of custom display mode with the specified ID. The created custom display mode will be based on GenericCalendarDisplayModes.DAY_GRID.

Parameters:

id - ID to pass

CustomCalendarDisplayMode

public CustomCalendarDisplayMode(String id,
 @Nullable CalendarDisplayMode baseDisplayMode)

Creates new instance of custom display mode with the specified ID and base display mode: GenericCalendarDisplayModes.

Parameters:

id - ID to pass

baseDisplayMode - the display mode to base on

Method Details

getDisplayMode

public CalendarDisplayMode getDisplayMode()

Returns:

calendar display mode object from the ID

getBaseDisplayMode

public CalendarDisplayMode getBaseDisplayMode()

Returns:

the type of custom calendar display mode

getDuration

public @Nullable CalendarDuration getDuration()

setDuration

public void setDuration(@Nullable CalendarDuration duration)

Sets the exact duration of a custom display mode.

Takes precedence over the setDayCount(Integer).

Parameters:

duration - the duration to set

withDuration

public CustomCalendarDisplayMode withDuration(@Nullable CalendarDuration duration)

Sets the exact duration of a custom display mode. See setDuration(CalendarDuration).

Parameters:

duration - the duration to set

Returns:

current instance of custom display mode

getDayCount

public @Nullable Integer getDayCount()

setDayCount

public void setDayCount(@Nullable Integer dayCount)

Sets the exact number of days displayed in a custom display mode, regardless of JmixFullCalendar.isWeekendsVisible() or hidden days.

Parameters:

dayCount - day count to set

withDayCount

public CustomCalendarDisplayMode withDayCount(@Nullable Integer dayCount)

Sets the exact number of days displayed in a custom display mode, regardless of JmixFullCalendar.isWeekendsVisible() or hidden days. See setDayCount(Integer).

Parameters:

dayCount - day count to set

Returns:

current instance of custom display mode