Packages

com.aspose.pdf.facades

Interfaces

Classes

java.lang.Object
- com.aspose.pdf.facades.Facade
- - com.aspose.pdf.facades.SaveableFacade
  - - com.aspose.pdf.facades.PdfFileStampWeb

All Implemented Interfaces:

com.aspose.ms.System.IDisposable, IFacade, IPdfFileStamp, ISaveableFacade
```
public final class PdfFileStampWeb
extends SaveableFacade
implements IPdfFileStamp
```
Class for adding stamps (watermark or background) to PDF files. Enable to work with HttpServletResponse.

Field Summary

Fields
Modifier and Type	Field and Description
`static int`	`POS_BOTTOM_LEFT` Bottom left position.
`static int`	`POS_BOTTOM_MIDDLE` Bottom middle position.
`static int`	`POS_BOTTOM_RIGHT` Bottom right position.
`static int`	`POS_SIDES_LEFT` Left position.
`static int`	`POS_SIDES_RIGHT` Right position.
`static int`	`POS_UPPER_LEFT` Upper let position.
`static int`	`POS_UPPER_MIDDLE` Upper middle position.
`static int`	`POS_UPPER_RIGHT` Right upper position.

Constructor Summary

Constructors
Constructor and Description
`PdfFileStampWeb()` Constructor of the PdfFileStamp.
`PdfFileStampWeb(IDocument document)` Initializes new `PdfFileStamp` object on base of the `document`.
`PdfFileStampWeb(IDocument document, OutputStream outputStream)` Initializes new `PdfFileStamp` object on base of the `document`.
`PdfFileStampWeb(IDocument document, String outputFile)` Initializes new `PdfFileStamp` object on base of the `document`.
`PdfFileStampWeb(InputStream inputStream, javax.servlet.http.HttpServletResponse response)` Creates PdfFileStampWeb which will save result into HttpResponse object.
`PdfFileStampWeb(InputStream inputStream, OutputStream outputStream)` Constructor for PdfFileStamp.
`PdfFileStampWeb(InputStream inputStream, OutputStream outputStream, boolean keepSecurity)` Constructor of PdfFileStamp.
`PdfFileStampWeb(String inputFile, javax.servlet.http.HttpServletResponse response)` Creates PdfFileStampWeb which will save result into HttpResponse object.
`PdfFileStampWeb(String inputFile, String outputFile)` Constructor for PdfFileStamp.
`PdfFileStampWeb(String inputFile, String outputFile, boolean keepSecurity)` Constructor for PdfFileStamp.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`addFooter(FormattedText formattedText, float bottomMargin)` Adds footer to the pages of the document.
`void`	`addFooter(FormattedText formattedText, float bottomMargin, float leftMargin, float rightMargin)` Adds footer to the pages of the document.
`void`	`addFooter(InputStream imageStream, float bottomMargin)` Adds image as footer of the page.
`void`	`addFooter(InputStream imageStream, float bottomMargin, float leftMargin, float rightMargin)` Adds image as footer of the page.
`void`	`addFooter(String imageFile, float bottomMargin)` Adds image as footer to the pages of the document.
`void`	`addFooter(String imageFile, float bottomMargin, float leftMargin, float rightMargin)` Adds image as footer of the pages.
`void`	`addHeader(FormattedText formattedText, float topMargin)` Adds header to the page.
`void`	`addHeader(FormattedText formattedText, float topMargin, float leftMargin, float rightMargin)` Adds header to the pages of file.
`void`	`addHeader(InputStream imageStream, float topMargin)` Adds image as header on the pages.
`void`	`addHeader(InputStream inputStream, float topMargin, float leftMargin, float rightMargin)` Adds image at the top of the page.
`void`	`addHeader(String imageFile, float topMargin)` Adds image as header to the pages of the file.
`void`	`addHeader(String imageFile, float topMargin, float leftMargin, float rightMargin)` Adds image as header on the pages.
`void`	`addPageNumber(FormattedText formattedText)` Adds page number to the page.
`void`	`addPageNumber(FormattedText formattedText, float x, float y)` Adds page number at the specified position on the page.
`void`	`addPageNumber(FormattedText formattedText, int position)` Adds page number to the pages.
`void`	`addPageNumber(FormattedText formattedText, int position, float leftMargin, float rightMargin, float topMargin, float bottomMargin)` Adds page number to the pages of document.
`void`	`addPageNumber(String formatString)` Add page number to file.
`void`	`addPageNumber(String formatString, float x, float y)` Adds page number at the specified position on the page.
`void`	`addPageNumber(String formatString, int position)` Adds page number to the pages.
`void`	`addPageNumber(String formatString, int position, float leftMargin, float rightMargin, float topMargin, float bottomMargin)` Adds page number to the pages of document.
`void`	`addStamp(Stamp stamp)` Adds stamp to the file.
`void`	`close()` Closes opened files and saves changes.
`void`	`dispose()` Disposes the facade.
`String`	`getAttachmentName()` Gets name of attachment when result of operation is stored into HttpResponse objects as attachment.
`int`	`getContentDisposition()` Gets how content will be stored when result of operation is stored into HttpResponse object.
`String`	`getInputFile()` Gets name and path of input file.
`InputStream`	`getInputStream()` Gets input stream.
`boolean`	`getKeepSecurity()` Keeps security if true.
`int`	`getNumberingStyle()` Gets or sets pabge numbering style.
`boolean`	`getOptimizeSize()` Gets or sets optimization flag.
`String`	`getOutputFile()` Gets name and path of output file.
`OutputStream`	`getOutputStream()` Gets output stream.
`float`	`getPageHeight()` Gets height of first page in source file.
`float`	`getPageNumberRotation()` Gets rotation of page number.
`float`	`getPageWidth()` Gets width of first page in input file.
`javax.servlet.http.HttpServletResponse`	`getResponse()` Gets Response object where result of operation will be stored.
`SaveOptions`	`getSaveOptions()` Gets save options when result is stored as HttpResponse.
`int`	`getStampId()` Stamp ID of next added stamp (including page headers/hooters/page numbers).
`int`	`getStartingNumber()` Gets or sets starting number for first page in input file.
`void`	`setAttachmentName(String value)` Sets name of attachment when result of operation is stored into HttpResponse objects as attachment.
`void`	`setContentDisposition(int value)` Sets how content will be stored when result of operation is stored into HttpResponse object.
`void`	`setConvertTo(int value)` Sets PDF file format.
`void`	`setInputFile(String value)` Sets name and path of input file.
`void`	`setInputStream(InputStream value)` Sets input stream.
`void`	`setKeepSecurity(boolean value)` Keeps security if true.
`void`	`setNumberingStyle(int value)` Gets or sets pabge numbering style.
`void`	`setOptimizeSize(boolean value)` Gets or sets optimization flag.
`void`	`setOutputFile(String value)` Sets name and path of output file.
`void`	`setOutputStream(OutputStream value)` Sets or sets output stream.
`void`	`setPageNumberRotation(float value)` Sets rotation of page number.
`void`	`setResponse(javax.servlet.http.HttpServletResponse value)` Sets Response object where result of operation will be stored.
`void`	`setSaveOptions(SaveOptions value)` Sets save options when result is stored as HttpResponse.
`void`	`setStampId(int value)` Stamp ID of next added stamp (including page headers/hooters/page numbers).
`void`	`setStartingNumber(int value)` Sets starting number for first page in input file.

