com.aspose.pdf.facades

Class PdfPageEditor

java.lang.Object

com.aspose.pdf.facades.Facade

com.aspose.pdf.facades.SaveableFacade

com.aspose.pdf.facades.PdfPageEditor

All Implemented Interfaces:

com.aspose.ms.System.IDisposable, IFacade, ISaveableFacade, Closeable, AutoCloseable

public final class PdfPageEditor
extends SaveableFacade

Represents a class to edit the PDF file's page, including rotating page, zooming page, moving position and changing page size.

Field Summary

Fields

Modifier and Type	Field and Description
static int	BLINDH Vertical Blinds
static int	BLINDV Vertical Blinds
static int	BTWIPE Bottom-Top Wipe
static int	DGLITTER Diagonal Glitter
static int	DISSOLVE The old page dissolves
static int	INBOX Inward Box
static int	LRGLITTER Left-Right Glitter
static int	LRWIPE Left-Right Wipe
static int	OUTBOX Outward Box
static int	RLWIPE Right-Left Wipe
static int	SPLITHIN IN Horizontal Split
static int	SPLITHOUT Out Horizontal Split
static int	SPLITVIN In Vertical Split
static int	SPLITVOUT Out Vertical Split
static int	TBGLITTER Top-Bottom Glitter
static int	TBWIPE Top-Bottom Wipe

Constructor Summary

Constructors

Constructor and Description
PdfPageEditor() Constructor for PdfPageEditor class.
PdfPageEditor(Document document) Constructor for PdfPageEditor class.

Method Summary

Modifier and Type	Method and Description
void	applyChanges() Apply changes made to the document pages.
AlignmentType	getAlignment() Deprecated.
int	getDisplayDuration() Gets display duration for pages.
HorizontalAlignment	getHorizontalAlignment() Gets the horizontal alignment of the original PDF content on the result page, default is AlignmentType.Left.
Rectangle	getPageBoxSize(int page, String pageBoxName) Returns size of specified box in document.
static Rectangle	getPageRectangle(Page page) Return page size of the page.
int	getPageRotation(int page) Returns the rotation of specified page.
Map<Integer,Integer>	getPageRotations() Gets the rotation of the pages, A hashtable contains the page number and rotation degree, the key represents the page number, the value of key represents the rotation in degrees.
int	getPages() Returns total number of pages.
PageSize	getPageSize() Gets the output file's page size.
PageSize	getPageSize(int page) Returns the page size of the specified page.
int[]	getProcessPages() Gets the page numbers to be edited.
int	getRotation() Gets the rotation of the pages, the rotation must be 0, 90, 180 or 270.
int	getTransitionDuration() Gets duration of the transition effect.
int	getTransitionType() Gets transition style to use when moving to this page from another during a presentation.
VerticalAlignmentType	getVerticalAlignment() Deprecated.
VerticalAlignment	getVerticalAlignmentType() Gets the vertical alignment of the original PDF content on the result page, default is VerticalAlignmentType.Bottom.
float	getZoom() Get zoom coefficient.
static boolean	isBoxDefined(Page page, String boxName) Check is the box is defined on the page.
void	movePosition(float moveX, float moveY) Moves the origin from (0, 0) to the point that appointted.
void	save(OutputStream outputStream) Saves changed document into stream.
void	save(String outputFile) Saves changed document into file.
void	setAlignment(AlignmentType value) Deprecated.
void	setDisplayDuration(int value) Sets display duration for pages.
void	setHorizontalAlignment(HorizontalAlignment value) Sets the horizontal alignment of the original PDF content on the result page, default is AlignmentType.Left.
void	setPageRotations(Map<Integer,Integer> value) Sets the rotation of the pages, A hashtable contains the page number and rotation degree, the key represents the page number, the value of key represents the rotation in degrees.
void	setPageSize(PageSize value) Sets the output file's page size.
void	setProcessPages(int[] value) Sets the page numbers to be edited.
void	setRotation(int value) Sets the rotation of the pages, the rotation must be 0, 90, 180 or 270.
void	setTransitionDuration(int value) Sets duration of the transition effect.
void	setTransitionType(int value) Sets transition style to use when moving to this page from another during a presentation.
void	setVerticalAlignment(VerticalAlignmentType value) Deprecated.
void	setVerticalAlignmentType(VerticalAlignment value) Sets the vertical alignment of the original PDF content on the result page, default is VerticalAlignmentType.Bottom.
void	setZoom(float value) Sets zoom coefficient.

Methods inherited from class com.aspose.pdf.facades.Facade

bindPdf, bindPdf, bindPdf, bindPdf, bindPdf, close, dispose, getDocument

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.aspose.pdf.facades.IFacade

bindPdf, bindPdf, bindPdf, close

Methods inherited from interface com.aspose.ms.System.IDisposable

dispose

Field Detail

SPLITVOUT

public static final int SPLITVOUT

Out Vertical Split

See Also:

Constant Field Values

SPLITHOUT

public static final int SPLITHOUT

Out Horizontal Split

See Also:

Constant Field Values

