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

Enum ViewingHint

java.lang.Object

java.lang.Enum<ViewingHint>

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

All Implemented Interfaces:

Serializable, Comparable<ViewingHint>

public enum ViewingHint
extends Enum<ViewingHint>

A hint to the client as to the most appropriate method of displaying the resource. Other values may be given, and if they are, they must be URIs.

Enum Constant Summary

Enum Constants

Enum Constant and Description
CONTINUOUS Valid on manifest, sequence and range.
INDIVIDUALS Valid on manifest, sequence and range.
NON_PAGED Canvases with this hint must not be presented in a page turning interface, and must be skipped over when determining the page sequence.
PAGED Valid on manifest, sequence and range.
TOP Only valid on a range.

Method Summary

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

CONTINUOUS

public static final ViewingHint CONTINUOUS

Valid on manifest, sequence and range. Each canvas is the complete view of one side of a long scroll or roll and an appropriate rendering might only display part of the canvas at any given time rather than the entire object.

INDIVIDUALS

public static final ViewingHint INDIVIDUALS

Valid on manifest, sequence and range. The canvases referenced from the resource are all individual sheets, and should not be presented in a page-turning interface. Examples include a set of views of a 3 dimensional object, or a set of the front sides of photographs in a collection.

NON_PAGED

public static final ViewingHint NON_PAGED

Canvases with this hint must not be presented in a page turning interface, and must be skipped over when determining the page sequence. This viewing hint must be ignored if the current sequence or manifest does not have the ‘paged’ viewing hint.

PAGED

public static final ViewingHint PAGED

Valid on manifest, sequence and range. The canvases represent pages in a bound volume, and should be presented in a page-turning interface if one is available. The first canvas is a single view (the first recto) and thus the second canvas represents the back of the object in the first canvas.

TOP

public static final ViewingHint TOP

Only valid on a range. A range which has this viewingHint is the top-most node in a hierarchy of ranges that represents a structure to be rendered by the client to assist in navigation. For example, a table of contents within a paged object, major sections of a 3d object, the textual areas within a single scroll, and so forth. Other ranges that are descendants of the “top” range are the entries to be rendered in the navigation structure. There may be multiple ranges marked with this hint. If so, the client should display a choice of multiple structures to navigate through.

Method Detail

values

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

Returns:

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

valueOf

public static ViewingHint 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()