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

Class AbstractDayGridProperties

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
All Implemented Interfaces:
Serializable
Direct Known Subclasses:
DayGridDayProperties, DayGridMonthProperties, DayGridWeekProperties, DayGridYearProperties
public abstract class AbstractDayGridProperties extends AbstractCalendarDisplayModeProperties
Base class for configuring properties of day-grid display modes.
See Also:

  • Field Details

    • dayPopoverFormat

      protected String dayPopoverFormat

    • dayHeaderFormat

      protected String dayHeaderFormat

    • weekNumberFormat

      protected String weekNumberFormat

    • eventTimeFormat

      protected String eventTimeFormat

    • displayEventEnd

      protected boolean displayEventEnd

  • Constructor Details

    • AbstractDayGridProperties

      public AbstractDayGridProperties(String name)

  • Method Details

    • getDayHeaderFormat

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

    • setDayHeaderFormat

      public void setDayHeaderFormat(@Nullable String format)
      Sets the format of the text that will be displayed on the calendar’s column headings. By default, component sets localized format from messages when is created.

      The null value makes component to use value from JmixFullCalendar.getDefaultDayHeaderFormat().

      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

    • getWeekNumberFormat

      @Nullable public String getWeekNumberFormat()
      Returns:
      the format of the week number or null if not set

    • setWeekNumberFormat

      public void setWeekNumberFormat(@Nullable String format)
      Sets the format of the week number that will be displayed when JmixFullCalendar.isWeekNumbersVisible() is true.By default, component sets localized format from messages when is created.

      The null value makes component to use value from JmixFullCalendar.getDefaultWeekNumberFormat().

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

      For instance, the "[Week] w" produces Week 1 (1, 2, ... 52, 53).

      Parameters:
      format - format to set

    • getEventTimeFormat

      @Nullable public String getEventTimeFormat()
      Returns:
      the event time format or null if not set

    • setEventTimeFormat

      public void setEventTimeFormat(@Nullable String format)
      Sets the format of the time-text that will be displayed on each event. By default, component sets localized format from messages when is created.

      The null value makes component to use value from JmixFullCalendar.getDefaultEventTimeFormat().

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

      For instance, the "HH:mm" produces 00:00 (01, 2, ... 24 : 01, 02 ... 59).

      Parameters:
      format - format to set

    • getDayPopoverFormat

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

    • setDayPopoverFormat

      public void setDayPopoverFormat(@Nullable String format)
      Sets the date format of title of the popover that is shown when "more" link is clicked. By default, component sets localized format from messages when is created.

      The null value makes component to use value from JmixFullCalendar.getDefaultDayPopoverFormat().

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

      For instance, the "MMM D, YY" produces Sep 9, 24.

      Parameters:
      format - format to set

    • isDisplayEventEnd

      public boolean isDisplayEventEnd()
      Returns:
      true if an event's end time is visible

    • setDisplayEventEnd

      public void setDisplayEventEnd(boolean displayEventEnd)
      Determines an event's end time visibility.

      By default true for CalendarDisplayModes.DAY_GRID_DAY and false for other day-grid display modes.

      Parameters:
      displayEventEnd - whether to display end time