Package nl.siegmann.epublib.domain

Class Guide

  • All Implemented Interfaces:
    java.io.Serializable
    public class Guide
extends java.lang.Object
implements java.io.Serializable
    The guide is a selection of special pages of the book. Examples of these are the cover, list of illustrations, etc. It is an optional part of an epub, and support for the various types of references varies by reader. The only part of this that is heavily used is the cover page.
    See Also:
    Serialized Form

    • Field Detail

      • DEFAULT_COVER_TITLE

        public static final java.lang.String DEFAULT_COVER_TITLE

      • coverPageIndex

        private int coverPageIndex

    • Constructor Detail

      • Guide

        public Guide()

    • Method Detail

      • getReferences

        public java.util.List<GuideReference> getReferences()

      • setReferences

        public void setReferences​(java.util.List<GuideReference> references)

      • uncheckCoverPage

        private void uncheckCoverPage()

      • setCoverReference

        public int setCoverReference​(GuideReference guideReference)

      • checkCoverPage

        private void checkCoverPage()

      • initCoverPage

        private void initCoverPage()

      • getCoverPage

        public Resource getCoverPage()
        The coverpage of the book.
        Returns:
        The coverpage of the book.

      • setCoverPage

        public void setCoverPage​(Resource coverPage)

      • getGuideReferencesByType

        public java.util.List<GuideReference> getGuideReferencesByType​(java.lang.String referenceTypeName)
        A list of all GuideReferences that have the given referenceTypeName (ignoring case).
        Parameters:
        referenceTypeName -
        Returns:
        A list of all GuideReferences that have the given referenceTypeName (ignoring case).