PdfPageData (org.jpedal:OpenViewerFX 7.12.28 API)

java.lang.Object
- org.jpedal.objects.PdfPageData

All Implemented Interfaces:

Serializable
```
public class PdfPageData
extends Object
implements Serializable
```
store data relating to page sizes set in PDF (MediaBox, CropBox, rotation)

See Also:

Serialized Form

Constructor Summary

Constructors
Constructor and Description

PdfPageData()

Constructors
Constructor and Description
`PdfPageData()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`checkSizeSet(int pageNumber)` make sure a value set for crop and media box (used internally to trap 'odd' settings and insure setup correctly)
`int`	`getCropBoxHeight(int pageNumber)`
`float`	`getCropBoxHeight2D(int pageNumber)`
`int`	`getCropBoxWidth(int pageNumber)`
`float`	`getCropBoxWidth2D(int pageNumber)` return cropBox width
`int`	`getCropBoxX(int pageNumber)`
`float`	`getCropBoxX2D(int pageNumber)`
`int`	`getCropBoxY(int pageNumber)`
`float`	`getCropBoxY2D(int pageNumber)`
`String`	`getCropValue(int currentPage)`
`HtmlPageData`	`getHTMLData()`
`int`	`getMediaBoxHeight(int pageNumber)`
`int`	`getMediaBoxWidth(int pageNumber)`
`int`	`getMediaBoxX(int pageNumber)`
`int`	`getMediaBoxY(int pageNumber)`
`String`	`getMediaValue(int currentPage)`
`PageOrigins`	`getOrigin()` allow page to start at different locations (bottom left is default)
`int`	`getPageCount()` get page count
`int`	`getRotation(int pageNumber)`
`int`	`getScaledCropBoxHeight(int pageNumber)`
`int`	`getScaledCropBoxWidth(int pageNumber)`
`int`	`getScaledCropBoxX(int pageNumber)`
`int`	`getScaledCropBoxY(int pageNumber)`
`int`	`getScaledMediaBoxHeight(int pageNumber)`
`int`	`getScaledMediaBoxWidth(int pageNumber)`
`int`	`getScaledMediaBoxX(int pageNumber)`
`int`	`getScaledMediaBoxY(int pageNumber)`
`int`	`getScaledTotalDoubleHeight()`
`int`	`getScaledTotalDoubleWidth()`
`int`	`getScaledTotalSingleHeight()`
`int`	`getScaledTotalSingleWidth()`
`float`	`getScalingValue()` Get the scaling value currently being used
`boolean`	`hasMultipleSizes()`
`void`	`setCropBox(float[] cropBox)` set crop with values and align with media box
`void`	`setMediaBox(float[] mediaBox)` set string with raw values and assign values to crop and media size
`void`	`setOrigin(PageOrigins newPageOrigin)` set page co-ord system to different location
`void`	`setPageCount(int count)`
`void`	`setPageRotation(int value, int pageNumber)`
`void`	`setScalingValue(float scalingValue)` Scaling value to apply to all values

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

- Constructor Detail
  - PdfPageData
```
public PdfPageData()
```
- Method Detail
  - checkSizeSet
```
public void checkSizeSet(int pageNumber)
```
    make sure a value set for crop and media box (used internally to trap 'odd' settings and insure setup correctly)
    
    Parameters:
    
    pageNumber - Page to be displayed
  - getMediaBoxHeight
```
public final int getMediaBoxHeight(int pageNumber)
```
    Parameters:
    
    pageNumber - Page to be displayed
    
    Returns:
    
    height of mediaBox
  - getMediaBoxY
```
public final int getMediaBoxY(int pageNumber)
```
    Parameters:
    
    pageNumber - Page to be displayed
    
    Returns:
    
    mediaBox y value
  - getMediaBoxX
```
public final int getMediaBoxX(int pageNumber)
```
    Parameters:
    
    pageNumber - Page to be displayed
    
    Returns:
    
    mediaBox x value
  - setMediaBox
```
public void setMediaBox(float[] mediaBox)
```
    set string with raw values and assign values to crop and media size
    
    Parameters:
    
    mediaBox - row values of PDF page data
  - setCropBox
```
public void setCropBox(float[] cropBox)
```
    set crop with values and align with media box
    
    Parameters:
    
    cropBox - crop values of PDF page data
  - setPageRotation
```
public void setPageRotation(int value,
                            int pageNumber)
