org.apache.poi.hwpf.usermodel
Class BookmarksImpl

java.lang.Object
  extended by org.apache.poi.hwpf.usermodel.BookmarksImpl
All Implemented Interfaces:
Bookmarks

public class BookmarksImpl
extends java.lang.Object
implements Bookmarks

Implementation of user-friendly interface for document bookmarks

Author:
Sergey Vladimirov (vlsergey {at} gmail {doc} com)

Constructor Summary
BookmarksImpl(BookmarksTables bookmarksTables)
           
 
Method Summary
 Bookmark getBookmark(int index)
           
 java.util.List<Bookmark> getBookmarksAt(int startCp)
           
 int getBookmarksCount()
           
 java.util.Map<java.lang.Integer,java.util.List<Bookmark>> getBookmarksStartedBetween(int startInclusive, int endExclusive)
           
 void remove(int index)
          Remove bookmark from document (but not the bookmark text)
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

BookmarksImpl

public BookmarksImpl(BookmarksTables bookmarksTables)
Method Detail

getBookmark

public Bookmark getBookmark(int index)
Specified by:
getBookmark in interface Bookmarks
Parameters:
index - bookmark document index
Returns:
Bookmark with specified index

getBookmarksAt

public java.util.List<Bookmark> getBookmarksAt(int startCp)

getBookmarksCount

public int getBookmarksCount()
Specified by:
getBookmarksCount in interface Bookmarks
Returns:
count of Bookmarks in document

getBookmarksStartedBetween

public java.util.Map<java.lang.Integer,java.util.List<Bookmark>> getBookmarksStartedBetween(int startInclusive,
                                                                                            int endExclusive)
Specified by:
getBookmarksStartedBetween in interface Bookmarks
Returns:
Map of bookmarks started in specified range, where key is start position and value is sorted List of Bookmark

remove

public void remove(int index)
Description copied from interface: Bookmarks
Remove bookmark from document (but not the bookmark text)

Specified by:
remove in interface Bookmarks
Parameters:
index - bookmark document index to be removed


Copyright 2012 The Apache Software Foundation or its licensors, as applicable.