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

All Implemented Interfaces:
    COSObjectable

This class represents a PDF Number tree. See the PDF Reference 1.7 section 7.9.7 for more details.
Constructor:
 public PDNumberTreeNode(Class valueClass) 
    Constructor.
    Parameters:
    valueClass - The PD Model type of object that is the value.
 public PDNumberTreeNode(COSDictionary dict,
    Class valueClass) 
    Constructor.
    Parameters:
    dict - The dictionary that holds the name information.
    valueClass - The PD Model type of object that is the value.
Method from org.apache.pdfbox.pdmodel.common.PDNumberTreeNode Summary:
convertCOSToPD,   createChildNode,   getCOSDictionary,   getCOSObject,   getKids,   getLowerLimit,   getNumbers,   getUpperLimit,   getValue,   setKids,   setNumbers
Methods from java.lang.Object:
clone,   equals,   finalize,   getClass,   hashCode,   notify,   notifyAll,   toString,   wait,   wait,   wait
Method from org.apache.pdfbox.pdmodel.common.PDNumberTreeNode Detail:
 protected Object convertCOSToPD(COSBase base) throws IOException 
    Method to convert the COS value in the name tree to the PD Model object. The default implementation will simply use reflection to create the correct object type. Subclasses can do whatever they want.
 protected PDNumberTreeNode createChildNode(COSDictionary dic) 
    Create a child node object.
 public COSDictionary getCOSDictionary() 
    Convert this standard java object to a COS object.
 public COSBase getCOSObject() 
    Convert this standard java object to a COS object.
 public List getKids() 
    Return the children of this node. This list will contain PDNumberTreeNode objects.
 public Integer getLowerLimit() 
    Get the lowest value for a key in the name map.
 public Map getNumbers() throws IOException 
    This will return a map of numbers. The key will be a java.lang.Integer, the value will depend on where this class is being used.
 public Integer getUpperLimit() 
    Get the highest value for a key in the name map.
 public Object getValue(Integer index) throws IOException 
    Returns the value corresponding to an index in the number tree.
 public  void setKids(List kids) 
    Set the children of this number tree.
 public  void setNumbers(Map numbers) 
    Set the names of for this node. The keys should be java.lang.String and the values must be a COSObjectable. This method will set the appropriate upper and lower limits based on the keys in the map.