DynamicPDF by ceTe Software

com.cete.dynamicpdf
Class ExtendedPageDimensions

java.lang.Object
  extended by com.cete.dynamicpdf.AreaDimensions
      extended by com.cete.dynamicpdf.PageDimensions
          extended by 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.


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 getArtBox()
          Gets the art box dimensions of the page.
 Dimensions getBleedBox()
          Gets the bleed box dimensions of the page.
 Dimensions getCropBox()
          Gets the crop box dimensions of the page.
 Dimensions getMediaBox()
          Gets the media box dimensions of the page.
 float getPdfY(float y)
          Gets the translated PDF y coordinate.
 Dimensions getTrimBox()
          Gets the trim box dimensions of the page.
 
Methods inherited from class com.cete.dynamicpdf.PageDimensions
setMargins, setMargins, setMargins
 
Methods inherited from class com.cete.dynamicpdf.AreaDimensions
getBody, getBottomMargin, getEdge, 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
 

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.

Returns:
the crop box dimensions of the page.

getMediaBox

public Dimensions getMediaBox()
Gets the media box dimensions of the page.

Returns:
the media box dimensions of the page.

getArtBox

public Dimensions getArtBox()
Gets the art box dimensions of the page.

Returns:
the art box dimensions of the page.

getBleedBox

public Dimensions getBleedBox()
Gets the bleed box dimensions of the page.

Returns:
the bleed box dimensions of the page.

getTrimBox

public Dimensions getTrimBox()
Gets the trim box dimensions of the page.

Returns:
the trim box dimensions 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.

DynamicPDF by ceTe Software

API Reference for DynamicPDF v10.07 for Java generated on Aug 12, 2020
© Copyright 2020, ceTe Software