SPLITVIN

public static final int SPLITVIN

In Vertical Split

See Also:

Constant Field Values

SPLITHIN

public static final int SPLITHIN

IN Horizontal Split

See Also:

Constant Field Values

BLINDV

public static final int BLINDV

Vertical Blinds

See Also:

Constant Field Values

BLINDH

public static final int BLINDH

Vertical Blinds

See Also:

Constant Field Values

INBOX

public static final int INBOX

Inward Box

See Also:

Constant Field Values

OUTBOX

public static final int OUTBOX

Outward Box

See Also:

Constant Field Values

LRWIPE

public static final int LRWIPE

Left-Right Wipe

See Also:

Constant Field Values

RLWIPE

public static final int RLWIPE

Right-Left Wipe

See Also:

Constant Field Values

BTWIPE

public static final int BTWIPE

Bottom-Top Wipe

See Also:

Constant Field Values

TBWIPE

public static final int TBWIPE

Top-Bottom Wipe

See Also:

Constant Field Values

DISSOLVE

public static final int DISSOLVE

The old page dissolves

See Also:

Constant Field Values

LRGLITTER

public static final int LRGLITTER

Left-Right Glitter

See Also:

Constant Field Values

TBGLITTER

public static final int TBGLITTER

Top-Bottom Glitter

See Also:

Constant Field Values

DGLITTER

public static final int DGLITTER

Diagonal Glitter

See Also:

Constant Field Values

Constructor Detail

PdfPageEditor

public PdfPageEditor()

Constructor for PdfPageEditor class.

PdfPageEditor

public PdfPageEditor(Document document)

Constructor for PdfPageEditor class.

Parameters:

document - Document object which should be processed.

Method Detail

getTransitionDuration

public int getTransitionDuration()

Gets duration of the transition effect.

Returns:

int value

setTransitionDuration

public void setTransitionDuration(int value)

Sets duration of the transition effect.

Parameters:

value - int value

getTransitionType

public int getTransitionType()

Gets transition style to use when moving to this page from another during a presentation.

Returns:

int value

setTransitionType

public void setTransitionType(int value)

Sets transition style to use when moving to this page from another during a presentation.

Parameters:

value - int value

getDisplayDuration

public int getDisplayDuration()

Gets display duration for pages.

Returns:

int value

setDisplayDuration

public void setDisplayDuration(int value)

Sets display duration for pages.

Parameters:

value - int value

getProcessPages

public int[] getProcessPages()

Gets the page numbers to be edited. By default, each page would be edited.

Returns:

array of int values

setProcessPages

public void setProcessPages(int[] value)

Sets the page numbers to be edited. By default, each page would be edited.

Parameters:

value - array of int values

getRotation

public int getRotation()

Gets the rotation of the pages, the rotation must be 0, 90, 180 or 270. Default value is 0.

Returns:

int value

setRotation

public void setRotation(int value)

Sets the rotation of the pages, the rotation must be 0, 90, 180 or 270. Default value is 0.

Parameters:

value - int value

getPageRotations

public Map<Integer,Integer> getPageRotations()

Gets the rotation of the pages, A hashtable contains the page number and rotation degree, the key represents the page number, the value of key represents the rotation in degrees.

Returns:

Map<Integer, Integer> object

setPageRotations

public void setPageRotations(Map<Integer,Integer> value)

Sets the rotation of the pages, A hashtable contains the page number and rotation degree, the key represents the page number, the value of key represents the rotation in degrees.

Parameters:

value - Map<Integer, Integer> object

getZoom

public float getZoom()

Get zoom coefficient. Value 1.0 corresponds to 100%. Default value is 1.0.

Returns:

float value

setZoom

public void setZoom(float value)

Sets zoom coefficient. Value 1.0 corresponds to 100%. Default value is 1.0.

Parameters:

value - float value

                              The following example demonstrates how to change zoom of the document pages.


                              PdfPageEditor editor = new PdfPageEditor();
                              editor.bindPdf("sample.pdf");
                              editor.setZoom ( 0.5f);
                              

getPageSize

public PageSize getPageSize()

Gets the output file's page size.

Returns:

PageSize object

setPageSize

public void setPageSize(PageSize value)

Sets the output file's page size.

Parameters:

value - PageSize object

getAlignment

@Deprecated
public AlignmentType getAlignment()

Deprecated.

Gets the horizontal alignment of the original PDF content on the result page, default is AlignmentType.Left.
Use getHorizontalAlignment instead

Returns:

AlignmentType object

See Also:

HorizontalAlignment

setAlignment

@Deprecated
public void setAlignment(AlignmentType value)

Deprecated.

Sets the horizontal alignment of the original PDF content on the result page, default is AlignmentType.Left.
Use setHorizontalAlignment instead

Parameters:

value - AlignmentType value

getHorizontalAlignment

public HorizontalAlignment getHorizontalAlignment()

Gets the horizontal alignment of the original PDF content on the result page, default is AlignmentType.Left.

Returns:

HorizontalAlignment element

See Also:

HorizontalAlignment

setHorizontalAlignment

