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

Class MultiMonthYearProperties

java.lang.Object
io.jmix.fullcalendarflowui.kit.component.model.option.CalendarOption
io.jmix.fullcalendarflowui.kit.component.model.AbstractCalendarDisplayModeProperties
io.jmix.fullcalendarflowui.kit.component.model.MultiMonthYearProperties
All Implemented Interfaces:
Serializable
public class MultiMonthYearProperties extends AbstractCalendarDisplayModeProperties
Configuration properties of multi-month year display mode CalendarDisplayModes.MULTI_MONTH_YEAR.

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


 calendar.getCalendarDisplayModeProperties(CalendarDisplayModes.MULTI_MONTH_YEAR);
See Also:

  • Field Details

    • multiMonthMaxColumns

      protected Integer multiMonthMaxColumns

    • multiMonthMinWidth

      protected Integer multiMonthMinWidth

    • multiMonthTitleFormat

      protected String multiMonthTitleFormat

    • fixedWeekCount

      protected boolean fixedWeekCount

    • showNonCurrentDates

      protected boolean showNonCurrentDates

  • Constructor Details

    • MultiMonthYearProperties

      public MultiMonthYearProperties()

  • Method Details

    • getMultiMonthMaxColumns

      @Nullable public Integer getMultiMonthMaxColumns()
      Returns:
      the maximum columns of months or null if not set

    • setMultiMonthMaxColumns

      public void setMultiMonthMaxColumns(@Nullable Integer multiMonthMaxColumns)
      Sets the maximum columns of months that the display mode will attempt to render.

      By default, the display mode will attempt to display 3 columns of mini-months. If there is insufficient space, requiring each month to be smaller than getMultiMonthMinWidth(), fewer columns will be displayed.

      The default value is 3.

      Parameters:
      multiMonthMaxColumns - maximum columns of months

    • getMultiMonthMinWidth

      @Nullable public Integer getMultiMonthMinWidth()

    • setMultiMonthMinWidth

      public void setMultiMonthMinWidth(@Nullable Integer multiMonthMinWidth)
      Sets thw minimum width of each mini-month. The component will not allow mini-month to be become smaller than this value.

      If the available width requires each mini-month to become smaller than this pixel value, the mini-months will wrap to subsequent rows instead.

      The default value is 350.

      Parameters:
      multiMonthMinWidth - minimum width in pixels

    • getMultiMonthTitleFormat

      @Nullable public String getMultiMonthTitleFormat()

    • setMultiMonthTitleFormat

      public void setMultiMonthTitleFormat(@Nullable String format)
      Sets the format of the text above 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 "MMM" produces Sep (Nov, Dec, etc.).

      Parameters:
      format - format to set

    • isFixedWeekCount

      public boolean isFixedWeekCount()
      Returns:
      true if calendar displays fixed week count

    • setFixedWeekCount

      public void setFixedWeekCount(boolean fixedWeekCount)
      Determines the number of displayed weeks.

      If true, the calendar will always be 6 weeks tall. If false, the calendar will have either 4, 5, or 6 weeks, depending on the month.

      The default value is true.

      Parameters:
      fixedWeekCount - whether to display fixed week count

    • isShowNonCurrentDates

      public boolean isShowNonCurrentDates()
      Returns:
      true if calendar shows dates from next/previous months

    • setShowNonCurrentDates

      public void setShowNonCurrentDates(boolean showNonCurrentDates)
      Determines displaying dates from previous and next months.

      The default value is true.

      Parameters:
      showNonCurrentDates - whether to show dates from next/previous months