Stamp

Inheritance: java.lang.Object

public final class Stamp

Class represeting stamp.

Constructors

ConstructorDescription
Stamp()Constructor for Stamp object.

Methods

MethodDescription
getStampId()Gets identifier of stamp.
setStampId(int value)Sets identifier of stamp.
getQuality()Gets quality of image stamp in percent.
setQuality(int value)Sets quality of image stamp in percent.
getOpacity()Gets opacity of the stamp.
setOpacity(float value)Sets opacity of the stamp.
getPageNumber()Gets page number.
setPageNumber(int value)Sets page number.
getPages()Gets array with numbers of pages which will be affected by stamp.
setPages(int[] value)Sets array with numbers of pages which will be affected by stamp.
bindTextState(TextState textState)Sets text state of stamp text.
getRotation()Gets rotation of the stamp in degrees.
setRotation(float value)Gets or sets rotation of the stamp in degrees.
isBackground()Gets background status.
setBackground(boolean value)Sets background status.
getBlendingSpace()Gets a BlendingColorSpace value that defines a color space that is used to perform transparency and blending operations on the page.
setBlendingSpace(int value)Sets a BlendingColorSpace value that defines a color space that is used to perform transparency and blending operations on the page.
bindPdf(String pdfFile, int pageNumber)Sets PDF file and number of page which will be used as stamp.
bindPdf(InputStream pdfStream, int pageNumber)Sets PDF file and number of page which will be used as stamp.
bindImage(String imageFile)Sets image as a stamp.
bindLogo(FormattedText formattedText)Sets text as stamp.
setOrigin(float originX, float originY)Sets position on page where stamp will be placed.
setImageSize(float width, float height)Sets size of image stamp.
bindImage(InputStream image)Sets image which will be used as stamp.
close()Closes this instance

Stamp()

public Stamp()

Constructor for Stamp object.

getStampId()

public int getStampId()

Gets identifier of stamp.

Returns: int - int value

setStampId(int value)

public void setStampId(int value)

Sets identifier of stamp.

Parameters:

ParameterTypeDescription
valueintint value

getQuality()

public int getQuality()

Gets quality of image stamp in percent. Valiued values 0..100%.

Returns: int - int value

setQuality(int value)

public void setQuality(int value)

Sets quality of image stamp in percent. Valiued values 0..100%.

Parameters:

ParameterTypeDescription
valueintint value

getOpacity()

public float getOpacity()

Gets opacity of the stamp.

Returns: float - float value

setOpacity(float value)

public void setOpacity(float value)

Sets opacity of the stamp.

Parameters:

ParameterTypeDescription
valuefloatfloat value

getPageNumber()

public int getPageNumber()

Gets page number.

Returns: int - int value

setPageNumber(int value)

public void setPageNumber(int value)

Sets page number.

Parameters:

ParameterTypeDescription
valueintint value

getPages()

public int[] getPages()

Gets array with numbers of pages which will be affected by stamp.

Returns: int[] - int array

setPages(int[] value)

public void setPages(int[] value)

Sets array with numbers of pages which will be affected by stamp. If Pages = null all pages of the document are affected.

Parameters:

ParameterTypeDescription
valueint[]int array

PdfFileStamp fileStamp = new PdfFileStamp("input.pdf", "output.pdf");
              Stamp stamp = new com.aspose.pdf.facades.Stamp();
              stamp.bindLogo(new FormattedText(text));
              //put stamp only on 1st, 4th and 6th page.
              stamp.setPages(new int[] { 1, 4, 6 });
              fileStamp.addStamp(stamp);
              fileStamp.close();
