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

Class AbstractListProperties

java.lang.Object
io.jmix.fullcalendarflowui.kit.component.model.option.CalendarOption
io.jmix.fullcalendarflowui.kit.component.model.AbstractCalendarDisplayModeProperties
io.jmix.fullcalendarflowui.kit.component.model.AbstractListProperties
All Implemented Interfaces:
Serializable
Direct Known Subclasses:
ListDayProperties, ListMonthProperties, ListWeekProperties, ListYearProperties
public abstract class AbstractListProperties extends AbstractCalendarDisplayModeProperties
Base class for configuring properties of list display modes.
See Also:

  • Field Details

    • listDayFormat

      protected String listDayFormat

    • listDayVisible

      protected boolean listDayVisible

    • listDaySideFormat

      protected String listDaySideFormat

    • listDaySideVisible

      protected boolean listDaySideVisible

  • Constructor Details

    • AbstractListProperties

      public AbstractListProperties(String name)

  • Method Details

    • getListDayFormat

      @Nullable public String getListDayFormat()
      Returns:
      the list day format or null if not set

    • setListDayFormat

      public void setListDayFormat(@Nullable String format)
      Sets the format of the text on the left side of the day headings. 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 "dd" produces Mo.

      Parameters:
      format - format to set

    • isListDayVisible

      public boolean isListDayVisible()
      Returns:
      true if the text on the left side of the day headings is visible

    • setListDayVisible

      public void setListDayVisible(boolean listDayVisible)
      Sets the visibility of the text on the left side of the day headings.

      The default value is true.

      Parameters:
      listDayVisible - whether to show the list day text

    • getListDaySideFormat

      @Nullable public String getListDaySideFormat()
      Returns:
      the list day side format or null if not set

    • setListDaySideFormat

      public void setListDaySideFormat(@Nullable String format)
      Sets the format of the text on the right side of the day headings. 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 "dd" produces Mo.

      Parameters:
      format - format to set

    • isListDaySideVisible

      public boolean isListDaySideVisible()
      Returns:
      true if the text on the right side of the day headings is visible

    • setListDaySideVisible

      public void setListDaySideVisible(boolean listDaySideVisible)
      Sets the visibility of the text on the right side of the day headings.

      The default value is true.

      Parameters:
      listDaySideVisible - whether to show the list day side text