com.github.mkolisnyk.sirius.client.ui

Enum ScrollTo

java.lang.Object

java.lang.Enum<ScrollTo>

com.github.mkolisnyk.sirius.client.ui.ScrollTo

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<ScrollTo>

public enum ScrollTo
extends java.lang.Enum<ScrollTo>

Enumeration which is used for scrolling operations. Mainly, it is involved in the following methods:

• Page.scrollTo(com.github.mkolisnyk.sirius.client.ui.controls.Control, ScrollTo)
• Page.scrollTo(String, ScrollTo)

Also, this enumeration is used for FindBy.scrollDirection() field.

Each enumeration value defines the sequence of scroll actions to reach some certain control or text. Thus, the meaning of constants are the following:

• TOP_ONLY - scrolling is performed only to the top.
• BOTTOM_ONLY - scrolling is performed only to the bottom.
• TOP_BOTTOM - the scrolling is performed to top first, then into the bottom.
• BOTTOM_TOP - the scrolling is performed to the bottom first, then into the top.

Author:

Mykola Kolisnyk

Enum Constant Summary

Enum Constants

Enum Constant and Description
BOTTOM_ONLY
BOTTOM_TOP
TOP_BOTTOM
TOP_ONLY

Method Summary

Modifier and Type	Method and Description
static ScrollTo	valueOf(java.lang.String name) Returns the enum constant of this type with the specified name.
static ScrollTo[]	values() Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

compareTo, equals, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

TOP_ONLY

public static final ScrollTo TOP_ONLY

BOTTOM_ONLY

public static final ScrollTo BOTTOM_ONLY

TOP_BOTTOM

public static final ScrollTo TOP_BOTTOM

BOTTOM_TOP

public static final ScrollTo BOTTOM_TOP

Method Detail

values

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

Returns:

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

valueOf

public static ScrollTo valueOf(java.lang.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:

java.lang.IllegalArgumentException - if this enum type has no constant with the specified name

java.lang.NullPointerException - if the argument is null