|
|||||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | ||||||||||
java.lang.Objectorg.pdfbox.pdfviewer.PDFTreeModel
A class to model a PDF document as a tree structure.
| Constructor Summary | |
PDFTreeModel()
constructor. |
|
PDFTreeModel(PDDocument doc)
Constructor to take a document. |
|
| Method Summary | |
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.
|
| Methods inherited from class java.lang.Object |
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
| Constructor Detail |
public PDFTreeModel()
public PDFTreeModel(PDDocument doc)
doc - The document to display in the tree.| Method Detail |
public void setDocument(PDDocument doc)
doc - The document to display in the tree.public void addTreeModelListener(TreeModelListener l)
TreeModelEvent
posted after the tree changes.
addTreeModelListener in interface TreeModell - the listener to addremoveTreeModelListener(javax.swing.event.TreeModelListener)
public Object getChild(Object parent,
int index)
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 < getChildCount(parent)).
getChild in interface TreeModelparent - a node in the tree, obtained from this data sourceindex - The index into the parent object to location the child object.
parent at index indexpublic int getChildCount(Object parent)
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.
getChildCount in interface TreeModelparent - a node in the tree, obtained from this data source
parent
public int getIndexOfChild(Object parent,
Object child)
parent
is null or child is null,
returns -1.
getIndexOfChild in interface TreeModelparent - a note in the tree, obtained from this data sourcechild - the node we are interested in
child or parent are nullpublic Object getRoot()
null
only if the tree has no nodes.
getRoot in interface TreeModelpublic boolean isLeaf(Object node)
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.
isLeaf in interface TreeModelnode - a node in the tree, obtained from this data source
node is a leafpublic void removeTreeModelListener(TreeModelListener l)
addTreeModelListener.
removeTreeModelListener in interface TreeModell - the listener to removeaddTreeModelListener(javax.swing.event.TreeModelListener)
public void valueForPathChanged(TreePath path,
Object newValue)
path to newValue.
If newValue signifies a truly new value
the model should post a treeNodesChanged event.
valueForPathChanged in interface TreeModelpath - path to the node that the user has alterednewValue - the new value from the TreeCellEditor
|
|||||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | ||||||||||