blob: 968d2f6d834f78f85daebefb0a128e71a0b15552 (
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
|
/*
* 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.event;
import java.io.Serializable;
import java.util.List;
import com.vaadin.data.sort.SortOrder;
import com.vaadin.ui.Component;
/**
* Event describing a change in sorting of a {@link Container}. Fired by
* {@link SortNotifier SortNotifiers}.
*
* @see SortListener
*
* @since
* @author Vaadin Ltd
*/
public class SortEvent extends Component.Event {
private final List<SortOrder> sortOrder;
private final boolean userOriginated;
/**
* Creates a new sort order change event with a sort order list.
*
* @param source
* the component from which the event originates
* @param sortOrder
* the new sort order list
* @param userOriginated
* <code>true</code> if event is a result of user interaction,
* <code>false</code> if from API call
*/
public SortEvent(Component source, List<SortOrder> sortOrder,
boolean userOriginated) {
super(source);
this.sortOrder = sortOrder;
this.userOriginated = userOriginated;
}
/**
* Gets the sort order list.
*
* @return the sort order list
*/
public List<SortOrder> getSortOrder() {
return sortOrder;
}
/**
* Returns whether this event originated from actions done by the user.
*
* @return true if sort event originated from user interaction
*/
public boolean isUserOriginated() {
return userOriginated;
}
/**
* Listener for sort order change events.
*/
public interface SortListener extends Serializable {
/**
* Called when the sort order has changed.
*
* @param event
* the sort order change event
*/
public void sort(SortEvent event);
}
/**
* The interface for adding and removing listeners for {@link SortEvent
* SortEvents}.
*/
public interface SortNotifier extends Serializable {
/**
* Adds a sort order change listener that gets notified when the sort
* order changes.
*
* @param listener
* the sort order change listener to add
*/
public void addSortListener(SortListener listener);
/**
* Removes a sort order change listener previously added using
* {@link #addSortListener(SortListener)}.
*
* @param listener
* the sort order change listener to remove
*/
public void removeSortistener(SortListener listener);
}
}
|
