Apache PDFBox 3.0.4 · org.apache.pdfbox.debugger.ui.PDFTreeModel

Modifier and Type	Field and Description
private Object	root

Access	Constructor and Description
public	PDFTreeModel() constructor.
public	PDFTreeModel(PDDocument The document to display in the tree. doc) Constructor to take a document.
public	PDFTreeModel(DocumentEntry The document to display in the tree. docEntry) Constructor to take a document.
public	PDFTreeModel(XrefEntries The cross reference table to display in the tree. xrefEntries) Constructor to take the cross reference table of a document.

Method Summary

Modifier and Type	Method and Description
public void	addTreeModelListener(TreeModelListener the listener to add l) Implements javax.swing.tree.TreeModel.addTreeModelListener. Adds a listener for the `TreeModelEvent` posted after the tree changes.
public Object	Returns: the child of `parent` at index `index` getChild(Object a node in the tree, obtained from this data source parent, int The index into the parent object to location the child object. index) Implements javax.swing.tree.TreeModel.getChild. Returns the child of `parent` at index `index` in the parent's child array.
public int	Returns: the number of children of the node `parent` getChildCount(Object a node in the tree, obtained from this data source parent) Implements javax.swing.tree.TreeModel.getChildCount. Returns the number of children of `parent`.
public int	Returns: the index of the child in the parent, or -1 if either `child` or `parent` are `null` getIndexOfChild(Object a node in the tree, obtained from this data source parent, Object the node we are interested in child) Implements javax.swing.tree.TreeModel.getIndexOfChild. Returns the index of child in parent.
public Object	Returns: the root of the tree getRoot() Implements javax.swing.tree.TreeModel.getRoot. Returns the root of the tree.
public boolean	Returns: true if `node` is a leaf isLeaf(Object a node in the tree, obtained from this data source node) Implements javax.swing.tree.TreeModel.isLeaf. Returns `true` if `node` is a leaf.
public void	removeTreeModelListener(TreeModelListener the listener to remove l) Implements javax.swing.tree.TreeModel.removeTreeModelListener. Removes a listener previously added with `addTreeModelListener`.
public void	valueForPathChanged(TreePath path to the node that the user has altered path, Object the new value from the TreeCellEditor newValue) Implements javax.swing.tree.TreeModel.valueForPathChanged. Messaged when the user has altered the value for the item identified by `path` to `newValue`.

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

root	back to summary
private Object root

PDFTreeModel	back to summary
public PDFTreeModel() constructor.

PDFTreeModel	back to summary
public PDFTreeModel(PDDocument doc) Constructor to take a document. Parameters doc:PDDocument The document to display in the tree.

PDFTreeModel	back to summary
public PDFTreeModel(DocumentEntry docEntry) Constructor to take a document. Parameters docEntry:DocumentEntry The document to display in the tree.

PDFTreeModel	back to summary
public PDFTreeModel(XrefEntries xrefEntries) Constructor to take the cross reference table of a document. Parameters xrefEntries:XrefEntries The cross reference table to display in the tree.

Method Detail

addTreeModelListener back to summary

addTreeModelListener	back to summary
public void addTreeModelListener(TreeModelListener l) Implements javax.swing.tree.TreeModel.addTreeModelListener. Adds a listener for the `TreeModelEvent` posted after the tree changes. Parameters l:TreeModelListener the listener to add Annotations @Override See Also `removeTreeModelListener`

public void addTreeModelListener(TreeModelListener l)

Implements javax.swing.tree.TreeModel.addTreeModelListener.

Adds a listener for the TreeModelEvent posted after the tree changes.

Parameters

l:TreeModelListener: the listener to add

Annotations

@Override

See Also

removeTreeModelListener

getChild back to summary