Methods inherited from class com.aspose.pdf.facades.SaveableFacade
save, save

Methods inherited from class com.aspose.pdf.facades.Facade
bindPdf, bindPdf, bindPdf, bindPdf, bindPdf, 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.IPdfFileStamp
dispose, getDocument

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

- Field Detail
  - POS_BOTTOM_MIDDLE
```
public static final int POS_BOTTOM_MIDDLE
```
    Bottom middle position.
    
    See Also:
    
    Constant Field Values
  - POS_BOTTOM_RIGHT
```
public static final int POS_BOTTOM_RIGHT
```
    Bottom right position.
    
    See Also:
    
    Constant Field Values
  - POS_UPPER_RIGHT
```
public static final int POS_UPPER_RIGHT
```
    Right upper position.
    
    See Also:
    
    Constant Field Values
  - POS_SIDES_RIGHT
```
public static final int POS_SIDES_RIGHT
```
    Right position.
    
    See Also:
    
    Constant Field Values
  - POS_UPPER_MIDDLE
```
public static final int POS_UPPER_MIDDLE
```
    Upper middle position.
    
    See Also:
    
    Constant Field Values
  - POS_BOTTOM_LEFT
```
public static final int POS_BOTTOM_LEFT
```
    Bottom left position.
    
    See Also:
    
    Constant Field Values
  - POS_SIDES_LEFT
```
public static final int POS_SIDES_LEFT
```
    Left position.
    
    See Also:
    
    Constant Field Values
  - POS_UPPER_LEFT
```
public static final int POS_UPPER_LEFT
```
    Upper let position.
    
    See Also:
    
    Constant Field Values
- Constructor Detail
  - PdfFileStampWeb
```
public PdfFileStampWeb()
```
    Constructor of the PdfFileStamp. Input file and output file may be specified via corresponding properties.
```
 
 
 PdfFileStamp fileStamp = new PdfFileStamp();
 fileStamp.setInputFile ( "input.pdf");
 fileStamp.setOutputFile ( "output.pdf");
 
```
  - PdfFileStampWeb
