PDFPage

java.lang.Object
- com.qoppa.android.pdfProcess.PDFPage

```
public class PDFPage
extends java.lang.Object
```
This class holds a page in a PDF document.

Author:

Qoppa Software

Field Summary

Fields
Modifier and Type	Field and Description
`static int`	`COMPRESSION_DEFLATE`
`static int`	`COMPRESSION_JBIG2`
`static int`	`COMPRESSION_JPEG`
`static int`	`DEFAULT_BACKGROUND_COLOR` The background color that will be used when rendering a page, if no specific color has been set.
`com.qoppa.android.pdf.loObjects.PDFDictionary`	`m_PageDict`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`addAnnotation(Annotation annot)` Adds an annotation to this page.
`SignatureField`	`addSignatureField(java.lang.String fieldName, RectF bounds)` Adds a signature field to this page.
`PointF`	`convPoint(float x, float y)` Converts a point from visual coordinates to PDF coordinate.
`RectF`	`convRect(RectF toConv)` Converts a rectangle from visual coordinates to PDF coordinate.
`PDFCanvas`	`createCanvas()` Creates a canvas object to draw into this page.
`void`	`deleteAnnotations()` Delete all annotations from the page.
`java.util.List<TextPosition>`	`findTextOccurrences(java.lang.String searchString)` Searches for a string in this page.
`java.util.List<TextPositionWithContext>`	`findTextOccurrencesWithContext(java.lang.String searchString)`
`void`	`flattenAnnotations(boolean paintNonPrintableAnnots)` Flattens the annotations.
`java.lang.String`	`getAllText()` Returns all text for this page.
`java.util.Vector<Annotation>`	`getAnnotations()` Returns a list of PDF annotations in this page.
`com.qoppa.android.pdf.text.AsyncTextModel`	`getAsyncTextModel()`
`int`	`getBackgroundColor()` Returns the background color to use when rendering this page.
`Bitmap`	`getBitmap()` Returns a Bitmap object containing a rendering of the page at the default PDF resolution: 72 DPI.
`Bitmap`	`getBitmap(int width, int height, boolean paintAnnotations)` Returns a Bitmap containing a rendering of the page at a specific width and height.
`Bitmap`	`getBitmap(Rect rect, boolean paintAnnotations)` Returns a Bitmap containing a rendering of the page for the specified rectangle
`com.qoppa.android.pdf.util.PeekInputStream`	`getContentStream()`
`RectF`	`getCropBox()` Returns the PDF page's 'CropBox'.
`float`	`getDisplayBottom()` Returns the cropbox's bottom most y
`float`	`getDisplayHeight()` Returns the display height of this page in 72 DPI.
`float`	`getDisplayRight()` Returns the cropbox's right most x
`float`	`getDisplayWidth()` Returns the display width of this page in 72 DPI.
`float`	`getDisplayX()` Returns the crop box's X origin.
`float`	`getDisplayY()` Returns the crop box's Y origin.
`PDFDocument`	`getDocument()` Returns the document that this page belongs to.
`IPicture`	`getIPicture()` This picture caches the drawing commands for the page.
`RectF`	`getMediaBox()` Returns the PDF page's 'MediaBox'.
`Matrix`	`getMirror()`
`com.qoppa.android.pdf.loObjects.PDFDictionary`	`getPageDict()`
`int`	`getPageIndex()` Gets the page index of this page within the document.
`int`	`getPageRotation()` Returns the rotation of this page in degrees.
`float`	`getPaperHeight()` Returns the paper's height of this page in 72 DPI.
`float`	`getPaperWidth()` Returns the paper's width of this page in 72 DPI.
`java.util.Vector<SlimAnnotation>`	`getSlimAnnots()` Returns a list of light weight annotations objects.
`java.lang.String`	`getTabbingOrder()` Returns the tabbing order as defined in the page description, if present.
`com.qoppa.android.pdf.text.TextModel`	`getTextModel()` Returns the TextModel for this page
`boolean`	`hasAnnotations()` Returns true if the page contains annotations.
`boolean`	`hasEditableAnnots()` Returns true if the page contains annotations of type other than Widget, Link, and FileAttachment
`Annotation`	`intersectsAnnot(float x, float y)` Returns the first annotation that contains the x,y point.
`void`	`paintPage(Canvas cv)` Paint the contents of this page to a Canvas.
`void`	`paintPage(Canvas cv, int bgndColor)` Paints the contents of this page and a background to a Canvas.
`void`	`removeAnnotation(Annotation annot)` Removes an annotation from this page.
`void`	`savePageAsJPEG(java.io.OutputStream outStream, int dpi, int quality, boolean paintAnnotations)` Render the page as an image and save it to the output stream in JPEG format.
`void`	`savePageAsPNG(java.io.OutputStream outStream, int dpi, boolean paintAnnotations)` Render the page as an image and save it to the output stream in PNG format.
`TextSelection`	`selectText(RectF rect)` Creates a TextSelection object for any text found in a rectangle.
`void`	`setBackgroundColor(int color)` Sets the background color to use when rendering this page.
`void`	`setPageRotation(int degrees)` Changes this page's rotation.
`java.lang.String`	`useExtGState(double strokeAlpha, double fillAlpha, java.lang.String blendName)` Internal method, do not use.
`java.lang.String`	`useFont(PDFFont font)` Internal method, do not use.
`com.qoppa.android.pdfProcess.util.ImageInfo`	`useImage(Bitmap image, ImageParam params)`
`com.qoppa.android.pdfProcess.util.ImageInfo`	`useImage(java.lang.String imagePath, java.lang.String alphaPath)`

Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - m_PageDict
```
public com.qoppa.android.pdf.loObjects.PDFDictionary m_PageDict
```
  - COMPRESSION_JPEG
