com.cete.dynamicpdf.merger
Class ImportedPageArea

java.lang.Object
  |
  +--com.cete.dynamicpdf.PageElement
        |
        +--com.cete.dynamicpdf.merger.ImportedPageArea

All Implemented Interfaces:

IArea, ICoordinate

public class ImportedPageArea

extends PageElement

implements ICoordinate, IArea

Represents the Imported Page Area class.

Constructor Summary

ImportedPageArea(ImportedPageContents contents, float x, float y)
Creates a new instance of ImportedPageArea.

ImportedPageArea(ImportedPageContents contents, float x, float y, float scale)
Creates a new instance of ImportedPageArea.

ImportedPageArea(PdfPage pdfPage, float x, float y)
Creates a new instance of ImportedPageArea.

ImportedPageArea(PdfPage pdfPage, float x, float y, float scale)
Creates a new instance of ImportedPageArea.

ImportedPageArea(java.lang.String filePath, int pageNumber, float x, float y)
Creates a new instance of ImportedPageArea.

ImportedPageArea(java.lang.String filePath, int pageNumber, float x, float y, float scale)
Creates a new instance of ImportedPageArea.

Method Summary

void	draw(PageWriter writer) Draws the image to the given PageWriter object.
float	getAngle() Gets the angle of the imported page area.
ImportedPageContents	getContents() Get the imported page area's ImportedPageContents object.
float	getHeight() Gets the height of the imported page area.
float	getScaleX() Gets the horizontal scale of the imported page area.
float	getScaleY() Gets the vertical scale of the imported page area.
float	getWidth() Gets the width of the imported page area.
float	getX() Gets the X coordinate of the page element.
float	getY() Gets the Y coordinate of the imported page area.
void	setAngle(float value) Sets the angle of the imported page area.
void	setBounds(float maximumWidth, float maximumHeight) Scales the image to fit in the given box keeping the X and Y scale equal.
void	setHeight(float value) Sets the height of the imported page area.
void	setScaleX(float value) Sets the horizontal scale of the imported page area.
void	setScaleY(float value) Sets the vertical scale of the imported page area.
void	setSize(float width, float height) Scales the image to fit the exact width and height given.
void	setWidth(float value) Sets the width of the imported page area.
void	setX(float value) Sets the X coordinate of the page element.
void	setY(float value) Sets the Y coordinate of the imported page area.

Methods inherited from class com.cete.dynamicpdf.PageElement

getRequiredLicenseLevel, getStrID, setRequiredLicenseLevel, setStrID

Methods inherited from class java.lang.Object

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

Constructor Detail

ImportedPageArea

public ImportedPageArea(java.lang.String filePath,
                        int pageNumber,
                        float x,
                        float y)

Creates a new instance of ImportedPageArea.

Parameters:

filePath - Physical file path of the PDF doument to import.

pageNumber - Page number to import.

x - X coordinate of the imported page area.

y - Y coordinate of the imported page area.

See Also:

ImportedPageArea

ImportedPageArea

public ImportedPageArea(java.lang.String filePath,
                        int pageNumber,
                        float x,
                        float y,
                        float scale)

Creates a new instance of ImportedPageArea.

Parameters:

filePath - Physical file path of the PDF document to import.

pageNumber - Page number to import.

x - X coordinate of the imported page area.

y - Y coordinate of the imported page area.

scale - The scale to use when rendering the imported page area.

See Also:

ImportedPageArea

ImportedPageArea

public ImportedPageArea(PdfPage pdfPage,
                        float x,
                        float y)

Creates a new instance of ImportedPageArea.

Parameters:

pdfPage - PdfPage object containing the page.

x - X coordinate of the imported page area.

y - Y coordinate of the imported page area.

See Also:

ImportedPageArea, PdfPage

ImportedPageArea

public ImportedPageArea(PdfPage pdfPage,
                        float x,
                        float y,
                        float scale)

Creates a new instance of ImportedPageArea.

Parameters:

pdfPage - PdfPage object containing the page.

x - X coordinate of the imported page area.

y - Y coordinate of the imported page area.

scale - The scale to use when rendering the imported page area.

See Also:

ImportedPageArea, PdfPage

ImportedPageArea

public ImportedPageArea(ImportedPageContents contents,
                        float x,
                        float y)

Creates a new instance of ImportedPageArea.

Parameters:

contents - ImportedPageContents object containing the page's contents.

x - X coordinate of the imported page area.

y - Y coordinate of the imported page area.

See Also:

ImportedPageArea, ImportedPageContents

ImportedPageArea

public ImportedPageArea(ImportedPageContents contents,
                        float x,
                        float y,
                        float scale)

Creates a new instance of ImportedPageArea.

Parameters:

contents - ImportedPageContents object containing the page's contents.

x - X coordinate of the imported page area.

y - Y coordinate of the imported page area.

scale - The scale to use when rendering the imported page area.

See Also:

ImportedPageArea, ImportedPageContents

Method Detail

getX

public float getX()

Gets the X coordinate of the page element.

Specified by:

getX in interface ICoordinate

Returns:

The X coordinate of the page element.

setX

public void setX(float value)

Sets the X coordinate of the page element.

Specified by:

setX in interface ICoordinate

getY

public float getY()

Gets the Y coordinate of the imported page area.

Specified by:

getY in interface ICoordinate

Returns:

The Y coordinate of the imported page area.

setY

public void setY(float value)

Sets the Y coordinate of the imported page area.

Specified by:

setY in interface ICoordinate

getAngle

public float getAngle()

Gets the angle of the imported page area.

Returns:

The angle of the imported page area.

setAngle

public void setAngle(float value)

Sets the angle of the imported page area.

getScaleX

public float getScaleX()

Gets the horizontal scale of the imported page area.

Returns:

The horizontal scale of the imported page area.

setScaleX

public void setScaleX(float value)

Sets the horizontal scale of the imported page area.

getScaleY

public float getScaleY()

Gets the vertical scale of the imported page area.

Returns:

The vertical scale of the imported page area.

setScaleY

public void setScaleY(float value)

Sets the vertical scale of the imported page area.

getWidth

public float getWidth()

Gets the width of the imported page area.

Specified by:

getWidth in interface IArea

Returns:

The width of the imported page area.

setWidth

public void setWidth(float value)

Sets the width of the imported page area.

Specified by:

setWidth in interface IArea

Parameters:

value - the float width of the area.

getHeight

public float getHeight()

Gets the height of the imported page area.

Specified by:

getHeight in interface IArea

Returns:

The height of the imported page area.

setHeight

public void setHeight(float value)

Sets the height of the imported page area.

Specified by:

setHeight in interface IArea

Parameters:

value - the float height of the area.

getContents

public ImportedPageContents getContents()

Get the imported page area's ImportedPageContents object.

See Also:

ImportedPageContents

draw

public void draw(PageWriter writer)

Draws the image to the given PageWriter object. param writer PageWriter object to receive the image's output.

Specified by:

draw in class PageElement

Parameters:

writer - the PageWriter class to receive the page elements output.

See Also:

PageWriter

setBounds

public void setBounds(float maximumWidth,
                      float maximumHeight)

Scales the image to fit in the given box keeping the X and Y scale equal.

Parameters:

maximumWidth - The maximum width.

maximumHeight - The maximum height.

setSize

public void setSize(float width,
                    float height)

Scales the image to fit the exact width and height given.

Parameters:

width - Width of image.

height - Height of image.