```
public PdfFileStampWeb(IDocument document)
```
    Initializes new PdfFileStamp object on base of the document.
    
    Parameters:
    
    document - Pdf document.
  - PdfFileStampWeb
```
public PdfFileStampWeb(IDocument document,
                       OutputStream outputStream)
```
    Initializes new PdfFileStamp object on base of the document.
    
    Parameters:
    
    document - Pdf document.
    
    outputStream - Output stream.
  - PdfFileStampWeb
```
public PdfFileStampWeb(IDocument document,
                       String outputFile)
```
    Initializes new PdfFileStamp object on base of the document.
    
    Parameters:
    
    document - Pdf document.
    
    outputFile - Output file name and path.
  - PdfFileStampWeb
```
public PdfFileStampWeb(InputStream inputStream,
                       OutputStream outputStream)
```
    Constructor for PdfFileStamp.
```
 
 
 InputStream input = new FileInputStream("input.pdf");
 OutputStream output = new FileInputStream("output.pdf");
 PdfFileStamp stamp = new PdfFileStamp(input, output);
 
```
    Parameters:
    
    inputStream - Input stream.
    
    outputStream - Output stream.
  - PdfFileStampWeb
```
public PdfFileStampWeb(InputStream inputStream,
                       OutputStream outputStream,
                       boolean keepSecurity)
```
    Constructor of PdfFileStamp.
    
    Parameters:
    
    inputStream - Input stream.
    
    outputStream - Output stream.
    
    keepSecurity - Keep security if true.
  - PdfFileStampWeb
```
public PdfFileStampWeb(String inputFile,
                       String outputFile)
```
    Constructor for PdfFileStamp.
```
 
 
 PdfFileStamp stamp = new PdfFileStamp("input.pdf", "output.pdf");
 
```
    Parameters:
    
    inputFile - Input file name and path.
    
    outputFile - Output file name and path.
  - PdfFileStampWeb
```
public PdfFileStampWeb(String inputFile,
                       String outputFile,
                       boolean keepSecurity)
```
    Constructor for PdfFileStamp.
    
    Parameters:
    
    inputFile - Input file name and path.
    
    outputFile - Output file name and path.
    
    keepSecurity - Keep security if true.
  - PdfFileStampWeb
```
public PdfFileStampWeb(InputStream inputStream,
                       javax.servlet.http.HttpServletResponse response)
```
    Creates PdfFileStampWeb which will save result into HttpResponse object.
    
    Parameters:
    
    inputStream - Stream with input document.
    
    response - HttpResponse object where result will be saved.
  - PdfFileStampWeb
```
public PdfFileStampWeb(String inputFile,
                       javax.servlet.http.HttpServletResponse response)
```
    Creates PdfFileStampWeb which will save result into HttpResponse object.
    
    Parameters:
    
    inputFile - Source file name.
    
    response - HttpResponse object where result will be saved.
- Method Detail
  - getKeepSecurity
```
public boolean getKeepSecurity()
```
    Keeps security if true. (This feature will be implemented in next versions).
    
    Specified by:
    
    getKeepSecurity in interface IPdfFileStamp
    
    Returns:
    
    boolean value
  - setKeepSecurity
```
public void setKeepSecurity(boolean value)
```
    Keeps security if true. (This feature will be implemented in next versions).
    
    Specified by:
    
    setKeepSecurity in interface IPdfFileStamp
    
    Parameters:
    
    value - boolean value
  - getInputFile
```
public String getInputFile()
```
    Gets name and path of input file.
    
    Specified by:
    
    getInputFile in interface IPdfFileStamp
    
    Returns:
    
    String object
  - setInputFile
```
public void setInputFile(String value)
```
    Sets name and path of input file.
    
    Specified by:
    
    setInputFile in interface IPdfFileStamp
    
    Parameters:
    
    value - String object
  - getInputStream
```
public InputStream getInputStream()
```
    Gets input stream.
    
    Specified by:
    
    getInputStream in interface IPdfFileStamp
    
    Returns:
    
    InputStream object
  - setInputStream
```
public void setInputStream(InputStream value)
```
    Sets input stream.
    
    Specified by:
    
    setInputStream in interface IPdfFileStamp
    
    Parameters:
    
    value - InputStream object
  - getOutputFile
```
public String getOutputFile()
```
    Gets name and path of output file.
    
    Specified by:
    
    getOutputFile in interface IPdfFileStamp
    
    Returns:
    
    String object
  - setOutputFile
```
public void setOutputFile(String value)
```
    Sets name and path of output file.
    
    Specified by:
    
    setOutputFile in interface IPdfFileStamp
    
    Parameters:
    
    value - String object
  - getOutputStream
```
public OutputStream getOutputStream()
```
    Gets output stream.
    
    Specified by:
    
    getOutputStream in interface IPdfFileStamp
    
    Returns:
    
    OutputStream object
  - setOutputStream