```
public static final int COMPRESSION_JPEG
```
    See Also:
    
    Constant Field Values
  - COMPRESSION_DEFLATE
```
public static final int COMPRESSION_DEFLATE
```
    See Also:
    
    Constant Field Values
  - COMPRESSION_JBIG2
```
public static final int COMPRESSION_JBIG2
```
    See Also:
    
    Constant Field Values
  - DEFAULT_BACKGROUND_COLOR
```
public static int DEFAULT_BACKGROUND_COLOR
```
    The background color that will be used when rendering a page, if no specific color has been set. The default value is Color#WHITE.
- Method Detail
  - hasAnnotations
```
public boolean hasAnnotations()
```
    Returns true if the page contains annotations. This call is much faster than getAnnotations().
  - hasEditableAnnots
```
public boolean hasEditableAnnots()
```
    Returns true if the page contains annotations of type other than Widget, Link, and FileAttachment
    
    Returns:
  - getAnnotations
```
public java.util.Vector<Annotation> getAnnotations()
                                            throws PDFException
```
    Returns a list of PDF annotations in this page. This vector is a clone of the actual annotations vector any changes made to this vector will not affect the actual vector. However annotations contained in the vector can be edited. The objects in the Vector are all derived from com.qoppa.pdf.annotations.Annotation.
    
    Returns:
    
    List of annotations.
    
    Throws:
    
    PDFException
  - getSlimAnnots
```
public java.util.Vector<SlimAnnotation> getSlimAnnots()
                                               throws PDFException
```
    Returns a list of light weight annotations objects. These objects are quicker to retrieve, and occupy less memory than those returned by getAnnotations. The list does not include Widgets, Links, FileAttachments, or Popups. Also, the SlimAnnotation objects are not modifiable
    
    Returns:
    
    Throws:
    
    PDFException
  - createCanvas
```
public PDFCanvas createCanvas()
                       throws PDFException
```
    Creates a canvas object to draw into this page. Anything drawn to this canvas will be drawn onto the PDF page and can then be saved into a PDF document or printed. New content will be drawn on top of the current page content.
    
    The canvas object will initially have its origin on the upper left corner of the page's crop box (the visible area of the page).
    
    Returns:
    
    PDFCanvas Canvas object used to draw into this page.
    
    Throws:
    
    PDFException
  - useImage
```
public com.qoppa.android.pdfProcess.util.ImageInfo useImage(Bitmap image,
                                                            ImageParam params)
                                                     throws PDFException
```
    Throws:
    
    PDFException
  - useImage
```
public com.qoppa.android.pdfProcess.util.ImageInfo useImage(java.lang.String imagePath,
                                                            java.lang.String alphaPath)
                                                     throws PDFException
```
    Throws:
    
    PDFException
  - useFont
```
public java.lang.String useFont(PDFFont font)
                         throws PDFException
```
    Internal method, do not use.
    
    Throws:
    
    PDFException
  - getCropBox
```
public RectF getCropBox()
```
    Returns the PDF page's 'CropBox'. The CropBox is a rectangle that is used to crop content before displaying or printing the page. This rectangle is in PDF native coordinates starting at the bottom left and increasing up to the right.
    
    Returns:
    
    RectF This page's CropBox
  - getBitmap
```
public Bitmap getBitmap()
                 throws PDFException
```
    Returns a Bitmap object containing a rendering of the page at the default PDF resolution: 72 DPI.
    
    Throws:
    
    PDFException
  - getBitmap
```
public Bitmap getBitmap(int width,
                        int height,
                        boolean paintAnnotations)
                 throws PDFException
```
    Returns a Bitmap containing a rendering of the page at a specific width and height.
    
    Parameters:
    
    width - The width of the output bitmap.
    
    height - The height of the output bitmap.
    
    paintAnnotations - Boolean indicating if annotations should be painted
    
    Returns:
    
    A Bitmap object of the page at the requested width and height.
    
    Throws:
    
    PDFException
  - getBitmap
```
public Bitmap getBitmap(Rect rect,
                        boolean paintAnnotations)
                 throws PDFException
```
    Returns a Bitmap containing a rendering of the page for the specified rectangle
    
    Parameters:
    
    rect - The rectangle to render
    
    paintAnnotations - Boolean indicating if annotations should be painted
    
    Returns:
    
    A Bitmap object of the page at the requested rect.
    
    Throws:
    
    PDFException
  - getIPicture
```
public IPicture getIPicture()
                     throws PDFException
```
    This picture caches the drawing commands for the page. The IPicture can be drawn to a Canvas. Drawing from the IPicture tends to take much less time than calling PDFPage.getBitmap; and the IPicture object has a very small memory footprint, making it easy to cache.
    
    Throws:
    
    PDFException
  - paintPage
```
public void paintPage(Canvas cv,
                      int bgndColor)
               throws PDFException
```
    Paints the contents of this page and a background to a Canvas.
    
    Parameters:
    
    cv - The Canvas object to draw into.
    
    Throws:
    
    PDFException
  - paintPage
```
public void paintPage(Canvas cv)
               throws PDFException
```
    Paint the contents of this page to a Canvas.
    
    Parameters:
    
    cv - The Canvas object to draw into.
    
    Throws:
    
    PDFException
  - getContentStream
```
public com.qoppa.android.pdf.util.PeekInputStream getContentStream()
                                                            throws PDFException
```
    Throws:
    
    PDFException
  - savePageAsJPEG
```
public void savePageAsJPEG(java.io.OutputStream outStream,
                           int dpi,
                           int quality,
                           boolean paintAnnotations)
                    throws java.io.IOException,
                           PDFException
```
    Render the page as an image and save it to the output stream in JPEG format.
    
    Parameters:
    
    outStream - The stream to save the image to.
    
    dpi - Dots per inch at which to render the image. 72 is the native PDF resolution.
    
    quality - The quality setting to use for JPEG compression. The range for this value is 0 to 100.
    
    paintAnnotations - Boolean indicating if annotations should be painted Lower values mean higher compression and lower quality. As a guideline, 25 is low quality, 50 is medium quality and 75 is high quality.
    
    Throws:
    
    java.io.IOException
    
    PDFException
  - savePageAsPNG
```
public void savePageAsPNG(java.io.OutputStream outStream,
                          int dpi,
                          boolean paintAnnotations)
                   throws PDFException,
                          java.io.IOException
```
    Render the page as an image and save it to the output stream in PNG format.
    
    Parameters:
    
    outStream - The stream to save the image to.
    
    dpi - Dots per inch at which to render the image. 72 is the native PDF resolution.
    
    paintAnnotations - Boolean indicating if annotations should be painted
    
    Throws:
    
    PDFException
    
    java.io.IOException
  - getMediaBox
```
public RectF getMediaBox()
```
    Returns the PDF page's 'MediaBox'. The MediaBox is a rectangle that defines the size of the Media that this page was designed for, this roughly corresponds to the page size when printing.
    
    Returns:
    
    RectF This page's MediaBox
  - getPaperHeight
```
public float getPaperHeight()
```
    Returns the paper's height of this page in 72 DPI. This values comes from the page's MediaBox.
    
    Returns:
    
    float Height of this page
  - getPaperWidth
