com.vaadin.shared.ui.grid

Enum ScrollDestination

java.lang.Object

java.lang.Enum<ScrollDestination>

com.vaadin.shared.ui.grid.ScrollDestination

All Implemented Interfaces:

Serializable, Comparable<ScrollDestination>

public enum ScrollDestination
extends Enum<ScrollDestination>

Enumeration, specifying the destinations that are supported when scrolling rows or columns into view.

Since:

7.4

Author:

Vaadin Ltd

Enum Constant Summary

Enum Constants

Enum Constant and Description
ANY Scroll as little as possible to show the target element.
END Scrolls so that the element is shown at the end of the viewport.
MIDDLE Scrolls so that the element is shown in the middle of the viewport.
START Scrolls so that the element is shown at the start of the viewport.

Method Summary

Modifier and Type	Method and Description
static ScrollDestination	valueOf(String name) Returns the enum constant of this type with the specified name.
static ScrollDestination[]	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

ANY

public static final ScrollDestination ANY

Scroll as little as possible to show the target element. If the element fits into view, this works as START or END depending on the current scroll position. If the element does not fit into view, this works as START.

START

public static final ScrollDestination START

Scrolls so that the element is shown at the start of the viewport. The viewport will, however, not scroll beyond its contents.

MIDDLE

public static final ScrollDestination MIDDLE

Scrolls so that the element is shown in the middle of the viewport. The viewport will, however, not scroll beyond its contents, given more elements than what the viewport is able to show at once. Under no circumstances will the viewport scroll before its first element.

END

public static final ScrollDestination END

Scrolls so that the element is shown at the end of the viewport. The viewport will, however, not scroll before its first element.

Method Detail

values

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

Returns:

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

valueOf

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