Index

A C D E G I L M N R S U V 
All Classes and Interfaces|All Packages|Constant Field Values|Serialized Form

A

AbstractDnDEvent<T> - Class in com.vaadin.flow.component.dnd
Abstract base class for HTML5 drag and drop events.
AbstractDnDEvent(T, boolean, int, int) - Constructor for class com.vaadin.flow.component.dnd.AbstractDnDEvent
Creates a new drag and drop event.
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.
ALL - Enum constant in enum class com.vaadin.flow.component.dnd.EffectAllowed
All operations are permitted.

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) - 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.DragSource
Gives access to the generic drag source API for the given component and applies the given draggable status to it.
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.
COPY - Enum constant in enum class com.vaadin.flow.component.dnd.DropEffect
A copy of the source item is made at the new location.
COPY - Enum constant in enum class com.vaadin.flow.component.dnd.EffectAllowed
A copy of the source item may be made at the new location.
COPY_LINK - Enum constant in enum class com.vaadin.flow.component.dnd.EffectAllowed
A copy or link operation is permitted.
COPY_MOVE - Enum constant in enum class com.vaadin.flow.component.dnd.EffectAllowed
A copy or move operation is permitted.
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.
DRAG_SOURCE_IMAGE - Static variable in class com.vaadin.flow.component.dnd.internal.DndUtil
Key for storing server side drag image for a DragSource.
DRAG_START_OFFSET_X_KEY - Static variable in class com.vaadin.flow.component.dnd.internal.DndUtil
Key for storing drag start offset X coordinate.
DRAG_START_OFFSET_Y_KEY - Static variable in class com.vaadin.flow.component.dnd.internal.DndUtil
Key for storing drag start offset Y coordinate.
DragEndEvent<T> - 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
Deprecated, for removal: This API element is subject to removal in a future version.
since 25.2, for removal. Use DragEndEvent(Component, boolean, String, int, int) which also captures the pointer's client coordinates. When this constructor is used, AbstractDnDEvent.getClientX() and AbstractDnDEvent.getClientY() return 0.
DragEndEvent(T, boolean, String, int, int) - Constructor for class com.vaadin.flow.component.dnd.DragEndEvent
Creates a drag end event.
DragSource<T> - Interface in com.vaadin.flow.component.dnd
Mixin interface that provides basic drag source API for any component.
DragStartEvent<T> - 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
Deprecated, for removal: This API element is subject to removal in a future version.
since 25.2, for removal. Use DragStartEvent(Component, boolean, int, int, int, int) which also captures the pointer's client and offset coordinates. When this constructor is used, AbstractDnDEvent.getClientX(), AbstractDnDEvent.getClientY(), DragStartEvent.getOffsetX() and DragStartEvent.getOffsetY() return 0.
DragStartEvent(T, boolean, int, int, int, int) - 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 Class in com.vaadin.flow.component.dnd
Used to specify the drop effect to use on dragenter or dragover events.
DropEvent<T> - Class in com.vaadin.flow.component.dnd
Server side drop event.
DropEvent(T, boolean, String) - Constructor for class com.vaadin.flow.component.dnd.DropEvent
Deprecated, for removal: This API element is subject to removal in a future version.
since 25.2, for removal. Use DropEvent(Component, boolean, String, int, int, int, int) which also captures the pointer's client and drop-target offset coordinates. When this constructor is used, AbstractDnDEvent.getClientX(), AbstractDnDEvent.getClientY(), DropEvent.getOffsetX() and DropEvent.getOffsetY() return 0.
DropEvent(T, boolean, String, int, int, int, int) - Constructor for class com.vaadin.flow.component.dnd.DropEvent
Creates a server side drop event.
DropTarget<T> - 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 Class 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 class com.vaadin.flow.component.dnd.EffectAllowed
Get the lower case string value that is accepted by the client side drag event.
getClientX() - Method in class com.vaadin.flow.component.dnd.AbstractDnDEvent
Gets the x coordinate of the mouse pointer relative to the viewport, excluding any scroll offset.
getClientY() - Method in class com.vaadin.flow.component.dnd.AbstractDnDEvent
Gets the y coordinate of the mouse pointer relative to the viewport, excluding any scroll offset.
getComponent() - Method in class com.vaadin.flow.component.dnd.AbstractDnDEvent
Returns the component associated with this event.
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.
getDragImage() - Method in interface com.vaadin.flow.component.dnd.DragSource
Get server side drag image.
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.
getDragStartOffsetX() - Method in class com.vaadin.flow.component.dnd.DropEvent
Gets the x coordinate of the mouse pointer relative to the drag source element when the drag started.
getDragStartOffsetY() - Method in class com.vaadin.flow.component.dnd.DropEvent
Gets the y coordinate of the mouse pointer relative to the drag source element when the drag started.
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.
getOffsetX() - Method in class com.vaadin.flow.component.dnd.DragStartEvent
Gets the x coordinate of the mouse pointer relative to the drag source element when the drag started.
getOffsetX() - Method in class com.vaadin.flow.component.dnd.DropEvent
Gets the x coordinate of the drop position relative to the drop target element.
getOffsetY() - Method in class com.vaadin.flow.component.dnd.DragStartEvent
Gets the y coordinate of the mouse pointer relative to the drag source element when the drag started.
getOffsetY() - Method in class com.vaadin.flow.component.dnd.DropEvent
Gets the y coordinate of the drop position relative to the drop target element.

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.

L

LINK - Enum constant in enum class com.vaadin.flow.component.dnd.DropEffect
A link is established to the source at the new location.
LINK - Enum constant in enum class com.vaadin.flow.component.dnd.EffectAllowed
A link may be established to the source at the new location.
LINK_MOVE - Enum constant in enum class com.vaadin.flow.component.dnd.EffectAllowed
A link or move operation is permitted.

M

MOVE - Enum constant in enum class com.vaadin.flow.component.dnd.DropEffect
An item is moved to a new location.
MOVE - Enum constant in enum class com.vaadin.flow.component.dnd.EffectAllowed
An item may be moved to a new location.

N

NONE - Enum constant in enum class com.vaadin.flow.component.dnd.DropEffect
The item may not be dropped.
NONE - Enum constant in enum class com.vaadin.flow.component.dnd.EffectAllowed
The item may not be dropped.

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.
setDragImage(Component) - Method in interface com.vaadin.flow.component.dnd.DragSource
Sets the drag image for the current drag source element.
setDragImage(Component, int, int) - Method in interface com.vaadin.flow.component.dnd.DragSource
Sets the drag image for the current drag source element.
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

UNINITIALIZED - Enum constant in enum class com.vaadin.flow.component.dnd.EffectAllowed
Default state, equivalent to ALL.
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 class com.vaadin.flow.component.dnd.DropEffect
Returns the enum constant of this class with the specified name.
valueOf(String) - Static method in enum class com.vaadin.flow.component.dnd.EffectAllowed
Returns the enum constant of this class with the specified name.
values() - Static method in enum class com.vaadin.flow.component.dnd.DropEffect
Returns an array containing the constants of this enum class, in the order they are declared.
values() - Static method in enum class com.vaadin.flow.component.dnd.EffectAllowed
Returns an array containing the constants of this enum class, in the order they are declared.
A C D E G I L M N R S U V 
All Classes and Interfaces|All Packages|Constant Field Values|Serialized Form