de.digitalcollections.iiif.presentation.model.api.enums

Enum ViewingDirection

java.lang.Object

java.lang.Enum<ViewingDirection>

de.digitalcollections.iiif.presentation.model.api.enums.ViewingDirection

All Implemented Interfaces:

Serializable, Comparable<ViewingDirection>

public enum ViewingDirection
extends Enum<ViewingDirection>

The direction that canvases of the resource should be presented when rendered for the user to navigate and/or read. Possible values are:

Enum Constant Summary

Enum Constants

Enum Constant and Description
BTT The object is read from the bottom to the top.
LTR The object is read from left to right, and is the default if not specified.
RTL The object is read from right to left.
TTB The object is read from the top to the bottom.

Method Summary

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

LTR

public static final ViewingDirection LTR

The object is read from left to right, and is the default if not specified.

RTL

public static final ViewingDirection RTL

The object is read from right to left.

TTB

public static final ViewingDirection TTB

The object is read from the top to the bottom.

BTT

public static final ViewingDirection BTT

The object is read from the bottom to the top.

Method Detail

values

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

Returns:

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

valueOf

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

getValue

public String getValue()