com.vaadin.flow.component.dnd.
Enum EffectAllowed
- java.lang.Object
-
- java.lang.Enum<EffectAllowed>
-
- com.vaadin.flow.component.dnd.EffectAllowed
-
All Implemented Interfaces:
public enum EffectAllowed extends Enum<EffectAllowed>
Used to specify the effect that is allowed for a drag operation.
Since:
2.0
Author:
Vaadin Ltd
-
-
Enum Constant Summary
Enum Constants Enum Constant Description ALL
All operations are permitted.
COPY
A copy of the source item may be made at the new location.
COPY_LINK
A copy or link operation is permitted.
COPY_MOVE
A copy or move operation is permitted.
LINK
A link may be established to the source at the new location.
LINK_MOVE
A link or move operation is permitted.
MOVE
An item may be moved to a new location.
NONE
The item may not be dropped.
UNINITIALIZED
Default state, equivalent to ALL.
-
Method Summary
All Methods Modifier and Type Method Description String
getClientPropertyValue()
Get the lower case string value that is accepted by the client side drag event.
static EffectAllowed
valueOf​(String name)
Returns the enum constant of this type with the specified name.
static EffectAllowed[]
values()
Returns an array containing the constants of this enum type, in the order they are declared.
-
-
-
Enum Constant Detail
-
NONE
public static final EffectAllowed NONE
The item may not be dropped.
-
COPY
public static final EffectAllowed COPY
A copy of the source item may be made at the new location.
-
MOVE
public static final EffectAllowed MOVE
An item may be moved to a new location.
-
LINK
public static final EffectAllowed LINK
A link may be established to the source at the new location.
-
COPY_MOVE
public static final EffectAllowed COPY_MOVE
A copy or move operation is permitted.
-
COPY_LINK
public static final EffectAllowed COPY_LINK
A copy or link operation is permitted.
-
LINK_MOVE
public static final EffectAllowed LINK_MOVE
A link or move operation is permitted.
-
ALL
public static final EffectAllowed ALL
All operations are permitted.
-
UNINITIALIZED
public static final EffectAllowed UNINITIALIZED
Default state, equivalent to ALL.
-
-
Method Detail
-
values
public static EffectAllowed[] 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 (EffectAllowed c : EffectAllowed.values()) System.out.println(c);
Returns:
an array containing the constants of this enum type, in the order they are declared
-
valueOf
public static EffectAllowed 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 nameNullPointerException
- if the argument is null
-
getClientPropertyValue
public String getClientPropertyValue()
Get the lower case string value that is accepted by the client side drag event.
Returns:
String clientPropertyValue accepted by the client side drag event.
-
-