Java Doc for PDOutlineItem.java in  » PDF » PDFBox-0.7.3 » org » pdfbox » pdmodel » interactive » documentnavigation » outline » Java Source Code / Java DocumentationJava Source Code and Java Documentation

Java Source Code / Java Documentation
1. 6.0 JDK Core
2. 6.0 JDK Modules
3. 6.0 JDK Modules com.sun
4. 6.0 JDK Modules com.sun.java
5. 6.0 JDK Modules sun
6. 6.0 JDK Platform
7. Ajax
8. Apache Harmony Java SE
9. Aspect oriented
10. Authentication Authorization
11. Blogger System
12. Build
13. Byte Code
14. Cache
15. Chart
16. Chat
17. Code Analyzer
18. Collaboration
19. Content Management System
20. Database Client
21. Database DBMS
22. Database JDBC Connection Pool
23. Database ORM
24. Development
25. EJB Server geronimo
26. EJB Server GlassFish
27. EJB Server JBoss 4.2.1
28. EJB Server resin 3.1.5
29. ERP CRM Financial
30. ESB
31. Forum
32. GIS
33. Graphic Library
34. Groupware
35. HTML Parser
36. IDE
37. IDE Eclipse
38. IDE Netbeans
39. Installer
40. Internationalization Localization
41. Inversion of Control
42. Issue Tracking
43. J2EE
44. JBoss
45. JMS
46. JMX
47. Library
48. Mail Clients
49. Net
50. Parser
51. PDF
52. Portal
53. Profiler
54. Project Management
55. Report
56. RSS RDF
57. Rule Engine
58. Science
59. Scripting
60. Search Engine
61. Security
62. Sevlet Container
63. Source Control
64. Swing Library
65. Template Engine
66. Test Coverage
67. Testing
68. UML
69. Web Crawler
70. Web Framework
71. Web Mail
72. Web Server
73. Web Services
74. Web Services apache cxf 2.0.1
75. Web Services AXIS2
76. Wiki Engine
77. Workflow Engines
78. XML
79. XML UI
Java
Java Tutorial
Java Open Source
Jar File Download
Java Articles
Java Products
Java by API
Photoshop Tutorials
Maya Tutorials
Flash Tutorials
3ds-Max Tutorials
Illustrator Tutorials
GIMP Tutorials
C# / C Sharp
C# / CSharp Tutorial
C# / CSharp Open Source
ASP.Net
ASP.NET Tutorial
JavaScript DHTML
JavaScript Tutorial
JavaScript Reference
HTML / CSS
HTML CSS Reference
C / ANSI-C
C Tutorial
C++
C++ Tutorial
Ruby
PHP
Python
Python Tutorial
Python Open Source
SQL Server / T-SQL
SQL Server / T-SQL Tutorial
Oracle PL / SQL
Oracle PL/SQL Tutorial
PostgreSQL
SQL / MySQL
MySQL Tutorial
VB.Net
VB.Net Tutorial
Flash / Flex / ActionScript
VBA / Excel / Access / Word
XML
XML Tutorial
Microsoft Office PowerPoint 2007 Tutorial
Microsoft Office Excel 2007 Tutorial
Microsoft Office Word 2007 Tutorial
Java Source Code / Java Documentation » PDF » PDFBox 0.7.3 » org.pdfbox.pdmodel.interactive.documentnavigation.outline 
Source Cross Reference  Class Diagram Java Document (Java Doc) 


java.lang.Object
   org.pdfbox.pdmodel.interactive.documentnavigation.outline.PDOutlineNode
      org.pdfbox.pdmodel.interactive.documentnavigation.outline.PDOutlineItem

PDOutlineItem
public class PDOutlineItem extends PDOutlineNode (Code)
This represents an outline in a pdf document.
author:
   Ben Litchfield
version:
   $Revision: 1.7 $



Constructor Summary
public  PDOutlineItem()
     Default Constructor.
public  PDOutlineItem(COSDictionary dic)
     Constructor for an existing outline item.

Method Summary
public  PDPagefindDestinationPage(PDDocument doc)
     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.
public  PDActiongetAction()
     Get the action of this node.
public  PDDestinationgetDestination()
     Get the page destination of this node.
public  PDOutlineItemgetNextSibling()
     Return the next sibling or null if there is no next sibling.
public  PDOutlineItemgetPreviousSibling()
     Return the previous sibling or null if there is no sibling.
public  PDStructureElementgetStructureElement()
     Get the structure element of this node.
public  PDColorSpaceInstancegetTextColor()
     Get the text color of this node.
public  StringgetTitle()
     Get the title of this node.
public  voidinsertSiblingAfter(PDOutlineItem item)
     Insert a sibling after this node.
public  booleanisBold()
     A flag telling if the text should be bold.
public  booleanisItalic()
     A flag telling if the text should be italic.
public  voidsetAction(PDAction action)
     Set the action for this node.
public  voidsetBold(boolean bold)
     Set the bold property of the text.
public  voidsetDestination(PDDestination dest)
     Set the page destination for this node.
public  voidsetDestination(PDPage page)
     A convenience method that will create an XYZ destination using only the defaults.
public  voidsetItalic(boolean italic)
     Set the italic property of the text.
protected  voidsetNextSibling(PDOutlineNode outlineNode)
     Set the next sibling, this will be maintained by this class.
protected  voidsetPreviousSibling(PDOutlineNode outlineNode)
     Set the previous sibling, this will be maintained by this class.
public  voidsetStructuredElement(PDStructureElement structureElement)
     Set the structure element for this node.
public  voidsetTextColor(PDColorSpaceInstance textColor)
     Set the text color for this node.
