Java Doc for PDOutlineNode.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

All known Subclasses:   org.pdfbox.pdmodel.interactive.documentnavigation.outline.PDDocumentOutline,  org.pdfbox.pdmodel.interactive.documentnavigation.outline.PDOutlineItem,
PDOutlineNode
public class PDOutlineNode implements COSObjectable(Code)
This represents an node in an outline in a pdf document.
author:
   Ben Litchfield
version:
   $Revision: 1.3 $


Field Summary
protected  COSDictionarynode
     The dictionary for this node.

Constructor Summary
public  PDOutlineNode()
     Default Constructor.
public  PDOutlineNode(COSDictionary dict)
     Default Constructor.

Method Summary
public  voidappendChild(PDOutlineItem outlineNode)
     append a child node to this node.
public  voidcloseNode()
     Close this node.
public  COSDictionarygetCOSDictionary()
     Convert this standard java object to a COS object.
public  COSBasegetCOSObject()
     Convert this standard java object to a COS object.
public  PDOutlineItemgetFirstChild()
     Return the first child or null if there is no child.
public  PDOutlineItemgetLastChild()
     Return the last child or null if there is no child.
public  intgetOpenCount()
     Get the number of open nodes.
public  PDOutlineNodegetParent()
     Get the parent of this object.
public  booleanisNodeOpen()
     Node is open if the open count is greater than zero.
public  voidopenNode()
     This will set this node to be open when it is shown in the viewer.
protected  voidsetFirstChild(PDOutlineNode outlineNode)
     Set the first child, this will be maintained by this class.
protected  voidsetLastChild(PDOutlineNode outlineNode)
     Set the last child, this will be maintained by this class.
protected  voidsetOpenCount(int openCount)
     Set the open count.
protected  voidsetParent(PDOutlineNode parent)
     Set the parent of this object, this is maintained by these objects and should not be called by any clients of PDFBox code.
protected  voidupdateParentOpenCount(int amount)
     The count parameter needs to be updated when you add or remove elements to the outline.

Field Detail
node
protected COSDictionary node(Code)
The dictionary for this node.




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



PDOutlineNode
public PDOutlineNode(COSDictionary dict)(Code)
Default Constructor.
Parameters:
  dict - The dictionary storage.




Method Detail
appendChild
public void appendChild(PDOutlineItem outlineNode)(Code)
append a child node to this node.
Parameters:
  outlineNode - The node to add.



closeNode
public void closeNode()(Code)
Close this node.



getCOSDictionary
public COSDictionary getCOSDictionary()(Code)
Convert this standard java object to a COS object. The cos object that matches this Java object.



getCOSObject
public COSBase getCOSObject()(Code)
Convert this standard java object to a COS object. The cos object that matches this Java object.



getFirstChild
public PDOutlineItem getFirstChild()(Code)
Return the first child or null if there is no child. The first child.



getLastChild
public PDOutlineItem getLastChild()(Code)
Return the last child or null if there is no child. The last child.



getOpenCount
public int getOpenCount()(Code)
Get the number of open nodes. Or a negative number if this node is closed. See PDF Reference for more details. This value is updated as you append children and siblings. The Count attribute of the outline dictionary.



getParent
public PDOutlineNode getParent()(Code)
Get the parent of this object. This will either be a DocumentOutline or an OutlineItem. The parent of this object, or null if this is the document outline and thereis no parent.



isNodeOpen
public boolean isNodeOpen()(Code)
Node is open if the open count is greater than zero. true if this node is open.



openNode
public void openNode()(Code)
This will set this node to be open when it is shown in the viewer. By default, when a new node is created it will be closed. This will do nothing if the node is already open.



setFirstChild
protected void setFirstChild(PDOutlineNode outlineNode)(Code)
Set the first child, this will be maintained by this class.
Parameters:
  outlineNode - The new first child.



setLastChild
protected void setLastChild(PDOutlineNode outlineNode)(Code)
Set the last child, this will be maintained by this class.
Parameters:
  outlineNode - The new last child.



setOpenCount
protected void setOpenCount(int openCount)(Code)
Set the open count. This number is automatically managed for you when you add items to the outline.
Parameters:
  openCount - The new open cound.



setParent
protected void setParent(PDOutlineNode parent)(Code)
Set the parent of this object, this is maintained by these objects and should not be called by any clients of PDFBox code.
Parameters:
  parent - The parent of this object.



updateParentOpenCount
protected void updateParentOpenCount(int amount)(Code)
The count parameter needs to be updated when you add or remove elements to the outline. When you add an element at a lower level then you need to increase all of the parents.
Parameters:
  amount - The amount to update by.



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.