com.vaadin.flow.component.grid.dnd

Enum GridDropLocation

java.lang.Object

java.lang.Enum<GridDropLocation>

com.vaadin.flow.component.grid.dnd.GridDropLocation

All Implemented Interfaces:

Serializable, Comparable<GridDropLocation>

public enum GridDropLocation
extends Enum<GridDropLocation>

Defines drop locations within a Grid row.

Author:

Vaadin Ltd.

Enum Constant Summary

Enum Constants

Enum Constant and Description
ABOVE Drop above or before the row.
BELOW Drop below or after the row.
EMPTY Dropping into an empty grid, or to the empty area below the grid rows when GridDropMode.ON_TOP is used.
ON_TOP Drop on top of the row.

Method Summary

Modifier and Type	Method and Description
String	getClientName() Gets name that is used in the client side representation of the component.
static GridDropLocation	valueOf(String name) Returns the enum constant of this type with the specified name.
static GridDropLocation[]	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

ON_TOP

public static final GridDropLocation ON_TOP

Drop on top of the row.

ABOVE

public static final GridDropLocation ABOVE

Drop above or before the row.

BELOW

public static final GridDropLocation BELOW

Drop below or after the row.

EMPTY

public static final GridDropLocation EMPTY

Dropping into an empty grid, or to the empty area below the grid rows when GridDropMode.ON_TOP is used.

Method Detail

values

public static GridDropLocation[] 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 (GridDropLocation c : GridDropLocation.values())
    System.out.println(c);

Returns:

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

valueOf

public static GridDropLocation 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

getClientName

public String getClientName()

Gets name that is used in the client side representation of the component.

Returns:

the name used in the client side representation of the component.