Package nl.siegmann.epublib.domain

Class SpineReference

java.lang.Object
nl.siegmann.epublib.domain.ResourceReference
nl.siegmann.epublib.domain.SpineReference
All Implemented Interfaces:
Serializable
public class SpineReference extends ResourceReference implements Serializable
A Section of a book. Represents both an item in the package document and a item in the index.
See Also:

  • Field Details

    • serialVersionUID

      private static final long serialVersionUID
      See Also:

    • linear

      private boolean linear

  • Constructor Details

    • SpineReference

      public SpineReference(Resource resource)

    • SpineReference

      public SpineReference(Resource resource, boolean linear)

  • Method Details

    • isLinear

      public boolean isLinear()
      Linear denotes whether the section is Primary or Auxiliary. Usually the cover page has linear set to false and all the other sections have it set to true. It's an optional property that readers may also ignore.
      primary or auxiliary is useful for Reading Systems which opt to present auxiliary content differently than primary content. For example, a Reading System might opt to render auxiliary content in a popup window apart from the main window which presents the primary content. (For an example of the types of content that may be considered auxiliary, refer to the example below and the subsequent discussion.)
      Returns:
      whether the section is Primary or Auxiliary.
      See Also:

    • setLinear

      public void setLinear(boolean linear)