Package com.vaadin.flow.component.dnd
Class DropEvent<T extends Component>
java.lang.Object
java.util.EventObject
com.vaadin.flow.component.ComponentEvent<T>
com.vaadin.flow.component.dnd.DropEvent<T>
- Type Parameters:
T
- Type of the drop target component.
- All Implemented Interfaces:
Serializable
Server side drop event. Fired when an HTML5 drop happens on a valid drop
target.
- Since:
- 2.0
- Author:
- Vaadin Ltd, Vaadin Ltd
- See Also:
-
Field Summary
Fields inherited from class java.util.EventObject
source
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionReturns the drop target component where the drop event occurred.Gets the server side drag data.Returns the drag source component if the drag originated from a component in the same UI as the drop target component, or an empty optional.Get the desireddropEffect
for the drop event.Get theeffectAllowed
set by the drag source.Methods inherited from class com.vaadin.flow.component.ComponentEvent
getSource, isFromClient, unregisterListener
Methods inherited from class java.util.EventObject
toString
-
Constructor Details
-
DropEvent
public DropEvent(T source, boolean fromClient, @EventData("event.dataTransfer.effectAllowed") String effectAllowed) Creates a server side drop event.- Parameters:
source
- Component that received the drop.fromClient
-true
if the event originated from the client side,false
otherwiseeffectAllowed
- the effect allowed by the drag source
-
-
Method Details
-
getDragData
Gets the server side drag data. This data can be set during the drag start event on the server side and can be used to transfer data between drag source and drop target when they are in the same UI.- Returns:
- Optional server side drag data if set and the drag source and the
drop target are in the same UI, otherwise empty
Optional
.
-
getDropEffect
Get the desireddropEffect
for the drop event.- Returns:
- the drop effect set to the drop target, or null if nothing set
- See Also:
-
getEffectAllowed
Get theeffectAllowed
set by the drag source.- Returns:
- the effect allowed by the drag source
- See Also:
-
getDragSourceComponent
Returns the drag source component if the drag originated from a component in the same UI as the drop target component, or an empty optional.- Returns:
- Drag source component from the same UI or an empty optional.
-
getComponent
Returns the drop target component where the drop event occurred.- Returns:
- Component on which a drag source was dropped.
-