findDestinationPage
public PDPage findDestinationPage(PDDocument doc)
throws IOException
This method will attempt to find the page in this PDF document that this outline points to.
If the outline does not point to anything then this method will return null. If the outline
is an action that is not a GoTo action then this methods will throw the OutlineNotLocationException
doc
- The document to get the page from.
- The page that this outline will go to when activated or null if it does not point to anything.
getAction
public PDAction getAction()
Get the action of this node.
getDestination
public PDDestination getDestination()
throws IOException
Get the page destination of this node.
- The page destination of this node.
getNextSibling
public PDOutlineItem getNextSibling()
Return the next sibling or null if there is no next sibling.
getPreviousSibling
public PDOutlineItem getPreviousSibling()
Return the previous sibling or null if there is no sibling.
getStructureElement
public PDStructureElement getStructureElement()
Get the structure element of this node.
- The structure element of this node.
getTextColor
public PDColorSpaceInstance getTextColor()
Get the text color of this node. Default is black and this method
will never return null.
- The structure element of this node.
getTitle
public String getTitle()
Get the title of this node.
insertSiblingAfter
public void insertSiblingAfter(PDOutlineItem item)
Insert a sibling after this node.
item
- The item to insert.
isBold
public boolean isBold()
A flag telling if the text should be bold.
isItalic
public boolean isItalic()
A flag telling if the text should be italic.
setAction
public void setAction(PDAction action)
Set the action for this node.
action
- The new action for this node.
setBold
public void setBold(boolean bold)
Set the bold property of the text.
bold
- The new bold flag.
setDestination
public void setDestination(PDPage page)
A convenience method that will create an XYZ destination using only the defaults.
page
- The page to refer to.
setDestination
public void setDestination(PDDestination dest)
Set the page destination for this node.
dest
- The new page destination for this node.
setItalic
public void setItalic(boolean italic)
Set the italic property of the text.
italic
- The new italic flag.
setNextSibling
protected void setNextSibling(PDOutlineNode outlineNode)
Set the next sibling, this will be maintained by this class.
outlineNode
- The new next sibling.
setPreviousSibling
protected void setPreviousSibling(PDOutlineNode outlineNode)
Set the previous sibling, this will be maintained by this class.
outlineNode
- The new previous sibling.
setStructuredElement
public void setStructuredElement(PDStructureElement structureElement)
Set the structure element for this node.
structureElement
- The new structure element for this node.
setTextColor
public void setTextColor(Color textColor)
Set the text color for this node. The colorspace must be a PDDeviceRGB.
textColor
- The text color for this node.
setTextColor
public void setTextColor(PDColorSpaceInstance textColor)
Set the text color for this node. The colorspace must be a PDDeviceRGB.
textColor
- The text color for this node.
setTitle
public void setTitle(String title)
Set the title for this node.
title
- The new title for this node.