```
  - getMediaBoxWidth
```
public final int getMediaBoxWidth(int pageNumber)
```
    Parameters:
    
    pageNumber - Page to be displayed
    
    Returns:
    
    width of media box
  - getMediaValue
```
public String getMediaValue(int currentPage)
```
    Parameters:
    
    currentPage - the new current page
    
    Returns:
    
    mediaBox string found in PDF file
  - getCropValue
```
public String getCropValue(int currentPage)
```
    Parameters:
    
    currentPage - the new current page
    
    Returns:
    
    cropBox string found in PDF file
  - getScaledCropBoxX
```
public int getScaledCropBoxX(int pageNumber)
```
    Parameters:
    
    pageNumber - the page to be displayed
    
    Returns:
    
    Scaled x value for cropBox
  - getScaledCropBoxWidth
```
public int getScaledCropBoxWidth(int pageNumber)
```
    Parameters:
    
    pageNumber - the page to be displayed
    
    Returns:
    
    Scaled cropBox width
  - getScaledCropBoxY
```
public int getScaledCropBoxY(int pageNumber)
```
    Parameters:
    
    pageNumber - the page to be displayed
    
    Returns:
    
    Scaled y value for cropox
  - getScaledCropBoxHeight
```
public int getScaledCropBoxHeight(int pageNumber)
```
    Parameters:
    
    pageNumber - the page to be displayed
    
    Returns:
    
    Scaled cropBox height
  - getCropBoxX
```
public int getCropBoxX(int pageNumber)
```
    Parameters:
    
    pageNumber - the page to be displayed
    
    Returns:
    
    x value for cropBox
  - getCropBoxX2D
```
public float getCropBoxX2D(int pageNumber)
```
    Parameters:
    
    pageNumber - the page to be displayed
    
    Returns:
    
    x value for cropBox
  - getCropBoxWidth
```
public int getCropBoxWidth(int pageNumber)
```
    Parameters:
    
    pageNumber - the page to be displayed
    
    Returns:
    
    cropBox width
  - getCropBoxWidth2D
```
public float getCropBoxWidth2D(int pageNumber)
```
    return cropBox width
    
    Parameters:
    
    pageNumber - the page to be displayed
  - getCropBoxY
```
public int getCropBoxY(int pageNumber)
```
    Parameters:
    
    pageNumber - the page to be displayed
    
    Returns:
    
    y value for cropox
  - getCropBoxY2D
```
public float getCropBoxY2D(int pageNumber)
```
    Parameters:
    
    pageNumber - the page to be displayed
    
    Returns:
    
    y value for cropox
  - getCropBoxHeight
```
public int getCropBoxHeight(int pageNumber)
```
    Parameters:
    
    pageNumber - the page to be displayed
    
    Returns:
    
    cropBox height
  - getCropBoxHeight2D
```
public float getCropBoxHeight2D(int pageNumber)
```
    Parameters:
    
    pageNumber - the page to be displayed
    
    Returns:
    
    cropBox height
  - getScalingValue
```
public float getScalingValue()
```
    Get the scaling value currently being used
    
    Returns:
    
    scalingValue
  - setScalingValue
```
public void setScalingValue(float scalingValue)
```
    Scaling value to apply to all values
    
    Parameters:
    
    scalingValue - The new scaling value
  - getPageCount
```
public final int getPageCount()
```
    get page count
    
    Returns:
    
    number of pages
  - getRotation
```
public final int getRotation(int pageNumber)
```
    Parameters:
    
    pageNumber - the page to be displayed
    
    Returns:
    
    rotation value (for outside class)
  - getScaledMediaBoxHeight
```
public final int getScaledMediaBoxHeight(int pageNumber)
```
    Parameters:
    
    pageNumber - the page to be displayed
    
    Returns:
    
    Scaled height of mediaBox
  - getScaledMediaBoxWidth
```
public final int getScaledMediaBoxWidth(int pageNumber)
```
    Parameters:
    
    pageNumber - the page to be displayed
    
    Returns:
    
    Scaled width of media box
  - getScaledMediaBoxX
```
public final int getScaledMediaBoxX(int pageNumber)
```
    Parameters:
    
    pageNumber - the page to be displayed
    
    Returns:
    
    Scaled mediaBox x value
  - getScaledMediaBoxY
```
public final int getScaledMediaBoxY(int pageNumber)
```
    Parameters:
    
    pageNumber - the page to be displayed
    
    Returns:
    
    Scaled mediaBox y value
  - getScaledTotalDoubleWidth
```
public int getScaledTotalDoubleWidth()
```
  - getScaledTotalDoubleHeight
```
public int getScaledTotalDoubleHeight()
```
  - getScaledTotalSingleHeight
```
public int getScaledTotalSingleHeight()
```
  - getScaledTotalSingleWidth
```
public int getScaledTotalSingleWidth()
```
  - hasMultipleSizes
```
public boolean hasMultipleSizes()
```
  - setOrigin
```
public void setOrigin(PageOrigins newPageOrigin)
```
    set page co-ord system to different location
    
    Parameters:
    
    newPageOrigin - New location of page co-ord
  - getOrigin
```
public PageOrigins getOrigin()
```
    allow page to start at different locations (bottom left is default)
    
    Returns:
    
    Start location of the page
  - setPageCount
```
public void setPageCount(int count)
```
  - getHTMLData
```
public HtmlPageData getHTMLData()
```

Class PdfPageData

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

PdfPageData

Method Detail

checkSizeSet

getMediaBoxHeight

getMediaBoxY

getMediaBoxX

setMediaBox

setCropBox

setPageRotation

getMediaBoxWidth

getMediaValue

getCropValue

getScaledCropBoxX

getScaledCropBoxWidth

getScaledCropBoxY

getScaledCropBoxHeight

getCropBoxX

getCropBoxX2D

getCropBoxWidth

getCropBoxWidth2D

getCropBoxY

getCropBoxY2D

getCropBoxHeight

getCropBoxHeight2D

getScalingValue

setScalingValue

getPageCount

getRotation

getScaledMediaBoxHeight

getScaledMediaBoxWidth

getScaledMediaBoxX

getScaledMediaBoxY

getScaledTotalDoubleWidth

getScaledTotalDoubleHeight

getScaledTotalSingleHeight

getScaledTotalSingleWidth

hasMultipleSizes

setOrigin

getOrigin

setPageCount

getHTMLData