blob: bfe1bc8c83249ca3fed871b9df4b4cc39c300234 (
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
|
/*
* Copyright 2000-2016 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.dnd;
import com.vaadin.shared.ui.dnd.EffectAllowed;
import com.vaadin.ui.AbstractComponent;
import com.vaadin.ui.Component;
/**
* Server side dragstart event. Fired when an HTML5 dragstart happens on the
* client.
*
* @param <T>
* Type of the component that is dragged.
* @author Vaadin Ltd
* @see DragSourceExtension#addDragStartListener(DragStartListener)
* @since 8.1
*/
public class DragStartEvent<T extends AbstractComponent> extends
Component.Event {
private final String dataTransferText;
private final EffectAllowed effectAllowed;
/**
* Creates a server side dragstart event.
*
* @param source
* Component that is dragged.
* @param dataTransferText
* Data of type {@code "text"} from the {@code DataTransfer}
* object.
* @param effectAllowed
* Allowed effects from {@code DataTransfer.effectAllowed} object.
*/
public DragStartEvent(T source, String dataTransferText,
EffectAllowed effectAllowed) {
super(source);
this.dataTransferText = dataTransferText;
this.effectAllowed = effectAllowed;
}
/**
* Get data of type {@code "text"} from the client side {@code DataTransfer}
* object.
*
* @return Data of type {@code "text"} if exists in the client side {@code
* DataTransfer} object, otherwise {@literal null}.
*/
public String getDataTransferText() {
return dataTransferText;
}
/**
* Returns the {@code effectAllowed} parameter of this event.
*
* @return This event's {@code effectAllowed} parameter.
*/
public EffectAllowed getEffectAllowed() {
return effectAllowed;
}
/**
* Returns the drag source component where the dragstart event occurred.
*
* @return Component which is dragged.
*/
@Override
@SuppressWarnings("unchecked")
public T getComponent() {
return (T) super.getComponent();
}
}
|
