Package org.apache.poi.hwpf.usermodel
Interface Bookmarks
-
- All Known Implementing Classes:
BookmarksImpl
public interface Bookmarks
User-friendly interface to access document bookmarks
-
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description Bookmark
getBookmark(int index)
int
getBookmarksCount()
Map<Integer,List<Bookmark>>
getBookmarksStartedBetween(int startInclusive, int endExclusive)
void
remove(int index)
Remove bookmark from document (but not the bookmark text)
-
-
-
Method Detail
-
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
Bookmark
s in document
-
getBookmarksStartedBetween
Map<Integer,List<Bookmark>> getBookmarksStartedBetween(int startInclusive, int endExclusive)
-
remove
void remove(int index)
Remove bookmark from document (but not the bookmark text)- Parameters:
index
- bookmark document index to be removed
-
-