org.pdfbox.pdfviewer
Class PDFTreeModel
java.lang.Object
org.pdfbox.pdfviewer.PDFTreeModel
- TreeModel
public class PDFTreeModel
extends java.lang.Object
implements TreeModel
A class to model a PDF document as a tree structure.
void | addTreeModelListener(TreeModelListener l) - Adds a listener for the
TreeModelEvent
posted after the tree changes.
|
Object | getChild(Object parent, int index) - Returns the child of
parent at index index
in the parent's
child array.
|
int | getChildCount(Object parent) - Returns the number of children of
parent .
|
int | getIndexOfChild(Object parent, Object child) - Returns the index of child in parent.
|
Object | getRoot() - Returns the root of the tree.
|
boolean | isLeaf(Object node) - Returns
true if node is a leaf.
|
void | removeTreeModelListener(TreeModelListener l) - Removes a listener previously added with
addTreeModelListener .
|
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
by
path to newValue .
|
PDFTreeModel
public PDFTreeModel()
constructor.
PDFTreeModel
public PDFTreeModel(PDDocument doc)
Constructor to take a document.
doc
- The document to display in the tree.
addTreeModelListener
public void addTreeModelListener(TreeModelListener l)
Adds a listener for the TreeModelEvent
posted after the tree changes.
getChild
public Object getChild(Object parent,
int index)
Returns the child of parent
at index index
in the parent's
child array. parent
must be a node previously obtained
from this data source. This should not return null
if index
is a valid index for parent
(that is index >= 0 &&
index <32getChildCount(parent
)).
parent
- a node in the tree, obtained from this data sourceindex
- The index into the parent object to location the child object.
- the child of
parent
at index index
getChildCount
public int getChildCount(Object parent)
Returns the number of children of parent
.
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.
parent
- a node in the tree, obtained from this data source
- the number of children of the node
parent
getIndexOfChild
public int getIndexOfChild(Object parent,
Object child)
Returns the index of child in parent. If parent
is null
or child
is null
,
returns -1.
parent
- a note in the tree, obtained from this data sourcechild
- the node we are interested in
- the index of the child in the parent, or -1 if either
child
or parent
are null
getRoot
public Object getRoot()
Returns the root of the tree. Returns null
only if the tree has no nodes.
isLeaf
public boolean isLeaf(Object node)
Returns true
if node
is a leaf.
It is possible for this method to return false
even if node
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.
node
- a node in the tree, obtained from this data source
removeTreeModelListener
public void removeTreeModelListener(TreeModelListener l)
Removes a listener previously added with
addTreeModelListener
.
l
- the listener to remove
setDocument
public void setDocument(PDDocument doc)
Set the document to display in the tree.
doc
- The document to display in the tree.
valueForPathChanged
public void valueForPathChanged(TreePath path,
Object newValue)
Messaged when the user has altered the value for the item identified
by path
to newValue
.
If newValue
signifies a truly new value
the model should post a treeNodesChanged
event.
path
- path to the node that the user has alterednewValue
- the new value from the TreeCellEditor