```
public void setOutputStream(OutputStream value)
```
    Sets or sets output stream.
    
    Specified by:
    
    setOutputStream in interface IPdfFileStamp
    
    Parameters:
    
    value - OutputStream object
  - getPageNumberRotation
```
public float getPageNumberRotation()
```
    Gets rotation of page number. Rotation is in degrees. Default is 0.
    
    Specified by:
    
    getPageNumberRotation in interface IPdfFileStamp
    
    Returns:
    
    float value
  - setPageNumberRotation
```
public void setPageNumberRotation(float value)
```
    Sets rotation of page number. Rotation is in degrees. Default is 0.
    
    Specified by:
    
    setPageNumberRotation in interface IPdfFileStamp
    
    Parameters:
    
    value - float value
  - setConvertTo
```
public void setConvertTo(int value)
```
    Sets PDF file format. Result file will be saved in specified file format. If this property is not specified then file will be save in default PDF format without conversion.
    
    Specified by:
    
    setConvertTo in interface IPdfFileStamp
    
    Parameters:
    
    value - PdfFormat element
    
    See Also:
    
    PdfFormat
  - getPageHeight
```
public float getPageHeight()
```
    Gets height of first page in source file.
```
 
 
  PdfFileStamp fileStamp = new PdfFileStamp("input.pdf", "output.pdf");
  System.out.println("Height = " + fileStamp.getPageHeight());
  fileStamp.close();
  
```
    Specified by:
    
    getPageHeight in interface IPdfFileStamp
    
    Returns:
    
    float value
  - getPageWidth
```
public float getPageWidth()
```
    Gets width of first page in input file.
```
 
 
  PdfFileStamp fileStamp = new PdfFileStamp("input.pdf", "output.pdf");
  System.out.println("Width = " + fileStamp.getPageWidth());
  fileStamp.close();
  
```
    Specified by:
    
    getPageWidth in interface IPdfFileStamp
    
    Returns:
    
    float value
  - getStartingNumber
```
public int getStartingNumber()
```
    Gets or sets starting number for first page in input file. Next pages will be numbered starting from this value.
    
    Specified by:
    
    getStartingNumber in interface IPdfFileStamp
    
    Returns:
    
    int value
  - setStartingNumber
```
public void setStartingNumber(int value)
```
    Sets starting number for first page in input file. Next pages will be numbered starting from this value. For example if StartingNumber is set to 100, document pages will have numbers 100, 101, 102...
```
 
 
  PdfFileStamp fileStamp = new PdfFileStamp("input.pdf", "output.pdf");
  fileStamp.setStartingNumber( 100);
  fileStamp.addPageNumber("Page #");
  fileStamp.close();
  
```
    Specified by:
    
    setStartingNumber in interface IPdfFileStamp
    
    Parameters:
    
    value - int value
  - addStamp
```
public void addStamp(Stamp stamp)
```
    Adds stamp to the file.
```
 
 
  PdfFileStamp fileStamp = new PdfFileStamp("input.pdf", "output.pdf");
  Stamp stamp = new com.aspose.pdf.facades.Stamp();
  stamp.setOrigin(140, 400);
  stamp.setImageSize(50, 50);
  stamp.setOpacity ( 0.8f);
  stamp.isBackground ( true);
  stamp.bindImage("image.jpg");
  fileStamp.addStamp(stamp);
  fileStamp.close();
  
```
    Specified by:
    
    addStamp in interface IPdfFileStamp
    
    Parameters:
    
    stamp - Stamp object.
  - addPageNumber
```
public void addPageNumber(String formatString)
```
    Add page number to file. Page number text may contain # sign which will be replaced with number of the page. Page number is placed in the bottom of the page centered horizontally.
```
 
 
  PdfFileStamp fileStamp = new PdfFileStamp("input.pdf", "output.pdf");
  fileStamp.addPageNumber("Page #");
  fileStamp.close();
  
```
    Specified by:
    
    addPageNumber in interface IPdfFileStamp
    
    Parameters:
    
    formatString - Text of page number
  - addPageNumber
```
public void addPageNumber(FormattedText formattedText)
```
    Adds page number to the page. Page number may contain # sign which will be replaced with page number. Page number is placed in the bottom of the page centered horizontally.
```
 
 
  PdfFileStamp fileStamp = new PdfFileStamp("input.pdf", "output.pdf");
  fileStamp.addPageNumber(new FormattedText("Page #"));
  fileStamp.close();
  
```
    Specified by:
    
    addPageNumber in interface IPdfFileStamp
    
    Parameters:
    
    formattedText - Format string for page number representes as FormattedText.
  - addPageNumber
```
public void addPageNumber(String formatString,
                          int position,
                          float leftMargin,
                          float rightMargin,
                          float topMargin,
                          float bottomMargin)
```
    Adds page number to the pages of document.
