Package io.jmix.fullcalendarflowui.component.event

Class DisplayModeInfo

java.lang.Object

io.jmix.fullcalendarflowui.component.event.DisplayModeInfo

public class DisplayModeInfo
extends Object

Class contains information about a calendar's display mode, such as a date range.

Field Summary

Fields

Modifier and Type	Field	Description
protected final LocalDate	activeEnd
protected final LocalDate	activeStart
protected final LocalDate	currentEnd
protected final LocalDate	currentStart
protected final CalendarDisplayMode	displayMode

Constructor Summary

Constructors

Constructor	Description
DisplayModeInfo(LocalDate activeStart, LocalDate activeEnd, LocalDate currentStart, LocalDate currentEnd, CalendarDisplayMode displayMode)

Method Summary

Modifier and Type	Method	Description
LocalDate	getActiveEndDate()	Returns a date that is the last visible day.
LocalDate	getActiveStartDate()	Returns a date that is the first visible day.
LocalDate	getCurrentEndDate()	Returns a date that marks the end of the interval represented by the display mode.
LocalDate	getCurrentStartDate()	Returns a date that marks the beginning of the interval represented by the display mode.
CalendarDisplayMode	getDisplayMode()

Methods inherited from class java.lang.Object

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

Field Details

activeStart

protected final LocalDate activeStart

activeEnd

protected final LocalDate activeEnd

currentStart

protected final LocalDate currentStart

currentEnd

protected final LocalDate currentEnd

displayMode

protected final CalendarDisplayMode displayMode

Constructor Details

DisplayModeInfo

public DisplayModeInfo(LocalDate activeStart,
 LocalDate activeEnd,
 LocalDate currentStart,
 LocalDate currentEnd,
 CalendarDisplayMode displayMode)

Method Details

getActiveStartDate

public LocalDate getActiveStartDate()

Returns a date that is the first visible day. In month display mode, this value is often before the first day of the month, because most months do not begin on the first day-of-week.

Returns:

a date that is the first visible day

getActiveEndDate

public LocalDate getActiveEndDate()

Returns a date that is the last visible day.

Note, this value is exclusive.

Returns:

a date that is the last visible day

getCurrentStartDate

public LocalDate getCurrentStartDate()

Returns a date that marks the beginning of the interval represented by the display mode. For example, in month mode, this will be the first day of the month. This value disregards hidden days.

Returns:

a date that marks the beginning of the interval represented by the display mode

getCurrentEndDate

public LocalDate getCurrentEndDate()

Returns a date that marks the end of the interval represented by the display mode.

Note, this value is exclusive. For example, in month mode, this will be the day after the last day of the month. This value disregards hidden days.

Returns:

a date that marks the end of the interval represented by the display mode

getDisplayMode

public CalendarDisplayMode getDisplayMode()

Returns:

current calendar's display mode