Index (Generic HTML 5 Drag and Drop support for Flow 3.1.2 API)

A C D E G I R S U V

A

addDragEndListener(ComponentEventListener<DragEndEvent<T>>) - Method in interface com.vaadin.flow.component.dnd.DragSource: Attaches dragend listener for the current drag source.The listener is triggered when dragend event happens on the client side.
addDragStartListener(ComponentEventListener<DragStartEvent<T>>) - Method in interface com.vaadin.flow.component.dnd.DragSource: Attaches dragstart listener for the current drag source.
addDropListener(ComponentEventListener<DropEvent<T>>) - Method in interface com.vaadin.flow.component.dnd.DropTarget: Attaches drop listener for the component this maps to.
addMobileDndPolyfillIfNeeded(Component) - Static method in class com.vaadin.flow.component.dnd.internal.DndUtil: Adds the mobile dnd polyfills when a iOS device is used.

C

clearDragData() - Method in class com.vaadin.flow.component.dnd.DragEndEvent: Clears the drag data for this drag operation (and the drag source component).
com.vaadin.flow.component.dnd - package com.vaadin.flow.component.dnd
com.vaadin.flow.component.dnd.internal - package com.vaadin.flow.component.dnd.internal
configure(T) - Static method in interface com.vaadin.flow.component.dnd.DragSource: Gives access to the generic drag source API for the given component.
configure(T, boolean) - Static method in interface com.vaadin.flow.component.dnd.DragSource: Gives access to the generic drag source API for the given component and applies the given draggable status to it.
configure(T) - Static method in interface com.vaadin.flow.component.dnd.DropTarget: Gives access to the generic drop target API for the given component.
configure(T, boolean) - Static method in interface com.vaadin.flow.component.dnd.DropTarget: Gives access to the generic drop target API for the given component and either activates or deactivates the drop target.
create(T) - Static method in interface com.vaadin.flow.component.dnd.DragSource: Makes the given component draggable and gives access to the generic drag source API for the component.
create(T) - Static method in interface com.vaadin.flow.component.dnd.DropTarget: Makes the given component a drop target and gives access to the generic drop target API for the component.

D

DND_CONNECTOR - Static variable in class com.vaadin.flow.component.dnd.internal.DndUtil: Resource path for importing dnd connector.
DndUtil - Class in com.vaadin.flow.component.dnd.internal: Internal class for drag and drop related utility methods.
DRAG_SOURCE_DATA_KEY - Static variable in class com.vaadin.flow.component.dnd.internal.DndUtil: Key for storing server side drag data for a DragSource.
DragEndEvent<T extends Component> - Class in com.vaadin.flow.component.dnd: HTML5 drag end event, fired when the user stops dragging a drag source either by dropping on top of a valid drop target or by canceling to drop.
DragEndEvent(T, boolean, String) - Constructor for class com.vaadin.flow.component.dnd.DragEndEvent: Creates a drag end event.
DragSource<T extends Component> - Interface in com.vaadin.flow.component.dnd: Mixin interface that provides basic drag source API for any component.
DragStartEvent<T extends Component> - Class in com.vaadin.flow.component.dnd: HTML5 drag start event, fired when the user starts dragging a drag source.
DragStartEvent(T, boolean) - Constructor for class com.vaadin.flow.component.dnd.DragStartEvent: Creates a drag start event.
DROP_EFFECT_ELEMENT_PROPERTY - Static variable in class com.vaadin.flow.component.dnd.internal.DndUtil: Property name for storing the DropEffect on element level.
DROP_TARGET_ACTIVE_PROPERTY - Static variable in class com.vaadin.flow.component.dnd.internal.DndUtil: Property name for storing drop target activity data for an element.
DropEffect - Enum in com.vaadin.flow.component.dnd: Used to specify the drop effect to use on dragenter or dragover events.
DropEvent<T extends Component> - Class in com.vaadin.flow.component.dnd: Server side drop event.
DropEvent(T, boolean, String) - Constructor for class com.vaadin.flow.component.dnd.DropEvent: Creates a server side drop event.
DropTarget<T extends Component> - Interface in com.vaadin.flow.component.dnd: Mixin interface that provides basic drop target API for any component.

E

EFFECT_ALLOWED_ELEMENT_PROPERTY - Static variable in class com.vaadin.flow.component.dnd.internal.DndUtil: Property name for storing the EffectAllowed on element level.
EffectAllowed - Enum in com.vaadin.flow.component.dnd: Used to specify the effect that is allowed for a drag operation.
END_LISTENER_REGISTRATION_KEY - Static variable in class com.vaadin.flow.component.dnd.internal.DndUtil: Key for storing an internal drag end listener registration for a DragSource.

