Interface Bookmarks

All Known Implementing Classes:
BookmarksImpl

public interface Bookmarks
User-friendly interface to access document bookmarks
Author:
Sergey Vladimirov (vlsergey {at} gmail {dot} com)
  • Method Details

    • getBookmark

      Bookmark getBookmark(int index) throws IndexOutOfBoundsException
      Parameters:
      index - bookmark document index
      Returns:
      Bookmark with specified index
      Throws:
      IndexOutOfBoundsException - if bookmark with specified index not present in document
    • getBookmarksCount

      int getBookmarksCount()
      Returns:
      count of Bookmarks in document
    • getBookmarksStartedBetween

      Map<Integer,List<Bookmark>> getBookmarksStartedBetween(int startInclusive, int endExclusive)
      Returns:
      Map of bookmarks started in specified range, where key is start position and value is sorted List of Bookmark
    • remove

      void remove(int index)
      Remove bookmark from document (but not the bookmark text)
      Parameters:
      index - bookmark document index to be removed