```
 
 
  PdfFileStamp fileStamp = new PdfFileStamp("input.pdf", "output.pdf");
  fileStamp.addPageNumber("Page #", PdfFileStamp.POS_BOTTOM_LEFT, 100, 100, 200, 200);
  fileStamp.close();
  
```
    Specified by:
    
    addPageNumber in interface IPdfFileStamp
    
    Parameters:
    
    formatString - Format string for page number.
    
    position - Position where page number will be placed on the page. 0-bottom middle, 1-bottom right, 2-upper right, 3 - sides right, 4 - upper middle,5 - bottom left,6 - sides left,7 - upper left. You can use the following constants: PosBottomMiddle = 0, PosBottomRight = 1, PosUpperRight = 2, PosSidesRight = 3, PosUpperMiddle, PosBottomLeft = 5, PosSidesLeft, PosUpperLeft
    
    leftMargin - Margin on the left edge of the page.
    
    rightMargin - Margin on the right edge of the page.
    
    topMargin - Margin on the top edge of the page.
    
    bottomMargin - Margin on the bottom edge of the page.
  - addPageNumber
```
public void addPageNumber(String formatString,
                          float x,
                          float y)
```
    Adds page number at the specified position on the page.
```
 
 
 PdfFileStamp fileStamp = new PdfFileStamp("input.pdf", "output.pdf");
 fileStamp.addPageNumber(new FormattedText("Page  #"), 123, 357);
 fileStamp.close();
 
```
    Specified by:
    
    addPageNumber in interface IPdfFileStamp
    
    Parameters:
    
    formatString - Format string. Format string can contain # sign which will be replaced with page number.
    
    x - X coordinate of page number.
    
    y - Y coordinate of page number.
  - addPageNumber
```
public void addPageNumber(FormattedText formattedText,
                          int position,
                          float leftMargin,
                          float rightMargin,
                          float topMargin,
                          float bottomMargin)
```
    Adds page number to the pages of document.
```
 
 
  PdfFileStamp fileStamp = new PdfFileStamp("input.pdf", "output.pdf");
  fileStamp.addPageNumber(new FormattedText("Page #"), PdfFileStamp.POS_BOTTOM_LEFT, 100, 100, 200, 200);
  fileStamp.close();
  
```
    Specified by:
    
    addPageNumber in interface IPdfFileStamp
    
    Parameters:
    
    formattedText - FormattedText object which represents page number format and properties iof the text.
    
    position - Position where page number will be placed on the page. 0-bottom middle, 1-bottom right, 2-upper right, 3 - sides right, 4 - upper middle,5 - bottom left,6 - sides left,7 - upper left. You can use the following constants: PosBottomMiddle = 0, PosBottomRight = 1, PosUpperRight = 2, PosSidesRight = 3, PosUpperMiddle, PosBottomLeft = 5, PosSidesLeft, PosUpperLeft
    
    leftMargin - Margin on the left edge of the page.
    
    rightMargin - Margin on the right edge of the page.
    
    topMargin - Margin on the top edge of the page.
    
    bottomMargin - Margin on the bottom edge of the page.
  - addPageNumber
```
public void addPageNumber(FormattedText formattedText,
                          float x,
                          float y)
```
    Adds page number at the specified position on the page.
```
 
 
 PdfFileStamp fileStamp = new PdfFileStamp("input.pdf", "output.pdf");
 fileStamp.addPageNumber(new FormattedText("Page  #"), 123, 357);
 fileStamp.close();
 
```
    Specified by:
    
    addPageNumber in interface IPdfFileStamp
    
    Parameters:
    
    formattedText - Formatted text which represents page number format and properties of the text. Format string can contain # sign which will be replaced with page number.
    
    x - X coordinate of page number.
    
    y - Y coordinate of page number.
  - addHeader
```
public void addHeader(FormattedText formattedText,
                      float topMargin)
```
    Adds header to the page.
```
 
 
 PdfFileStamp fileStamp = new PdfFileStamp("input.pdf", "output.pdf");
 fileStamp.addHeader(new FormattedText("Head of the page"), 50);
 fileStamp.close();
 
```
    Specified by:
    
    addHeader in interface IPdfFileStamp
    
    Parameters:
    
    formattedText - Text for header and properties of the text.
    
    topMargin - Margin on the top of page.
  - addHeader
```
public void addHeader(FormattedText formattedText,
                      float topMargin,
                      float leftMargin,
                      float rightMargin)
```
    Adds header to the pages of file.
```
 
 
 PdfFileStamp stamp = new PdfFileStamp("input.pdf", "output.pdf");
 stamp.addHeader(new FormattedText("Head of the page"), 10, 50, 50);
 
```
    Specified by:
    
    addHeader in interface IPdfFileStamp
    
    Parameters:
    
    formattedText - Formatted text object which contains page text and its properties.
    
    topMargin - Margin on the top of the page.
    
    leftMargin - Margin on the left of the page.
    
    rightMargin - Margin on the right of the page.
  - addHeader
