|
|||||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | ||||||||||
java.lang.Objectorg.pdfbox.pdmodel.interactive.documentnavigation.outline.PDOutlineNode
org.pdfbox.pdmodel.interactive.documentnavigation.outline.PDOutlineItem
This represents an outline in a pdf document.
| Field Summary |
| Fields inherited from class org.pdfbox.pdmodel.interactive.documentnavigation.outline.PDOutlineNode |
node |
| Constructor Summary | |
PDOutlineItem()
Default Constructor. |
|
PDOutlineItem(COSDictionary dic)
Constructor for an existing outline item. |
|
| Method Summary | |
PDPage |
findDestinationPage(PDDocument doc)
This method will attempt to find the page in this PDF document that this outline points to. |
PDAction |
getAction()
Get the action of this node. |
PDDestination |
getDestination()
Get the page destination of this node. |
PDOutlineItem |
getNextSibling()
Return the next sibling or null if there is no next sibling. |
PDOutlineItem |
getPreviousSibling()
Return the previous sibling or null if there is no sibling. |
PDStructureElement |
getStructureElement()
Get the structure element of this node. |
PDColorSpaceInstance |
getTextColor()
Get the text color of this node. |
String |
getTitle()
Get the title of this node. |
void |
insertSiblingAfter(PDOutlineItem item)
Insert a sibling after this node. |
boolean |
isBold()
A flag telling if the text should be bold. |
boolean |
isItalic()
A flag telling if the text should be italic. |
void |
setAction(PDAction action)
Set the action for this node. |
void |
setBold(boolean bold)
Set the bold property of the text. |
void |
setDestination(PDDestination dest)
Set the page destination for this node. |
void |
setDestination(PDPage page)
A convenience method that will create an XYZ destination using only the defaults. |
void |
setItalic(boolean italic)
Set the italic property of the text. |
protected void |
setNextSibling(PDOutlineNode outlineNode)
Set the next sibling, this will be maintained by this class. |
protected void |
setPreviousSibling(PDOutlineNode outlineNode)
Set the previous sibling, this will be maintained by this class. |
void |
setStructuredElement(PDStructureElement structureElement)
Set the structure element for this node. |
void |
setTextColor(Color textColor)
Set the text color for this node. |
void |
setTextColor(PDColorSpaceInstance textColor)
Set the text color for this node. |
void |
setTitle(String title)
Set the title for this node. |
| Methods inherited from class org.pdfbox.pdmodel.interactive.documentnavigation.outline.PDOutlineNode |
appendChild, closeNode, getCOSDictionary, getCOSObject, getFirstChild, getLastChild, getOpenCount, getParent, isNodeOpen, openNode, setFirstChild, setLastChild, setOpenCount, setParent, updateParentOpenCount |
| Methods inherited from class java.lang.Object |
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
| Constructor Detail |
public PDOutlineItem()
public PDOutlineItem(COSDictionary dic)
dic - The storage dictionary.| Method Detail |
public void insertSiblingAfter(PDOutlineItem item)
item - The item to insert.public PDOutlineItem getPreviousSibling()
protected void setPreviousSibling(PDOutlineNode outlineNode)
outlineNode - The new previous sibling.public PDOutlineItem getNextSibling()
protected void setNextSibling(PDOutlineNode outlineNode)
outlineNode - The new next sibling.public String getTitle()
public void setTitle(String title)
title - The new title for this node.
public PDDestination getDestination()
throws IOException
IOException - If there is an error creating the destination.public void setDestination(PDDestination dest)
dest - The new page destination for this node.public void setDestination(PDPage page)
page - The page to refer to.
public PDPage findDestinationPage(PDDocument doc)
throws IOException
doc - The document to get the page from.
IOException - If there is an error when trying to find the page.public PDAction getAction()
public void setAction(PDAction action)
action - The new action for this node.public PDStructureElement getStructureElement()
public void setStructuredElement(PDStructureElement structureElement)
structureElement - The new structure element for this node.public PDColorSpaceInstance getTextColor()
public void setTextColor(PDColorSpaceInstance textColor)
textColor - The text color for this node.public void setTextColor(Color textColor)
textColor - The text color for this node.public boolean isItalic()
public void setItalic(boolean italic)
italic - The new italic flag.public boolean isBold()
public void setBold(boolean bold)
bold - The new bold flag.
|
|||||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | ||||||||||