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

All Implemented Interfaces:
    COSObjectable

This class will be used to signify a range. a(min) <= a* <= a(max)
Constructor:
 public PDRange() 
 public PDRange(COSArray range) 
    Constructor assumes a starting index of 0.
    Parameters:
    range - The array that describes the range.
 public PDRange(COSArray range,
    int index) 
    Constructor with an index into an array. Because some arrays specify multiple ranges ie [ 0,1, 0,2, 2,3 ] It is convenient for this class to take an index into an array. So if you want this range to represent 0,2 in the above example then you would say new PDRange( array, 1 ).
    Parameters:
    range - The array that describes the index
    index - The range index into the array for the start of the range.
Method from org.apache.pdfbox.pdmodel.common.PDRange Summary:
getCOSArray,   getCOSObject,   getMax,   getMin,   setMax,   setMin
Methods from java.lang.Object:
clone,   equals,   finalize,   getClass,   hashCode,   notify,   notifyAll,   toString,   wait,   wait,   wait
Method from org.apache.pdfbox.pdmodel.common.PDRange Detail:
 public COSArray getCOSArray() 
    This will get the underlying array value.
 public COSBase getCOSObject() 
    Convert this standard java object to a COS object.
 public float getMax() 
    This will get the maximum value of the range.
 public float getMin() 
    This will get the minimum value of the range.
 public  void setMax(float max) 
    This will set the maximum value for the range.
 public  void setMin(float min) 
    This will set the minimum value for the range.