PdfFileMend

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

public final class PdfFileMend extends SaveableFacade

Represents a class for adding texts and images on the pages of existing PDF document.

Constructors

Constructor	Description
PdfFileMend()	Constructor.
PdfFileMend(String inputFileName, String outputFileName)	Constructor.
PdfFileMend(InputStream inputStream, OutputStream outputStream)	Constructor.
PdfFileMend(System.IO.Stream inputStream, System.IO.Stream outputStream)	Constructor.
PdfFileMend(IDocument document)	Initializes new PdfFileMend object on base of the document .
PdfFileMend(IDocument document, String outputFileName)	Initializes new PdfFileMend object on base of the document .
PdfFileMend(IDocument document, System.IO.Stream outputStream)	Initializes new PdfFileMend object on base of the document .

Methods

Method	Description
getInputStream()	Gets the input stream.
setInputStream(InputStream value)	Sets the input stream.
getOutputStream()	Gets the output stream.
setOutputStream(OutputStream value)	This method is Deprecated.
getInputFile()	Gets the input file.
setInputFile(String value)
getOutputFile()	Gets the output file.
setOutputFile(String value)	Sets the output file.
setWordWrap(boolean value)	Sets a bool value that indicates word wrap in AddText methods.
getWrapMode()	Gets word wrapping algorithm.
setWrapMode(int value)	Sets word wrapping algorithm.
getTextPositioningMode()	Gets text positioning strategy.
setTextPositioningMode(int value)	Sets text positioning strategy.
addImage(InputStream imageStream, int pageNum, float lowerLeftX, float lowerLeftY, float upperRightX, float upperRightY)	Adds image to the specified page of PDF document at specified coordinates.
addImage(InputStream imageStream, int pageNum, float lowerLeftX, float lowerLeftY, float upperRightX, float upperRightY, CompositingParameters compositingParameters)	Adds image to the specified page of PDF document at specified coordinates.
addImage(InputStream imageStream, int[] pageNums, float lowerLeftX, float lowerLeftY, float upperRightX, float upperRightY)	Adds image to the specified pages of PDF document at specified coordinates.
addImage(InputStream imageStream, int[] pageNums, float lowerLeftX, float lowerLeftY, float upperRightX, float upperRightY, CompositingParameters compositingParameters)	Adds image to the specified pages of PDF document at specified coordinates.
addImage(String imageName, int pageNum, float lowerLeftX, float lowerLeftY, float upperRightX, float upperRightY)	Adds image to the specified page of PDF document at specified coordinates.
addImage(String imageName, int pageNum, float lowerLeftX, float lowerLeftY, float upperRightX, float upperRightY, CompositingParameters compositingParameters)	Adds image to the specified page of PDF document at specified coordinates.
addImage(String imageName, int[] pageNums, float lowerLeftX, float lowerLeftY, float upperRightX, float upperRightY)	Adds image to the specified pages of PDF document at specified coordinates.
addImage(String imageName, int[] pageNums, float lowerLeftX, float lowerLeftY, float upperRightX, float upperRightY, CompositingParameters compositingParameters)	Adds image to the specified pages of PDF document at specified coordinates.
addText(FormattedText text, int pageNum, float lowerLeftX, float lowerLeftY)	Not implemented.
addText(FormattedText text, int pageNum, float lowerLeftX, float lowerLeftY, float upperRightX, float upperRightY)	Not implemented.
addText(FormattedText text, Integer[] pageNums, float lowerLeftX, float lowerLeftY, float upperRightX, float upperRightY)	Not implemented.
close()	Closes PdfFileMend object.
dispose()	Closes PdfFileMend object.
save(String destFile)	Saves the PDF document to the specified file.
save(OutputStream destStream)	Saves the PDF document to the specified file.
getDocument()	Gets the document PdfFileMend is working on.

PdfFileMend()

public PdfFileMend()

Constructor.

PdfFileMend(String inputFileName, String outputFileName)

public PdfFileMend(String inputFileName, String outputFileName)

Constructor.

Obsolete(“Use constructor without destination.”)

Parameters:

Parameter	Type	Description
inputFileName	java.lang.String	Input PDF file name.
outputFileName	java.lang.String	Output PDF file name.

PdfFileMend(InputStream inputStream, OutputStream outputStream)

public PdfFileMend(InputStream inputStream, OutputStream outputStream)

Constructor. Obsolete(“Use constructor without destination.”)

Parameters:

Parameter	Type	Description
inputStream	java.io.InputStream	Input PDF stream.
outputStream	java.io.OutputStream	Output PDF stream.

PdfFileMend(System.IO.Stream inputStream, System.IO.Stream outputStream)

public PdfFileMend(System.IO.Stream inputStream, System.IO.Stream outputStream)

Constructor.

