LocatorService class abstract

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.
Inheritance
Implementers

Constructors

LocatorService()

Properties

hashCode int
The hash code for this object.
no setterinherited
Links which will be added to Publication.links. It can be used to expose a web API for the service, through Publication.get.
no setterinherited
runtimeType Type
A representation of the runtime type of the object.
no setterinherited
serviceType Type
This is the supertype of the service that the subclass is implementing
no setteroverride

Methods

close() → void
Closes any opened file handles, removes temporary files, etc.
override
get(Link link) Resource?
A service can return a Resource to:
inherited
locate(Locator locator) Future<Locator?>
Locates the target of the given locator.
locateProgression(double totalProgression) Future<Locator?>
Locates the target at the given totalProgression relative to the whole publication.
noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
toString() String
A string representation of this object.
inherited

Operators

operator ==(Object other) bool
The equality operator.
inherited