``` |

### bindTextState(TextState textState) {#bindTextState-com.aspose.pdf.TextState-}

public void bindTextState(TextState textState)



Sets text state of stamp text.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| textState | [TextState](../../com.aspose.pdf/textstate) | TextState object which specifies text properties. |

### getRotation() {#getRotation--}

public float getRotation()



Gets rotation of the stamp in degrees.

**Returns:**
float - float value
### setRotation(float value) {#setRotation-float-}

public void setRotation(float value)



Gets or sets rotation of the stamp in degrees.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | float | float value

--------------------

PdfFileStamp fileStamp = new PdfFileStamp(“input.pdf”, “output.pdf”); Stamp stamp = new Stamp(); stamp.bindLogo(new FormattedText(“STAMP”)); stamp.setRotation(90); fileStamp.addStamp(stamp); fileStamp.close();


### isBackground() {#isBackground--}

public boolean isBackground()



Gets background status. If true stamp will be placed as background of the spamped page. By default is set to false.

**Returns:**
boolean - boolean value
### setBackground(boolean value) {#setBackground-boolean-}

public void setBackground(boolean value)



Sets background status. If true stamp will be placed as background of the spamped page. By default is set to false.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | boolean | boolean value |

### getBlendingSpace() {#getBlendingSpace--}

public int getBlendingSpace()



Gets a BlendingColorSpace value that defines a color space that is used to perform transparency and blending operations on the page.

**Returns:**
int - int value
### setBlendingSpace(int value) {#setBlendingSpace-int-}

public void setBlendingSpace(int value)



Sets a BlendingColorSpace value that defines a color space that is used to perform transparency and blending operations on the page.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | int | int value |

### bindPdf(String pdfFile, int pageNumber) {#bindPdf-java.lang.String-int-}

public void bindPdf(String pdfFile, int pageNumber)



Sets PDF file and number of page which will be used as stamp.

--------------------

PdfFileStamp fileStamp = new PdfFileStamp(“input.pdf”, “output.pdf”); Stamp stamp = new Stamp(); //First page will be used as stamp. stamp.bindPdf(“stamp.pdf”, 1); stamp.isBackground (true); fileStamp.addStamp(stamp); fileStamp.close();


**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| pdfFile | java.lang.String | Path to PDF file. |
| pageNumber | int | Number of page in PDF file |

### bindPdf(InputStream pdfStream, int pageNumber) {#bindPdf-java.io.InputStream-int-}

public void bindPdf(InputStream pdfStream, int pageNumber)



Sets PDF file and number of page which will be used as stamp.

--------------------

PdfFileStamp fileStamp = new PdfFileStamp(“input.pdf”, “output.pdf”); Stamp stamp = new Stamp(); //First page will be used as stamp. InputStream stream = new FileInputStream(“stamp.pdf”); stamp.bindPdf(stream, 1); fileStamp.addStamp(stamp); fileStamp.close();


**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| pdfStream | java.io.InputStream | Stream which contains PDF document. |
| pageNumber | int | Page index of the document whihc will be used as stamp. |

### bindImage(String imageFile) {#bindImage-java.lang.String-}

public void bindImage(String imageFile)



Sets image as a stamp.

--------------------

PdfFileStamp fileStamp = new PdfFileStamp(“input.pdf”, “output.pdf”); Stamp stamp = new Stamp(); stamp.bindImage(“image.jpg”); fileStamp.addStamp(stamp); fileStamp.close();


**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| imageFile | java.lang.String | Image file name and path. |

### bindLogo(FormattedText formattedText) {#bindLogo-com.aspose.pdf.facades.FormattedText-}

public void bindLogo(FormattedText formattedText)



Sets text as stamp.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| formattedText | [FormattedText](../../com.aspose.pdf.facades/formattedtext) | FormattedText object which specifies text and text properties. |

### setOrigin(float originX, float originY) {#setOrigin-float-float-}

public void setOrigin(float originX, float originY)



Sets position on page where stamp will be placed.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| originX | float | X coordinate of the stamp. |
| originY | float | Y coordinate of the stamp. |

### setImageSize(float width, float height) {#setImageSize-float-float-}

public void setImageSize(float width, float height)



Sets size of image stamp. Image will be scaled according to the specified values.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| width | float | Image width. |
| height | float | Image height. |

### bindImage(InputStream image) {#bindImage-java.io.InputStream-}

public void bindImage(InputStream image)



Sets image which will be used as stamp.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| image | java.io.InputStream | Stream which contains image data. |

### close() {#close--}

public void close()



Closes this instance