Obsolete(“Use constructor without destination.”)

Parameters:

Parameter	Type	Description
inputStream	com.aspose.ms.System.IO.Stream	Input PDF stream.
outputStream	com.aspose.ms.System.IO.Stream	Output PDF stream.

PdfFileMend(IDocument document)

public PdfFileMend(IDocument document)

Initializes new PdfFileMend object on base of the document .

Parameters:

Parameter	Type	Description
document	IDocument	Pdf document.

PdfFileMend(IDocument document, String outputFileName)

public PdfFileMend(IDocument document, String outputFileName)

Initializes new PdfFileMend object on base of the document .

Obsolete(“Use constructor without destination.”)

Parameters:

Parameter	Type	Description
document	IDocument	Pdf document.
outputFileName	java.lang.String	Output PDF file name.

PdfFileMend(IDocument document, System.IO.Stream outputStream)

public PdfFileMend(IDocument document, System.IO.Stream outputStream)

Initializes new PdfFileMend object on base of the document .

Obsolete(“Use constructor without destination.”)

Parameters:

Parameter	Type	Description
document	IDocument	Pdf document.
outputStream	com.aspose.ms.System.IO.Stream	Output PDF stream.

getInputStream()

public InputStream getInputStream()

Gets the input stream.

Returns: java.io.InputStream - input stream.

setInputStream(InputStream value)

public void setInputStream(InputStream value)

Sets the input stream.

Parameters:

Parameter	Type	Description
value	java.io.InputStream	input stream.

getOutputStream()

public OutputStream getOutputStream()

Gets the output stream.

Returns: java.io.OutputStream - output stream.

setOutputStream(OutputStream value)

public void setOutputStream(OutputStream value)

This method is Deprecated. Use Save(outputStream) method for getting facade results.

Parameters:

Parameter	Type	Description
value	java.io.OutputStream	output stream.

getInputFile()

public String getInputFile()

Gets the input file.

Returns: java.lang.String - String value

setInputFile(String value)

public void setInputFile(String value)

Parameters:

Parameter	Type	Description
value	java.lang.String

getOutputFile()

public String getOutputFile()

Gets the output file.

Returns: java.lang.String - String value

setOutputFile(String value)

public void setOutputFile(String value)

Sets the output file.

Parameters:

Parameter	Type	Description
value	java.lang.String	String value

setWordWrap(boolean value)

public void setWordWrap(boolean value)

Sets a bool value that indicates word wrap in AddText methods. If the value is true, the text in FormattedText will word wrap. By defalt, the value is false.

Parameters:

Parameter	Type	Description
value	boolean	boolean value

getWrapMode()

public int getWrapMode()

Gets word wrapping algorithm.

Returns: int - WordWrapMode value

setWrapMode(int value)

public void setWrapMode(int value)

Sets word wrapping algorithm.

Parameters:

Parameter	Type	Description
value	int	WordWrapMode element

getTextPositioningMode()

public int getTextPositioningMode()

Gets text positioning strategy. PositioningMode Default mode is Legacy.

Returns: int - PositioningMode element

setTextPositioningMode(int value)

public void setTextPositioningMode(int value)

Sets text positioning strategy. PositioningMode Default mode is Legacy.

Parameters:

Parameter	Type	Description
value	int	PositioningMode element

addImage(InputStream imageStream, int pageNum, float lowerLeftX, float lowerLeftY, float upperRightX, float upperRightY)

public boolean addImage(InputStream imageStream, int pageNum, float lowerLeftX, float lowerLeftY, float upperRightX, float upperRightY)

Adds image to the specified page of PDF document at specified coordinates.

PdfFileMend mendor = new PdfFileMend("example.pdf", "out_example.pdf");
 InputStream stream = new FileInputStream("picture.jpg"))
 mendor.addImage(stream, 1, 10, 10, 100, 100);
 mendor.close();

Parameters:

Parameter	Type	Description
imageStream	java.io.InputStream	Input image stream.
pageNum	int	The number of page that will receive the image.
lowerLeftX	float	The lower left x of image rectangle.
lowerLeftY	float	The lower left y of image rectangle.
upperRightX	float	The upper right x of image rectangle.
upperRightY	float	The upper right y of image rectangle.

Returns: boolean - True if success false otherwise.

addImage(InputStream imageStream, int pageNum, float lowerLeftX, float lowerLeftY, float upperRightX, float upperRightY, CompositingParameters compositingParameters)

public boolean addImage(InputStream imageStream, int pageNum, float lowerLeftX, float lowerLeftY, float upperRightX, float upperRightY, CompositingParameters compositingParameters)

Adds image to the specified page of PDF document at specified coordinates.

