com.vaadin.flow.component.grid.dnd.
Enum GridDropMode
- java.lang.Object
-
- java.lang.Enum<GridDropMode>
-
- com.vaadin.flow.component.grid.dnd.GridDropMode
-
All Implemented Interfaces:
public enum GridDropMode extends Enum<GridDropMode>
Defines the locations within the Grid row where an element can be dropped.
Author:
Vaadin Ltd.
-
-
Enum Constant Summary
Enum Constants Enum Constant Description BETWEEN
The drop event can happen between Grid rows.
ON_GRID
The drop event will not happen on any specific row, it will show the drop target outline around the whole grid.
ON_TOP
The drop event can happen on top of Grid rows.
ON_TOP_OR_BETWEEN
The drop event can happen either on top of or between Grid rows.
-
Method Summary
All Methods Modifier and Type Method Description String
getClientName()
Gets name that is used in the client side representation of the component.
static GridDropMode
valueOf​(String name)
Returns the enum constant of this type with the specified name.
static GridDropMode[]
values()
Returns an array containing the constants of this enum type, in the order they are declared.
-
-
-
Enum Constant Detail
-
BETWEEN
public static final GridDropMode BETWEEN
The drop event can happen between Grid rows. The drop is above a row when the cursor is over the top 50% of a row, otherwise below the row.
-
ON_TOP
public static final GridDropMode ON_TOP
The drop event can happen on top of Grid rows. The target of the drop is the row under the cursor at the time of the drop event.
-
ON_TOP_OR_BETWEEN
public static final GridDropMode ON_TOP_OR_BETWEEN
The drop event can happen either on top of or between Grid rows. The drop is either
- above a row when the cursor is over a specified portion of the top part of the row,
- below when the cursor is over a specified portion of the bottom part of the row, or
- on top when the cursor is over the middle portions of the row.
-
ON_GRID
public static final GridDropMode ON_GRID
The drop event will not happen on any specific row, it will show the drop target outline around the whole grid. For this drop target, the drop event will not contain any target row information. This is the drop target used when the grid is completely empty.
-
-
Method Detail
-
values
public static GridDropMode[] 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 (GridDropMode c : GridDropMode.values()) System.out.println(c);
Returns:
an array containing the constants of this enum type, in the order they are declared
-
valueOf
public static GridDropMode 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
-
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.
-
-