getChild	back to summary
public Object getChild(Object parent, int index) Implements javax.swing.tree.TreeModel.getChild. 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`)). Parameters parent:Object a node in the tree, obtained from this data source index:int The index into the parent object to location the child object. Returns:Object the child of `parent` at index `index` Annotations @Override Exceptions IllegalArgumentException: if an unknown unknown COS type is passed as parent parameter.

public Object getChild(Object parent, int index)

Implements javax.swing.tree.TreeModel.getChild.

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)).

Parameters

parent:Object: a node in the tree, obtained from this data source
index:int: The index into the parent object to location the child object.

Returns:Object

the child of parent at index index

Annotations

@Override

Exceptions

IllegalArgumentException:: if an unknown unknown COS type is passed as parent parameter.

getChildCount back to summary

getChildCount	back to summary
public int getChildCount(Object parent) Implements javax.swing.tree.TreeModel.getChildCount. 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. Parameters parent:Object a node in the tree, obtained from this data source Returns:int the number of children of the node `parent` Annotations @Override

public int getChildCount(Object parent)

Implements javax.swing.tree.TreeModel.getChildCount.

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.

Parameters

parent:Object: a node in the tree, obtained from this data source

Returns:int

the number of children of the node parent

Annotations

@Override

getIndexOfChild back to summary

getIndexOfChild	back to summary
public int getIndexOfChild(Object parent, Object child) Implements javax.swing.tree.TreeModel.getIndexOfChild. Returns the index of child in parent. If `parent` is `null` or `child` is `null`, returns -1. Parameters parent:Object a node in the tree, obtained from this data source child:Object the node we are interested in Returns:int the index of the child in the parent, or -1 if either `child` or `parent` are `null` Annotations @Override Exceptions IllegalArgumentException: if an unknown unknown COS type is passed as parent parameter.

public int getIndexOfChild(Object parent, Object child)

Implements javax.swing.tree.TreeModel.getIndexOfChild.

Returns the index of child in parent. If parent is null or child is null, returns -1.

Parameters

parent:Object: a node in the tree, obtained from this data source
child:Object: the node we are interested in

Returns:int

the index of the child in the parent, or -1 if either child or parent are null

Annotations

@Override

Exceptions

IllegalArgumentException:: if an unknown unknown COS type is passed as parent parameter.

getRoot back to summary

getRoot	back to summary
public Object getRoot() Implements javax.swing.tree.TreeModel.getRoot. Returns the root of the tree. Returns `null` only if the tree has no nodes. Returns:Object the root of the tree Annotations @Override

public Object getRoot()

Implements javax.swing.tree.TreeModel.getRoot.

Returns the root of the tree. Returns null only if the tree has no nodes.

Returns:Object

the root of the tree

Annotations

@Override

isLeaf back to summary

isLeaf	back to summary
public boolean isLeaf(Object node) Implements javax.swing.tree.TreeModel.isLeaf. 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. Parameters node:Object a node in the tree, obtained from this data source Returns:boolean true if `node` is a leaf Annotations @Override

public boolean isLeaf(Object node)

Implements javax.swing.tree.TreeModel.isLeaf.

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.

Parameters

node:Object: a node in the tree, obtained from this data source

Returns:boolean

true if node is a leaf

Annotations

@Override

removeTreeModelListener back to summary

removeTreeModelListener	back to summary
public void removeTreeModelListener(TreeModelListener l) Implements javax.swing.tree.TreeModel.removeTreeModelListener. Removes a listener previously added with `addTreeModelListener`. Parameters l:TreeModelListener the listener to remove Annotations @Override See Also `addTreeModelListener`

public void removeTreeModelListener(TreeModelListener l)

Implements javax.swing.tree.TreeModel.removeTreeModelListener.

Removes a listener previously added with addTreeModelListener.

Parameters

l:TreeModelListener: the listener to remove

Annotations

@Override

See Also

addTreeModelListener

valueForPathChanged back to summary

valueForPathChanged	back to summary
public void valueForPathChanged(TreePath path, Object newValue) Implements javax.swing.tree.TreeModel.valueForPathChanged. 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. Parameters path:TreePath path to the node that the user has altered newValue:Object the new value from the TreeCellEditor Annotations @Override

public void valueForPathChanged(TreePath path, Object newValue)

Implements javax.swing.tree.TreeModel.valueForPathChanged.

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.

Parameters

path:TreePath: path to the node that the user has altered
newValue:Object: the new value from the TreeCellEditor

Annotations

@Override

public Class PDFTreeModel

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail