Page (PDFxStream API Reference)

```
public interface Page
```
Provides access to the text, images, and attributes of a page extracted from a PDF document.

Version:

©2004-2014 Snowtide

See Also:

Document.getPage(int)

Field Summary

Fields
Modifier and Type	Field and Description
`static int`	`COLUMN_POSITION_HALVES` A constant parameter for use with `Page.addColumnPartition(int)`.
`static int`	`COLUMN_POSITION_QUARTERS` A constant parameter for use with `Page.addColumnPartition(int)`.
`static int`	`COLUMN_POSITION_THIRDS` A constant parameter for use with `Page.addColumnPartition(int)`.

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method and Description
`void`	`addColumnPartition(int xcoord)` Adds the given coordinate as an acceptable midline between columns, used when this page is segmented.
`Page`	`crop(Region area)` Returns a `Page` instance that contains only the content held by this `Page` instance that intersects the given "query" area.
`java.util.Collection<TextUnit>`	`getCharacters()` Returns a collection of `TextUnit`s on this page.
`Configuration`	`getConfig()` Returns the `Configuration` instance provided to this page by its parent `Document` instance.
`Region`	`getCropBox()` The "crop box" defined by the PDF for this page, expressed in user space units as with `Page.getPageHeight()` and `Page.getPageWidth()`.
`Document`	`getDocument()` Returns the `Document` from which this Page was sourced.
`java.util.Collection<Image>`	`getImages()` Returns a Collection of `Image` objects, one for each image on this page.
`int`	`getPageHeight()` Returns the height of this page in PDF "default user space units" (as specified by the PDF spec).
`int`	`getPageNumber()` Returns this Page's page number.
`int`	`getPageWidth()` Returns the width of this page in PDF "default user space units" (as specified by the PDF spec).
`int`	`getRotationTheta()` Returns the number of degrees by which the page has been rotated clockwise.
`BlockParent`	`getTextContent()` Returns a BlockParent instance that contains all Block instances held by this Page, which in turn hold all text content for this Page.
`void`	`pipe(OutputHandler tgt)` Extracts all text from this page, sending necessary events to the given `OutputHandler` implementation.

- Field Detail
  - COLUMN_POSITION_HALVES
```
static final int COLUMN_POSITION_HALVES
```
    A constant parameter for use with Page.addColumnPartition(int).
    
    Since:
    
    2.5.0
    
    See Also:
    
    Constant Field Values
  - COLUMN_POSITION_THIRDS
```
static final int COLUMN_POSITION_THIRDS
```
    A constant parameter for use with Page.addColumnPartition(int).
    
    Since:
    
    2.5.0
    
    See Also:
    
    Constant Field Values
  - COLUMN_POSITION_QUARTERS
```
static final int COLUMN_POSITION_QUARTERS
```
    A constant parameter for use with Page.addColumnPartition(int).
    
    Since:
    
    2.5.0
    
    See Also:
    
    Constant Field Values
- Method Detail
  - addColumnPartition
```
void addColumnPartition(int xcoord)
```
    Adds the given coordinate as an acceptable midline between columns, used when this page is segmented. By default, no specific coordinate restrictions are applied to column partitioning. Adding any column partition coordinate will restrict acceptable column spacing midlines to only those coordinates specified.
    
    The exceptions to this are when privileged constants of Page.COLUMN_POSITION_HALVES, Page.COLUMN_POSITION_THIRDS, or Page.COLUMN_POSITION_QUARTERS are provided. Those constants "expand" into multiple column partitions; e.g. specifying Page.COLUMN_POSITION_THIRDS will result in two column partitions, one at getPageWidth() / 3 and another at 2 * getPageWidth() / 3.
    
    In order to be effective, this method must be used before either Page.getTextContent() or Page.pipe(OutputHandler) are invoked.
    
    Throws:
    
    java.lang.UnsupportedOperationException - if this Page's implementation does not support specifying column positions.
    
    Since:
    
    2.5.0
  - getDocument
