Package org.apache.poi.hwpf.usermodel
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 Summary
Modifier and TypeMethodDescriptiongetBookmark
(int index) int
getBookmarksStartedBetween
(int startInclusive, int endExclusive) void
remove
(int index) Remove bookmark from document (but not the bookmark text)
-
Method Details
-
getBookmark
- 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
Bookmark
s in document
-
getBookmarksStartedBetween
-
remove
void remove(int index) Remove bookmark from document (but not the bookmark text)- Parameters:
index
- bookmark document index to be removed
-