```
public float getPaperWidth()
```
    Returns the paper's width of this page in 72 DPI. This values comes from the page's MediaBox.
    
    Returns:
    
    float Width of this page
  - getDisplayWidth
```
public float getDisplayWidth()
```
    Returns the display width of this page in 72 DPI. This value comes from the pages CropBox
    
    Returns:
    
    float Width of this page
  - getDisplayRight
```
public float getDisplayRight()
```
    Returns the cropbox's right most x
    
    Returns:
    
    float Right of the page
  - getDisplayBottom
```
public float getDisplayBottom()
```
    Returns the cropbox's bottom most y
    
    Returns:
    
    float Right of the page
  - getDisplayHeight
```
public float getDisplayHeight()
```
    Returns the display height of this page in 72 DPI. This value comes from the pages CropBox
    
    Returns:
    
    float Width of this page
  - getDisplayX
```
public float getDisplayX()
```
    Returns the crop box's X origin.
    
    Returns:
    
    The crop box's X origin.
  - getDisplayY
```
public float getDisplayY()
```
    Returns the crop box's Y origin.
    
    Returns:
    
    The crop box's Y origin.
  - getMirror
```
public Matrix getMirror()
```
  - getPageRotation
```
public int getPageRotation()
```
    Returns the rotation of this page in degrees.
    
    Returns:
    
    int Page rotation in degrees.
  - setPageRotation
```
public void setPageRotation(int degrees)
```
    Changes this page's rotation.
    
    Parameters:
    
    degrees - The new page rotation, in degrees
  - getPageDict
```
public com.qoppa.android.pdf.loObjects.PDFDictionary getPageDict()
```
  - getDocument
```
public PDFDocument getDocument()
```
    Returns the document that this page belongs to. A PDFPage can only belong to a single document at a time.
    
    Returns:
    
    The parent document.
  - addAnnotation
```
public void addAnnotation(Annotation annot)
                   throws PDFException
```
    Adds an annotation to this page.
    
    Parameters:
    
    annot - The annotation to add.
    
    Throws:
    
    PDFException
  - getPageIndex
```
public int getPageIndex()
```
    Gets the page index of this page within the document. Page index starts at 0.
    
    Returns:
    
    int This page's index
  - removeAnnotation
```
public void removeAnnotation(Annotation annot)
                      throws PDFException
```
    Removes an annotation from this page.
    
    Parameters:
    
    annot - A reference to the annotation that needs to be removed.
    
    Throws:
    
    PDFException
  - deleteAnnotations
```
public void deleteAnnotations()
                       throws PDFException
```
    Delete all annotations from the page. This removes all the annotations in the PDF page. Even though technically, links, widgets (text fields, buttons, etc) and file attachments are annotations, this method does flatten them as they are not annotations in the logical sense.
    
    Throws:
    
    PDFException
  - flattenAnnotations
```
public void flattenAnnotations(boolean paintNonPrintableAnnots)
                        throws PDFException
```
    Flattens the annotations. This makes the annotations uneditable and merges the content of the annotations with the page. Even though technically, links, widgets (text fields, buttons, etc) and file attachments are annotations, this method does not delete them as they are not annotations in the logical sense. To delete these, the application needs to call the removeAnnotation() method with the annotation as an argument.
    
    Parameters:
    
    paintNonPrintableAnnots - Flag to indicate whether non-printable annotations should be painted or not.
    
    Throws:
    
    PDFException
  - intersectsAnnot
```
public Annotation intersectsAnnot(float x,
                                  float y)
                           throws PDFException
```
    Returns the first annotation that contains the x,y point. This method loops through all the annotations in this page and returns the first one that contains the passed in point.
    
    Parameters:
    
    x - The X coordinate of the point of interest.
    
    y - The Y coordinate of the point of interest.
    
    Returns:
    
    The first annotation that contains the point, null if none.
    
    Throws:
    
    PDFException
  - getTabbingOrder
```
public java.lang.String getTabbingOrder()
```
    Returns the tabbing order as defined in the page description, if present. The tabbing order is used by viewers to determine the tabbing between form fields. The possible values are R for row order, C for column order and S for structure order.
    
    Returns:
    
    A string that holds the entry for the tabbing order from the page description.
  - convPoint
