com.cete.dynamicpdf
Class ExtendedPageDimensions

java.lang.Object
  |
  +--com.cete.dynamicpdf.AreaDimensions
        |
        +--com.cete.dynamicpdf.PageDimensions
              |
              +--com.cete.dynamicpdf.ExtendedPageDimensions

public class ExtendedPageDimensions

extends PageDimensions

Class represents the extended dimensions of a page.

Licensing:
This class is a DynamicPDF Generator Community Edition feature.

Field Summary

Dimensions	artBox Represents the dimensions of the pages art box.
Dimensions	bleedBox Represents the dimensions of the pages bleed box.
Dimensions	mediaBox Represents the dimensions of the pages media box.
Dimensions	trimBox Represents the dimensions of the pages trim box.

Fields inherited from class com.cete.dynamicpdf.AreaDimensions

body, edge

Constructor Summary

ExtendedPageDimensions(Dimensions edge, Dimensions body)
Initializes a new instance of the ExtendedPageDimensions class.

ExtendedPageDimensions(Dimensions edge, Dimensions bleedBox, Dimensions trimBox, Dimensions body)
Initializes a new instance of the ExtendedPageDimensions class.

ExtendedPageDimensions(Dimensions mediaBox, Dimensions cropBox, Dimensions bleedBox, Dimensions trimBox, Dimensions artBox)
Initializes a new instance of the ExtendedPageDimensions class.

ExtendedPageDimensions(Dimensions mediaBox, Dimensions cropBox, Dimensions bleedBox, Dimensions trimBox, Dimensions artBox, Dimensions body)
Initializes a new instance of the ExtendedPageDimensions class.

Method Summary

void	draw(DocumentWriter writer) Draws the page dimensions to the given DocumentWriter object.
Dimensions	getCropBox() Gets the crop box dimensions of the page.
float	getPdfY(float y) Gets the translated PDF y coordinate.

Methods inherited from class com.cete.dynamicpdf.PageDimensions

setMargins, setMargins, setMargins

Methods inherited from class com.cete.dynamicpdf.AreaDimensions

getBottomMargin, getHeight, getLeftMargin, getPdfX, getRightMargin, getTopMargin, getWidth, setBottomMargin, setHeight, setLeftMargin, setRightMargin, setTopMargin, setWidth

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

mediaBox

public Dimensions mediaBox

Represents the dimensions of the pages media box.

bleedBox

public Dimensions bleedBox

Represents the dimensions of the pages bleed box.

trimBox

public Dimensions trimBox

Represents the dimensions of the pages trim box.

artBox

public Dimensions artBox

Represents the dimensions of the pages art box.

Constructor Detail

ExtendedPageDimensions

public ExtendedPageDimensions(Dimensions edge,
                              Dimensions body)

Initializes a new instance of the ExtendedPageDimensions class.

Parameters:

edge - Edge dimensions of the page.

body - Body dimensions of the page.

See Also:

ExtendedPageDimensions

ExtendedPageDimensions

public ExtendedPageDimensions(Dimensions mediaBox,
                              Dimensions cropBox,
                              Dimensions bleedBox,
                              Dimensions trimBox,
                              Dimensions artBox)

Initializes a new instance of the ExtendedPageDimensions class.

Parameters:

mediaBox - Media box dimensions of the page.

cropBox - Crop box dimensions of the page.

bleedBox - Bleed dimensions of the page.

trimBox - Trim dimensions of the page.

artBox - Art box dimensions of the page.

See Also:

ExtendedPageDimensions

ExtendedPageDimensions

public ExtendedPageDimensions(Dimensions edge,
                              Dimensions bleedBox,
                              Dimensions trimBox,
                              Dimensions body)

Initializes a new instance of the ExtendedPageDimensions class.

Parameters:

edge - Edge dimensions of the page.

bleedBox - Bleed box dimensions of the page.

trimBox - Trim box dimensions of the page.

body - Body dimensions of the page.

See Also:

ExtendedPageDimensions

ExtendedPageDimensions

public ExtendedPageDimensions(Dimensions mediaBox,
                              Dimensions cropBox,
                              Dimensions bleedBox,
                              Dimensions trimBox,
                              Dimensions artBox,
                              Dimensions body)

Initializes a new instance of the ExtendedPageDimensions class.

Parameters:

mediaBox - Media box dimensions of the page.

cropBox - Crop box dimensions of the page.

bleedBox - Bleed dimensions of the page.

trimBox - Trim dimensions of the page.

artBox - Art box dimensions of the page.

body - Body dimensions of the page.

See Also:

ExtendedPageDimensions

Method Detail

getCropBox

public Dimensions getCropBox()

Gets the crop box dimensions of the page. This is the same as the edge of the page.

draw

public void draw(DocumentWriter writer)

Draws the page dimensions to the given DocumentWriter object.

Overrides:

draw in class PageDimensions

Parameters:

writer - DocumentWriter to receive the page dimensions output.

See Also:

DocumentWriter

getPdfY

public float getPdfY(float y)

Gets the translated PDF y coordinate.

Overrides:

getPdfY in class PageDimensions

Parameters:

y - Y coordinate to translate.

Returns:

A translated Y coordinate.