Module com.pi4j.crowpi

Package com.pi4j.crowpi.components

Enum Class LedMatrixComponent.ScrollMode

java.lang.Object

java.lang.Enum<LedMatrixComponent.ScrollMode>

com.pi4j.crowpi.components.LedMatrixComponent.ScrollMode

All Implemented Interfaces:

Serializable, Comparable<LedMatrixComponent.ScrollMode>, Constable

Enclosing class:

LedMatrixComponent

protected static enum LedMatrixComponent.ScrollMode
extends Enum<LedMatrixComponent.ScrollMode>

Specifies which mode should be used while scrolling the LED matrix.

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
NORMAL	Normally scroll the LED matrix in one direction, causing one row or column to be empty.
REPLACE	Scroll the LED matrix in one direction and replace the now empty row or column with values from a new buffer.
ROTATE	Scroll the LED matrix in one direction and wrap the row or column around to the other side.

Method Summary

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

NORMAL

public static final LedMatrixComponent.ScrollMode NORMAL

Normally scroll the LED matrix in one direction, causing one row or column to be empty.

ROTATE

public static final LedMatrixComponent.ScrollMode ROTATE

Scroll the LED matrix in one direction and wrap the row or column around to the other side.

REPLACE

public static final LedMatrixComponent.ScrollMode REPLACE

Scroll the LED matrix in one direction and replace the now empty row or column with values from a new buffer. This can be used to gradually transition from one buffer to another via scrolling.

Method Details

values

public static LedMatrixComponent.ScrollMode[] 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 LedMatrixComponent.ScrollMode 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