PdfPageEditor

Inheritance: java.lang.Object, com.aspose.pdf.facades.IVentureLicenseTarget, com.aspose.pdf.facades.Facade, com.aspose.pdf.facades.SaveableFacade

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.

Constructors

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

Fields

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

Methods

Method	Description
getTransitionDuration()	Gets duration of the transition effect.
setTransitionDuration(int value)	Sets duration of the transition effect.
getTransitionType()	Gets transition style to use when moving to this page from another during a presentation.
setTransitionType(int value)	Sets transition style to use when moving to this page from another during a presentation.
getDisplayDuration()	Gets display duration for pages.
setDisplayDuration(int value)	Sets display duration for pages.
getProcessPages()	Gets the page numbers to be edited.
setProcessPages(int[] value)	Sets the page numbers to be edited.
getRotation()	Gets the rotation of the pages, the rotation must be 0, 90, 180 or 270.
setRotation(int value)	Sets the rotation of the pages, the rotation must be 0, 90, 180 or 270.
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.
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.
getZoom()	Get zoom coefficient.
setZoom(float value)	Sets zoom coefficient.
getPageSize()	Gets the output file’s page size.
setPageSize(PageSize value)	Sets the output file’s page size.
getAlignment()	Gets the horizontal alignment of the original PDF content on the result page, default is AlignmentType.Left.
setAlignment(AlignmentType value)	Sets the horizontal alignment of the original PDF content on the result page, default is AlignmentType.Left.
getHorizontalAlignment()	Gets the horizontal alignment of the original PDF content on the result page, default is AlignmentType.Left.
setHorizontalAlignment(HorizontalAlignment value)	Sets the horizontal alignment of the original PDF content on the result page, default is AlignmentType.Left.
getVerticalAlignment()	Gets the vertical alignment of the original PDF content on the result page, default is VerticalAlignmentType.Bottom.
setVerticalAlignment(VerticalAlignmentType value)	Sets the vertical alignment of the original PDF content on the result page, default is VerticalAlignmentType.Bottom.
getVerticalAlignmentType()	Gets the vertical alignment of the original PDF content on the result page, default is VerticalAlignmentType.Bottom.
setVerticalAlignmentType(VerticalAlignment value)	Sets the vertical alignment of the original PDF content on the result page, default is VerticalAlignmentType.Bottom.
movePosition(float moveX, float moveY)	Moves the origin from (0, 0) to the point that appointted.
getPages()	Returns total number of pages.
getPageSize(int page)	Returns the page size of the specified page.
getPageRotation(int page)	Returns the rotation of specified page.
getPageBoxSize(int page, String pageBoxName)	Returns size of specified box in document.
save(String outputFile)	Saves changed document into file.
save(OutputStream outputStream)	Saves changed document into stream.
applyChanges()	Apply changes made to the document pages.

PdfPageEditor()

public PdfPageEditor()

Constructor for PdfPageEditor class.

PdfPageEditor(Document document)

public PdfPageEditor(Document document)

Constructor for PdfPageEditor class.

Parameters:

Parameter	Type	Description
document	Document	Document object which should be processed.

SPLITVOUT

public static final int SPLITVOUT

Out Vertical Split

SPLITHOUT

public static final int SPLITHOUT

Out Horizontal Split

SPLITVIN

public static final int SPLITVIN

In Vertical Split

SPLITHIN

public static final int SPLITHIN

IN Horizontal Split

BLINDV

public static final int BLINDV

Vertical Blinds

BLINDH

public static final int BLINDH

Vertical Blinds

INBOX

public static final int INBOX

Inward Box

OUTBOX

public static final int OUTBOX

Outward Box

LRWIPE

public static final int LRWIPE

Left-Right Wipe

RLWIPE

public static final int RLWIPE

Right-Left Wipe

BTWIPE

public static final int BTWIPE

Bottom-Top Wipe

TBWIPE

public static final int TBWIPE

Top-Bottom Wipe

DISSOLVE

public static final int DISSOLVE

The old page dissolves

LRGLITTER

public static final int LRGLITTER

Left-Right Glitter

TBGLITTER

public static final int TBGLITTER

Top-Bottom Glitter

DGLITTER

public static final int DGLITTER

Diagonal Glitter

getTransitionDuration()

public int getTransitionDuration()

Gets duration of the transition effect.

Returns: int - int value

setTransitionDuration(int value)

public void setTransitionDuration(int value)

Sets duration of the transition effect.

Parameters:

Parameter	Type	Description
value	int	int value

getTransitionType()

public int getTransitionType()

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

Returns: int - int value

setTransitionType(int value)

public void setTransitionType(int value)

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

Parameters:

Parameter	Type	Description
value	int	int value

getDisplayDuration()

public int getDisplayDuration()

Gets display duration for pages.

Returns: int - int value

setDisplayDuration(int value)

public void setDisplayDuration(int value)

Sets display duration for pages.

Parameters:

Parameter	Type	Description
value	int	int value

getProcessPages()

public int[] getProcessPages()

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

Returns: int[] - array of int values

