Home » pdfbox-1.1.0-src » org.apache.pdfbox.pdfviewer » [javadoc | source]
org.apache.pdfbox.pdfviewer
public class: PDFTreeModel [javadoc | source]
java.lang.Object
   org.apache.pdfbox.pdfviewer.PDFTreeModel

All Implemented Interfaces:
    TreeModel

A class to model a PDF document as a tree structure.
Constructor:
 public PDFTreeModel() 
 public PDFTreeModel(PDDocument doc) 
    Constructor to take a document.
    Parameters:
    doc - The document to display in the tree.
Method from org.apache.pdfbox.pdfviewer.PDFTreeModel Summary:
addTreeModelListener,   getChild,   getChildCount,   getIndexOfChild,   getRoot,   isLeaf,   removeTreeModelListener,   setDocument,   valueForPathChanged
Methods from java.lang.Object:
clone,   equals,   finalize,   getClass,   hashCode,   notify,   notifyAll,   toString,   wait,   wait,   wait
Method from org.apache.pdfbox.pdfviewer.PDFTreeModel Detail:
 public  void addTreeModelListener(TreeModelListener l) 
    Adds a listener for the TreeModelEvent posted after the tree changes.
 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 < getChildCount(parent)).
 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.
 public int getIndexOfChild(Object parent,
    Object child) 
    Returns the index of child in parent. If parent is null or child is null, returns -1.
 public Object getRoot() 
    Returns the root of the tree. Returns null only if the tree has no nodes.
 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.
 public  void removeTreeModelListener(TreeModelListener l) 
    Removes a listener previously added with addTreeModelListener.
 public  void setDocument(PDDocument doc) 
    Set the document to display in the tree.
 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.