public  voidsetTextColor(Color textColor)
     Set the text color for this node.
public  voidsetTitle(String title)
     Set the title for this node.


Constructor Detail
PDOutlineItem
public PDOutlineItem()(Code)
Default Constructor.



PDOutlineItem
public PDOutlineItem(COSDictionary dic)(Code)
Constructor for an existing outline item.
Parameters:
  dic - The storage dictionary.




Method Detail
findDestinationPage
public PDPage findDestinationPage(PDDocument doc) throws IOException(Code)
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
Parameters:
  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.
throws:
  IOException - If there is an error when trying to find the page.



getAction
public PDAction getAction()(Code)
Get the action of this node. The action of this node.



getDestination
public PDDestination getDestination() throws IOException(Code)
Get the page destination of this node. The page destination of this node.
throws:
  IOException - If there is an error creating the destination.



getNextSibling
public PDOutlineItem getNextSibling()(Code)
Return the next sibling or null if there is no next sibling. The next sibling.



getPreviousSibling
public PDOutlineItem getPreviousSibling()(Code)
Return the previous sibling or null if there is no sibling. The previous sibling.



getStructureElement
public PDStructureElement getStructureElement()(Code)
Get the structure element of this node. The structure element of this node.



getTextColor
public PDColorSpaceInstance getTextColor()(Code)
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()(Code)
Get the title of this node. The title of this node.



insertSiblingAfter
public void insertSiblingAfter(PDOutlineItem item)(Code)
Insert a sibling after this node.
Parameters:
  item - The item to insert.



isBold
public boolean isBold()(Code)
A flag telling if the text should be bold. The bold flag.



isItalic
public boolean isItalic()(Code)
A flag telling if the text should be italic. The italic flag.



setAction
public void setAction(PDAction action)(Code)
Set the action for this node.
Parameters:
  action - The new action for this node.



setBold
public void setBold(boolean bold)(Code)
Set the bold property of the text.
Parameters:
  bold - The new bold flag.



setDestination
public void setDestination(PDDestination dest)(Code)
Set the page destination for this node.
Parameters:
  dest - The new page destination for this node.



setDestination
public void setDestination(PDPage page)(Code)
A convenience method that will create an XYZ destination using only the defaults.
Parameters:
  page - The page to refer to.



setItalic
public void setItalic(boolean italic)(Code)
Set the italic property of the text.
Parameters:
  italic - The new italic flag.



setNextSibling
protected void setNextSibling(PDOutlineNode outlineNode)(Code)
Set the next sibling, this will be maintained by this class.
Parameters:
  outlineNode - The new next sibling.



setPreviousSibling
protected void setPreviousSibling(PDOutlineNode outlineNode)(Code)
Set the previous sibling, this will be maintained by this class.
Parameters:
  outlineNode - The new previous sibling.



setStructuredElement
public void setStructuredElement(PDStructureElement structureElement)(Code)
Set the structure element for this node.
Parameters:
  structureElement - The new structure element for this node.



setTextColor
public void setTextColor(PDColorSpaceInstance textColor)(Code)
Set the text color for this node. The colorspace must be a PDDeviceRGB.
Parameters:
  textColor - The text color for this node.



setTextColor
public void setTextColor(Color textColor)(Code)
Set the text color for this node. The colorspace must be a PDDeviceRGB.
Parameters:
  textColor - The text color for this node.



setTitle
public void setTitle(String title)(Code)
Set the title for this node.
Parameters:
  title - The new title for this node.



Fields inherited from org.pdfbox.pdmodel.interactive.documentnavigation.outline.PDOutlineNode
protected COSDictionary node(Code)(Java Doc)

Methods inherited from org.pdfbox.pdmodel.interactive.documentnavigation.outline.PDOutlineNode
public void appendChild(PDOutlineItem outlineNode)(Code)(Java Doc)
public void closeNode()(Code)(Java Doc)
public COSDictionary getCOSDictionary()(Code)(Java Doc)
public COSBase getCOSObject()(Code)(Java Doc)
public PDOutlineItem getFirstChild()(Code)(Java Doc)
public PDOutlineItem getLastChild()(Code)(Java Doc)
public int getOpenCount()(Code)(Java Doc)
public PDOutlineNode getParent()(Code)(Java Doc)
public boolean isNodeOpen()(Code)(Java Doc)
public void openNode()(Code)(Java Doc)
protected void setFirstChild(PDOutlineNode outlineNode)(Code)(Java Doc)
protected void setLastChild(PDOutlineNode outlineNode)(Code)(Java Doc)
protected void setOpenCount(int openCount)(Code)(Java Doc)
protected void setParent(PDOutlineNode parent)(Code)(Java Doc)
protected void updateParentOpenCount(int amount)(Code)(Java Doc)

Methods inherited from java.lang.Object
native protected Object clone() throws CloneNotSupportedException(Code)(Java Doc)
public boolean equals(Object obj)(Code)(Java Doc)
protected void finalize() throws Throwable(Code)(Java Doc)
final native public Class getClass()(Code)(Java Doc)
native public int hashCode()(Code)(Java Doc)
final native public void notify()(Code)(Java Doc)
final native public void notifyAll()(Code)(Java Doc)
public String toString()(Code)(Java Doc)
final native public void wait(long timeout) throws InterruptedException(Code)(Java Doc)
final public void wait(long timeout, int nanos) throws InterruptedException(Code)(Java Doc)
final public void wait() throws InterruptedException(Code)(Java Doc)

www.java2java.com | Contact Us
Copyright 2009 - 12 Demo Source and Support. All rights reserved.
All other trademarks are property of their respective owners.