setProcessPages(int[] value)

public void setProcessPages(int[] value)

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

Parameters:

Parameter	Type	Description
value	int[]	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 - int value

setRotation(int value)

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:

Parameter	Type	Description
value	int	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: java.util.Map<java.lang.Integer,java.lang.Integer> - Map object

setPageRotations(Map<Integer,Integer> value)

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:

Parameter	Type	Description
value	java.util.Map<java.lang.Integer,java.lang.Integer>	Map object

getZoom()

public float getZoom()

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

Returns: float - float value

setZoom(float value)

public void setZoom(float value)

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

Parameters:

Parameter	Type	Description
value	float	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() {#getPageSize--}

public PageSize getPageSize()



Gets the output file's page size.

**Returns:**
[PageSize](../../com.aspose.pdf/pagesize) - PageSize object
### setPageSize(PageSize value) {#setPageSize-com.aspose.pdf.PageSize-}

public void setPageSize(PageSize value)



Sets the output file's page size.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | [PageSize](../../com.aspose.pdf/pagesize) | PageSize object |

### getAlignment() {#getAlignment--}

public AlignmentType getAlignment()



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

**Returns:**
[AlignmentType](../../com.aspose.pdf.facades/alignmenttype) - AlignmentType object
### setAlignment(AlignmentType value) {#setAlignment-com.aspose.pdf.facades.AlignmentType-}

public void setAlignment(AlignmentType value)



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

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | [AlignmentType](../../com.aspose.pdf.facades/alignmenttype) | AlignmentType value |

### getHorizontalAlignment() {#getHorizontalAlignment--}

public HorizontalAlignment getHorizontalAlignment()



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

**Returns:**
[HorizontalAlignment](../../com.aspose.pdf/horizontalalignment) - HorizontalAlignment element
### setHorizontalAlignment(HorizontalAlignment value) {#setHorizontalAlignment-com.aspose.pdf.HorizontalAlignment-}

public void setHorizontalAlignment(HorizontalAlignment value)



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

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | [HorizontalAlignment](../../com.aspose.pdf/horizontalalignment) | int value |

### getVerticalAlignment() {#getVerticalAlignment--}

public VerticalAlignmentType getVerticalAlignment()



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

**Returns:**
[VerticalAlignmentType](../../com.aspose.pdf.facades/verticalalignmenttype) - VerticalAlignmentType object
### setVerticalAlignment(VerticalAlignmentType value) {#setVerticalAlignment-com.aspose.pdf.facades.VerticalAlignmentType-}

public void setVerticalAlignment(VerticalAlignmentType value)



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

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | [VerticalAlignmentType](../../com.aspose.pdf.facades/verticalalignmenttype) | VerticalAlignmentType value |

### getVerticalAlignmentType() {#getVerticalAlignmentType--}

public VerticalAlignment getVerticalAlignmentType()



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

**Returns:**
[VerticalAlignment](../../com.aspose.pdf/verticalalignment) - VerticalAlignmentType element
### setVerticalAlignmentType(VerticalAlignment value) {#setVerticalAlignmentType-com.aspose.pdf.VerticalAlignment-}

public void setVerticalAlignmentType(VerticalAlignment value)



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

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | [VerticalAlignment](../../com.aspose.pdf/verticalalignment) | VerticalAlignment element |

### movePosition(float moveX, float moveY) {#movePosition-float-float-}

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:**
| Parameter | Type | Description |
| --- | --- | --- |
| moveX | float | X-coordinate. |
| moveY | float | Y-coordinate. |

### getPages() {#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:**
int - Number of pages.
### getPageSize(int page) {#getPageSize-int-}

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:**
| Parameter | Type | Description |
| --- | --- | --- |
| page | int | Page index. Document pages are numbered from 1. |

**Returns:**
[PageSize](../../com.aspose.pdf/pagesize) - Result is instance of PageSize. Use Width and Height properties of the returned object to get page width and height.
### getPageRotation(int page) {#getPageRotation-int-}

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:**
| Parameter | Type | Description |
| --- | --- | --- |
| page | int | Page index. Document pages are numbered from 1. |

**Returns:**
int - Page rotation in degrees.
### getPageBoxSize(int page, String pageBoxName) {#getPageBoxSize-int-java.lang.String-}

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:**
| Parameter | Type | Description |
| --- | --- | --- |
| page | int | Page index. Document pages are numbered from 1. |
| pageBoxName | java.lang.String | Box type name. Valid values are: "art", "bleed", "crop", "media", "trim". |

**Returns:**
[Rectangle](../../java.awt/rectangle) - Rectangle which contains requested box.
### save(String outputFile) {#save-java.lang.String-}

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”);


**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| outputFile | java.lang.String | Path to file where document will be saved. |

### save(OutputStream outputStream) {#save-java.io.OutputStream-}

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”);


**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| outputStream | java.io.OutputStream | Stream where changed PDF document will be saved. |

### applyChanges() {#applyChanges--}

public void applyChanges()



Apply changes made to the document pages.

PdfJavaScriptStripper PdfPrintPageInfo