blob: 9765a370dc941eb93c598d85925d6194f35ccc83 (
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
|
/*
* Copyright 2000-2022 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.dnd.event;
import com.vaadin.shared.ui.dnd.DropEffect;
import com.vaadin.ui.AbstractComponent;
import com.vaadin.ui.Component;
import com.vaadin.ui.dnd.DragSourceExtension;
import com.vaadin.ui.dnd.DropTargetExtension;
/**
* HTML5 drag end event.
*
* @param <T>
* Type of the component that was dragged.
* @author Vaadin Ltd
* @see DragSourceExtension#addDragEndListener(DragEndListener)
* @since 8.1
*/
public class DragEndEvent<T extends AbstractComponent> extends Component.Event {
private final DropEffect dropEffect;
/**
* Creates a drag end event.
*
* @param source
* Component that was dragged.
* @param dropEffect
* Drop effect from {@code DataTransfer.dropEffect} object.
*/
public DragEndEvent(T source, DropEffect dropEffect) {
super(source);
this.dropEffect = dropEffect;
}
/**
* Get drop effect of the dragend event. The value will be the desired
* action, that is the dropEffect value of the last dragenter or dragover
* event. The value depends on the effectAllowed parameter of the drag
* source, the dropEffect parameter of the drop target, and its drag over
* and drop criteria.
* <p>
* If the drop is not successful, the value will be {@code NONE}.
* <p>
* In case the desired drop effect is {@code MOVE}, the data being dragged
* should be removed from the source.
*
* @return The {@code DataTransfer.dropEffect} parameter of the client side
* dragend event.
* @see DragSourceExtension#setEffectAllowed(com.vaadin.shared.ui.dnd.EffectAllowed)
* DragSourceExtension#setEffectAllowed(EffectAllowed)
* @see DropTargetExtension#setDropEffect(DropEffect)
* @see DropTargetExtension#setDropCriteriaScript(String)
*/
public DropEffect getDropEffect() {
return dropEffect;
}
/**
* Returns whether the drag event was cancelled. This is a shorthand for
* {@code dropEffect == NONE}.
*
* @return {@code true} if the drop event was cancelled, {@code false}
* otherwise.
*/
public boolean isCanceled() {
return getDropEffect() == DropEffect.NONE;
}
/**
* Returns the drag source component where the dragend event occurred.
*
* @return Component which was dragged.
*/
@Override
@SuppressWarnings("unchecked")
public T getComponent() {
return (T) super.getComponent();
}
}
|
