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