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

Class AbstractTimeGridProperties

java.lang.Object
io.jmix.fullcalendarflowui.kit.component.model.option.CalendarOption
io.jmix.fullcalendarflowui.kit.component.model.AbstractCalendarDisplayModeProperties
io.jmix.fullcalendarflowui.kit.component.model.AbstractTimeGridProperties
All Implemented Interfaces:
Serializable
Direct Known Subclasses:
TimeGridDayProperties, TimeGridWeekProperties
public abstract class AbstractTimeGridProperties extends AbstractCalendarDisplayModeProperties
Base class for configuring properties of time-grid display modes.
See Also:

  • Field Details

    • dayPopoverFormat

      protected String dayPopoverFormat

    • dayHeaderFormat

      protected String dayHeaderFormat

    • weekNumberFormat

      protected String weekNumberFormat

    • eventTimeFormat

      protected String eventTimeFormat

    • slotLabelFormat

      protected String slotLabelFormat

    • eventMinHeight

      protected Integer eventMinHeight

    • eventShortHeight

      protected Integer eventShortHeight

    • slotEventOverlap

      protected boolean slotEventOverlap

    • allDaySlotVisible

      protected boolean allDaySlotVisible

    • displayEventEnd

      protected boolean displayEventEnd

  • Constructor Details

    • AbstractTimeGridProperties

      public AbstractTimeGridProperties(String name)

  • Method Details

    • 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

    • 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

    • getSlotLabelFormat

      @Nullable public String getSlotLabelFormat()
      Returns:
      the slot label format or null if not set

    • setSlotLabelFormat

      public void setSlotLabelFormat(@Nullable String format)
      Sets the format of the text that will be displayed within a time slot. 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 "ha" produces 1 am (1, 2, ... 12 am/pm).

      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

    • getEventMinHeight

      @Nullable public Integer getEventMinHeight()
      Returns:
      the minimum height or null if not set

    • setEventMinHeight

      public void setEventMinHeight(@Nullable Integer eventMinHeight)
      Sets the minimum height that an event can have.

      The default value is 15.

      Parameters:
      eventMinHeight - minimum height

    • getEventShortHeight

      @Nullable public Integer getEventShortHeight()
      Returns:
      the event short height or null if not set

    • setEventShortHeight

      public void setEventShortHeight(@Nullable Integer eventShortHeight)
      Sets the height threshold for when an event has a "short" style.
      Parameters:
      eventShortHeight - the event short height
      See Also:

    • isSlotEventOverlap

      public boolean isSlotEventOverlap()
      Returns:
      true if events overlap each other

    • setSlotEventOverlap

      public void setSlotEventOverlap(boolean slotEventOverlap)
      Determines if timed events should visually overlap.

      The default value is true.

      Parameters:
      slotEventOverlap - whether events should overlap each other
      See Also:

    • isAllDaySlotVisible

      public boolean isAllDaySlotVisible()
      Returns:
      true if all-day slots are displayed

    • setAllDaySlotVisible

      public void setAllDaySlotVisible(boolean allDaySlotVisible)
      Determines if the all-day slots are displayed at the top of the calendar.

      The default value is true.

      Parameters:
      allDaySlotVisible - whether to display all-day slots

    • 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.

      The default value is true.

      Parameters:
      displayEventEnd - whether to display end time