Package org.apache.pdfbox.debugger.ui
Class PDFTreeModel
- java.lang.Object
-
- org.apache.pdfbox.debugger.ui.PDFTreeModel
-
- All Implemented Interfaces:
javax.swing.tree.TreeModel
public class PDFTreeModel extends java.lang.Object implements javax.swing.tree.TreeModel
A class to model a PDF document as a tree structure.
-
-
Field Summary
Fields Modifier and Type Field Description private java.lang.Object
root
-
Constructor Summary
Constructors Constructor Description PDFTreeModel()
constructor.PDFTreeModel(DocumentEntry docEntry)
Constructor to take a document.PDFTreeModel(PDDocument doc)
Constructor to take a document.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description void
addTreeModelListener(javax.swing.event.TreeModelListener l)
Adds a listener for theTreeModelEvent
posted after the tree changes.java.lang.Object
getChild(java.lang.Object parent, int index)
Returns the child ofparent
at indexindex
in the parent's child array.int
getChildCount(java.lang.Object parent)
Returns the number of children ofparent
.int
getIndexOfChild(java.lang.Object parent, java.lang.Object child)
Returns the index of child in parent.java.lang.Object
getRoot()
Returns the root of the tree.boolean
isLeaf(java.lang.Object node)
Returnstrue
ifnode
is a leaf.void
removeTreeModelListener(javax.swing.event.TreeModelListener l)
Removes a listener previously added withaddTreeModelListener
.void
valueForPathChanged(javax.swing.tree.TreePath path, java.lang.Object newValue)
Messaged when the user has altered the value for the item identified bypath
tonewValue
.
-
-
-
Constructor Detail
-
PDFTreeModel
public PDFTreeModel()
constructor.
-
PDFTreeModel
public PDFTreeModel(PDDocument doc)
Constructor to take a document.- Parameters:
doc
- The document to display in the tree.
-
PDFTreeModel
public PDFTreeModel(DocumentEntry docEntry)
Constructor to take a document.- Parameters:
docEntry
- The document to display in the tree.
-
-
Method Detail
-
addTreeModelListener
public void addTreeModelListener(javax.swing.event.TreeModelListener l)
Adds a listener for theTreeModelEvent
posted after the tree changes.- Specified by:
addTreeModelListener
in interfacejavax.swing.tree.TreeModel
- Parameters:
l
- the listener to add- See Also:
removeTreeModelListener(javax.swing.event.TreeModelListener)
-
getChild
public java.lang.Object getChild(java.lang.Object parent, int index)
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
)).- Specified by:
getChild
in interfacejavax.swing.tree.TreeModel
- Parameters:
parent
- a node in the tree, obtained from this data sourceindex
- The index into the parent object to location the child object.- Returns:
- the child of
parent
at indexindex
- Throws:
java.lang.IllegalArgumentException
- if an unknown unknown COS type is passed as parent parameter.
-
getChildCount
public int getChildCount(java.lang.Object parent)
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 interfacejavax.swing.tree.TreeModel
- Parameters:
parent
- a node in the tree, obtained from this data source- Returns:
- the number of children of the node
parent
-
getIndexOfChild
public int getIndexOfChild(java.lang.Object parent, java.lang.Object child)
Returns the index of child in parent. Ifparent
isnull
orchild
isnull
, returns -1.- Specified by:
getIndexOfChild
in interfacejavax.swing.tree.TreeModel
- Parameters:
parent
- a node 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
- Throws:
java.lang.IllegalArgumentException
- if an unknown unknown COS type is passed as parent parameter.
-
getRoot
public java.lang.Object getRoot()
Returns the root of the tree. Returnsnull
only if the tree has no nodes.- Specified by:
getRoot
in interfacejavax.swing.tree.TreeModel
- Returns:
- the root of the tree
-
isLeaf
public boolean isLeaf(java.lang.Object node)
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.- Specified by:
isLeaf
in interfacejavax.swing.tree.TreeModel
- Parameters:
node
- a node in the tree, obtained from this data source- Returns:
- true if
node
is a leaf
-
removeTreeModelListener
public void removeTreeModelListener(javax.swing.event.TreeModelListener l)
Removes a listener previously added withaddTreeModelListener
.- Specified by:
removeTreeModelListener
in interfacejavax.swing.tree.TreeModel
- Parameters:
l
- the listener to remove- See Also:
addTreeModelListener(javax.swing.event.TreeModelListener)
-
valueForPathChanged
public void valueForPathChanged(javax.swing.tree.TreePath path, java.lang.Object newValue)
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 interfacejavax.swing.tree.TreeModel
- Parameters:
path
- path to the node that the user has alterednewValue
- the new value from the TreeCellEditor
-
-