Package org.apache.pdfbox.pdfviewer
Class PDFTreeModel
java.lang.Object
org.apache.pdfbox.pdfviewer.PDFTreeModel
- All Implemented Interfaces:
TreeModel
A class to model a PDF document as a tree structure.
- Version:
- $Revision: 1.9 $
- Author:
- Ben Litchfield
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionvoidAdds a listener for theTreeModelEventposted after the tree changes.Returns the child ofparentat indexindexin the parent's child array.intgetChildCount(Object parent) Returns the number of children ofparent.intgetIndexOfChild(Object parent, Object child) Returns the index of child in parent.getRoot()Returns the root of the tree.booleanReturnstrueifnodeis a leaf.voidRemoves a listener previously added withaddTreeModelListener.voidsetDocument(PDDocument doc) Set the document to display in the tree.voidvalueForPathChanged(TreePath path, Object newValue) Messaged when the user has altered the value for the item identified bypathtonewValue.
-
Constructor Details
-
PDFTreeModel
public PDFTreeModel()constructor. -
PDFTreeModel
Constructor to take a document.- Parameters:
doc- The document to display in the tree.
-
-
Method Details
-
setDocument
Set the document to display in the tree.- Parameters:
doc- The document to display in the tree.
-
addTreeModelListener
Adds a listener for theTreeModelEventposted after the tree changes.- Specified by:
addTreeModelListenerin interfaceTreeModel- Parameters:
l- the listener to add- See Also:
-
getChild
Returns the child ofparentat indexindexin the parent's child array.parentmust be a node previously obtained from this data source. This should not returnnullifindexis a valid index forparent(that isindex >= 0 && index < getChildCount(parent)). -
getChildCount
Returns the number of children ofparent. Returns 0 if the node is a leaf or if it has no children.parentmust be a node previously obtained from this data source.- Specified by:
getChildCountin interfaceTreeModel- Parameters:
parent- a node in the tree, obtained from this data source- Returns:
- the number of children of the node
parent
-
getIndexOfChild
Returns the index of child in parent. Ifparentisnullorchildisnull, returns -1.- Specified by:
getIndexOfChildin interfaceTreeModel- Parameters:
parent- a note in the tree, obtained from this data sourcechild- the node we are interested in- Returns:
- the index of the child in the parent, or -1 if either
childorparentarenull
-
getRoot
Returns the root of the tree. Returnsnullonly if the tree has no nodes. -
isLeaf
Returnstrueifnodeis a leaf. It is possible for this method to returnfalseeven ifnodehas no children. A directory in a filesystem, for example, may contain no files; the node representing the directory is not a leaf, but it also has no children. -
removeTreeModelListener
Removes a listener previously added withaddTreeModelListener.- Specified by:
removeTreeModelListenerin interfaceTreeModel- Parameters:
l- the listener to remove- See Also:
-
valueForPathChanged
Messaged when the user has altered the value for the item identified bypathtonewValue. IfnewValuesignifies a truly new value the model should post atreeNodesChangedevent.- Specified by:
valueForPathChangedin interfaceTreeModel- Parameters:
path- path to the node that the user has alterednewValue- the new value from the TreeCellEditor
-