public void setHorizontalAlignment(HorizontalAlignment value)

Sets the horizontal alignment of the original PDF content on the result page, default is AlignmentType.Left.

Parameters:

value - int value

See Also:

HorizontalAlignment

getVerticalAlignment

@Deprecated
public VerticalAlignmentType getVerticalAlignment()

Deprecated.

Gets the vertical alignment of the original PDF content on the result page, default is VerticalAlignmentType.Bottom.
Use getVerticalAlignmentType instead

Returns:

VerticalAlignmentType object

setVerticalAlignment

@Deprecated
public void setVerticalAlignment(VerticalAlignmentType value)

Deprecated.

Sets the vertical alignment of the original PDF content on the result page, default is VerticalAlignmentType.Bottom.
Use setVerticalAlignmentType instead

Parameters:

value - VerticalAlignmentType value

getVerticalAlignmentType

public VerticalAlignment getVerticalAlignmentType()

Gets the vertical alignment of the original PDF content on the result page, default is VerticalAlignmentType.Bottom.

Returns:

VerticalAlignmentType element

See Also:

VerticalAlignmentType

setVerticalAlignmentType

public void setVerticalAlignmentType(VerticalAlignment value)

Sets the vertical alignment of the original PDF content on the result page, default is VerticalAlignmentType.Bottom.

Parameters:

value - VerticalAlignment element

See Also:

VerticalAlignment

movePosition

public void movePosition(float moveX,
                         float moveY)

Moves the origin from (0, 0) to the point that appointted. The origin is left-bottom and the unit is point(1 inch = 72 points).

 PdfPageEditor editor = new PdfPageEditor();
 editor.bindPdf("input.pdf");
 editor.movePosition(-100, 60);
 editor.save("moved.pdf");
 

Parameters:

moveX - X-coordinate.

moveY - Y-coordinate.

getPages

public int getPages()

Returns total number of pages.

 The following example demonstrates using of GetPages() method:


 PdfPageEditor editor = new PdfPageEditor();
 editor.bindPdf("sample.pdf");
 System.out.println("Document has: " + editor.GetPages());
 

Returns:

Number of pages.

getPageSize

public PageSize getPageSize(int page)

Returns the page size of the specified page.

 The following example demonstrates using of GetPageSize method:


 PdfPageEditor editor = new PdfPageEditor();
 editor.bindPdf("sample.pdf");
 PageSize size = editor.getPageSize(1);
 System.out.println("Size of 1st page : " + size.getWidth() + " x " + size.getHeight());
 

Parameters:

page - Page index. Document pages are numbered from 1.

Returns:

Result is instance of PageSize. Use Width and Height properties of the returned object to get page width and height.

getPageRotation

public int getPageRotation(int page)

Returns the rotation of specified page.

 The following example demonstrates how to get page rotation:


 PdfPageEditor editor = new PdfPageEditor();
 editor.bindPdf("sample.pdf");
 int rotation = editor.getPageSize(1);
 System.out.println("Rotation of 1st page : " + rotation + " degrees");
 

Parameters:

page - Page index. Document pages are numbered from 1.

Returns:

Page rotation in degrees.

getPageBoxSize

public Rectangle getPageBoxSize(int page,
                                String pageBoxName)

Returns size of specified box in document.

 The following example demonstrates how to get media box of the 1st page:


 PdfPageEditor editor = new PdfPageEditor();
 editor.bindPdf("sample.pdf");
 Rectangle rect = editor.getBoxSize(1, "media");
 

Parameters:

page - Page index. Document pages are numbered from 1.

pageBoxName - Box type name. Valid values are: "art", "bleed", "crop", "media", "trim".

Returns:

Rectangle which contains requested box.

save

public void save(String outputFile)

Saves changed document into file.

 The following sample demonstrates how to save changed PDF document


 PdfPageEditor editor = new PdfPageEditor();
 editor.bindPdf("sample.pdf");
 editor.setZoom ( 0.5f);
 editor.save("newdocument.pdf");
 

Specified by:

save in interface ISaveableFacade

Overrides:

save in class SaveableFacade

Parameters:

outputFile - Path to file where document will be saved.

save

public void save(OutputStream outputStream)

Saves changed document into stream.

 The following sample demonstrates how to save changed PDF document into stream.


 PdfPageEditor editor = new PdfPageEditor();
 editor.bindPdf("sample.pdf");
 editor.setZoom ( 0.5f);
 editor.save("newdocument.pdf");
 

Specified by:

save in interface ISaveableFacade

Overrides:

save in class SaveableFacade

Parameters:

outputStream - Stream where changed PDF document will be saved.

applyChanges

public void applyChanges()

Apply changes made to the document pages.

isBoxDefined

public static boolean isBoxDefined(Page page,
                                   String boxName)

Check is the box is defined on the page.

Parameters:

page - The page.

boxName - The box name.

Returns:

true if the box is defined; otherwise, false.

getPageRectangle

public static Rectangle getPageRectangle(Page page)

Return page size of the page.

Parameters:

page - The page.

Returns:

Rectangle.