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 TypeMethodDescriptionvoid
Adds a listener for theTreeModelEvent
posted after the tree changes.Returns the child ofparent
at indexindex
in the parent's child array.int
getChildCount
(Object parent) Returns the number of children ofparent
.int
getIndexOfChild
(Object parent, Object child) Returns the index of child in parent.getRoot()
Returns the root of the tree.boolean
Returnstrue
ifnode
is a leaf.void
Removes a listener previously added withaddTreeModelListener
.void
setDocument
(PDDocument doc) Set the document to display in the tree.void
valueForPathChanged
(TreePath path, Object newValue) Messaged when the user has altered the value for the item identified bypath
tonewValue
.
-
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 theTreeModelEvent
posted after the tree changes.- Specified by:
addTreeModelListener
in interfaceTreeModel
- Parameters:
l
- the listener to add- See Also:
-
getChild
Returns the child ofparent
at indexindex
in the parent's child array.parent
must be a node previously obtained from this data source. This should not returnnull
ifindex
is 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.parent
must be a node previously obtained from this data source.- Specified by:
getChildCount
in 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. Ifparent
isnull
orchild
isnull
, returns -1.- Specified by:
getIndexOfChild
in 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
child
orparent
arenull
-
getRoot
Returns the root of the tree. Returnsnull
only if the tree has no nodes. -
isLeaf
Returnstrue
ifnode
is a leaf. It is possible for this method to returnfalse
even ifnode
has 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:
removeTreeModelListener
in interfaceTreeModel
- Parameters:
l
- the listener to remove- See Also:
-
valueForPathChanged
Messaged when the user has altered the value for the item identified bypath
tonewValue
. IfnewValue
signifies a truly new value the model should post atreeNodesChanged
event.- Specified by:
valueForPathChanged
in interfaceTreeModel
- Parameters:
path
- path to the node that the user has alterednewValue
- the new value from the TreeCellEditor
-