Interface EditableCalendarEvent

  • All Superinterfaces:
    CalendarEvent, Serializable
    All Known Implementing Classes:
    BasicEvent

    public interface EditableCalendarEvent
    extends CalendarEvent

    Extension to the basic CalendarEvent. This interface provides setters (and thus editing capabilities) for all CalendarEvent fields. For descriptions on the fields, refer to the extended interface.

    This interface is used by some of the basic Calendar event handlers in the com.vaadin.addon.calendar.ui.handler package to determine whether an event can be edited.

    Since:
    7.1
    Author:
    Vaadin Ltd.
    • Method Detail

      • setCaption

        void setCaption​(String caption)
        Set the visible text in the calendar for the event.
        Parameters:
        caption - The text to show in the calendar
      • setDescription

        void setDescription​(String description)
        Set the description of the event. This is shown in the calendar when hoovering over the event.
        Parameters:
        description - The text which describes the event
      • setEnd

        void setEnd​(Date end)
        Set the end date of the event. Must be after the start date.
        Parameters:
        end - The end date to set
      • setStart

        void setStart​(Date start)
        Set the start date for the event. Must be before the end date
        Parameters:
        start - The start date of the event
      • setStyleName

        void setStyleName​(String styleName)
        Set the style name for the event used for styling the event cells
        Parameters:
        styleName - The stylename to use
      • setAllDay

        void setAllDay​(boolean isAllDay)
        Does the event span the whole day. If so then set this to true
        Parameters:
        isAllDay - True if the event spans the whole day. In this case the start and end times are ignored.