G

getClientPropertyValue() - Method in enum com.vaadin.flow.component.dnd.EffectAllowed: Get the lower case string value that is accepted by the client side drag event.
getComponent() - Method in class com.vaadin.flow.component.dnd.DragEndEvent: Returns the drag source component where the dragend event occurred.
getComponent() - Method in class com.vaadin.flow.component.dnd.DragStartEvent: Returns the drag source component where the dragstart event occurred.
getComponent() - Method in class com.vaadin.flow.component.dnd.DropEvent: Returns the drop target component where the drop event occurred.
getDragData() - Method in interface com.vaadin.flow.component.dnd.DragSource: Get server side drag data.
getDragData() - Method in class com.vaadin.flow.component.dnd.DropEvent: Gets the server side drag data.
getDraggableElement() - Method in interface com.vaadin.flow.component.dnd.DragSource: Returns the element where the draggable attribute is applied, making it draggable by the user.
getDragSourceComponent() - Method in interface com.vaadin.flow.component.dnd.DragSource: Returns the drag source component.
getDragSourceComponent() - Method in class com.vaadin.flow.component.dnd.DropEvent: 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.
getDropEffect() - Method in class com.vaadin.flow.component.dnd.DragEndEvent: Get drop effect of the dragend event.
getDropEffect() - Method in class com.vaadin.flow.component.dnd.DropEvent: Get the desired dropEffect for the drop event.
getDropEffect() - Method in interface com.vaadin.flow.component.dnd.DropTarget: Returns the drop effect for the current drop target.
getDropTargetComponent() - Method in interface com.vaadin.flow.component.dnd.DropTarget: Returns the drop target component.
getEffectAllowed() - Method in interface com.vaadin.flow.component.dnd.DragSource: Returns the allowed effects for the current drag source element.
getEffectAllowed() - Method in class com.vaadin.flow.component.dnd.DropEvent: Get the effectAllowed set by the drag source.
getElement() - Method in interface com.vaadin.flow.component.dnd.DragSource
getElement() - Method in interface com.vaadin.flow.component.dnd.DropTarget: Returns the element which is made as a drop target in the UI.

I

isActive() - Method in interface com.vaadin.flow.component.dnd.DropTarget: Gets whether this drop target is activate or not.
isDraggable() - Method in interface com.vaadin.flow.component.dnd.DragSource: Is this component currently draggable.
isSuccessful() - Method in class com.vaadin.flow.component.dnd.DragEndEvent: Returns whether the drop event succesful or was it cancelled or didn't succeed.

R

reportUsage() - Static method in class com.vaadin.flow.component.dnd.internal.DndUtil: Reports DnD feature usage from mixin interfaces.

S

setActive(boolean) - Method in interface com.vaadin.flow.component.dnd.DropTarget: Activate or deactivate this drop target.
setDragData(Object) - Method in interface com.vaadin.flow.component.dnd.DragSource: Set server side drag data.
setDragData(Object) - Method in class com.vaadin.flow.component.dnd.DragStartEvent: Set server side drag data for this started drag operation.
setDraggable(boolean) - Method in interface com.vaadin.flow.component.dnd.DragSource: Sets this component as draggable.
setDropEffect(DropEffect) - Method in interface com.vaadin.flow.component.dnd.DropTarget: Sets the drop effect for the current drop target.
setEffectAllowed(EffectAllowed) - Method in interface com.vaadin.flow.component.dnd.DragSource: Sets the allowed effects for the current drag source element.
START_LISTENER_REGISTRATION_KEY - Static variable in class com.vaadin.flow.component.dnd.internal.DndUtil: Key for storing an internal drag start listener registration for a DragSource.

U

updateDragSourceActivation(DragSource<T>) - Static method in class com.vaadin.flow.component.dnd.internal.DndUtil: Triggers drag source activation method in JS connector once when the component has been attached.
updateDropTargetActivation(DropTarget<T>) - Static method in class com.vaadin.flow.component.dnd.internal.DndUtil: Triggers drop target activation method in JS connector once when the component has been attached.

V

valueOf(String) - Static method in enum com.vaadin.flow.component.dnd.DropEffect: Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum com.vaadin.flow.component.dnd.EffectAllowed: Returns the enum constant of this type with the specified name.
values() - Static method in enum com.vaadin.flow.component.dnd.DropEffect: Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum com.vaadin.flow.component.dnd.EffectAllowed: Returns an array containing the constants of this enum type, in the order they are declared.

A C D E G I R S U V