```
Document getDocument()
```
    Returns the Document from which this Page was sourced.
  - getPageNumber
```
int getPageNumber()
```
    Returns this Page's page number.
  - getPageWidth
```
int getPageWidth()
```
    Returns the width of this page in PDF "default user space units" (as specified by the PDF spec). Typically, each "user space unit" is equivalent to 1/72 of an inch, so dividing the value returned by this method by 72 will yield the page height in inches.
    
    The value returned from this method corresponds to the width value of the /MediaBox attribute of a PDF page object.
  - getPageHeight
```
int getPageHeight()
```
    Returns the height of this page in PDF "default user space units" (as specified by the PDF spec). Typically, each "user space unit" is equivalent to 1/72 of an inch, so dividing the value returned by this method by 72 will yield the page height in inches.
    
    The value returned from this method corresponds to the height value of the /MediaBox attribute of a PDF page object.
  - getCropBox
```
Region getCropBox()
```
    The "crop box" defined by the PDF for this page, expressed in user space units as with Page.getPageHeight() and Page.getPageWidth(). This rectangle will default to the page width and height if it is not otherwise specified.
  - getRotationTheta
```
int getRotationTheta()
```
    Returns the number of degrees by which the page has been rotated clockwise. This value should be a factor of 90, and can be negative.
    
    The value returned from this method corresponds to the value of the /Rotate attribute of a PDF page object.
  - pipe
```
void pipe(OutputHandler tgt)
```
    Extracts all text from this page, sending necessary events to the given OutputHandler implementation. Equivalent to page.getTextContent().pipe(...).
    
    Unless custom text event handling is required, using an OutputTarget is the easiest way to take advantage of this function.
    
    Throws:
    
    InsufficientLicenseException - if a license has been loaded, but that license does not include PDF.Feature.Text.
  - getTextContent
```
BlockParent getTextContent()
```
    Returns a BlockParent instance that contains all Block instances held by this Page, which in turn hold all text content for this Page.
    
    Throws:
    
    InsufficientLicenseException - if a license has been loaded, but that license does not include PDF.Feature.Text.
  - getCharacters
```
java.util.Collection<TextUnit> getCharacters()
```
    Returns a collection of TextUnits on this page.
    Note that this collection is unordered unless a license has been loaded that includes PDF.Feature.Text.
    
    If attempting PDF text extraction, using Page.pipe(OutputHandler) with an appropriate OutputHandler, or accessing the document model produced by PDFTextStream is strongly recommended.
  - getImages
```
java.util.Collection<Image> getImages()
```
    Returns a Collection of Image objects, one for each image on this page. Note that the same image data might be displayed multiple times on a page; in such situations, multiple Image instances will still be included in the returned collection so as to represent each displayed image's dimensions and position.
    
    Throws:
    
    InsufficientLicenseException - if a license has been loaded, but that license does not include PDF.Feature.Images.
  - getConfig
```
Configuration getConfig()
```
    Returns the Configuration instance provided to this page by its parent Document instance.
  - crop
```
Page crop(Region area)
```
    Returns a Page instance that contains only the content held by this Page instance that intersects the given "query" area. If all of the content held by this instance is intersected by the query area, then this instance may be returned unchanged. If no content in this Page intersects the query area, then an empty Page instance will be returned.
    
    Throws:
    
    java.lang.UnsupportedOperationException - if this Page implementation does not support crop.
    
    See Also:
    
    Block.crop(Region)

Interface Page

Field Summary

Method Summary

Field Detail

COLUMN_POSITION_HALVES

COLUMN_POSITION_THIRDS

COLUMN_POSITION_QUARTERS

Method Detail

addColumnPartition

getDocument

getPageNumber

getPageWidth

getPageHeight

getCropBox

getRotationTheta

pipe

getTextContent

getCharacters

getImages

getConfig

crop