```
public void addHeader(String imageFile,
                      float topMargin)
```
    Adds image as header to the pages of the file.
```
 
 
 PdfFileStamp fileStamp = new PdfFileStamp("input.pdf", output.pdf");
 fileStamp.addHeader("image.jpg", 50);
 fileStamp.close();
 
```
    Specified by:
    
    addHeader in interface IPdfFileStamp
    
    Parameters:
    
    imageFile - Path to the image file.
    
    topMargin - Margin at top of the page.
  - addHeader
```
public void addHeader(String imageFile,
                      float topMargin,
                      float leftMargin,
                      float rightMargin)
```
    Adds image as header on the pages.
```
 
 
 PdfFileStamp fileStamp = new PdfFileStamp("input.pdf", output.pdf");
 fileStamp.addHeader("image.jpg", 50, 100, 100);
 fileStamp.close();
 
```
    Specified by:
    
    addHeader in interface IPdfFileStamp
    
    Parameters:
    
    imageFile - Path to the image file.
    
    topMargin - Margin at top of the page.
    
    leftMargin - Margin at left side of the page.
    
    rightMargin - Margin at right side of the page.
  - addHeader
```
public void addHeader(InputStream imageStream,
                      float topMargin)
```
    Adds image as header on the pages.
```
 
 
 PdfFileStamp fileStamp = new PdfFileStamp("input.pdf", output.pdf");
 InputStream input = new FileInputStream("test.jpg");
 fileStamp.addHeader(input, 50);
 fileStamp.close();
 
```
    Specified by:
    
    addHeader in interface IPdfFileStamp
    
    Parameters:
    
    imageStream - Stream of the image.
    
    topMargin - Margin at top of the page.
  - addHeader
```
public void addHeader(InputStream inputStream,
                      float topMargin,
                      float leftMargin,
                      float rightMargin)
```
    Adds image at the top of the page.
```
 
 
 PdfFileStamp fileStamp = new PdfFileStamp("input.pdf", output.pdf");
 InputStream input = new FileInputStream("test.jpg");
 fileStamp.addHeader(input, 50, 100, 100);
 fileStamp.close();
 
```
    Specified by:
    
    addHeader in interface IPdfFileStamp
    
    Parameters:
    
    inputStream - Stream which contains image data.
    
    topMargin - Margin at top of the page.
    
    leftMargin - Margin at left side of the page.
    
    rightMargin - Margin at right side of the page.
  - addFooter
```
public void addFooter(FormattedText formattedText,
                      float bottomMargin)
```
    Adds footer to the pages of the document.
```
 
 
 PdfFileStamp stamp = new PdfFileStamp("input.pdf", "output.pdf");
 stamp.addFooter(new FormattedText("Foot of the page"), 10);
 
```
    Specified by:
    
    addFooter in interface IPdfFileStamp
    
    Parameters:
    
    formattedText - FormattedText object which contains text of the footer and text properties.
    
    bottomMargin - Margin at the top of page.
  - addFooter
```
public void addFooter(FormattedText formattedText,
                      float bottomMargin,
                      float leftMargin,
                      float rightMargin)
```
    Adds footer to the pages of the document.
```
 
 
 PdfFileStamp stamp = new PdfFileStamp("input.pdf", "output.pdf");
 stamp.addFooter(new FormattedText("Foot of the page"), 10, 50, 50);
 
```
    Specified by:
    
    addFooter in interface IPdfFileStamp
    
    Parameters:
    
    formattedText - FormattedText object which contains footer text and text properties.
    
    bottomMargin - Margin at the bottom of the page.
    
    leftMargin - Margin at the left side of the page.
    
    rightMargin - Margin at the right side of the page.
  - addFooter
```
public void addFooter(String imageFile,
                      float bottomMargin)
```
    Adds image as footer to the pages of the document.
```
 
 
 PdfFileStamp fileStamp = new PdfFileStamp("input.pdf", output.pdf");
 fileStamp.addFooter("image.jpg", 50);
 fileStamp.close();
 
```
    Specified by:
    
    addFooter in interface IPdfFileStamp
    
    Parameters:
    
    imageFile - Image file name and path.
    
    bottomMargin - Margin at the bottom of the page.
  - addFooter
```
public void addFooter(String imageFile,
                      float bottomMargin,
                      float leftMargin,
                      float rightMargin)
```
    Adds image as footer of the pages.
    
    Specified by:
    
    addFooter in interface IPdfFileStamp
    
    Parameters:
    
    imageFile - Iamge file name and path.
    
    bottomMargin - Margin at the bottom of the page.
    
    leftMargin - Margin at the left side of the page.
    
    rightMargin - Margin at the right side of the page.
  - addFooter
