1 package com.folioreader.model;
6 * Interface to access Highlight data.
8 * @author gautam chibde on 9/10/17.
11 public interface HighLight {
16 enum HighLightAction {
21 * <p> Returns Book id, which can be provided to intent to folio reader, if not provided id is
22 * used from epub's dc:identifier field in metadata.
23 * <p>for reference, look here:
24 * <a href="http://www.idpf.org/epub/30/spec/epub30-publications.html#sec-package-metadata-identifiers">IDPF</a>.</p>
25 * in case identifier is not found in the epub,
26 * <a href="https://docs.oracle.com/javase/7/docs/api/java/lang/String.html#hashCode()">hash code</a>
27 * of book title is used also if book title is not found then
28 * hash code of the book file name is used.
34 * Returns Highlighted text content text content.
39 * Returns Date time when highlight is created (format:- MMM dd, yyyy | HH:mm).
44 * Returns Field defines the color of the highlight.
49 * Returns Page index in the book taken from Epub spine reference.
54 * Returns href of the page from the Epub spine list.
59 * <p> Contains highlight meta data in terms of rangy format.</p>
60 * <strong>format </strong>:- start$end$id$class$containerId.
61 * <p>for reference, look here: <a href="https://github.com/timdown/rangy">rangy</a>.</p>
66 * returns Unique identifier.
71 * Returns Note linked to the highlight (optional)