PdfFileMend mendor = new PdfFileMend("example.pdf", "out_example.pdf");
 InputStream stream = new FileInputStream("picture.jpg"))
 mendor.addImage(stream, 1, 10, 10, 100, 100, new CompositingParameters(BlendMode.Multiply);
 mendor.close();

Parameters:

Parameter	Type	Description
imageStream	java.io.InputStream	Input image stream.
pageNum	int	The number of page that will receive the image.
lowerLeftX	float	The lower left x of image rectangle.
lowerLeftY	float	The lower left y of image rectangle.
upperRightX	float	The upper right x of image rectangle.
upperRightY	float	The upper right y of image rectangle.
compositingParameters	CompositingParameters	The graphics compositing parameters for the image.

Returns: boolean - True if success false otherwise.

addImage(InputStream imageStream, int[] pageNums, float lowerLeftX, float lowerLeftY, float upperRightX, float upperRightY)

public boolean addImage(InputStream imageStream, int[] pageNums, float lowerLeftX, float lowerLeftY, float upperRightX, float upperRightY)

Adds image to the specified pages of PDF document at specified coordinates.

PdfFileMend mendor = new PdfFileMend("example.pdf", "out_example.pdf");
 InputStream stream = new FileInputStream("picture.jpg")
     mendor.addImage(stream, new int[]{1, 2}, 10, 10, 100, 100);
 mendor.close();

Parameters:

Parameter	Type	Description
imageStream	java.io.InputStream	Input image stream.
pageNums	int[]	The numbers of pages that will receive the image.
lowerLeftX	float	The lower left x of image rectangle.
lowerLeftY	float	The lower left y of image rectangle.
upperRightX	float	The upper right x of image rectangle.
upperRightY	float	The upper right y of image rectangle.

Returns: boolean - True if success false otherwise.

addImage(InputStream imageStream, int[] pageNums, float lowerLeftX, float lowerLeftY, float upperRightX, float upperRightY, CompositingParameters compositingParameters)

public boolean addImage(InputStream imageStream, int[] pageNums, float lowerLeftX, float lowerLeftY, float upperRightX, float upperRightY, CompositingParameters compositingParameters)

Adds image to the specified pages of PDF document at specified coordinates.

PdfFileMend mendor = new PdfFileMend("example.pdf", "out_example.pdf");
 InputStream stream = new FileInputStream("picture.jpg")
     mendor.addImage(stream, new int[]{1, 2}, 10, 10, 100, 100, new CompositingParameters(BlendMode.Multiply);
 mendor.close();

Parameters:

Parameter	Type	Description
imageStream	java.io.InputStream	Input image stream.
pageNums	int[]	The numbers of pages that will receive the image.
lowerLeftX	float	The lower left x of image rectangle.
lowerLeftY	float	The lower left y of image rectangle.
upperRightX	float	The upper right x of image rectangle.
upperRightY	float	The upper right y of image rectangle.
compositingParameters	CompositingParameters	The graphics compositing parameters for the images.

Returns: boolean - True if success false otherwise.

addImage(String imageName, int pageNum, float lowerLeftX, float lowerLeftY, float upperRightX, float upperRightY)

public boolean addImage(String imageName, int pageNum, float lowerLeftX, float lowerLeftY, float upperRightX, float upperRightY)

Adds image to the specified page of PDF document at specified coordinates.

PdfFileMend mendor = new PdfFileMend("example.pdf", "out_example.pdf");
 mendor.addImage("picture.jpg", 1, 10, 10, 100, 100);
 mendor.close();

Parameters:

Parameter	Type	Description
imageName	java.lang.String	The path of input image file.
pageNum	int	The number of page that will receive the image.
lowerLeftX	float	The lower left x of image rectangle.
lowerLeftY	float	The lower left y of image rectangle.
upperRightX	float	The upper right x of image rectangle.
upperRightY	float	The upper right y of image rectangle.

Returns: boolean - True if success false otherwise.

addImage(String imageName, int pageNum, float lowerLeftX, float lowerLeftY, float upperRightX, float upperRightY, CompositingParameters compositingParameters)

public boolean addImage(String imageName, int pageNum, float lowerLeftX, float lowerLeftY, float upperRightX, float upperRightY, CompositingParameters compositingParameters)

Adds image to the specified page of PDF document at specified coordinates.

PdfFileMend mendor = new PdfFileMend("example.pdf", "out_example.pdf");
 mendor.addImage("picture.jpg", 1, 10, 10, 100, 100, new CompositingParameters(BlendMode.Multiply));
 mendor.close();

Parameters:

Parameter	Type	Description
imageName	java.lang.String	The path of input image file.
pageNum	int	The number of page that will receive the image.
lowerLeftX	float	The lower left x of image rectangle.
lowerLeftY	float	The lower left y of image rectangle.
upperRightX	float	The upper right x of image rectangle.
upperRightY	float	The upper right y of image rectangle.
compositingParameters	CompositingParameters	The graphics compositing parameters for the images.

Returns: boolean - True if success false otherwise.

addImage(String imageName, int[] pageNums, float lowerLeftX, float lowerLeftY, float upperRightX, float upperRightY)

public boolean addImage(String imageName, int[] pageNums, float lowerLeftX, float lowerLeftY, float upperRightX, float upperRightY)

Adds image to the specified pages of PDF document at specified coordinates.

PdfFileMend mendor = new PdfFileMend("example.pdf", "out_example.pdf");
 mendor.addImage("picture.jpg", 1, 10, 10, 100, 100);
 mendor.close();

Parameters:

Parameter	Type	Description
imageName	java.lang.String	The path of input image file.
pageNums	int[]	The numbers of pages that will receive the image.
lowerLeftX	float	The lower left x of image rectangle.
lowerLeftY	float	The lower left y of image rectangle.
upperRightX	float	The upper right x of image rectangle.
upperRightY	float	The upper right y of image rectangle.

Returns: boolean - True if success false otherwise.

addImage(String imageName, int[] pageNums, float lowerLeftX, float lowerLeftY, float upperRightX, float upperRightY, CompositingParameters compositingParameters)

public boolean addImage(String imageName, int[] pageNums, float lowerLeftX, float lowerLeftY, float upperRightX, float upperRightY, CompositingParameters compositingParameters)

Adds image to the specified pages of PDF document at specified coordinates.

PdfFileMend mendor = new PdfFileMend("example.pdf", "out_example.pdf");
 mendor.addImage("picture.jpg", 1, 10, 10, 100, 100, new CompositingParameters(BlendMode.Multiply));
 mendor.close();

Parameters:

Parameter	Type	Description
imageName	java.lang.String	The path of input image file.
pageNums	int[]	The numbers of pages that will receive the image.
lowerLeftX	float	The lower left x of image rectangle.
lowerLeftY	float	The lower left y of image rectangle.
upperRightX	float	The upper right x of image rectangle.
upperRightY	float	The upper right y of image rectangle.
compositingParameters	CompositingParameters	The graphics compositing parameters for the images.

Returns: boolean - True if success false otherwise.

addText(FormattedText text, int pageNum, float lowerLeftX, float lowerLeftY)

public boolean addText(FormattedText text, int pageNum, float lowerLeftX, float lowerLeftY)

Not implemented.

Parameters:

Parameter	Type	Description
text	FormattedText	FormattedText object.
pageNum	int	Page number.
lowerLeftX	float	Lower left X coordinate.
lowerLeftY	float	Lower left Y coordinate.

Returns: boolean - True in case text was successfully added.

addText(FormattedText text, int pageNum, float lowerLeftX, float lowerLeftY, float upperRightX, float upperRightY)

public boolean addText(FormattedText text, int pageNum, float lowerLeftX, float lowerLeftY, float upperRightX, float upperRightY)

Not implemented.

Parameters:

Parameter	Type	Description
text	FormattedText	FormattedText object.
pageNum	int	Page number.
lowerLeftX	float	Lower left X coordinate.
lowerLeftY	float	Lower left Y coordinate.
upperRightX	float	Upper right X coordinate.
upperRightY	float	Upper right Y coordinate.

Returns: boolean - True in case text was successfully added.

addText(FormattedText text, Integer[] pageNums, float lowerLeftX, float lowerLeftY, float upperRightX, float upperRightY)

public boolean addText(FormattedText text, Integer[] pageNums, float lowerLeftX, float lowerLeftY, float upperRightX, float upperRightY)

Not implemented.

Parameters:

Parameter	Type	Description
text	FormattedText	FormattedText object.
pageNums	java.lang.Integer[]	Page numbers array.
lowerLeftX	float	Lower left X coordinate.
lowerLeftY	float	Lower left Y coordinate.
upperRightX	float	Upper right X coordinate.
upperRightY	float	Upper right Y coordinate.

Returns: boolean - True in case text was successfully added.

close()

public void close()

Closes PdfFileMend object.

dispose()

public void dispose()

Closes PdfFileMend object. This method is obsolete, use close() instead.

save(String destFile)

public void save(String destFile)

Saves the PDF document to the specified file.

Parameters:

Parameter	Type	Description
destFile	java.lang.String	The destination file.

save(OutputStream destStream)

public void save(OutputStream destStream)

Saves the PDF document to the specified file.

Parameters:

Parameter	Type	Description
destStream	java.io.OutputStream	The destination stream.

getDocument()

public IDocument getDocument()

Gets the document PdfFileMend is working on.

Returns: IDocument - IDocument object

PdfFileInfo PdfFileSanitization