source.dussan.org Git - vaadin-framework.git/blob

   1 /*
   2  * Copyright 2000-2018 Vaadin Ltd.
   3  *
   4  * Licensed under the Apache License, Version 2.0 (the "License"); you may not
   5  * use this file except in compliance with the License. You may obtain a copy of
   6  * the License at
   7  *
   8  * http://www.apache.org/licenses/LICENSE-2.0
   9  *
  10  * Unless required by applicable law or agreed to in writing, software
  11  * distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
  12  * WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
  13  * License for the specific language governing permissions and limitations under
  14  * the License.
  15  */
  16 package com.vaadin.v7.ui.components.calendar.event;
  17
  18 import java.util.Date;
  19
  20 /**
  21  * <p>
  22  * Extension to the basic {@link com.vaadin.addon.calendar.event.CalendarEvent
  23  * CalendarEvent}. This interface provides setters (and thus editing
  24  * capabilities) for all {@link com.vaadin.addon.calendar.event.CalendarEvent
  25  * CalendarEvent} fields. For descriptions on the fields, refer to the extended
  26  * interface.
  27  * </p>
  28  *
  29  * <p>
  30  * This interface is used by some of the basic Calendar event handlers in the
  31  * <code>com.vaadin.addon.calendar.ui.handler</code> package to determine
  32  * whether an event can be edited.
  33  * </p>
  34  *
  35  * @since 7.1
  36  * @author Vaadin Ltd.
  37  */
  38 @Deprecated
  39 public interface EditableCalendarEvent extends CalendarEvent {
  40
  41     /**
  42      * Set the visible text in the calendar for the event.
  43      *
  44      * @param caption
  45      *            The text to show in the calendar
  46      */
  47     void setCaption(String caption);
  48
  49     /**
  50      * Set the description of the event. This is shown in the calendar when
  51      * hoovering over the event.
  52      *
  53      * @param description
  54      *            The text which describes the event
  55      */
  56     void setDescription(String description);
  57
  58     /**
  59      * Set the end date of the event. Must be after the start date.
  60      *
  61      * @param end
  62      *            The end date to set
  63      */
  64     void setEnd(Date end);
  65
  66     /**
  67      * Set the start date for the event. Must be before the end date
  68      *
  69      * @param start
  70      *            The start date of the event
  71      */
  72     void setStart(Date start);
  73
  74     /**
  75      * Set the style name for the event used for styling the event cells.
  76      *
  77      * @param styleName
  78      *            The stylename to use
  79      *
  80      */
  81     void setStyleName(String styleName);
  82
  83     /**
  84      * Does the event span the whole day. If so then set this to true.
  85      *
  86      * @param isAllDay
  87      *            True if the event spans the whole day. In this case the start
  88      *            and end times are ignored.
  89      */
  90     void setAllDay(boolean isAllDay);
  91
  92 }