Package org.mycore.iiif.presentation.model.attributes

Enum Class MCRIIIFViewingHint

java.lang.Object
java.lang.Enum<MCRIIIFViewingHint>
org.mycore.iiif.presentation.model.attributes.MCRIIIFViewingHint
All Implemented Interfaces:
Serializable, Comparable<MCRIIIFViewingHint>, java.lang.constant.Constable
public enum MCRIIIFViewingHint extends Enum<MCRIIIFViewingHint>
A hint to the client as to the most appropriate method of displaying the resource.
See Also:

  • 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
    continuous
    "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.
    facing_pages
    "Canvases with this hint, in a sequence or manifest with the “paged” viewing hint, must be displayed by themselves, as they depict both parts of the opening.
    individuals
    "The canvases referenced from the resource are all individual sheets, and should not be presented in a page-turning interface.
    multi_part
    " Valid only for collections.
    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
    "The canvases represent pages in a bound volume, and should be presented in a page-turning interface if one is available.
    top
    "Only valid on a range.

  • Method Summary

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

    • individuals

      @SerializedName("individuals") public static final MCRIIIFViewingHint individuals
      "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."

    • paged

      @SerializedName("paged") public static final MCRIIIFViewingHint paged
      "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."

    • multi_part

      @SerializedName("multi-part") public static final MCRIIIFViewingHint multi_part
      " Valid only for collections. Collections with this hint consist of multiple manifests that each form part of a logical whole. Clients might render the collection as a table of contents, rather than with thumbnails. Examples include multi-volume books or a set of journal issues or other serials. "

    • continuous

      @SerializedName("continuous") public static final MCRIIIFViewingHint continuous
      "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. "

    • non_paged

      @SerializedName("non-paged") public static final MCRIIIFViewingHint 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."

    • top

      @SerializedName("top") public static final MCRIIIFViewingHint 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."

    • facing_pages

      @SerializedName("facing-pages") public static final MCRIIIFViewingHint facing_pages
      "Canvases with this hint, in a sequence or manifest with the “paged” viewing hint, must be displayed by themselves, as they depict both parts of the opening. If all of the canvases are like this, then page turning is not possible, so simply use “individuals” instead."

  • Method Details

    • values

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