Package at.bestsolution.uia

Enum Class ScrollAmount

java.lang.Object

java.lang.Enum<ScrollAmount>

at.bestsolution.uia.ScrollAmount

All Implemented Interfaces:

INativeEnum, Serializable, Comparable<ScrollAmount>, Constable

public enum ScrollAmount
extends Enum<ScrollAmount>
implements INativeEnum

Contains values that specify the direction and distance to scroll.

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
LargeDecrement	Scrolling is done in large decrements, equivalent to pressing the PAGE UP key or clicking on a blank part of a scroll bar.
LargeIncrement	Scrolling is done in large increments, equivalent to pressing the PAGE DOWN or PAGE UP key or clicking on a blank part of a scroll bar.
NoAmount	No scrolling is done.
SmallDecrement	Scrolling is done in small decrements, equivalent to pressing an arrow key or clicking the arrow button on a scroll bar.
SmallIncrement	Scrolling is done in small increments, equivalent to pressing an arrow key or clicking the arrow button on a scroll bar.

Method Summary

Modifier and Type	Method	Description
static Optional<ScrollAmount>	fromNativeValue(int nativeValue)
String	getConstantName()
int	getNativeValue()
static ScrollAmount	valueOf(String name)	Returns the enum constant of this class with the specified name.
static ScrollAmount[]	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

LargeDecrement

public static final ScrollAmount LargeDecrement

Scrolling is done in large decrements, equivalent to pressing the PAGE UP key or clicking on a blank part of a scroll bar. If one page up is not a relevant amount for the control and no scroll bar exists, the value represents an amount equal to the current visible window.

SmallDecrement

public static final ScrollAmount SmallDecrement

Scrolling is done in small decrements, equivalent to pressing an arrow key or clicking the arrow button on a scroll bar.

NoAmount

public static final ScrollAmount NoAmount

No scrolling is done.

LargeIncrement

public static final ScrollAmount LargeIncrement

Scrolling is done in large increments, equivalent to pressing the PAGE DOWN or PAGE UP key or clicking on a blank part of a scroll bar. If one page is not a relevant amount for the control and no scroll bar exists, the value represents an amount equal to the current visible window.

SmallIncrement

public static final ScrollAmount SmallIncrement

Scrolling is done in small increments, equivalent to pressing an arrow key or clicking the arrow button on a scroll bar.

Method Details

values

public static ScrollAmount[] 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 ScrollAmount 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

getNativeValue

public int getNativeValue()

Specified by:

getNativeValue in interface INativeEnum

getConstantName

public String getConstantName()

Specified by:

getConstantName in interface INativeEnum

fromNativeValue

public static Optional<ScrollAmount> fromNativeValue(int nativeValue)