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

Class DayGridYearProperties

java.lang.Object

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

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

io.jmix.fullcalendarflowui.kit.component.model.AbstractDayGridProperties

io.jmix.fullcalendarflowui.kit.component.model.DayGridYearProperties

All Implemented Interfaces:

Serializable

public class DayGridYearProperties
extends AbstractDayGridProperties

Configuration properties of day-grid year display mode CalendarDisplayModes.DAY_GRID_YEAR.

The properties can be retrieved from JmixFullCalendar.getCalendarDisplayModeProperties(CalendarDisplayModes). For instance:

 calendar.getCalendarDisplayModeProperties(CalendarDisplayModes.DAY_GRID_YEAR);
 

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 String	monthStartFormat

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

dayHeaderFormat, dayPopoverFormat, displayEventEnd, eventTimeFormat, weekNumberFormat

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
DayGridYearProperties()

Method Summary

Modifier and Type	Method	Description
String	getMonthStartFormat()
void	setMonthStartFormat(String format)	Sets the format of the text format for the first cell of each month.

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

getDayHeaderFormat, getDayPopoverFormat, getEventTimeFormat, getWeekNumberFormat, isDisplayEventEnd, setDayHeaderFormat, setDayPopoverFormat, setDisplayEventEnd, setEventTimeFormat, setWeekNumberFormat

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

monthStartFormat

protected String monthStartFormat

Constructor Details

DayGridYearProperties

public DayGridYearProperties()

Method Details

getMonthStartFormat

@Nullable
public String getMonthStartFormat()

Returns:

the text format for the first cell of each month or null if not set

setMonthStartFormat

public void setMonthStartFormat(@Nullable
 String format)

Sets the format of the text format for the first cell of each month. By default, component sets localized format from messages when is created.

The null value resets day format to FullCalendar's default.

As component uses moment plugin for FullCalendar, we should follow the moment.js formatting rules: Moment.js Documentation

For instance, the "MMMM" produces September (November, December, etc.).

Parameters:

format - format to set