```
public PointF convPoint(float x,
                        float y)
```
    Converts a point from visual coordinates to PDF coordinate. The method applies the rotation (if any) in the page to convert to internal PDF coordinates.
    
    Parameters:
    
    x - The X location of the point
    
    y - The Y location of the point
    
    Returns:
    
    A PointF object containing the point coordinates in the page's native PDF coordinate space
  - convRect
```
public RectF convRect(RectF toConv)
```
    Converts a rectangle from visual coordinates to PDF coordinate. The method applies the rotation (if any) in the page to convert to internal PDF coordinates.
    
    Parameters:
    
    toConv - The rectangle to convert
    
    Returns:
    
    The converted rectangle
  - getTextModel
```
public com.qoppa.android.pdf.text.TextModel getTextModel()
```
    Returns the TextModel for this page
    
    Returns:
    
    the TextModel
  - getAllText
```
public java.lang.String getAllText()
```
    Returns all text for this page. For more detailed information about the text locations, see getTextModel().
    
    Returns:
    
    the page's text
  - getAsyncTextModel
```
public com.qoppa.android.pdf.text.AsyncTextModel getAsyncTextModel()
```
  - selectText
```
public TextSelection selectText(RectF rect)
```
    Creates a TextSelection object for any text found in a rectangle. The method looks at the rectangle that is passed in and creates a TextSelection object that contains any text that is within that rectangle.
    
    Parameters:
    
    rect - The rectangle of interest.
    
    Returns:
    
    A TextSelection object containing the text in the rectangle.
  - findTextOccurrences
```
public java.util.List<TextPosition> findTextOccurrences(java.lang.String searchString)
```
    Searches for a string in this page. This method searches the text content in this page and returns a list of occurrences, each wrapped in a TextPosition object.
    
    Parameters:
    
    searchString - The string to search for.
    
    Returns:
    
    A List of TextPosition objects, one for each occurrence of the string.
  - findTextOccurrencesWithContext
```
public java.util.List<TextPositionWithContext> findTextOccurrencesWithContext(java.lang.String searchString)
```
  - useExtGState
```
public java.lang.String useExtGState(double strokeAlpha,
                                     double fillAlpha,
                                     java.lang.String blendName)
                              throws PDFException
```
    Internal method, do not use.
    
    Throws:
    
    PDFException
  - addSignatureField
```
public SignatureField addSignatureField(java.lang.String fieldName,
                                        RectF bounds)
                                 throws PDFException
```
    Adds a signature field to this page. The signature field is added to the page but is NOT signed. To sign the document, the application must call PDFDocument.signDocument. To create an invisible signature field, the bound rectangle should be set to (0,0,0,0) for the bounds.
    
    Parameters:
    
    fieldName - The name of the new field.
    
    bounds - The bounds of the field on the page. (0,0,0,0) indicates that the signature field will be invisible.
    
    Throws:
    
    PDFException
  - setBackgroundColor
```
public void setBackgroundColor(int color)
```
    Sets the background color to use when rendering this page. If no color is set, DEFAULT_BACKGROUND_COLOR will be used.
    
    Parameters:
    
    color - The background color.
  - getBackgroundColor
```
public int getBackgroundColor()
```
    Returns the background color to use when rendering this page. This color will only be used if it been specified by calling setBackgroundColor(int).
    
    Returns:
    
    The background color.

Class PDFPage

Field Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

m_PageDict

COMPRESSION_JPEG

COMPRESSION_DEFLATE

COMPRESSION_JBIG2

DEFAULT_BACKGROUND_COLOR

Method Detail

hasAnnotations

hasEditableAnnots

getAnnotations

getSlimAnnots

createCanvas

useImage

useImage

useFont

getCropBox

getBitmap

getBitmap

getBitmap

getIPicture

paintPage

paintPage

getContentStream

savePageAsJPEG

savePageAsPNG

getMediaBox

getPaperHeight

getPaperWidth

getDisplayWidth

getDisplayRight

getDisplayBottom

getDisplayHeight

getDisplayX

getDisplayY

getMirror

getPageRotation

setPageRotation

getPageDict

getDocument

addAnnotation

getPageIndex

removeAnnotation

deleteAnnotations

flattenAnnotations

intersectsAnnot

getTabbingOrder

convPoint

convRect

getTextModel

getAllText

getAsyncTextModel

selectText

findTextOccurrences

findTextOccurrencesWithContext

useExtGState

addSignatureField

setBackgroundColor

getBackgroundColor