Package com.vaadin.flow.component.grid

Enum Class ColumnRendering

java.lang.Object

java.lang.Enum<ColumnRendering>

com.vaadin.flow.component.grid.ColumnRendering

All Implemented Interfaces:

Serializable, Comparable<ColumnRendering>, Constable

public enum ColumnRendering
extends Enum<ColumnRendering>

Constants for the rendering mode of columns.

Author:

Vaadin Ltd.

See Also:

• Grid.setColumnRendering(ColumnRendering)

Nested Class Summary

Nested classes/interfaces inherited from class java.lang.Enum

Enum.EnumDesc<E extends Enum<E>>

Enum Constant Summary

Enum Constants

Enum Constant	Description
EAGER	In this mode, all columns are rendered upfront, regardless of their visibility within the viewport.
LAZY	In this mode, body cells are rendered only when their corresponding columns are inside the visible viewport.

Method Summary

Modifier and Type	Method	Description
static ColumnRendering	fromPropertyValue(String propertyValue)	Converts the property name in String form to the corresponding enum value.
String	getPropertyValue()	Gets the property value for the rendering mode.
static ColumnRendering	valueOf(String name)	Returns the enum constant of this class with the specified name.
static ColumnRendering[]	values()	Returns an array containing the constants of this enum class, in the order they are declared.

Methods inherited from class java.lang.Enum

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

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

EAGER

public static final ColumnRendering EAGER

In this mode, all columns are rendered upfront, regardless of their visibility within the viewport.

LAZY

public static final ColumnRendering LAZY

In this mode, body cells are rendered only when their corresponding columns are inside the visible viewport.

Method Details

values

public static ColumnRendering[] values()

Returns an array containing the constants of this enum class, in the order they are declared.

Returns:

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

valueOf

public static ColumnRendering valueOf(String name)

Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (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 class has no constant with the specified name

NullPointerException - if the argument is null

fromPropertyValue

public static ColumnRendering fromPropertyValue(String propertyValue)

Converts the property name in String form to the corresponding enum value. Values that cannot be mapped to a direct constant (including null) are mapped to EAGER.

Parameters:

propertyValue - the value for the rendering property

Returns:

the enum value corresponding to the property value, not null

getPropertyValue

public String getPropertyValue()

Gets the property value for the rendering mode.

Returns:

the property value