Package 

Interface LocatorService

  • All Implemented Interfaces:
    org.readium.r2.shared.publication.Publication.Service , org.readium.r2.shared.util.Closeable 
    
public interface LocatorService
 implements Publication.Service

    Locates the destination of various sources (e.g. locators, progression, etc.) in the publication.

    This service can be used to implement a variety of features, such as:

    • Jumping to a given position or total progression, by converting it first to a Locator.

    • Converting a Locator which was created from an alternate manifest with a different reading order. For example, when downloading a streamed manifest or offloading a package.

    • Nested Class Summary

      Nested Classes 
      Modifier and Type Class Description

    • Field Summary

      Fields 
      Modifier and Type Field Description

    • Constructor Summary

      Constructors 
      Constructor Description

    • Enum Constant Summary

      Enum Constants 
      Enum Constant Description

    • Method Summary

      Modifier and Type Method Description
      abstract Locator locate(Locator locator) Locates the target of the given locator.
      abstract Locator locateProgression(Double totalProgression) Locates the target at the given totalProgression relative to the whole publication.

      • Methods inherited from class org.readium.r2.shared.publication.Publication.Service

        close, get, getLinks

      • Methods inherited from class java.lang.Object

        clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait