|
fop 1.1 | |||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||
java.lang.Objectorg.apache.fop.area.AbstractOffDocumentItem
org.apache.fop.area.BookmarkData
public class BookmarkData
An instance of this class is either a PDF bookmark-tree and its child bookmark-items, or a bookmark-item and the child child bookmark-items under it.
| Field Summary |
|---|
| Fields inherited from class org.apache.fop.area.AbstractOffDocumentItem |
|---|
AFTER_PAGE, END_OF_DOC, IMMEDIATELY, START_OF_DOC, whenToProcess |
| Constructor Summary | |
|---|---|
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(java.lang.String title,
boolean showChildren,
PageViewport pv,
java.lang.String idRef)
Create a new bookmark data object. |
|
| Method Summary | |
|---|---|
void |
addSubData(BookmarkData sub)
Add a child bookmark data object. |
java.lang.String |
getBookmarkTitle()
Get the title for this bookmark object. |
int |
getCount()
Get the size of child data objects. |
java.lang.String |
getIDRef()
Get the idref for this bookmark-item |
java.lang.String[] |
getIDRefs()
Get the array of idrefs of this resolvable object. |
java.lang.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(java.lang.String id,
java.util.List<PageViewport> pages)
Resolve this resolvable object. |
boolean |
showChildItems()
Indicator of whether to initially display child bookmarks. |
| Methods inherited from class org.apache.fop.area.AbstractOffDocumentItem |
|---|
getWhenToProcess |
| Methods inherited from class java.lang.Object |
|---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
| Constructor Detail |
|---|
public BookmarkData(BookmarkTree bookmarkTree)
bookmarkTree - fo:bookmark-tree for this documentpublic BookmarkData(Bookmark bookmark)
bookmark - the fo:bookmark objectpublic BookmarkData()
public BookmarkData(java.lang.String title,
boolean showChildren,
PageViewport pv,
java.lang.String idRef)
title - the bookmark's titleshowChildren - whether to initially display the bookmark's childrenpv - the target PageViewportidRef - the target ID| Method Detail |
|---|
public java.lang.String getIDRef()
public void addSubData(BookmarkData sub)
sub - the child bookmark datapublic java.lang.String getBookmarkTitle()
public boolean showChildItems()
public int getCount()
public BookmarkData getSubData(int count)
count - the index to get
public PageViewport getPageViewport()
public boolean isResolved()
isResolved in interface Resolvablepublic java.lang.String[] getIDRefs()
getIDRefs in interface Resolvable
public void resolveIDRef(java.lang.String id,
java.util.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 java.lang.String getName()
getName in interface OffDocumentItemgetName in class AbstractOffDocumentItem
|
fop 1.1 | |||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||