blob: 35719a13f390227dc6ff7f18672e0763020fc5a2 (
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
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
|
/*
* Copyright 2000-2014 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.io.Serializable;
import java.util.Date;
import java.util.List;
/**
* Interface for querying events. The Vaadin Calendar always has a
* CalendarEventProvider set.
*
* @since 7.1.0
* @author Vaadin Ltd.
*/
public interface CalendarEventProvider extends Serializable {
/**
* <p>
* Gets all available events in the target date range between startDate and
* endDate. The Vaadin Calendar queries the events from the range that is
* shown, which is not guaranteed to be the same as the date range that is
* set.
* </p>
*
* <p>
* For example, if you set the date range to be monday 22.2.2010 - wednesday
* 24.2.2000, the used Event Provider will be queried for events between
* monday 22.2.2010 00:00 and sunday 28.2.2010 23:59. Generally you can
* expect the date range to be expanded to whole days and whole weeks.
* </p>
*
* @param startDate
* Start date
* @param endDate
* End date
* @return List of events
*/
public List<CalendarEvent> getEvents(Date startDate, Date endDate);
/**
* Event to signal that the set of events has changed and the calendar
* should refresh its view from the
* {@link com.vaadin.addon.calendar.event.CalendarEventProvider
* CalendarEventProvider} .
*
*/
@SuppressWarnings("serial")
public class EventSetChangeEvent implements Serializable {
private CalendarEventProvider source;
public EventSetChangeEvent(CalendarEventProvider source) {
this.source = source;
}
/**
* @return the
* {@link com.vaadin.addon.calendar.event.CalendarEventProvider
* CalendarEventProvider} that has changed
*/
public CalendarEventProvider getProvider() {
return source;
}
}
/**
* Listener for EventSetChange events.
*/
public interface EventSetChangeListener extends Serializable {
/**
* Called when the set of Events has changed.
*/
public void eventSetChange(EventSetChangeEvent changeEvent);
}
/**
* Notifier interface for EventSetChange events.
*/
public interface EventSetChangeNotifier extends Serializable {
/**
* Add a listener for listening to when new events are adding or removed
* from the event provider.
*
* @param listener
* The listener to add
*/
void addEventSetChangeListener(EventSetChangeListener listener);
/**
* Remove a listener which listens to {@link EventSetChangeEvent}-events
*
* @param listener
* The listener to remove
*/
void removeEventSetChangeListener(EventSetChangeListener listener);
}
}
|