```
public void addFooter(InputStream imageStream,
                      float bottomMargin)
```
    Adds image as footer of the page.
```
 
 
 PdfFileStamp fileStamp = new PdfFileStamp("input.pdf", output.pdf");
 InputStream input = new FileInputStream("test.jpg");
 fileStamp.addFooter(input, 50);
 fileStamp.close();
 
```
    Specified by:
    
    addFooter in interface IPdfFileStamp
    
    Parameters:
    
    imageStream - Stream contains image data.
    
    bottomMargin - Margin at the bottom of the page.
  - addFooter
```
public void addFooter(InputStream imageStream,
                      float bottomMargin,
                      float leftMargin,
                      float rightMargin)
```
    Adds image as footer of the page.
```
 
 
 PdfFileStamp fileStamp = new PdfFileStamp("input.pdf", output.pdf");
 InputStream input = new FileInputStream("test.jpg");
 fileStamp.addFooter(input, 50, 50, 50);
 fileStamp.close();
 
```
    Specified by:
    
    addFooter in interface IPdfFileStamp
    
    Parameters:
    
    imageStream - Stream contains image data.
    
    bottomMargin - Margin at the bottom of the page.
    
    leftMargin - Margin at the left side of the page.
    
    rightMargin - Margin at the right side of the page.
  - addPageNumber
```
public void addPageNumber(String formatString,
                          int position)
```
    Adds page number to the pages.
```
 
 
  PdfFileStamp fileStamp = new PdfFileStamp("input.pdf", "output.pdf");
  fileStamp.addPageNumber("Page #", PdfFileStamp.PosUpperRight);
  fileStamp.close();
 
```
    Specified by:
    
    addPageNumber in interface IPdfFileStamp
    
    Parameters:
    
    formatString - Format of the page number. This text may contain # which will be replaced with page number.
    
    position - Position where page number will be placed on the page. 0-bottom middle, 1-bottom right, 2-upper right, 3 - sides right, 4 - upper middle,5 - bottom left,6 - sides left,7 - upper left. You can use the following constants: PosBottomMiddle = 0, PosBottomRight = 1, PosUpperRight = 2, PosSidesRight = 3, PosUpperMiddle, PosBottomLeft = 5, PosSidesLeft, PosUpperLeft
  - addPageNumber
```
public void addPageNumber(FormattedText formattedText,
                          int position)
```
    Adds page number to the pages.
```
 
 
  PdfFileStamp fileStamp = new PdfFileStamp("input.pdf", "output.pdf");
  fileStamp.addPageNumber("Page #", PdfFileStamp.PosUpperRight);
  fileStamp.close();
 
```
    Specified by:
    
    addPageNumber in interface IPdfFileStamp
    
    Parameters:
    
    formattedText - FormattedText object which contains format of the page number and text properties. This text may contain # which will be replaced with page number.
    
    position - Position where page number will be placed on the page. 0-bottom middle, 1-bottom right, 2-upper right, 3 - sides right, 4 - upper middle,5 - bottom left,6 - sides left,7 - upper left. You can use the following constants: PosBottomMiddle = 0, PosBottomRight = 1, PosUpperRight = 2, PosSidesRight = 3, PosUpperMiddle, PosBottomLeft = 5, PosSidesLeft, PosUpperLeft
  - getContentDisposition
```
public int getContentDisposition()
```
    Gets how content will be stored when result of operation is stored into HttpResponse object. Possible value: inline / attachment. Default: inline.
    
    Specified by:
    
    getContentDisposition in interface IPdfFileStamp
    
    Returns:
    
    ContentDisposition element
    
    See Also:
    
    ContentDisposition
  - setContentDisposition
```
public void setContentDisposition(int value)
```
    Sets how content will be stored when result of operation is stored into HttpResponse object. Possible value: inline / attachment. Default: inline.
    
    Specified by:
    
    setContentDisposition in interface IPdfFileStamp
    
    Parameters:
    
    value - ContentDisposition element
    
    See Also:
    
    ContentDisposition
  - getSaveOptions
```
public SaveOptions getSaveOptions()
```
    Gets save options when result is stored as HttpResponse. Default value: PdfSaveOptions.
    
    Specified by:
    
    getSaveOptions in interface IPdfFileStamp
    
    Returns:
    
    SaveOptions object
  - setSaveOptions
```
public void setSaveOptions(SaveOptions value)
```
    Sets save options when result is stored as HttpResponse. Default value: PdfSaveOptions.
    
    Specified by:
    
    setSaveOptions in interface IPdfFileStamp
    
    Parameters:
    
    value - SaveOptions object
  - getAttachmentName
