public class BookmarkData extends AbstractOffDocumentItem implements Resolvable
AFTER_PAGE, END_OF_DOC, IMMEDIATELY, START_OF_DOC, whenToProcess| Constructor and Description |
|---|
BookmarkData()
Create a new bookmark data root object.
|
BookmarkData(Bookmark bookmark)
Create a new pdf bookmark data object.
|
BookmarkData(BookmarkTree bookmarkTree)
Create a new bookmark data object.
|
BookmarkData(String title,
boolean showChildren,
PageViewport pv,
String idRef)
Create a new bookmark data object.
|
| Modifier and Type | Method and Description |
|---|---|
void |
addSubData(BookmarkData sub)
Add a child bookmark data object.
|
String |
getBookmarkTitle()
Get the title for this bookmark object.
|
int |
getCount()
Get the size of child data objects.
|
String |
getIDRef()
Get the idref for this bookmark-item
|
String[] |
getIDRefs()
Get the array of idrefs of this resolvable object.
|
String |
getName()
Return a human-readable name for this ODI (for error messages, etc.)
|
PageViewport |
getPageViewport()
Get the PageViewport object that this bookmark refers to
|
BookmarkData |
getSubData(int count)
Get the child data object.
|
boolean |
isResolved()
Check if this resolvable object has been resolved.
|
void |
resolveIDRef(String id,
List<PageViewport> pages)
Resolve this resolvable object.
|
boolean |
showChildItems()
Indicator of whether to initially display child bookmarks.
|
getWhenToProcesspublic BookmarkData(BookmarkTree bookmarkTree)
bookmarkTree - fo:bookmark-tree for this documentpublic BookmarkData(Bookmark bookmark)
bookmark - the fo:bookmark objectpublic BookmarkData()
public BookmarkData(String title, boolean showChildren, PageViewport pv, String idRef)
title - the bookmark's titleshowChildren - whether to initially display the bookmark's childrenpv - the target PageViewportidRef - the target IDpublic String getIDRef()
public void addSubData(BookmarkData sub)
sub - the child bookmark datapublic String getBookmarkTitle()
public boolean showChildItems()
public int getCount()
public BookmarkData getSubData(int count)
count - the index to getpublic PageViewport getPageViewport()
public boolean isResolved()
isResolved in interface Resolvablepublic String[] getIDRefs()
getIDRefs in interface Resolvablepublic void resolveIDRef(String id, List<PageViewport> pages)
resolveIDRef in interface Resolvableid - an ID matching one of the Resolvable object's
unresolved idref's.pages - the list of PageViewports with the given IDpublic String getName()
getName in interface OffDocumentItemgetName in class AbstractOffDocumentItemCopyright © 2025 Apache Software Foundation. All rights reserved.