com.vaadin.flow.component.dnd

Enum DropEffect

java.lang.Object

java.lang.Enum<DropEffect>

com.vaadin.flow.component.dnd.DropEffect

All Implemented Interfaces:

Serializable, Comparable<DropEffect>

public enum DropEffect
extends Enum<DropEffect>

Used to specify the drop effect to use on dragenter or dragover events.

Since:

2.0

Author:

Vaadin Ltd

Enum Constant Summary

Enum Constants

Enum Constant and Description
COPY A copy of the source item is made at the new location.
LINK A link is established to the source at the new location.
MOVE An item is moved to a new location.
NONE The item may not be dropped.

Method Summary

Modifier and Type	Method and Description
static DropEffect	valueOf(String name) Returns the enum constant of this type with the specified name.
static DropEffect[]	values() Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

COPY

public static final DropEffect COPY

A copy of the source item is made at the new location.

MOVE

public static final DropEffect MOVE

An item is moved to a new location.

LINK

public static final DropEffect LINK

A link is established to the source at the new location.

NONE

public static final DropEffect NONE

The item may not be dropped.

Method Detail

values

public static DropEffect[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (DropEffect c : DropEffect.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static DropEffect valueOf(String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

IllegalArgumentException - if this enum type has no constant with the specified name

NullPointerException - if the argument is null