```
public String getAttachmentName()
```
    Gets name of attachment when result of operation is stored into HttpResponse objects as attachment.
    
    Specified by:
    
    getAttachmentName in interface IPdfFileStamp
    
    Returns:
    
    string object
  - setAttachmentName
```
public void setAttachmentName(String value)
```
    Sets name of attachment when result of operation is stored into HttpResponse objects as attachment.
    
    Specified by:
    
    setAttachmentName in interface IPdfFileStamp
    
    Parameters:
    
    value - string object
  - close
```
public void close()
```
    Closes opened files and saves changes. Warning. If input or output streams are specified they are not closed by Close() method.
```
 
 
 PdfFileStamp stamp = new PdfFileStamp("input.pdf", "output.pdf");
 //do some work... 
 stamp.close();
 
```
    Specified by:
    
    close in interface IFacade
    
    Specified by:
    
    close in interface IPdfFileStamp
  - getResponse
```
public javax.servlet.http.HttpServletResponse getResponse()
```
    Gets Response object where result of operation will be stored.
    
    Returns:
    
    HttpServletResponse object
  - setResponse
```
public void setResponse(javax.servlet.http.HttpServletResponse value)
```
    Sets Response object where result of operation will be stored.
    
    Parameters:
    
    value - HttpServletResponse object
  - getOptimizeSize
```
public boolean getOptimizeSize()
```
    Gets or sets optimization flag. Equal resource streams in resultant file are merged into one PDF object if this flag set. This allows to decrease resultant file size but may cause slower execution and larger memory requirements. Default value: false.
    
    Returns:
    
    boolean value
  - setOptimizeSize
```
public void setOptimizeSize(boolean value)
```
    Gets or sets optimization flag. Equal resource streams in resultant file are merged into one PDF object if this flag set. This allows to decrease resultant file size but may cause slower execution and larger memory requirements. Default value: false.
    
    Parameters:
    
    value - boolean value
  - dispose
```
public void dispose()
```
    Description copied from class: Facade
    
    Disposes the facade.
    
    Specified by:
    
    dispose in interface com.aspose.ms.System.IDisposable
    
    Specified by:
    
    dispose in interface IPdfFileStamp
    
    Overrides:
    
    dispose in class Facade
  - getNumberingStyle
```
public int getNumberingStyle()
```
    Gets or sets pabge numbering style. Possible values: NumeralsArabic, NumeralsRomanUppercase, NumeralsRomanLowercase, LettersAppercase, LettersLowercase
    
    Returns:
    
    NumberingStyle element
    
    See Also:
    
    NumberingStyle
  - setNumberingStyle
```
public void setNumberingStyle(int value)
```
    Gets or sets pabge numbering style. Possible values: NumeralsArabic, NumeralsRomanUppercase, NumeralsRomanLowercase, LettersAppercase, LettersLowercase
    
    Parameters:
    
    value - NumberingStyle element
    
    See Also:
    
    NumberingStyle
  - getStampId
```
public int getStampId()
```
    Stamp ID of next added stamp (including page headers/hooters/page numbers).
    
    Returns:
    
    int value
  - setStampId
```
public void setStampId(int value)
```
    Stamp ID of next added stamp (including page headers/hooters/page numbers).
    
    Parameters:
    
    value - int value

Packages

com.aspose.pdf.facades

Interfaces

Classes

Class PdfFileStampWeb

Field Summary

Constructor Summary

Method Summary

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

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

Methods inherited from class java.lang.Object

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

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

Field Detail

POS_BOTTOM_MIDDLE

POS_BOTTOM_RIGHT

POS_UPPER_RIGHT

POS_SIDES_RIGHT

POS_UPPER_MIDDLE

POS_BOTTOM_LEFT

POS_SIDES_LEFT

POS_UPPER_LEFT

Constructor Detail

PdfFileStampWeb

PdfFileStampWeb

PdfFileStampWeb

PdfFileStampWeb

PdfFileStampWeb

PdfFileStampWeb

PdfFileStampWeb

PdfFileStampWeb

PdfFileStampWeb

PdfFileStampWeb

Method Detail

getKeepSecurity

setKeepSecurity

getInputFile

setInputFile

getInputStream

setInputStream

getOutputFile

setOutputFile

getOutputStream

setOutputStream

getPageNumberRotation

setPageNumberRotation

setConvertTo

getPageHeight

getPageWidth

getStartingNumber

setStartingNumber

addStamp

addPageNumber

addPageNumber

addPageNumber

addPageNumber

addPageNumber

addPageNumber

addHeader

addHeader

addHeader

addHeader

addHeader

addHeader

addFooter

addFooter

addFooter

addFooter

addFooter

addFooter

addPageNumber

addPageNumber

getContentDisposition

setContentDisposition

getSaveOptions

setSaveOptions

getAttachmentName

setAttachmentName

close

getResponse